Struct WidgetInstance

pub struct WidgetInstance { /* private fields */ }

An instance of a Widget.

Implementations

impl WidgetInstance

pub fn with_id<W>(widget: W, id: WidgetTag) -> Self

where W: Widget,

Returns a new instance containing widget that is assigned the unique id provided.

pub fn new<W>(widget: W) -> Self

where W: Widget,

Returns a new instance containing widget.

pub fn id(&self) -> WidgetId

Returns the unique id of this widget instance.

pub fn with_next_focus( self, next_focus: impl IntoValue<Option<WidgetId>>, ) -> WidgetInstance

Sets the widget that should be focused next.

Cushy automatically determines reverse tab order by using this same relationship.

Panics

This function can only be called when one instance of the widget exists. If any clones exist, a panic will occur.

pub fn with_enabled(self, enabled: impl IntoValue<bool>) -> WidgetInstance

Sets this widget to be enabled/disabled based on enabled and returns self.

If this widget is disabled, all children widgets will also be disabled.

Panics

This function can only be called when one instance of the widget exists. If any clones exist, a panic will occur.

pub fn into_default(self) -> WidgetInstance

Sets this widget as a “default” widget.

Default widgets are automatically activated when the user signals they are ready for the default action to occur.

Example widgets this is used for are:

• Submit buttons on forms
• Ok buttons

Panics

This function can only be called when one instance of the widget exists. If any clones exist, a panic will occur.

pub fn into_escape(self) -> WidgetInstance

Sets this widget as an “escape” widget.

Escape widgets are automatically activated when the user signals they are ready to escape their current situation.

Example widgets this is used for are:

• Close buttons
• Cancel buttons

Panics

This function can only be called when one instance of the widget exists. If any clones exist, a panic will occur.

pub fn lock(&self) -> WidgetGuard<'_>

Locks the widget for exclusive access. Locking widgets should only be done for brief moments of time when you are certain no deadlocks can occur due to other widget locks being held.

pub fn next_focus(&self) -> Option<WidgetId>

Returns the id of the widget that should receive focus after this widget.

This value comes from MakeWidget::with_next_focus().

pub fn is_default(&self) -> bool

Returns true if this is a default widget.

See MakeWidget::into_default() for more information.

pub fn is_escape(&self) -> bool

Returns true if this is an escape widget.

See MakeWidget::into_escape() for more information.

pub fn to_window(&self) -> Window<Self>

where Self: Clone,

Returns a new window containing self as the root widget.

Trait Implementations

impl AsRef<WidgetId> for WidgetInstance

fn as_ref(&self) -> &WidgetId

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for WidgetInstance

fn clone(&self) -> WidgetInstance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WidgetInstance

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

Formats the value using the given formatter.

impl From<WidgetInstance> for WidgetRef

fn from(value: WidgetInstance) -> Self

Converts to this type from the input type.

impl MakeWidget for WidgetInstance

fn make_widget(self) -> WidgetInstance

Returns a new widget.

fn into_window(self) -> Window

Returns a new window containing self as the root widget.

fn build_standalone_window(self) -> StandaloneWindowBuilder

Returns a builder for a standalone window.

fn build_recorder(self) -> VirtualRecorderBuilder<Rgb8>

Returns a builder for a VirtualRecorder

fn with_styles(self, styles: impl IntoValue<Styles>) -> Style

where Self: Sized,

Associates styles with this widget.

fn with<C: ComponentDefinition>( self, name: &C, component: impl IntoValue<C::ComponentType>, ) -> Style

where Value<C::ComponentType>: IntoComponentValue,

Associates a style component with self.

fn with_local<C: ComponentDefinition>( self, name: &C, component: impl IntoValue<C::ComponentType>, ) -> Style

where Value<C::ComponentType>: IntoComponentValue,

Associates a style component with self, ensuring that no child widgets inherit this component.

