Struct gooey::value::Dynamic

impl<T> Dynamic<T>

pub fn new(value: T) -> Self

Creates a new instance wrapping value.

pub fn downgrade(&self) -> WeakDynamic<T>

Returns a weak reference to this dynamic.

This is powered by Arc/Weak and follows the same semantics for reference counting.

pub fn linked<R, TIntoR, TIntoRResult, RIntoT, RIntoTResult>( &self, t_into_r: TIntoR, r_into_t: RIntoT ) -> Dynamic<R>
where T: PartialEq + Send + 'static, R: PartialEq + Send + 'static, TIntoRResult: Into<Option<R>> + Send + 'static, RIntoTResult: Into<Option<T>> + Send + 'static, TIntoR: FnMut(&T) -> TIntoRResult + Send + 'static, RIntoT: FnMut(&R) -> RIntoTResult + Send + 'static,

Returns a new dynamic that has its contents linked with self by the pair of mapping functions provided.

When the returned dynamic is updated, r_into_t will be invoked. This function accepts &R and can return T, or Option<T>. If a value is produced, self will be updated with the new value.

When self is updated, t_into_r will be invoked. This function accepts &T and can return R or Option<R>. If a value is produced, the returned dynamic will be updated with the new value.

Panics

This function panics if calling t_into_r with the current contents of the Dynamic produces a None value. This requirement is only for the first invocation, and it is guaranteed to occur before this function returns.

pub fn linked_string(&self) -> Dynamic<String>
where T: ToString + FromStr + PartialEq + Send + 'static,

Creates a linked dynamic containing a String.

When self is updated, ToString::to_string() will be called to produce a new string value to store in the returned dynamic.

When the returned dynamic is updated, str::parse is called to produce a new T. If an error is returned, self will not be updated. Otherwise, self will be updated with the produced value.

pub fn map_ref<R>(&self, map: impl FnOnce(&T) -> R) -> R

Maps the contents with read-only access.

Panics

This function panics if this value is already locked by the current thread.

pub fn map_generational<R>( &self, map: impl FnOnce(&GenerationalValue<T>) -> R ) -> R

Maps the contents with read-only access, providing access to the value’s Generation.

Panics

This function panics if this value is already locked by the current thread.

pub fn map_mut<R>(&self, map: impl FnOnce(&mut T) -> R) -> R

Maps the contents with exclusive access. Before returning from this function, all observers will be notified that the contents have been updated.

Panics

This function panics if this value is already locked by the current thread.

pub fn toggle(&self) -> T
where T: Not<Output = T> + Clone,

Updates the value to the result of invoking Not on the current value. This function returns the new value.

pub fn set_source(&self, source: CallbackHandle)

Sets the current source for this dynamic with source.

A dynamic can have multiple source callbacks.

This ensures that source stays active as long as any clones of self are alive.

pub fn debounced_every(&self, period: Duration) -> Self
where T: PartialEq + Clone + Send + Sync + 'static,

Returns a new dynamic that contains the updated contents of this dynamic at most once every period.

pub fn debounced_with_delay(&self, period: Duration) -> Self
where T: PartialEq + Clone + Send + Sync + 'static,

Returns a new dynamic that contains the updated contents of this dynamic delayed by period. Each time this value is updated, the delay is reset.

pub fn map_each_into(&self) -> Dynamic
where U: PartialEq + From<T> + Send + 'static, T: Clone + Send + 'static,

Returns a new dynamic that is updated using U::from(T.clone()) each time self is updated.

pub fn map_each_to(&self) -> Dynamic
where U: PartialEq + for<'a> From<&'a T> + Send + 'static, T: Clone + Send + 'static,

Returns a new dynamic that is updated using U::from(&T) each time self is updated.

