Module orbtk::prelude

Modules

api
behaviors	Behavior widgets are provides a default set of event actions like mouse event handling. Use them as child to expand the event behavior of your widget.
colors
ecs
fonts
material_font_icons
render
shell
theme
utils
widget

Macros

Debug	Derive macro generating an impl of the trait Debug.
into_property_source
widget	Used to define a widget, with properties and event handlers.

Structs

Application	The Application represents the entry point of an OrbTk based application.
AttachedProperty	Used ot generate attached properties.
Border	Describes a border of a shape with border brush, thickness and radius.
BorderBuilder	Used to build a border, specifying additional details.
Button	The Button widget can be clicked by user. It's used to perform an action.
Canvas	Canvas is used to render 3D graphics.
CheckBox	The CheckBox widget can be switch its selected state. It contains a selection box and a text.
ClearRenderObject
ClickEvent
ClickEventHandler	Used to handle click events. Could be attached to a widget.
Color	A r g b a color.
Column	Used to define the column of the Grid.
ColumnBuilder	Used to build a column, specifying additional details.
Columns	Helper struct used inside of the columns Property.
ColumnsBuilder	Used to build a columns, specifying additional details.
ComponentBox	This struct is used to store a component with its type id. Used for dynamic component adding.
ComponentBuilder	The TypeComponentBuilder is used to build a set of type key based components.
ComponentStore	The TypeComponentStore stores the components of all entities. It could be used to borrow the components of the entities.
Constraint	Constraint describes a box constraint.
ConstraintBuilder	Used to build a constraint, specifying additional details.
Container	The Container layout widget surrounds its child with a padding. Draws a box around the child.
Cursor	The Cursor widget represents a text cursor used to mark text.
CursorState
DefaultRenderObject
DirtySize	Size with width, height and dirty flag.
Entity	Represents an entity.
EntityBuilder	The entity builder is used to create an entity with components.
EntityComponentManager	The EntityComponentManager represents the main entity and component storage.
EntityStore	VecEntityStore is the default vector based implementation of an entity store.
EventBox
EventQeueIterator
EventQueue
EventStateSystem	The EventStateSystem pops events from the event queue and delegates the events to the corresponding event handlers of the widgets and updates the states.
FixedSizeLayout	Fixed size layout is defined by fixed bounds like the size of an image or the size of a text.
FontIconBlock	The FontIconBlock widget is used to draw text. It is not interactive.
FontIconRenderObject
Global	The Global struct is used to define global properties that could be access application width.
Grid	The Grid defines a flexible grid area that consists of columns and rows.
GridLayout	Orders its children in a grid layout with columns and rows. If now columns and rows are defined the gird layout could also be used as alignment layout.
HashMap	A hash map implemented with quadratic probing and SIMD lookup.
Image
ImageRenderObject	Used to render an image.
ImageWidget	The ImageWidget widget is used to draw an image. It is not interactive.
InitSystem	This system is used to initializes the widgets.
ItemsWidget	The ItemsWidget is a simple no interactive items drawer widget.
ItemsWidgetState
KeyDownEvent
KeyDownEventHandler	Used to handle key down events. Could be attached to a widget.
KeyUpEvent
KeyboardState	Contains the state information for the keyboard.
LayoutSystem	The LayoutSystem builds per iteration the layout of the current ui. The layout parts are calulated by the layout objects of layout widgets.
LinearGradientStop	Describes a position on a colorful gradient.
ListView	The ListView is an items drawer widget with selectable items.
ListViewItem
ListViewItemState
ListViewState
MouseDownEvent
MouseDownEventHandler	Used to handle mouse down events. Could be attached to a widget.
MouseMoveEvent
MouseUpEvent
MouseUpEventHandler	Used to handle mouse down events. Could be attached to a widget.
PaddingLayout	Add padding to the widget.
PipelineRenderObject
Point
PostLayoutStateSystem	The PostLayoutStateSystem calls the update_post_layout methods of widget states.
Rc	A single-threaded reference-counting pointer. 'Rc' stands for 'Reference Counted'.
Rectangle	Describes a new visual rectangle.
RectangleRenderObject
RefCell	A mutable memory location with dynamically checked borrow rules
RenderPipeline	RenderPipeline object.
RenderSystem	The RenderSystem iterates over all visual widgets and used its render objects to draw them on the screen.
Row	Used to define the row of the Grid.
RowBuilder	Used to build a row, specifying additional details.
Rows	Helper struct used inside of the row Property.
RowsBuilder
ScrollBar	The ScrollBar widget represents a position inside of a scroll container.
ScrollEvent
ScrollEventHandler
ScrollIndicator	The ScrollIndicator widget contains two scroll bars.
ScrollIndicatorState	The ScrollIndicatorState handles the ScrollIndicator widget.
ScrollLayout	IMPORTANT: The scroll layout will only work for the text box now. A update will follow!!!!
ScrollViewer	The ScrollViewer defines a layout that is used to stack its children on the z-axis.
ScrollViewerMode	ScrollViewerMode describes the vertical and horizontal scroll behavior of the ScrollViewer.
ScrollViewerState	The ScrollViewerState handles the ScrollViewer widget.
SelectedEntities	SelectedEntities describes a list of selected entities.
SelectedIndices	SelectedIndices describes a list of selected indices.
Selector	Describes a css selector.
SharedComponentBox	This struct is used to store a shared component with its type id. Used for dynamic component adding.
Stack	The Stack defines a layout that is used to stack its children on the z-axis.
StackLayout	Stacks visual the children widgets vertical or horizontal.
String16	A UTF-16 encoded, growable string.
StringComponentBuilder	The StringComponentBuilder is used to build a set of string key based components.
StringComponentStore	The StringComponentStore stores the components of entities and uses strings as component keys. It could be used to borrow the components of the entities.
Switch	The Switch widget can be switch between on and off.
SwitchState	State to handle the position of switch toggle.
TextBlock	The TextBlock widget is used to draw text. It is not interactive.
TextBox	The TextBox widget represents a single line text input widget.
TextBoxState	The TextBoxState handles the text processing of the TextBox widget.
TextRenderObject	Used to render a text.
TextSelection	Is used to mark the selection of a text.
TextSelectionLayout	The text selection layout is used to measure and arrange a text selection cursor.
Theme	Theme is the representation of a css styling.
ThemeBuilder	Used to build a theme, specifying additional details.
ThemeValue	Theme is the representation of a css styling.
Thickness	Used to describes a thickness e.g a border thickness.
ToggleButton	The ToggleButton widget can be clicked by user and could switch between selected / not selected. It's used to perform an action.
Tree	Base data structure to manage the entity entities of a window in a tree based structure.
TreeIterator	Used to create an iterator for the tree.
TypeId	A TypeId represents a globally unique identifier for a type.
Window	The Window widget provides access to the properties of a application window. It also contains global properties like keyboard modifier and focused widget.
WindowAdapter	Represents a window. Each window has its own tree, event pipeline and shell.
World	The World struct represents the main interface of the library. It used as storage of entities, components and systems.
WorldWrapper

