Struct AppContext

pub struct AppContext<'a, Global, Event, Error>
where
    Event: 'static + Send,
    Error: 'static + Send,
{
    pub g: &'a mut Global,
    pub focus: Option<Focus>,
    pub count: usize,
    /* private fields */
}

Application context for event handling.

Fields

g: &'a mut Global

Global state for the application.

focus: Option<Focus>

Can be set to hold a Focus, if needed.

count: usize

Last frame count rendered.

Implementations

impl<Global, Event, Error> AppContext<'_, Global, Event, Error>

where Event: 'static + Send, Error: 'static + Send,

pub fn add_timer(&self, t: TimerDef) -> TimerHandle

Add a timer.

Panic

Panics if no timer support is configured.

pub fn remove_timer(&self, tag: TimerHandle)

Remove a timer.

Panic

Panics if no timer support is configured.

pub fn replace_timer(&self, h: Option<TimerHandle>, t: TimerDef) -> TimerHandle

Replace a timer. Remove the old timer and create a new one. If the old timer no longer exists it just creates the new one.

Panic

Panics if no timer support is configured.

pub fn spawn( &self, task: impl FnOnce(Cancel, &Sender<Result<Control<Event>, Error>>) -> Result<Control<Event>, Error> + Send + 'static, ) -> Result<Cancel, SendError<()>>

where Event: 'static + Send, Error: 'static + Send,

Add a background worker task.

let cancel = ctx.spawn(|cancel, send| {
    // ... do stuff
    Ok(Control::Continue)
});

Panic

Panics if no worker-thread support is configured.

pub fn queue(&self, ctrl: impl Into<Control<Event>>)

Queue additional results.

pub fn queue_err(&self, err: Error)

Queue an error.

pub fn focus(&self) -> &Focus

Access the focus-field.

Panic

Panics if no focus has been set.

pub fn focus_mut(&mut self) -> &mut Focus

Access the focus-field.

Panic

Panics if no focus has been set.

pub fn focus_event<E>(&mut self, event: &E)

where Focus: HandleEvent<E, Regular, Outcome>,

Handle the focus-event and automatically queue the result.

Panic

Panics if no focus has been set.

Trait Implementations

impl<'a, Global: Debug, Event, Error> Debug for AppContext<'a, Global, Event, Error>

where Event: 'static + Send + Debug, Error: 'static + Send + Debug,

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

Formats the value using the given formatter.