fn with_dynamic<C: ComponentDefinition>( self, name: &C, dynamic: impl IntoDynamicComponentValue, ) -> Style

where C::ComponentType: IntoComponentValue,

Associates a style component with self, resolving its value using dynamic at runtime.

fn with_local_dynamic<C: ComponentDefinition>( self, name: &C, dynamic: impl IntoDynamicComponentValue, ) -> Style

where C::ComponentType: IntoComponentValue,

Associates a style component with self, resolving its value using dynamic at runtime. This component will not be inherited to child widgets.

fn with_shortcut<F>( self, key: impl Into<ShortcutKey>, modifiers: ModifiersState, callback: F, ) -> Shortcuts

where F: FnMut(KeyEvent) -> EventHandling + Send + 'static,

Invokes callback when key is pressed while modifiers are pressed.

fn with_repeating_shortcut<F>( self, key: impl Into<ShortcutKey>, modifiers: ModifiersState, callback: F, ) -> Shortcuts

where F: FnMut(KeyEvent) -> EventHandling + Send + 'static,

Invokes callback when key is pressed while modifiers are pressed. If the shortcut is held, the callback will be invoked on repeat events.

fn h1(self) -> Style

Styles self with the largest of 6 heading styles.

fn h2(self) -> Style

Styles self with the second largest of 6 heading styles.

fn h3(self) -> Style

Styles self with the third largest of 6 heading styles.

fn h4(self) -> Style

Styles self with the third smallest of 6 heading styles.

fn h5(self) -> Style

Styles self with the second smallest of 6 heading styles.

fn h6(self) -> Style

Styles self with the smallest of 6 heading styles.

fn xxxx_large(self) -> Style

Styles self with the largest text size.

fn xxx_large(self) -> Style

Styles self with the second largest text size.

fn xx_large(self) -> Style

Styles self with the third largest text size.

fn x_large(self) -> Style

Styles self with the fourth largest text size.

fn large(self) -> Style

Styles self with the fifth largest text size.

fn default_size(self) -> Style

Styles self with the third smallest text size.

fn small(self) -> Style

Styles self with the second smallest text size.

fn x_small(self) -> Style

Styles self with the smallest text size.

fn hint(self) -> Style

Styles self as an informational hint message.

fn with_hint(self, hint: impl MakeWidget) -> Stack

Attaches hint as an informational hint message below self.

fn with_next_focus( self, next_focus: impl IntoValue<Option<WidgetId>>, ) -> WidgetInstance

Sets the widget that should be focused next.

fn with_enabled(self, enabled: impl IntoValue<bool>) -> WidgetInstance

Sets this widget to be enabled/disabled based on enabled and returns self.

fn into_default(self) -> WidgetInstance

Sets this widget as a “default” widget.

fn into_escape(self) -> WidgetInstance

Sets this widget as an “escape” widget.

fn and(self, other: impl MakeWidget) -> WidgetList

Returns a collection of widgets using self and other.

fn chain<W: MakeWidget>(self, others: impl IntoIterator<Item = W>) -> WidgetList

Chains self and others into a WidgetList.

fn expand(self) -> Expand

Expands self to grow to fill its parent.

fn expand_weighted(self, weight: u8) -> Expand

Expands self to grow to fill its parent proportionally with other weighted siblings.

fn expand_horizontally(self) -> Expand

Expands self to grow to fill its parent horizontally.

fn expand_vertically(self) -> Expand

Expands self to grow to fill its parent vertically.

fn size<T>(self, size: Size<T>) -> Resize

where T: Into<DimensionRange>,

Resizes self to size.

fn width(self, width: impl Into<DimensionRange>) -> Resize

Resizes self to width.

fn height(self, height: impl Into<DimensionRange>) -> Resize

Resizes self to height.

fn into_button(self) -> Button

Returns this widget as the contents of a clickable button.

fn to_button(&self) -> Button

where Self: Clone,

Returns this widget as the contents of a clickable button.

