denise-ui 0.10.1

Scene graph, widgets and compositor for Denise.
Documentation 
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

//! The widgets that ship with Denise.
//!
//! Deliberately few. This is a toolkit for panels and kiosks, not a general
//! application framework, and the bar a widget has to clear is being something
//! several panels would otherwise each get subtly wrong — focus handling,
//! keyboard semantics, hit areas, disabled states — rather than saving a caller
//! three `fill_rect` calls. Anything more specific is better written against
//! [`Widget`](crate::Widget) in the application than guessed at here.
//!
//! | | |
//! |---|---|
//! | [`Panel`] | A surface with an optional border |
//! | [`Label`] | Static text, aligned in its box |
//! | [`Button`] | Emits a message of your type |
//! | [`TextInput`] | Editing, a caret, and the only widget that animates by default |
//! | [`Checkbox`] | A boolean. Space toggles, Enter does not, the label is part of the hit area |
//! | [`Toggle`] | The same boolean as a switch, with a sliding knob |
//! | [`RadioGroup`] | One choice from a few. **One node, so one tab stop** |
//! | [`Progress`] | Purely an output. Clamps a value nobody checked |
//! | [`Slider`] | A value in a range. Keeps the pointer after a drag leaves it |
//! | [`Divider`] | A rule, optionally with a label in it |
//! | [`Badge`] | A short string in a coloured pill |
//! | [`Alert`] | A coloured banner with a wrapped message |
//! | [`Tabs`] | A row of labels, one selected. **One node, so one tab stop** |
//! | [`List`] | Rows, at most one selected. Selecting and activating are separate |
//! | [`RadialProgress`] | The circular counterpart, with room for a number in the middle |
//! | [`Spinner`] | An arc that turns. **The one widget that can keep a device awake** |
//! | [`Select`] | The closed half of a dropdown. [`open_select`] is the open half |
//! | [`Image`] | A picture with a [`Fit`]. Bring your own pixels, premultiplied |
//! | [`Rating`] | Stars, filled to a value. Continuous to read, whole stars to set |
//! | [`Avatar`] | A picture, or initials on a colour derived from them |
//! | [`Table`] | Cells under a pinned header. **Windows its data, so row count is free** |
//! | [`Timeline`] | Events in order: time, disc, connector, label |
//! | [`Carousel`] | Pictures sliding on the animation clock. **One wake per hold** |
//! | [`Collapse`] | A section that folds to its header. [`Accordion`] adds exclusivity |
//! | [`Video`] | The rectangle a video plane sits in. **The frames never come through here** |
//!
//! The first four are what CoreCanvas 0.4 shipped. The rest are being added one
//! at a time against <https://github.com/bisand/denise/issues/6>.
//!
//! Every one of them names theme *roles* rather than colours, so a panel built
//! from these survives a theme swap without a single widget knowing it happened.
//!
//! # Two rules they all share
//!
//! **A setter is silent.** `set_checked`, `set_value`, `set_selected` change the
//! widget and emit nothing. The message reports what a *person* did, and an
//! application that assigned and got its own message back would either loop or
//! have to guard against itself.
//!
//! **A message carries the new value**, as a `fn(T) -> M` rather than a fixed
//! message, so an application matches on what the widget became instead of
//! looking it up afterwards. An enum's tuple variant already is such a function:
//! `Checkbox::new("Mute", Message::Muted)`.
//!
mod alert;
mod avatar;
mod badge;
mod button;
mod carousel;
mod checkbox;
mod collapse;
mod divider;
mod image;
mod label;
mod list;
mod panel;
mod progress;
mod radial;
mod radio;
mod rating;
mod select;
mod slider;
mod spinner;
mod style;
mod table;
mod tabs;
mod text_input;
mod timeline;
mod toggle;
mod video;

pub use alert::Alert;
pub use avatar::{Avatar, Presence, initials_of};
pub use badge::Badge;
pub use button::Button;
pub use carousel::Carousel;
pub use checkbox::Checkbox;
pub use collapse::{Accordion, Collapse, FOLD_MS, set_open};
pub use divider::Divider;
pub use image::{Fit, Image};
pub use label::Label;
pub use list::{List, ListItem};
pub use panel::Panel;
pub use progress::Progress;
pub use radial::RadialProgress;
pub use radio::RadioGroup;
pub use rating::Rating;
pub use select::{Select, open_select};
pub use slider::Slider;
pub use spinner::Spinner;
pub use style::{Align, Orientation};
pub use table::{Column, Table};
pub use tabs::Tabs;
pub use text_input::TextInput;
pub use timeline::{Timeline, TimelineItem};
pub use toggle::Toggle;
pub use video::Video;