Skip to main content

KeyedStack

Struct KeyedStack 

Source
pub struct KeyedStack<K, T> { /* private fields */ }
Expand description

A row or column of children kept in step with a list of keyed items.

Each item’s widget is built once and kept while its key stays in the list, updating through the Signal it was built with. New items animate in, one after another with a Stagger; removed items animate out while the gap they leave closes; items that change places glide to their new positions. An item added back while it is still leaving turns around and comes back.

Implementations§

Source§

impl<K, T> KeyedStack<K, T>
where K: Clone + Eq + Hash + 'static, T: Clone + PartialEq + 'static,

Source

pub fn new<O, KF, B, W>( axis: Axis, items: O, key_for: KF, build: B, ) -> KeyedStack<K, T>
where O: Observable<Vec<T>> + 'static, KF: Fn(&T) -> K + 'static, B: Fn(&K, Signal<T>) -> W + 'static, W: Widget + 'static,

A stack along axis of the items in items, identified by key_for and built by build.

Source

pub fn vertical<O, KF, B, W>( items: O, key_for: KF, build: B, ) -> KeyedStack<K, T>
where O: Observable<Vec<T>> + 'static, KF: Fn(&T) -> K + 'static, B: Fn(&K, Signal<T>) -> W + 'static, W: Widget + 'static,

Source

pub fn horizontal<O, KF, B, W>( items: O, key_for: KF, build: B, ) -> KeyedStack<K, T>
where O: Observable<Vec<T>> + 'static, KF: Fn(&T) -> K + 'static, B: Fn(&K, Signal<T>) -> W + 'static, W: Widget + 'static,

Source

pub fn gap(self, gap: f32) -> KeyedStack<K, T>

Source

pub fn alignment(self, alignment: Alignment) -> KeyedStack<K, T>

How items line up across the stack. Stretch, the default, makes them all as wide (or tall) as the stack.

Source

pub fn transition(self, transition: PresenceTransition) -> KeyedStack<K, T>

How items enter and leave. The stack collapses the space of leaving items unless the transition turns collapse off.

Source

pub fn stagger(self, stagger: Stagger) -> KeyedStack<K, T>

Delays for items that arrive together; Stagger::NONE brings them in at once.

Source

pub fn move_spec(self, spec: Option<AnimationSpec>) -> KeyedStack<K, T>

How items glide to new places, or None to move them at once.

Source

pub fn appear(self, appear: bool) -> KeyedStack<K, T>

Animate the first items in too, instead of showing them at once.

Source

pub fn len(&self) -> usize

The items shown, and those still leaving, in order.

Source

pub fn is_empty(&self) -> bool

Trait Implementations§

Source§

impl<K, T> Widget for KeyedStack<K, T>
where K: Clone + Eq + Hash + 'static, T: Clone + PartialEq + 'static,

Source§

fn measure(&mut self, ctx: &mut MeasureCtx, constraints: Constraints) -> Size

Source§

fn arrange(&mut self, ctx: &mut ArrangeCtx, bounds: Rect)

Source§

fn paint(&self, ctx: &mut PaintCtx)

Source§

fn semantics(&self, ctx: &mut SemanticsCtx)

Source§

fn visit_children(&self, visitor: &mut dyn WidgetPodVisitor)

Visit this widget’s logical children. Read more
Source§

fn visit_children_mut(&mut self, visitor: &mut dyn WidgetPodMutVisitor)

Mutably visit this widget’s logical children. Read more
Source§

fn event(&mut self, _ctx: &mut EventCtx, _event: &Event)

Source§

fn command(&mut self, _ctx: &mut EventCtx, _command: &Command<'_>)

Receive a typed command addressed directly to this widget. Commands are target-only and do not capture or bubble through the widget tree.
Source§

fn debug_name(&self) -> &'static str

Source§

fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)

Publish widget-specific state for an inspector snapshot. Read more
Source§

fn measure_size( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, ) -> Size

