Struct furnace_iui::UiContext

pub struct UiContext { /* fields omitted */ }

Methods

impl UiContext

pub fn init() -> Result<Self, UIError>

Methods from Deref<Target = UI>

pub fn parent_of<T>(&self, control: T) -> Option<Control> where
    T: Into<Control>, 

pub fn is_toplevel<T>(&self, control: T) -> bool where
    T: Into<Control>, 

Returns true if this control is a top-level control; the root of the UI tree.

pub fn is_shown<T>(&self, control: T) -> bool where
    T: Into<Control>, 

Returns true if this control is currently set to be displayed.

pub fn is_enabled<T>(&self, control: T) -> bool where
    T: Into<Control>, 

Returns true if the control is enabled (can be interacted with).

pub fn main(&self)

Hands control of this thread to the UI toolkit, allowing it to display the UI and respond to events. Does not return until the UI quits.

For more control, use the EventLoop struct.

pub fn event_loop(&self) -> EventLoop

Returns an EventLoop, a struct that allows you to step over iterations or events in the UI.

pub fn quit(&self)

Running this function causes the UI to quit, exiting from main and no longer showing any widgets.

Run in every window's default on_closing callback.

pub fn queue_main<F>(&self, callback: F) where
    F: FnMut(), 

Queues a function to be executed on the GUI threa when next possible. Returns immediately, not waiting for the function to be executed.

Example

use iui::prelude::*;

let ui = UI::init().unwrap();

ui.queue_main(|| { println!("Runs first") } );
ui.queue_main(|| { println!("Runs second") } );
ui.quit();

pub fn on_should_quit<F>(&self, callback: F) where
    F: FnMut(), 

Set a callback to be run when the application quits.

Trait Implementations

impl Clone for UiContext

fn clone(&self) -> UiContext

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Deref for UiContext

type Target = UI

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl RenderContext for UiContext

type Widget = Control

type Queue = UiQueue

fn show(&mut self, widget: Self::Widget)

fn main_loop<'a>(&'a mut self, f: impl FnMut(&Self) + 'a)

fn queue(&mut self) -> Self::Queue

fn quit(&self)