1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
use {
color,
Color,
Colorable,
Positionable,
Scalar,
Sizeable,
Widget,
Ui,
UiCell,
};
use graph;
use std;
use widget;
#[derive(Clone)]
#[allow(missing_copy_implementations)]
pub struct List {
pub common: widget::CommonBuilder,
pub style: Style,
pub item_instantiation: ItemInstantiation,
item_h: Scalar,
num_items: usize,
}
widget_style! {
style Style {
- scrollbar_width: Option<Scalar> { None }
- scrollbar_color: Color { theme.border_color }
- scrollbar_position: Option<ScrollbarPosition> { None }
}
}
widget_ids! {
struct Ids {
scroll_trigger,
items[],
scrollbar,
}
}
pub struct State {
ids: Ids,
}
#[derive(Copy, Clone, Debug)]
pub struct Item {
pub i: usize,
pub widget_id: widget::Id,
pub last_id: Option<widget::Id>,
pub w: Scalar,
pub h: Scalar,
scroll_trigger_id: widget::Id,
first_item_margin: Scalar,
}
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum ItemInstantiation {
All,
OnlyVisible,
}
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum ScrollbarPosition {
NextTo,
OnTop,
}
pub struct Scrollbar {
widget: widget::Scrollbar<widget::scroll::Y>,
id: widget::Id,
}
pub struct Items {
item_indices: std::ops::Range<usize>,
next_item_indices_index: usize,
list_id: widget::Id,
last_id: Option<widget::Id>,
scroll_trigger_id: widget::Id,
first_item_margin: Scalar,
item_w: Scalar,
item_h: Scalar,
}
impl List {
pub fn new(num_items: usize, item_height: Scalar) -> Self {
List {
common: widget::CommonBuilder::new(),
style: Style::new(),
item_h: item_height,
num_items: num_items,
item_instantiation: ItemInstantiation::OnlyVisible,
}.crop_kids()
}
pub fn scrollbar_next_to(mut self) -> Self {
self.style.scrollbar_position = Some(Some(ScrollbarPosition::NextTo));
self.scroll_kids_vertically()
}
pub fn scrollbar_on_top(mut self) -> Self {
self.style.scrollbar_position = Some(Some(ScrollbarPosition::OnTop));
self.scroll_kids_vertically()
}
pub fn scrollbar_width(mut self, w: Scalar) -> Self {
self.style.scrollbar_width = Some(Some(w));
self
}
pub fn scrollbar_color(mut self, color: Color) -> Self {
self.style.scrollbar_color = Some(color);
self
}
pub fn instantiate_all_items(mut self) -> Self {
self.item_instantiation = ItemInstantiation::All;
self
}
pub fn instantiate_only_visible_items(mut self) -> Self {
self.item_instantiation = ItemInstantiation::OnlyVisible;
self
}
}
impl Widget for List {
type State = State;
type Style = Style;
type Event = (Items, Option<Scrollbar>);
fn common(&self) -> &widget::CommonBuilder {
&self.common
}
fn common_mut(&mut self) -> &mut widget::CommonBuilder {
&mut self.common
}
fn init_state(&self, id_gen: widget::id::Generator) -> Self::State {
State {
ids: Ids::new(id_gen),
}
}
fn style(&self) -> Self::Style {
self.style.clone()
}
fn update(self, args: widget::UpdateArgs<Self>) -> Self::Event {
let widget::UpdateArgs { id, state, rect, prev, mut ui, style, .. } = args;
let List { common, item_h, num_items, item_instantiation, .. } = self;
assert!(item_h > 0.0, "the given item height was {:?} however it must be > 0", item_h);
let total_item_h = num_items as Scalar * item_h;
let is_scrollable = common.maybe_y_scroll.is_some() && total_item_h > rect.h();
let scrollbar_w = style.scrollbar_width(&ui.theme)
.unwrap_or_else(|| {
ui.theme.widget_style::<widget::scrollbar::Style>()
.and_then(|style| style.style.thickness)
.unwrap_or(10.0)
});
let scrollbar_position = style.scrollbar_position(&ui.theme);
let item_w = match (is_scrollable, scrollbar_position) {
(true, Some(ScrollbarPosition::NextTo)) => rect.w() - scrollbar_w,
_ => rect.w(),
};
widget::Rectangle::fill([rect.w(), total_item_h])
.mid_top_of(id)
.color(color::TRANSPARENT)
.parent(id)
.set(state.ids.scroll_trigger, ui);
let (item_idx_range, first_item_margin) = match item_instantiation {
ItemInstantiation::All => {
let range = 0..num_items;
let margin = 0.0;
(range, margin)
},
ItemInstantiation::OnlyVisible => {
let scroll_trigger_rect = ui.rect_of(state.ids.scroll_trigger).unwrap();
let hidden_range_length = (scroll_trigger_rect.top() - rect.top()).max(0.0);
let num_top_hidden_items = hidden_range_length / item_h;
let num_visible_items = rect.h() / item_h;
let first_visible_item_idx = num_top_hidden_items.floor() as usize;
let end_visible_item_idx = std::cmp::min(
(num_top_hidden_items + num_visible_items).ceil() as usize,
num_items,
);
let range = first_visible_item_idx..end_visible_item_idx;
let margin = first_visible_item_idx as Scalar * item_h;
(range, margin)
},
};
if state.ids.items.len() < item_idx_range.len() {
let id_gen = &mut ui.widget_id_generator();
state.update(|state| state.ids.items.resize(item_idx_range.len(), id_gen));
}
let items = Items {
list_id: id,
item_indices: item_idx_range,
next_item_indices_index: 0,
last_id: None,
scroll_trigger_id: state.ids.scroll_trigger,
first_item_margin: first_item_margin,
item_w: item_w,
item_h: item_h,
};
let auto_hide = match (is_scrollable, scrollbar_position) {
(false, _) | (true, None) => return (items, None),
(_, Some(ScrollbarPosition::NextTo)) => false,
(_, Some(ScrollbarPosition::OnTop)) => true,
};
let scrollbar_color = style.scrollbar_color(&ui.theme);
let scrollbar = widget::Scrollbar::y_axis(id)
.and_if(prev.maybe_floating.is_some(), |s| s.floating(true))
.color(scrollbar_color)
.thickness(scrollbar_w)
.auto_hide(auto_hide);
let scrollbar = Scrollbar {
widget: scrollbar,
id: state.ids.scrollbar,
};
(items, Some(scrollbar))
}
}
impl Items {
pub fn next(&mut self, ui: &Ui) -> Option<Item> {
let Items {
ref mut item_indices,
ref mut next_item_indices_index,
ref mut last_id,
list_id,
scroll_trigger_id,
first_item_margin,
item_w,
item_h,
} = *self;
let node_index = match ui.widget_graph().widget(list_id)
.and_then(|container| container.unique_widget_state::<List>())
.and_then(|&graph::UniqueWidgetState { ref state, .. }| {
state.ids.items.get(*next_item_indices_index).map(|&id| id)
})
{
Some(node_index) => {
*next_item_indices_index += 1;
Some(node_index)
},
None => return None,
};
match (item_indices.next(), node_index) {
(Some(i), Some(node_index)) => {
let item = Item {
i: i,
last_id: *last_id,
widget_id: node_index,
scroll_trigger_id: scroll_trigger_id,
w: item_w,
h: item_h,
first_item_margin: first_item_margin,
};
*last_id = Some(node_index);
Some(item)
},
_ => None,
}
}
}
impl Item {
pub fn set<W>(self, widget: W, ui: &mut UiCell) -> W::Event
where W: Widget,
{
let Item { widget_id, last_id, w, h, scroll_trigger_id, first_item_margin, .. } = self;
widget
.w_h(w, h)
.and(|w| match last_id {
None => w.mid_top_with_margin_on(scroll_trigger_id, first_item_margin)
.align_left_of(scroll_trigger_id),
Some(id) => w.down_from(id, 0.0),
})
.parent(scroll_trigger_id)
.set(widget_id, ui)
}
}
impl Scrollbar {
pub fn set(self, ui: &mut UiCell) {
let Scrollbar { widget, id } = self;
widget.set(id, ui);
}
}