pub fn for_each<F>(&self, for_each: F) -> CallbackHandle
where T: Send + 'static, F: for<'a> FnMut(&'a T) + Send + 'static,

Attaches for_each to this value so that it is invoked each time the value’s contents are updated.

pub fn for_each_generational<F>(&self, for_each: F) -> CallbackHandle
where T: Send + 'static, F: for<'a> FnMut(&'a GenerationalValue<T>) + Send + 'static,

Attaches for_each to this value and its Generation so that it is invoked each time the value’s contents are updated.

pub fn for_each_cloned<F>(&self, for_each: F) -> CallbackHandle
where T: Clone + Send + 'static, F: FnMut(T) + Send + 'static,

Attaches for_each to this value so that it is invoked each time the value’s contents are updated.

pub fn with_for_each<F>(self, for_each: F) -> Self
where T: Send + 'static, F: for<'a> FnMut(&'a T) + Send + 'static,

Attaches for_each to this value so that it is invoked each time the value’s contents are updated. This function returns self.

pub fn map_each<R, F>(&self, map: F) -> Dynamic<R>
where T: Send + 'static, F: for<'a> FnMut(&'a T) -> R + Send + 'static, R: PartialEq + Send + 'static,

Creates a new dynamic value that contains the result of invoking map each time this value is changed.

pub fn map_each_generational<R, F>(&self, map: F) -> Dynamic<R>
where T: Send + 'static, F: for<'a> FnMut(&'a GenerationalValue<T>) -> R + Send + 'static, R: PartialEq + Send + 'static,

Creates a new dynamic value that contains the result of invoking map each time this value is changed.

pub fn map_each_cloned<R, F>(&self, map: F) -> Dynamic<R>
where T: Clone + Send + 'static, F: FnMut(T) -> R + Send + 'static, R: PartialEq + Send + 'static,

Creates a new dynamic value that contains the result of invoking map each time this value is changed.

pub fn with_clone<R>(&self, with_clone: impl FnOnce(Self) -> R) -> R

A helper function that invokes with_clone with a clone of self. This code may produce slightly more readable code.

let value = gooey::value::Dynamic::new(1);

// Using with_clone
value.with_clone(|value| {
    std::thread::spawn(move || {
        println!("{}", value.get());
    })
});

// Using an explicit clone
std::thread::spawn({
    let value = value.clone();
    move || {
        println!("{}", value.get());
    }
});

println!("{}", value.get());

pub fn get(&self) -> T
where T: Clone,

Returns a clone of the currently contained value.

Panics

This function panics if this value is already locked by the current thread.

pub fn get_tracking_redraw(&self, context: &WidgetContext<'_, '_>) -> T
where T: Clone,

Returns a clone of the currently contained value.

context will be invalidated when the value is updated.

Panics

This function panics if this value is already locked by the current thread.

pub fn get_tracking_invalidate(&self, context: &WidgetContext<'_, '_>) -> T
where T: Clone,

Returns a clone of the currently contained value.

context will be invalidated when the value is updated.

Panics

This function panics if this value is already locked by the current thread.

pub fn take(&self) -> T
where T: Default,

Returns the currently stored value, replacing the current contents with T::default().

Panics

This function panics if this value is already locked by the current thread.

pub fn take_if_not_default(&self) -> Option<T>
where T: Default + PartialEq,

Checks if the currently stored value is different than T::default(), and if so, returns Some(self.take()).

Panics

This function panics if this value is already locked by the current thread.

pub fn replace(&self, new_value: T) -> Option<T>
where T: PartialEq,

Replaces the contents with new_value, returning the previous contents. Before returning from this function, all observers will be notified that the contents have been updated.

If the calling thread has exclusive access to the contents of this dynamic, this call will return None and the value will not be updated. If detecting this is important, use Self::try_replace().

pub fn try_replace(&self, new_value: T) -> Result<T, ReplaceError<T>>
where T: PartialEq,

Replaces the contents with new_value if new_value is different than the currently stored value. If the value is updated, the previous contents are returned.

Before returning from this function, all observers will be notified that the contents have been updated.

Errors

ReplaceError::NoChange: Returned when new_value is equal to the currently stored value.
ReplaceError::Deadlock: Returned when the current thread already has exclusive access to the contents of this dynamic.

pub fn set(&self, new_value: T)
where T: PartialEq,

Stores new_value in this dynamic. Before returning from this function, all observers will be notified that the contents have been updated.

If the calling thread has exclusive access to the contents of this dynamic, this call will return None and the value will not be updated. If detecting this is important, use Self::try_replace().

pub fn try_compare_swap( &self, expected_current: &T, new_value: T ) -> Result<T, TryCompareSwapError<T>>
where T: Clone + PartialEq,

Replaces the current value with new_value if the current value is equal to expected_current.

Returns Ok with the overwritten value upon success.

Errors

TryCompareSwapError::Deadlock: This operation would result in a thread deadlock.
TryCompareSwapError::CurrentValueMismatch: The current value did not match expected_current. The T returned is a clone of the currently stored value.

pub fn compare_swap(&self, expected_current: &T, new_value: T) -> Result<T, T>
where T: Clone + PartialEq,

Replaces the current value with new_value if the current value is equal to expected_current.

Returns Ok with the overwritten value upon success.

Errors

Returns Err with the currently stored value when expected_current does not match the currently stored value.

pub fn create_reader(&self) -> DynamicReader<T>

Returns a new reference-based reader for this dynamic value.

Panics

This function panics if this value is already locked by the current thread.

pub fn into_reader(self) -> DynamicReader<T>

Converts this Dynamic into a reader.

Panics

This function panics if this value is already locked by the current thread.

pub fn lock(&self) -> DynamicGuard<'_, T>

Returns an exclusive reference to the contents of this dynamic.

This call will block until all other guards for this dynamic have been dropped.

Panics

This function panics if this value is already locked by the current thread.

pub fn generation(&self) -> Generation

Returns the current generation of the value.

Panics

This function panics if this value is already locked by the current thread.

pub fn transition_to(&self, new_value: T) -> DynamicTransition<T>
where T: LinearInterpolate + Clone + Send + Sync,

Returns a pending transition for this value to new_value.

pub fn new_radio(&self, widget_value: T, label: impl MakeWidget) -> Radio<T>
where Self: Clone, T: Clone + Eq,

Returns a new Radio that updates this dynamic to widget_value when pressed. label is drawn next to the checkbox and is also clickable to select the radio.

pub fn new_select(&self, widget_value: T, label: impl MakeWidget) -> Select<T>
where Self: Clone, T: Clone + Eq,

Returns a new Select that updates this dynamic to widget_value when pressed. label is drawn next to the checkbox and is also clickable to select the widget.

pub fn validate_with<E, Valid>(&self, check: Valid) -> Dynamic<Validation>
where T: Send + 'static, Valid: for<'a> FnMut(&'a T) -> Result<(), E> + Send + 'static, E: Display,

Validates the contents of this dynamic using the check function, returning a dynamic that contains the validation status.

impl Dynamic<WidgetInstance>

pub fn into_switcher(self) -> Switcher

Returns a new Switcher widget whose contents is the value of this dynamic.

impl Dynamic<Children>

pub fn into_rows(self) -> Stack

Returns self as a vertical Stack of rows.

pub fn into_columns(self) -> Stack

Returns self as a horizontal Stack of columns.

pub fn into_layers(self) -> Layers

Returns self as Layers, with the widgets being stacked in the Z direction.

pub fn wrap(self) -> Wrap

Returns a Wrap that lays the children out horizontally, wrapping into additional rows as needed.

Trait Implementations§

impl<T> Clone for Dynamic<T>

fn clone(&self) -> Self

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<T> Debug for Dynamic<T>
where T: Debug,

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

Formats the value using the given formatter. Read more

impl<T> Default for Dynamic<T>
where T: Default,

fn default() -> Self

Returns the “default value” for a type. Read more

impl<T> Drop for Dynamic<T>

fn drop(&mut self)

Executes the destructor for this type. Read more

impl<'a, T> From<&'a Dynamic<T>> for WeakDynamic<T>

fn from(value: &'a Dynamic<T>) -> Self

Converts to this type from the input type.

impl From<&str> for Dynamic<String>

fn from(value: &str) -> Self

Converts to this type from the input type.

impl<T> From<Dynamic<T>> for DynamicReader<T>

fn from(value: Dynamic<T>) -> Self

Converts to this type from the input type.

impl<T> From<Dynamic<T>> for WeakDynamic<T>

fn from(value: Dynamic<T>) -> Self

Converts to this type from the input type.

impl From<String> for Dynamic<String>

fn from(value: String) -> Self

Converts to this type from the input type.

impl<T> IntoComponentValue for Dynamic<T>
where T: Clone + Send + 'static, Component: From<T>,

fn into_component_value(self) -> Value<Component>

Returns self stored in a component value.

impl IntoDynamic<CheckboxState> for Dynamic<Option<bool>>

fn into_dynamic(self) -> Dynamic<CheckboxState>

Returns self as a dynamic.

impl IntoDynamic<CheckboxState> for Dynamic<bool>

fn into_dynamic(self) -> Dynamic<CheckboxState>

Returns self as a dynamic.

impl<T> IntoDynamic<T> for Dynamic<T>

fn into_dynamic(self) -> Dynamic<T>

Returns self as a dynamic.

impl<T, E> IntoDynamic<Validation> for Dynamic<Result<T, E>>
where T: Send + 'static, E: Display + Send + 'static,

fn into_dynamic(self) -> Dynamic<Validation>

Returns self as a dynamic.

impl<T> IntoDynamicComponentValue for Dynamic<T>
where T: ComponentDefinition + Clone + Send + Sync + 'static,

fn into_dynamic_component(self) -> Value<DynamicComponent>

Returns this type converted into a dynamic component value.

impl IntoValue<ContainerShadow> for Dynamic<ContainerShadow<Lp>>

fn into_value(self) -> Value<ContainerShadow>

Returns this type as a Value.

impl IntoValue<ContainerShadow> for Dynamic<ContainerShadow<Px>>

fn into_value(self) -> Value<ContainerShadow>

Returns this type as a Value.

impl IntoValue<CowString> for Dynamic<&'static str>

fn into_value(self) -> Value<CowString>

Returns this type as a Value.

impl IntoValue<CowString> for Dynamic<String>

fn into_value(self) -> Value<CowString>

Returns this type as a Value.

impl IntoValue<MaskedString> for Dynamic<&'static str>

fn into_value(self) -> Value<MaskedString>

Returns this type as a Value.

impl IntoValue<MaskedString> for Dynamic<String>

fn into_value(self) -> Value<MaskedString>

Returns this type as a Value.

impl IntoValue<String> for Dynamic<&'static str>

fn into_value(self) -> Value<String>

Returns this type as a Value.

impl<T> IntoValue<T> for &Dynamic<T>

fn into_value(self) -> Value<T>

Returns this type as a Value.

impl<T> IntoValue<T> for Dynamic<T>

fn into_value(self) -> Value<T>

Returns this type as a Value.

impl MakeWidgetWithTag for Dynamic<&'static str>

fn make_with_tag(self, id: WidgetTag) -> WidgetInstance

Returns a new WidgetInstance whose WidgetId comes from tag.

impl MakeWidgetWithTag for Dynamic<Option<WidgetInstance>>

fn make_with_tag(self, id: WidgetTag) -> WidgetInstance

Returns a new WidgetInstance whose WidgetId comes from tag.

impl MakeWidgetWithTag for Dynamic<String>

fn make_with_tag(self, id: WidgetTag) -> WidgetInstance

Returns a new WidgetInstance whose WidgetId comes from tag.

impl MakeWidgetWithTag for Dynamic<WidgetInstance>

fn make_with_tag(self, id: WidgetTag) -> WidgetInstance

Returns a new WidgetInstance whose WidgetId comes from tag.

impl<T> PartialEq<Dynamic<T>> for WeakDynamic<T>

fn eq(&self, other: &Dynamic<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

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

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

impl<T> PartialEq<WeakDynamic<T>> for Dynamic<T>

fn eq(&self, other: &WeakDynamic<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

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

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

impl<T> PartialEq for Dynamic<T>

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

This method tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

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

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

impl Progressable for Dynamic
where U: ProgressValue + Send,

fn progress_bar(self) -> ProgressBar

Returns a new progress bar that displays progress from T::MIN to T::MAX.

impl<T> Eq for Dynamic<T>

Auto Trait Implementations§

impl<T> UnwindSafe for Dynamic<T>

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<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> Checkable for T
where T: IntoDynamic<CheckboxState>,

fn into_checkbox(self, label: impl MakeWidget) -> Checkbox

Returns a new checkbox using self as the value and label.

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 + Send + Sync>

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<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> InputValue<Cow<'static, str>> for T
where T: IntoDynamic<Cow<'static, str>>,

fn into_input(self) -> Input<Storage>

Returns this string as a text input widget.

impl<T> InputValue<CowString> for T
where T: IntoDynamic<CowString>,

fn into_input(self) -> Input<Storage>

Returns this string as a text input widget.

impl<T> InputValue<MaskedString> for T
where T: IntoDynamic<MaskedString>,

fn into_input(self) -> Input<Storage>

Returns this string as a text input widget.

impl<T> InputValue<String> for T
where T: IntoDynamic<String>,

fn into_input(self) -> Input<Storage>

Returns this string as a text input widget.

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<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> IntoStimulus<T> for T

fn into_stimulus(self) -> T

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

impl<T> IntoStoredComponent for T
where T: IntoComponentValue,

fn into_stored_component(self) -> StoredComponent

Returns this value as a stored component.

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> MakeWidget for T
where T: MakeWidgetWithTag,

fn make_widget(self) -> WidgetInstance

Returns a new widget.

fn into_window(self) -> Window<WidgetInstance>

Returns a new window containing self as the root widget.

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_dynamic<C: ComponentDefinition>( self, name: &C, dynamic: impl IntoDynamicComponentValue ) -> Style
where Value<C::ComponentType>: IntoComponentValue,

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

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 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) -> Children

Returns a collection of widgets using self and other.

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 into_checkbox(self, value: impl IntoDynamic<CheckboxState>) -> Checkbox

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 widget_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 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<T> Open for T
where T: MakeWidget,

fn open<App>(self, app: &App) -> Result<Option<WindowHandle>, EventLoopError>
where App: Application,

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> 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<U, T> Slidable for T
where T: IntoDynamic, U: SliderValue,

fn slider(self) -> Slider<T>
where T::Value: Ranged,

Returns a new slider over the full range of the type.

fn slider_between( self, min: impl IntoValue<T::Value>, max: impl IntoValue<T::Value> ) -> Slider<T>

Returns a new slider using the value of self. The slider will be limited to values between min and max.

impl<T, W> Switchable<T> for W
where W: IntoDynamic<T>,

fn switcher<F>(self, map: F) -> Switcher
where F: FnMut(&T, &Dynamic<T>) -> WidgetInstance + Send + 'static, T: Send + 'static,

Returns a new Switcher whose contents is the result of invoking map each time self is updated.

fn switch_between<Collection>(self, map: Collection) -> Switcher
where Collection: GetWidget<T> + Send + 'static, T: Send + 'static,

Returns a new Switcher whose contents switches between the values contained in map using the value in self as the key.

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<'a, 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<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> Trackable for T
where T: Trackable,

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