Struct gooey::core::Gooey

pub struct Gooey<F> where
    F: Frontend,  { /* private fields */ }

A graphical user interface.

Implementations

impl<F> Gooey<F> where
    F: Frontend, 

pub fn new(
    transmogrifiers: Arc<Transmogrifiers<F>>,
    root: WidgetRegistration,
    storage: WidgetStorage
) -> Gooey<F>

Creates a new instance

pub fn root_widget(&self) -> &WidgetRegistration

Returns the root widget.

pub fn transmogrifier_for_type_id(
    &self,
    widget_type_id: TypeId
) -> Option<&<F as Frontend>::AnyTransmogrifier>

Returns the transmogrifier fo the type id

pub fn with_transmogrifier<R, C>(
    &self,
    widget_id: &WidgetId,
    frontend: &F,
    callback: C
) -> Option<R> where
    C: FnOnce(&<F as Frontend>::AnyTransmogrifier, AnyTransmogrifierContext<'_, F>) -> R, 

Executes callback with the transmogrifier and transmogrifier state as parameters.

pub fn for_each_widget<C>(&self, frontend: &F, callback: C) where
    C: FnMut(&<F as Frontend>::AnyTransmogrifier, &mut (dyn AnySendSync + 'static), &(dyn AnyWidget + 'static)), 

Executes callback with the transmogrifier and transmogrifier state as parameters.

pub fn process_widget_messages(&self, frontend: &F)

Loops over each widget processing its events first, then its commands.

Panics

Panics upon internal locking errors.

pub fn stylesheet(&self) -> &StyleSheet

Returns the root widget.

pub fn enter_managed_code(&self, frontend: &F) -> ManagedCodeGuard

Enters a region of managed code. Automatically exits the region when the returned guard is dropped.

When the last managed code region is exited, widget messages are processed before returning.

pub fn is_managed_code(&self) -> bool

Returns whether Gooey managed code is currently executing.

pub fn localize<'a>(
    &self,
    key: &str,
    parameters: impl Into<Option<LocalizationParameters<'a>>>
) -> String

Localizes key with parameters.

Methods from Deref<Target = WidgetStorage>

pub fn app(&self) -> &AppContext

Returns the application.

pub fn register<W>(&self, styled_widget: StyledWidget<W>) -> WidgetRegistration where
    W: Widget + AnyWidget, 

Register a widget with storage.

pub fn allocate<W>(&self) -> WidgetRegistration where
    W: Widget + AnyWidget, 

Allocates a widget registration. This allows obtaining a registration before the widget has been created, allowing for a parent widget to pass its id to its children during widget construction. Attempting to interact with this widget before calling register with the created widget will panic.

Panics

Panics on internal locking failures.

pub fn widget_state(&self, widget_id: &WidgetId) -> Option<WidgetState>

Returns the state of the widget with id widget_id.

Panics

Panics if internal lock handling results in an error.

pub fn lock_widget<W>(
    &self,
    widget_id: &WidgetId,
    frontend: &(dyn AnyFrontend + 'static)
) -> Option<LockedWidget<W>> where
    W: Widget, 

Returns the state of the widget with id widget_id.

Panics

Panics if internal lock handling results in an error.

pub fn for_each_widget<C>(&self, callback: C) where
    C: FnMut(WidgetState), 

Executes callback with the widget state parameters.

Panics

Panics if internal lock handling results in an error.

pub fn set_widget_has_messages(&self, widget: WidgetId)

Marks a widget as having messages. If this isn’t set, pending messages will not be received.

Panics

Panics if internal lock handling results in an error.

pub fn localize<'a>(
    &self,
    key: &str,
    parameters: impl Into<Option<LocalizationParameters<'a>>>
) -> String

Localizes key with parameters.

Trait Implementations

impl<F> Clone for Gooey<F> where
    F: Clone + Frontend, 

fn clone(&self) -> Gooey<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F> Debug for Gooey<F> where
    F: Debug + Frontend, 

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

Formats the value using the given formatter.

impl<F> Deref for Gooey<F> where
    F: Frontend, 

type Target = WidgetStorage

The resulting type after dereferencing.

fn deref(&self) -> &<Gooey<F> as Deref>::Target

Dereferences the value.