Enums

Alignment	Used to align a widget vertical or horizontal.
Brush	A Brushdescribes how a shape is filled or stroked.
ColumnWidth	Used to define the width of a grid column.
EventError
EventStrategy	Defines the strategy a event moves through the tree.
Key	Represents a keyboard key.
NotFound	Not found error.
NotFound	Used as return type if a requested entity is not found on the tree.
Orientation	Is used to control the orientation of the Stack.
PropertySource	Use to build a property or to share it.
RowHeight	Used to define the height of a grid row.
ScrollMode	The ScrollMode defines the mode of a scroll direction.
SelectionMode	Represents a selection mode.
SelectorRelation
SystemEvent
TextAlignment	Used to align a text.
TextBaseline	Text baseline being used when drawing text
Visibility	Is used to control the visibility of a widget
WindowEvent

Traits

Any	A type to emulate dynamic typing.
Bordered	Contains a set of getters and setters to read and write to a border.
Component	This trait is used to internal handle all components types. This trait is implicitly implemented for all other types.
Debug	? formatting.
Event	Used to define an event.
EventHandler	This trait is used to define an event handler.
IntoPropertySource	Used to convert components / properties into a PropertySource object.
KeyDownHandler
Layout	A layout is used to dynamic order the children of a widget.
MouseHandler
RenderObject
System	This trait is used to interact with the components of entities. It could read and write to the components.

Functions

check_mouse_condition	Checks if the given point is inside of a widget.
default_theme
get_property	Used to the a property of a widget.
get_property_or_value	Returns the value of a property of a widget if it exists otherwise the given value.
light_theme
print_tree

Type Definitions

EventHandlerMap
KeyHandler
MouseHandlerFunction
Priority	The run order of a system. The systems will be executed by priority from small to great.

Derive Macros

Pipeline