Struct carbide_core::UiCell

pub struct UiCell<'a, S: GlobalState> { /* fields omitted */ }

A wrapper around the Ui that restricts the user from mutating the Ui in certain ways while in the scope of the Ui::set_widgets function and within Widgets' update methods. Using the UiCell, users may access the Ui immutably (via Deref) however they wish, however they may only mutate the Ui via the &mut self methods provided by the UiCell.

The name came from its likening to a "jail cell for the Ui", as it restricts a user's access to it. However, we realise that the name may also cause ambiguity with the std Cell and RefCell render (which UiCell has nothing to do with). Thus, if you have a better name for this type in mind, please let us know at the github repo via an issue or PR sometime before we hit 1.0.0!

Implementations

impl<'a, S: GlobalState> UiCell<'a, S>

pub fn font(&self, id: Id) -> Option<&Font>

A convenience method for borrowing the Font for the given Id if it exists.

pub fn window_dim(&self) -> Dimensions

Returns the dimensions of the window

pub fn set_mouse_cursor(&mut self, cursor: MouseCursor)

Sets the mouse cursor

Methods from Deref<Target = Ui<S>>

pub fn mouse_cursor(&self) -> MouseCursor

Get mouse cursor state.

Trait Implementations

impl<'a, S: GlobalState> AsRef<Ui<S>> for UiCell<'a, S>

fn as_ref(&self) -> &Ui<S>

Performs the conversion.

impl<'a, S: Debug + GlobalState> Debug for UiCell<'a, S>

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

Formats the value using the given formatter.

impl<'a, S: GlobalState> Deref for UiCell<'a, S>

type Target = Ui<S>

The resulting type after dereferencing.

fn deref(&self) -> &Ui<S>

Dereferences the value.