Struct gooey::frontends::browser::WebSys

pub struct WebSys {
    pub ui: Gooey<WebSys>,
    // some fields omitted
}

WebSys is a Frontend implementor that implements Gooey interfaces through web-sys in a web browser.

Fields

ui: Gooey<WebSys>

Implementations

impl WebSys

pub fn initialize()

pub fn new(ui: Gooey<WebSys>, configuration: Configuration) -> WebSys

pub fn install_in_id(&mut self, id: &str, _window_config: WindowConfiguration)

pub fn with_transmogrifier<TResult, C>(
    &self,
    widget_id: &WidgetId,
    callback: C
) -> Option<TResult> where
    C: FnOnce(&dyn AnyWebSysTransmogrifier, AnyTransmogrifierContext<'_, WebSys>) -> TResult, 

Executes callback with the transmogrifier and transmogrifier state as parameters.

pub fn register_intent_handler(
    &self,
    intent: Intent,
    widget: &WidgetRegistration,
    callback: Callback<(), ()>
)

Trait Implementations

impl AnyTransmogrifier<WebSys> for RegisteredTransmogrifier

pub fn process_messages(&self, context: AnyTransmogrifierContext<'_, WebSys>)

Processes commands and events for this widget and transmogrifier.

pub fn widget_type_id(&self) -> TypeId

Returns the TypeId of the underlying Widget.

pub fn default_state_for(
    &self,
    widget: &mut (dyn AnyWidget + 'static),
    registration: &WidgetRegistration,
    frontend: &WebSys
) -> TransmogrifierState

Initializes default state for a newly created widget.

impl Clone for WebSys

pub fn clone(&self) -> WebSys

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebSys

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

Formats the value using the given formatter.

impl Frontend for WebSys

type AnyTransmogrifier = RegisteredTransmogrifier

The generic-free type of the frontend-specific transmogrifier trait.

type Context = WebSys

The context type provided to aide in transmogrifying.

pub fn gooey(&self) -> &Gooey<WebSys>

Returns the underlying Gooey instance.

pub fn set_widget_has_messages(&self, widget: WidgetId)

Notifies the frontend that a widget has messages. Frontends should ensure that process_widget_messages is called at some point after this method is called.

pub fn theme(&self) -> SystemTheme

Returns the current system theme.

pub fn load_image(
    &self,
    image: &Image,
    completed: Callback<Image, ()>,
    error: Callback<String, ()>
)

Loads an image asynchronously, executing completed when loaded.

pub fn asset_configuration(&self) -> &Configuration

Returns the asset configuration.

pub fn schedule_timer(
    &self,
    callback: Callback<(), ()>,
    period: Duration,
    repeating: bool
) -> Timer

Schedules a timer that invokes callback after duration, and repeats if repeating is true.

pub fn window(&self) -> Option<&(dyn Window + 'static)>

Returns the window for this interface, if present.

pub fn open(&self, _window: Box<dyn AnyWindowBuilder + 'static, Global>) -> bool

Opens a window. Returns false if unable to open the window.

fn ui_state_for(&self, widget_id: &WidgetId) -> State

Returns the State for the widget. Not all frontends track UI state, and this function is primarily used when building frontends.

fn asset_url(&self, asset: &Asset) -> Option<Url>

Returns the full Url for the asset, if available.

fn exit_managed_code(&self)

Executed when Gooey exits a managed code block.

fn widget_initialized(&self, widget: &WidgetId, style: &Style)

A widget is being initialized.

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

Localizes key with parameters.

impl<B> Transmogrifier<WebSys> for ComponentTransmogrifier<B> where
    B: Behavior, 

type State = Option<CssRules>

The type the storage this transmogrifier uses for state.

type Widget = Component<B>

The type of the widget being transmogrified.

pub fn initialize(
    &self,
    component: &mut <ComponentTransmogrifier<B> as Transmogrifier<WebSys>>::Widget,
    widget: &WidgetRef<<ComponentTransmogrifier<B> as Transmogrifier<WebSys>>::Widget>,
    frontend: &WebSys
) -> <ComponentTransmogrifier<B> as Transmogrifier<WebSys>>::State

Called after a transmogrifier is initialized.

pub fn receive_command(
    &self,
    command: <<ComponentTransmogrifier<B> as Transmogrifier<WebSys>>::Widget as Widget>::Command,
    context: &mut TransmogrifierContext<'_, ComponentTransmogrifier<B>, WebSys>
)

Called when a command is received from the widget.

fn process_messages(
    &self,
    transmogrifier_context: TransmogrifierContext<'_, Self, F>
)

Processes commands and events for this widget and transmogrifier.

fn default_state_for(
    &self,
    widget: &mut Self::Widget,
    reference: &WidgetRef<Self::Widget>,
    frontend: &F
) -> TransmogrifierState

Returns an initialized state using Self::State::default().

fn widget_type_id(&self) -> TypeId

Returns the TypeId of Self::Widget.

impl Transmogrifier<WebSys> for CheckboxTransmogrifier

type State = Option<CssRules>

The type the storage this transmogrifier uses for state.

type Widget = Checkbox

The type of the widget being transmogrified.

pub fn receive_command(
    &self,
    command: CheckboxCommand,
    context: &mut TransmogrifierContext<'_, CheckboxTransmogrifier, WebSys>
)

Called when a command is received from the widget.

fn initialize(
    &self,
    widget: &mut Self::Widget,
    reference: &WidgetRef<Self::Widget>,
    frontend: &F
) -> Self::State

Called after a transmogrifier is initialized.

fn process_messages(
    &self,
    transmogrifier_context: TransmogrifierContext<'_, Self, F>
)

Processes commands and events for this widget and transmogrifier.

fn default_state_for(
    &self,
    widget: &mut Self::Widget,
    reference: &WidgetRef<Self::Widget>,
    frontend: &F
) -> TransmogrifierState

Returns an initialized state using Self::State::default().

fn widget_type_id(&self) -> TypeId

Returns the TypeId of Self::Widget.

impl Transmogrifier<WebSys> for ContainerTransmogrifier

type State = Vec<CssRules, Global>

The type the storage this transmogrifier uses for state.

type Widget = Container

The type of the widget being transmogrified.

fn initialize(
    &self,
    widget: &mut Self::Widget,
    reference: &WidgetRef<Self::Widget>,
    frontend: &F
) -> Self::State

Called after a transmogrifier is initialized.

fn receive_command(
    &self,
    command: <Self::Widget as Widget>::Command,
    context: &mut TransmogrifierContext<'_, Self, F>
)

Called when a command is received from the widget.

fn process_messages(
    &self,
    transmogrifier_context: TransmogrifierContext<'_, Self, F>
)

Processes commands and events for this widget and transmogrifier.

fn default_state_for(
    &self,
    widget: &mut Self::Widget,
    reference: &WidgetRef<Self::Widget>,
    frontend: &F
) -> TransmogrifierState

Returns an initialized state using Self::State::default().

fn widget_type_id(&self) -> TypeId

Returns the TypeId of Self::Widget.

impl Transmogrifier<WebSys> for LayoutTransmogrifier

type State = WebSysLayoutState

The type the storage this transmogrifier uses for state.

type Widget = Layout

The type of the widget being transmogrified.

pub fn receive_command(
    &self,
    command: LayoutCommand,
    context: &mut TransmogrifierContext<'_, LayoutTransmogrifier, WebSys>
)

Called when a command is received from the widget.

fn initialize(
    &self,
    widget: &mut Self::Widget,
    reference: &WidgetRef<Self::Widget>,
    frontend: &F
) -> Self::State

Called after a transmogrifier is initialized.

fn process_messages(
    &self,
    transmogrifier_context: TransmogrifierContext<'_, Self, F>
)

Processes commands and events for this widget and transmogrifier.

fn default_state_for(
    &self,
    widget: &mut Self::Widget,
    reference: &WidgetRef<Self::Widget>,
    frontend: &F
) -> TransmogrifierState

Returns an initialized state using Self::State::default().

fn widget_type_id(&self) -> TypeId

Returns the TypeId of Self::Widget.

impl Transmogrifier<WebSys> for LabelTransmogrifier

type State = Option<CssRules>

The type the storage this transmogrifier uses for state.

type Widget = Label

The type of the widget being transmogrified.

pub fn receive_command(
    &self,
    command: Command,
    context: &mut TransmogrifierContext<'_, LabelTransmogrifier, WebSys>
)

Called when a command is received from the widget.

fn initialize(
    &self,
    widget: &mut Self::Widget,
    reference: &WidgetRef<Self::Widget>,
    frontend: &F
) -> Self::State

Called after a transmogrifier is initialized.

fn process_messages(
    &self,
    transmogrifier_context: TransmogrifierContext<'_, Self, F>
)

Processes commands and events for this widget and transmogrifier.

fn default_state_for(
    &self,
    widget: &mut Self::Widget,
    reference: &WidgetRef<Self::Widget>,
    frontend: &F
) -> TransmogrifierState

Returns an initialized state using Self::State::default().

fn widget_type_id(&self) -> TypeId

Returns the TypeId of Self::Widget.

impl Transmogrifier<WebSys> for ButtonTransmogrifier

type State = Option<CssRules>

The type the storage this transmogrifier uses for state.

type Widget = Button

The type of the widget being transmogrified.

pub fn receive_command(
    &self,
    command: ButtonCommand,
    context: &mut TransmogrifierContext<'_, ButtonTransmogrifier, WebSys>
)

Called when a command is received from the widget.

fn initialize(
    &self,
    widget: &mut Self::Widget,
    reference: &WidgetRef<Self::Widget>,
    frontend: &F
) -> Self::State

Called after a transmogrifier is initialized.

fn process_messages(
    &self,
    transmogrifier_context: TransmogrifierContext<'_, Self, F>
)

Processes commands and events for this widget and transmogrifier.

fn default_state_for(
    &self,
    widget: &mut Self::Widget,
    reference: &WidgetRef<Self::Widget>,
    frontend: &F
) -> TransmogrifierState

Returns an initialized state using Self::State::default().

fn widget_type_id(&self) -> TypeId

Returns the TypeId of Self::Widget.

impl Transmogrifier<WebSys> for InputTransmogrifier

type State = Option<CssRules>

The type the storage this transmogrifier uses for state.

type Widget = Input

The type of the widget being transmogrified.

pub fn receive_command(
    &self,
    command: Command,
    context: &mut TransmogrifierContext<'_, InputTransmogrifier, WebSys>
)

Called when a command is received from the widget.

fn initialize(
    &self,
    widget: &mut Self::Widget,
    reference: &WidgetRef<Self::Widget>,
    frontend: &F
) -> Self::State

Called after a transmogrifier is initialized.

fn process_messages(
    &self,
    transmogrifier_context: TransmogrifierContext<'_, Self, F>
)

Processes commands and events for this widget and transmogrifier.

fn default_state_for(
    &self,
    widget: &mut Self::Widget,
    reference: &WidgetRef<Self::Widget>,
    frontend: &F
) -> TransmogrifierState

Returns an initialized state using Self::State::default().

fn widget_type_id(&self) -> TypeId

Returns the TypeId of Self::Widget.

impl Transmogrifier<WebSys> for ListTransmogrifier

type State = Option<CssRules>

The type the storage this transmogrifier uses for state.

type Widget = List

The type of the widget being transmogrified.

pub fn receive_command(
    &self,
    command: ListCommand,
    context: &mut TransmogrifierContext<'_, ListTransmogrifier, WebSys>
)

Called when a command is received from the widget.

fn initialize(
    &self,
    widget: &mut Self::Widget,
    reference: &WidgetRef<Self::Widget>,
    frontend: &F
) -> Self::State

Called after a transmogrifier is initialized.

fn process_messages(
    &self,
    transmogrifier_context: TransmogrifierContext<'_, Self, F>
)

Processes commands and events for this widget and transmogrifier.

fn default_state_for(
    &self,
    widget: &mut Self::Widget,
    reference: &WidgetRef<Self::Widget>,
    frontend: &F
) -> TransmogrifierState

Returns an initialized state using Self::State::default().

fn widget_type_id(&self) -> TypeId

Returns the TypeId of Self::Widget.

impl Window for WebSys

pub fn set_title(&self, title: &str)

Sets the window title.

pub fn inner_size(&self) -> Size<u32, Pixels>

Returns the size of the content area of the window.

pub fn set_inner_size(&self, new_size: Size<u32, Pixels>)

Attempts to resize the window to new_size. This may not work on all platforms.

pub fn set_outer_position(&self, new_position: Point<i32, Pixels>)

Sets the outer position of the window. This may not work on all platforms.

pub fn inner_position(&self) -> Point<i32, Pixels>

Returns the position of the top-left of the content area in screen coordinates.

pub fn set_always_on_top(&self, _always: bool)

Sets whether the window should always be on top of other windows.

pub fn maximized(&self) -> bool

Returns true if the window is maximized.

pub fn set_maximized(&self, maximized: bool)

Sets whether the window should be maximized.

pub fn set_minimized(&self, _minimized: bool)

Sets whether the window should be minimized.

pub fn close(&self)

Closes the window.

fn outer_position(&self) -> Point<i32, Pixels>

Returns the position on the screen of the window’s top-left corner. On platforms where this is unsupported, innner_position() is returned.