Struct orbtk::prelude::Context

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

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

Fields

entity: Entity

theme: Theme

Implementations

impl<'a> Context<'a>

pub fn new(
    ecs: (Entity, &'a mut EntityComponentManager<Tree, StringComponentStore>),
    theme: &Theme,
    provider: &'a ContextProvider,
    render_context: &'a mut RenderContext2D
) -> 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 there is no id defined, it will panic.

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 there is no id 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<'_>>

Returns the parent of the current widget. 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 there is no id defined None will be 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_to_overlay<W>(&mut self, child: W) -> Result<(), String> where
    W: Widget, 

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

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

Appends a child widget by entity to the given parent.

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

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

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

Appends a child to the current widget.

pub fn append_child_entity(&mut self, child: Entity)

Appends a child widget by entity to the current widget.

pub fn remove_child(&mut self, child: Entity)

Removes a child from the current widget. If the given entity is not a child of the given parent nothing will happen.

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

Removes a child from the overlay. If the given entity is not a child of the given parent nothing will happen.

pub fn remove_child_from(&mut self, remove_entity: Entity, parent: Entity)

Removes (recursive) a child from the given parent. If the given entity is not a child of the given parent nothing will happen.

pub fn remove_widget_list(&mut self) -> &mut Vec<Entity>

Returns a mutable reference of the children that should be removed.

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_style<'b>(
    &mut self,
    element: impl Into<&'b str>
) -> Option<Entity>

Returns the entity of the parent referenced by css element. If there is no id defined None will be 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 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 push_event_by_window<E>(&mut self, event: E) where
    E: Event, 

Pushes an event to the event queue.

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

Pushes an event to the event queue.

pub fn show_window<F>(&mut self, create_fn: F) where
    F: 'static + Fn(&mut BuildContext<'_>) -> Entity, 

Creates and show a new window.

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

Returns a mutable reference of the 2d render ctx.

pub fn send_window_request(&self, request: WindowRequest)

Gets a new sender that allows to communicate with the window shell.

pub fn window_sender(&self) -> Sender<WindowRequest>

Gets a window request sender.

pub fn new_states_keys(&self) -> Vec<Entity>

Returns a keys collection of new added states.

pub fn switch_theme(&mut self, theme: Theme)

Switch the current theme.

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.