[][src]Crate orbtk

Re-exports

pub use orbtk_proc_macros as proc_macros;

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
css_engine
ecs
fonts
material_font_icons
prelude
render
shell
theme
tree
utils
widgets

Macros

Debug

Derive macro generating an impl of the trait Debug.

Structs

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.

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.

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
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.

FontIconBlock

The FontIconBlock widget is used to draw text. It is not interactive.

Grid

The Grid defines a flexible grid area that consists of columns and rows.

HashMap

A hash map implemented with quadratic probing and SIMD lookup.

Image
ImageWidget

The ImageWidget widget is used to draw an image. It is not interactive.

ItemsWidget

The ItemsWidget is a simple no interactive items drawer widget.

ItemsWidgetState
ListView

The ListView is an items drawer widget with selectable items.

ListViewItem
ListViewItemState
ListViewState
Rc

A single-threaded reference-counting pointer. 'Rc' stands for 'Reference Counted'.

RefCell

A mutable memory location with dynamically checked borrow rules

ScrollBar

The ScrollBar widget represents a position inside of a scroll container.

ScrollIndicator

The ScrollIndicator widget contains two scroll bars.

ScrollIndicatorState

The ScrollIndicatorState handles the ScrollIndicator widget.

ScrollViewer

The ScrollViewer defines a layout that is used to stack its children on the z-axis.

ScrollViewerState

The ScrollViewerState handles the ScrollViewer widget.

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.

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.

Theme

Theme is the representation of a css styling.

ToggleButton

The ToggleButton widget can be clicked by user and could switch between selected / not selected. It's used to perform an action.

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.

World

The World struct represents the main interface of the library. It used as storage of entities, components and systems.

Enums

NotFound

Not found error.

Traits

Any

A type to emulate dynamic typing.

Component

This trait is used to internal handle all components types. This trait is implicitly implemented for all other types.

Debug

? formatting.

System

This trait is used to interact with the components of entities. It could read and write to the components.

Functions

default_theme
initialize
light_theme

Type Definitions

Priority

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