Module orbtk::api

Modules

widget

Macros

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.
ClearRenderObject
ClickEvent
ClickEventHandler	Used to handle click events. Could be attached to a widget.
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.
Constraint	Constraint describes a box constraint.
ConstraintBuilder	Used to build a constraint, specifying additional details.
DefaultRenderObject
Entity	Represents an entity.
EntityComponentManager	The EntityComponentManager represents the main entity and component storage.
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.
FontIconRenderObject
Global	The Global struct is used to define global properties that could be access application width.
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.
ImageRenderObject	Used to render an image.
InitSystem	This system is used to initializes the widgets.
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.
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
PostLayoutStateSystem	The PostLayoutStateSystem calls the update_post_layout methods of widget states.
RectangleRenderObject
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
ScrollEvent
ScrollEventHandler
ScrollLayout	IMPORTANT: The scroll layout will only work for the text box now. A update will follow!!!!
ScrollViewerMode	ScrollViewerMode describes the vertical and horizontal scroll behavior of the ScrollViewer.
SelectedEntities	SelectedEntities describes a list of selected entities.
SelectedIndices	SelectedIndices describes a list of selected indices.
Selector	Describes a css selector.
StackLayout	Stacks visual the children widgets vertical or horizontal.
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.
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.
ThemeBuilder	Used to build a theme, specifying additional details.
ThemeValue	Theme is the representation of a css styling.
Tree	Base data structure to manage the entity entities of a window in a tree based structure.
WindowAdapter	Represents a window. Each window has its own tree, event pipeline and shell.
WorldWrapper

Enums

ColumnWidth	Used to define the width of a grid column.
EventError
EventStrategy	Defines the strategy a event moves through the tree.
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.
SelectorRelation
SystemEvent
WindowEvent

Traits

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

Functions

check_mouse_condition	Checks if the given point is inside of a widget.
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.
print_tree

Type Definitions

EventHandlerMap
KeyHandler
MouseHandlerFunction