Struct oxygengine_user_interface::raui::core::application::ProcessContext

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

Allows you to get mutable or immutable references to data exposed by the host of the RAUI application

This allows RAUI hosts to provide the UI with direct access to application data, if necessary, instead of using DataBindings.

See Application::process for more information.

Implementations

impl<'a> ProcessContext<'a>

pub fn new() -> ProcessContext<'a>

Create an empty ProcessContext

pub fn get_mut<T>(&mut self) -> Option<&mut T> where
    T: 'static, 

Can be used to get mutable access to application data provided by the RAUI host.

Example

fn my_component(ctx: WidgetContext) -> WidgetNode {
    let app_data = ctx.process_context.get_mut::<AppData>().unwrap();
    let counter = &mut app_data.counter;
    *counter += 1;

    // widget stuff...
}

pub fn insert_mut<T>(&mut self, item: &'a mut T) -> &mut ProcessContext<'a> where
    T: 'static, 

Allows RAUI hosts to add mutable references to application data to the process_context that is available to widget components.

See Application::process for more information.

pub fn get<T>(&self) -> Option<&T> where
    T: 'static, 

Can be used to get immutable access to application data provided by the RAUI host.

Example

fn my_component(ctx: WidgetContext) -> WidgetNode {
    let app_data = ctx.process_context.get::<AppData>().unwrap();
    let counter = app_data.counter;

    // widget stuff...
}

pub fn insert<T>(&mut self, item: &'a T) -> &mut ProcessContext<'a> where
    T: 'static, 

Allows RAUI hosts to add immutable references to application data to the process_context that is available to widget components.

See Application::process for more information.

pub fn owned_ref<T>(&self) -> Option<&T> where
    T: 'static, 

Can be used to get immutable access to owned objects available for current application processing run provided by the RAUI host.

Example

fn my_component(ctx: WidgetContext) -> WidgetNode {
    let app_data = ctx.process_context.owned_ref::<AppData>().unwrap();
    let counter = app_data.counter;

    // widget stuff...
}

pub fn owned_mut<T>(&mut self) -> Option<&mut T> where
    T: 'static, 

Can be used to get mutable access to owned objects available for current application processing run provided by the RAUI host.

Example

fn my_component(ctx: WidgetContext) -> WidgetNode {
    let app_data = ctx.process_context.owned_mut::<AppData>().unwrap();
    let counter = app_data.counter;

    // widget stuff...
}

pub fn insert_owned<T>(&mut self, item: T) -> &mut ProcessContext<'a> where
    T: 'static, 

Allows RAUI hosts to add owned objects to application data to the process_context that is available to widget components.

pub fn has<T>(&self) -> bool where
    T: 'static, 

Trait Implementations

impl<'a> Debug for ProcessContext<'a>

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a> Default for ProcessContext<'a>

pub fn default() -> ProcessContext<'a>

Returns the “default value” for a type.