Struct orbtk::prelude::api::widget::Context

pub struct Context<'a> {
    pub entity: Entity,
    pub theme: &'a Theme,
    // some fields omitted
}

The Context is provides access for the states to objects they could work with.

Fields

entity: Entity

theme: &'a Theme

Methods

impl<'a> Context<'a>

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

Creates a new container.

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

Returns a specific widget.

pub fn widget(&mut self) -> WidgetContainer

Returns the widget of the current state ctx.

pub fn window(&mut self) -> WidgetContainer

Returns the window widget.

pub fn child<'b>(&mut self, id: impl Into<&'b str>) -> WidgetContainer

Returns a child of the widget of the current state referenced by css id. If the no id is defined its panics.

pub fn try_child<'b>(
    &mut self,
    id: impl Into<&'b str>
) -> Option<WidgetContainer>

Returns a child of the widget of the current state referenced by css id. If the no id is defined None will returned.

pub fn parent(&mut self) -> WidgetContainer

Returns the parent of the current widget. Panics if the parent does not exists.

pub fn try_parent(&mut self) -> Option<WidgetContainer>

If the current widget is the root None will be returned.

pub fn parent_from_id<'b>(&mut self, id: impl Into<&'b str>) -> WidgetContainer

Returns a parent of the widget of the current state referenced by css id. Panics if a parent with the given id could not be found

pub fn try_parent_from_id<'b>(
    &mut self,
    id: impl Into<&'b str>
) -> Option<WidgetContainer>

Returns a parent of the widget of the current state referenced by css id. If the no id is defined None will returned.

pub fn child_from_index(&mut self, index: usize) -> WidgetContainer

Returns the child of the current widget. Panics if a child on the given index could not be found.

pub fn try_child_from_index(&mut self, index: usize) -> Option<WidgetContainer>

Returns the child of the current widget. If the index is out of the children index bounds or the widget has no children None will be returned.

pub fn build_context(&mut self) -> BuildContext

Returns the current build ctx.

pub fn append_child_to<W>(&mut self, child: W, parent: Entity) where
    W: Widget, 

Appends a child widget to the given parent.

pub fn append_child<W>(&mut self, child: W) where
    W: Widget, 

Appends a child to the current widget.

pub fn clear_children(&mut self)

Clears all children of the current widget.

pub fn clear_children_of(&mut self, parent: Entity)

Clears all children of the given widget.

pub fn entity_of_child<'b>(&mut self, id: impl Into<&'b str>) -> Option<Entity>

Returns the entity id of an child by the given name.

pub fn parent_entity_by_element<'b>(
    &mut self,
    element: impl Into<&'b str>
) -> Option<Entity>

Returns the entity of the parent referenced by css element. If the no id is defined None will returned.

pub fn entity_of_parent(&mut self) -> Option<Entity>

Returns the entity of the parent.

pub fn index_as_child(&mut self, entity: Entity) -> Option<usize>

Returns the child index of the current entity.

pub fn send_message(
    &mut self,
    target_widget: &str,
    message: impl Into<MessageBox>
)

Sends a message to the widget with the given id over the message channel.

pub fn push_event_strategy<E>(&mut self, event: E, strategy: EventStrategy) where
    E: Event, 

Pushes an event to the event queue with the given strategy.

pub fn push_event<E>(&mut self, event: E) where
    E: Event, 

Pushes an event to the event queue.

pub fn push_event_by_entity<E>(&mut self, event: E, entity: Entity) where
    E: Event, 

Pushes an event to the event queue.

pub fn render_context_2_d(&mut self) -> &mut RenderContext2D

Returns a mutable reference of the 2d render ctx.

Trait Implementations

impl<'a> Drop for Context<'a>

fn drop(&mut self)

Executes the destructor for this type.