Struct orbtk::prelude::BuildContext

pub struct BuildContext<'a> { /* fields omitted */ }

Used to create an entity for a widget with its properties as components.

Implementations

impl<'a> BuildContext<'a>

pub fn get_widget(&mut self, entity: Entity) -> WidgetContainer<'_>

Returns a specific widget.

pub fn create_entity(&mut self) -> Entity

Creates a new entity.

pub fn update_theme_by_state(&mut self, entity: Entity)

Update theme by state.

pub fn append_child(&mut self, parent: Entity, child: Entity)

Appends a child to a parent.

pub fn append_child_to_overlay(&mut self, child: Entity) -> Result<(), String>

Appends a child to overlay (on the top of the main tree). If the overlay does not exists an error will be returned.

pub fn register_property<P>(&mut self, key: &str, widget: Entity, property: P) where
    P: Component, 

Registers a property as component.

pub fn register_property_box(
    &mut self,
    key: &str,
    widget: Entity,
    property: ComponentBox
)

Registers a property box as component.

pub fn register_shared_property<P>(
    &mut self,
    key: &str,
    target: Entity,
    source: Entity
) where
    P: Component, 

Registers a shared property. Uses the key as source key

pub fn register_shared_property_by_source_key<P>(
    &mut self,
    key: &str,
    source_key: &str,
    target: Entity,
    source: Entity
) where
    P: Component, 

Registers a shared property.

pub fn register_property_shared_box(
    &mut self,
    key: &str,
    widget: Entity,
    property: SharedComponentBox
)

Registers a shared component box. Uses the key as source key

pub fn register_property_shared_box_by_source_key(
    &mut self,
    key: &str,
    source_key: &str,
    widget: Entity,
    property: SharedComponentBox
)

Registers a shared component box.

pub fn register_state(
    &mut self,
    widget: Entity,
    state: Box<dyn State + 'static>
)

Registers a state with a widget.

pub fn register_render_object(
    &mut self,
    widget: Entity,
    render_object: Box<dyn RenderObject + 'static>
)

Registers a render object with a widget.

pub fn register_handler(
    &mut self,
    widget: Entity,
    handler: Rc<dyn EventHandler + 'static>
)

Registers an event handler with a widget.

pub fn register_layout(
    &mut self,
    widget: Entity,
    layout: Box<dyn Layout + 'static>
)

Registers a layout object with a widget.

impl<'a> BuildContext<'a>

pub fn new(
    ecm: &'a mut EntityComponentManager<Tree, StringComponentStore>,
    render_objects: &'a RefCell<BTreeMap<Entity, Box<dyn RenderObject + 'static>>>,
    layouts: &'a RefCell<BTreeMap<Entity, Box<dyn Layout + 'static>>>,
    handlers: &'a RefCell<BTreeMap<Entity, Vec<Rc<dyn EventHandler + 'static>>>>,
    states: &'a mut BTreeMap<Entity, Box<dyn State + 'static>>,
    theme: &'a Theme,
    event_queue: &'a Rc<RefCell<EventQueue>>
) -> BuildContext<'a>