kas-widgets 0.17.1

KAS GUI / widgets
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
109
110
111
112
113
114
115
116
117
118

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License in the LICENSE-APACHE file or at:
//     https://www.apache.org/licenses/LICENSE-2.0

//! KAS widget library
//!
//! ## Complex widgets
//!
//! -   [`EventConfig`] provides an editor for event configuration
//! -   [`TitleBar`] is a window title-bar (including buttons)
//! -   [`TitleBarButtons`] is the standard minimize/maximize/close button cluster on a title-bar
//!
//! ## Sub-modules
//!
//! -   [`adapt`] provides [`Adapt`], [`AdaptWidget`], [`AdaptWidgetAny`] and supporting items
//!     (the items mentioned are re-export here).
//! -   [`dialog`] provides [`MessageBox`](dialog::MessageBox), ...
//! -   [`edit`] provides text-editing functionality; the [`EditBox`] and [`EditField`] widgets are re-export here
//! -   [`menu`] provides a [`MenuBar`](menu::MenuBar), [`SubMenu`](menu::SubMenu), ...
//!
//! ## Container widgets
//!
//! -   [`Frame`]: a frame around content
//! -   [`ClipRegion`], [`ScrollRegion`]: larger on the inside
//! -   [`Stack`], [`TabStack`]: a stack of widgets in the same rect
//! -   [`List`]: a row / column of children
//! -   [`Splitter`]: like [`List`] but with resizing handles
//! -   [`Grid`]: a container using grid layout
//!
//! ## Controls
//!
//! -   [`Button`], [`MarkButton`]: button widgets
//! -   [`CheckBox`], [`CheckButton`]: checkable boxes
//! -   [`RadioBox`], [`RadioButton`]: linked checkable boxes
//! -   [`ComboBox`]: a drop-down menu over a list
//! -   [`ScrollBar`]: a scroll bar
//!     bars around an inner widget
//! -   [`Slider`]: a slider
//! -   [`SpinBox`]: numeric entry
//!
//! ## Displays
//!
//! -   [`Filler`]: an empty widget, sometimes used to fill space
//! -   [`Label`], [`AccessLabel`]: are static text labels
//! -   [`Text`]: a dynamic (input-data derived) text label
//! -   [`Mark`]: a small mark
//! -   [`ScrollLabel`]: static text label supporting scrolling and selection
//! -   [`ScrollText`]: dynamic text label supporting scrolling and selection
//! -   [`Separator`]: a visible bar to separate things
//! -   [`format_text`] and [`format_label`] are constructors for [`Text`],
//!     displaying a text label derived from input data
//! -   [`ProgressBar`]: show completion level
//!
//! ## Components
//!
//! -   [`AccessLabel`]: a label which parses access keys
//! -   [`GripPart`]: a handle (e.g. for a slider, splitter or scroll_bar)

pub mod adapt;
#[doc(no_inline)]
pub use adapt::{Adapt, AdaptWidget, AdaptWidgetAny};

mod access_label;
mod button;
mod check_box;
mod combobox;
pub mod dialog;
pub mod edit;
mod event_config;
mod filler;
mod float;
mod flow;
mod frame;
mod grid;
mod grip;
mod list;
pub mod menu;
mod progress;
mod radio_box;
mod scroll;
mod scroll_bar;
mod scroll_label;
mod separator;
mod slider;
mod spin_box;
mod splitter;
mod stack;
mod tab_stack;
mod text;

#[doc(inline)] pub use kas::widgets::*;

pub use access_label::AccessLabel;
pub use button::Button;
pub use check_box::{CheckBox, CheckButton};
pub use combobox::ComboBox;
pub use edit::{EditBox, EditField};
pub use event_config::EventConfig;
pub use filler::Filler;
pub use float::Float;
pub use flow::Flow;
pub use frame::Frame;
pub use grid::Grid;
pub use grip::{GripMsg, GripPart};
pub use list::*;
pub use progress::ProgressBar;
pub use radio_box::{RadioBox, RadioButton};
pub use scroll::{ClipRegion, ScrollRegion};
pub use scroll_bar::{ScrollBar, ScrollBarMode, ScrollBarMsg};
pub use scroll_label::{ScrollLabel, ScrollText, SelectableLabel, SelectableText};
pub use separator::Separator;
pub use slider::{Slider, SliderValue};
pub use spin_box::{SpinBox, SpinValue};
pub use splitter::Splitter;
pub use stack::{Page, Stack};
pub use tab_stack::{BoxTabStack, Tab, TabStack};
pub use text::Text;