Compute a provisional size. Containers can override this to query child sizes without committing their final layouts. The default preserves existing custom widgets by delegating to measure; it may mutate state. Child measure calls still commit state. Use child size probes explicitly when only their scalar results are needed. Results must match measure for the same content and constraints. A final measure is still required before arrangement after a probe miss.
Source§

fn measure_axis( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, axis: Axis, ) -> f32

Query one component of measure_size under exactly the same constraints. Overrides may avoid computing the other component, but must return the same extent. Like size probes, this does not replace final measurement.
Source§

fn intrinsic_size( &mut self, ctx: &mut MeasureCtx, axis: Axis, available_cross: f32, ) -> IntrinsicSize

Report the smallest and preferred extent along one axis. Read more
Source§

fn supports_output_reuse(&self) -> bool

Opt into retaining paint and semantics between targeted invalidations. Output must depend only on widget state, context, and observed sources; changes must invalidate the widget. Untracked readers and callbacks with side effects should keep the default. An opaque descendant also prevents caching its ancestors. Explicit subtree/window requests always rerun them. A source observed only in paint or semantics invalidates that callback, not its descendants. Mutating child state requires a child/subtree request.
Source§

fn layer_options(&self) -> LayerOptions

Source§

fn layer_properties(&self) -> LayerProperties

Source§

fn layer_properties_at(&self, frame_time: f64) -> LayerProperties

Layer properties for the frame shown at frame_time. Override this instead of Widget::layer_properties when they come from Motion values; the runtime refreshes them without repainting when the motion invalidates Transform or Effect.
Source§

fn stack_host_options(&self) -> Option<StackHostOptions>

Source§

fn stack_surface_options(&self) -> Option<StackSurfaceOptions>

Source§

fn overlay_options(&self) -> Option<OverlayOptions>

Describe this widget as the logical owner of a presented overlay. Read more
Source§

fn accepts_focus(&self) -> bool

Source§

fn hit_test_self(&self) -> bool

Whether points inside this widget that none of its children take hit the widget itself. Containers laid over other content, like a layer of floating views, return false so those points reach what is behind them.
Source§

fn focus_changed(&mut self, _ctx: &mut EventCtx, _focused: bool)

Auto Trait Implementations§

§

impl<K, T> !RefUnwindSafe for KeyedStack<K, T>

§

impl<K, T> !Send for KeyedStack<K, T>

§

impl<K, T> !Sync for KeyedStack<K, T>

§

impl<K, T> !UnwindSafe for KeyedStack<K, T>

§

impl<K, T> Forget for KeyedStack<K, T>

§

impl<K, T> Freeze for KeyedStack<K, T>
where Arc<dyn Observable<Vec<T>>>: Freeze, Box<dyn Fn(&T) -> K>: Freeze, Box<dyn Fn(&K, Signal<T>) -> Box<dyn Widget>>: Freeze, Vec<StackEntry<K, T>>: Freeze, Option<Vec<T>>: Freeze,

§

impl<K, T> Move for KeyedStack<K, T>

§

impl<K, T> Unpin for KeyedStack<K, T>
where Arc<dyn Observable<Vec<T>>>: Unpin, Box<dyn Fn(&T) -> K>: Unpin, Box<dyn Fn(&K, Signal<T>) -> Box<dyn Widget>>: Unpin, Vec<StackEntry<K, T>>: Unpin, Option<Vec<T>>: Unpin,

§

impl<K, T> UnsafeUnpin for KeyedStack<K, T>
where Arc<dyn Observable<Vec<T>>>: UnsafeUnpin, Box<dyn Fn(&T) -> K>: UnsafeUnpin, Box<dyn Fn(&K, Signal<T>) -> Box<dyn Widget>>: UnsafeUnpin, Vec<StackEntry<K, T>>: UnsafeUnpin, Option<Vec<T>>: UnsafeUnpin,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

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.
Source§

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.
Source§

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.
Source§

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.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

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

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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