Struct cushy :: widget :: WidgetInstance Copy item path

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. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for WidgetInstance

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

Formats the value using the given formatter. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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

Sets the widget that should be focused next. Read more

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

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

fn into_default(self) -> WidgetInstance

Sets this widget as a “default” widget. Read more

fn into_escape(self) -> WidgetInstance

Sets this widget as an “escape” widget. Read more

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. Read more

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

Resizes self to height. Read more

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 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. Read more

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

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

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 ==.

1.0.0 · source§

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 ==.

1.0.0 · source§

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

Auto Trait Implementations§

impl !UnwindSafe for WidgetInstance

Blanket Implementations§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, >::Scalar>, ) -> T

Converts self into C, using the provided parameters.

impl<A> Cast for A

fn cast<To>(self) -> To
where To: CastFrom<A>,

Casts self to the To type. This may be a lossy operation.

impl<A> CastFrom<A> for A

fn from_cast(from: A) -> A

Returns from as Self.

impl<A, B> CastInto<A> for B
where A: CastFrom,

fn cast_into(self) -> A

Returns self as To.

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> DowncastSync for T
where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromAngle<T> for T

fn from_angle(angle: T) -> T

Performs a conversion from angle.

impl<T, U> FromStimulus for T
where U: IntoStimulus<T>,

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, U> IntoAngle for T
where U: FromAngle<T>,

fn into_angle(self) -> U

Performs a conversion into T.

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, >::Scalar>, ) -> T

Converts self into C, using the provided parameters.

impl<T, U> IntoColor for T
where U: FromColor<T>,

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more

impl<T, U> IntoColorUnclamped for T
where U: FromColorUnclamped<T>,

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> IntoReadOnly<T> for T

fn into_read_only(self) -> ReadOnly<T>

Returns self as a ReadOnly.

impl<T> IntoStimulus<T> for T

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.

impl<T> IntoValue<Option<T>> for T

fn into_value(self) -> Value<Option<T>>

Returns this type as a Value.

impl<T> IntoValue<T> for T

fn into_value(self) -> Value<T>

Returns this type as a Value.

impl<T> MakeWindow for T
where T: MakeWidget,

type Behavior = WidgetInstance

The behavior associated with this window.

fn make_window(self) -> Window<<T as MakeWindow>::Behavior>

Returns a new window from self.

fn open_centered<App>(self, app: &mut App) -> Result<WindowHandle>
where Self: Sized, App: Application + ?Sized,

Opens self in the center of the monitor the window initially appears on.

fn run_centered(self) -> Result
where Self: Sized,

Runs self in the center of the monitor the window initially appears on.

fn run_centered_in(self, app: PendingApp) -> Result
where Self: Sized,

Runs app after opening self in the center of the monitor the window initially appears on.

impl<T> Open for T
where T: MakeWindow,

fn open<App>(self, app: &mut App) -> Result<WindowHandle, EventLoopError>
where App: Application + ?Sized,

Opens the provided type as a window inside of app.

fn run_in(self, app: PendingApp) -> Result<(), EventLoopError>

Runs the provided type inside of the pending app, returning Ok(()) upon successful execution and program exit. Note that this function may not ever return on some platforms.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Run for T
where T: MakeWidget,

fn run(self) -> Result<(), EventLoopError>

Runs the provided type, returning Ok(()) upon successful execution and program exit. Note that this function may not ever return on some platforms.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T, U> TryIntoColor for T
where U: TryFromColor<T>,

fn try_into_color(self) -> Result<U, OutOfBounds>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more

impl<C, U> UintsFrom<C> for U
where C: IntoUints,

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.

impl<C, U> UintsInto<C> for U
where C: FromUints,

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> MaybeSendSync for T

impl<T> WasmNotSend for T
where T: Send,

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,