[][src]Crate orbtk_api

API crate that provides base api and elements for OrbTk like widgets basis.

Re-exports

pub use orbtk_proc_macros as proc_macros;

Modules

application

This module contains the base elements of an OrbTk application (Application, WindowBuilder and Window).

css_engine
event

This module contains all resources to call and handle events.

layout
macros
prelude
properties

This sub module contains extra structs used as widget properties.

render
render_object

This module contains all render objects used in OrbTk. Render objects are used to define how to draw parts of a widget.

services

This module contains global services.

shell
systems

Contains all system used in OrbTk. Systems are meant as systems in OrbTks Entity Component System. These are used for event handling, building layout and drawing.

theme
tree
utils
widget

Macros

into_property_source
trigger_event
widget

Used to define a widget, with properties and event handlers.

Structs

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.

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.

SharedComponentBox

This struct is used to store a shared component with its type id. Used for dynamic component adding.

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.

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

Component

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

System

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

Type Definitions

Priority

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