fn into_checkbox(self, value: impl IntoDynamic<CheckboxState>) -> Checkbox

Returns this widget as the label of a Checkbox.

fn to_checkbox(&self, value: impl IntoDynamic<CheckboxState>) -> Checkbox

where Self: Clone,

Returns this widget as the label of a Checkbox.

fn centered(self) -> Align

Aligns self to the center vertically and horizontally.

fn align_left(self) -> Align

Aligns self to the left.

fn align_right(self) -> Align

Aligns self to the right.

fn align_top(self) -> Align

Aligns self to the top.

fn align_bottom(self) -> Align

Aligns self to the bottom.

fn fit_horizontally(self) -> Align

Fits self horizontally within its parent.

fn fit_vertically(self) -> Align

Fits self vertically within its parent.

fn scroll(self) -> Scroll

Allows scrolling self both vertically and horizontally.

fn vertical_scroll(self) -> Scroll

Allows scrolling self vertically.

fn horizontal_scroll(self) -> Scroll

Allows scrolling self horizontally.

fn into_ref(self) -> WidgetRef

Creates a WidgetRef for use as child widget.

fn contain(self) -> Container

Wraps self in a Container.

fn contain_level(self, level: impl IntoValue<ContainerLevel>) -> Container

Wraps self in a Container with the specified level.

fn background_color(self, color: impl IntoValue<Color>) -> Container

Returns a new widget that renders color behind self.

fn pad(self) -> Container

Wraps self with the default padding.

fn pad_by(self, padding: impl IntoValue<Edges<Dimension>>) -> Container

Wraps self with the specified padding.

fn themed(self, theme: impl IntoValue<ThemePair>) -> Themed

Applies theme to self and its children.

fn localized_in(self, locale: impl IntoValue<LanguageIdentifier>) -> Localized

Applies theme to self and its children.

fn themed_mode(self, mode: impl IntoValue<ThemeMode>) -> ThemedMode

Applies mode to self and its children.

fn collapse_horizontally( self, collapse_when: impl IntoDynamic<bool>, ) -> Collapse

Returns a widget that collapses self horizontally based on the dynamic boolean value.

fn collapse_vertically(self, collapse_when: impl IntoDynamic<bool>) -> Collapse

Returns a widget that collapses self vertically based on the dynamic boolean value.

fn disclose(self) -> Disclose

Returns a new widget that allows hiding and showing contents.

fn validation(self, validation: impl IntoDynamic<Validation>) -> Validated

Returns a widget that shows validation errors and/or hints.

fn tooltip(self, layer: &OverlayLayer, tip: impl MakeWidget) -> Tooltipped

Returns a widget that shows tip on layer when self is hovered.

impl ManageWidget for WidgetInstance

type Managed = Option<MountedWidget>

The managed type, which can be Option<MountedWidget> or MountedWidget.

fn manage(&self, context: &WidgetContext<'_>) -> Self::Managed

Resolve self into a MountedWidget.

impl PartialEq<WidgetInstance> for MountedWidget

fn eq(&self, other: &WidgetInstance) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for WidgetInstance

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl WindowBehavior for WidgetInstance

type Context = WidgetInstance

The type that is provided when initializing this window.

fn initialize( _window: &mut RunningWindow<Window<'_, WindowCommand>>, context: Self::Context, ) -> Self

Return a new instance of this behavior using context.

fn make_root(&mut self) -> WidgetInstance

Create the window’s root widget. This function is only invoked once.

fn initialized<W>(&mut self, window: &mut W)

where W: PlatformWindow,

Invoked once the window has been fully initialized.

fn close_requested<W>(&self, window: &mut W) -> bool

where W: PlatformWindow,

The window has been requested to close. If this function returns true, the window will be closed. Returning false prevents the window from closing.

fn run_with(context: Self::Context) -> Result

Runs this behavior as an application, initialized with context.

impl Eq for WidgetInstance

impl<T> MenuItemContents<T> for WidgetInstance