KAS Widgets

This is KAS's widget library.

For documentation of feature flags, see Cargo.toml.

Copyright and Licence

The COPYRIGHT file includes a list of contributors who claim copyright on this project. This list may be incomplete; new contributors may optionally add themselves to this list.

The KAS library is published under the terms of the Apache License, Version 2.0. You may obtain a copy of this licence from the LICENSE file or on the following webpage: https://www.apache.org/licenses/LICENSE-2.0

lib.rs:

KAS widget library

Complex widgets

• EventConfig provides an editor for event configuration
• kas::Window is the root of any UI tree used as a window
• kas::Popup is the root of any popup

Sub-modules

• adapt provides Adapt, AdaptWidget, AdaptWidgetAny and supporting items (the items mentioned are re-export here).
• dialog provides MessageBox, ...
• edit provides EditBox, EditField widgets, EditGuard trait and some impls
• menu provides a MenuBar, SubMenu, ...

Container widgets

• Frame, NavFrame: frames around content
• ScrollRegion, ScrollBarRegion: 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 matrix 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; ScrollBars: a wrapper adding scroll bars around an inner widget
• Slider: a slider
• Spinner: numeric entry

Displays

• Filler: an empty widget, sometimes used to fill space
• Image: a pixmap image
• 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_value and format_data 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)