pub struct BottomSheet { /* private fields */ }Expand description
A modal surface anchored to the bottom edge of its allocated viewport.
BottomSheet follows the same focus, dismissal, semantics, and action
contracts as SideSheet, while exposing height-oriented configuration.
Implementations§
Source§impl BottomSheet
impl BottomSheet
pub fn new<W>(title: impl Into<String>, body: W) -> BottomSheetwhere
W: Widget + 'static,
pub fn theme(self, theme: DefaultTheme) -> BottomSheet
pub fn theme_when<F>(self, theme: F) -> BottomSheetwhere
F: Fn() -> DefaultTheme + 'static,
pub fn description(self, description: impl Into<String>) -> BottomSheet
Sourcepub fn open(self, open: bool) -> BottomSheet
pub fn open(self, open: bool) -> BottomSheet
Whether the sheet is open; see SideSheet::open.
Sourcepub fn open_when<F>(self, open: F) -> BottomSheet
pub fn open_when<F>(self, open: F) -> BottomSheet
Self::open, read each time the sheet lays out.
Sourcepub fn open_from<O>(self, open: O) -> BottomSheetwhere
O: Observable<bool> + 'static,
pub fn open_from<O>(self, open: O) -> BottomSheetwhere
O: Observable<bool> + 'static,
Self::open, following an observable.
pub fn is_open(&self) -> bool
Sourcepub fn set_open(&mut self, open: bool) -> bool
pub fn set_open(&mut self, open: bool) -> bool
Open or close a built sheet, returning whether that changed it.
pub fn state(self, state: SheetState) -> BottomSheet
pub fn modal(self, modal: bool) -> BottomSheet
pub fn dismiss_on_scrim(self, dismiss: bool) -> BottomSheet
pub fn height(self, height: f32) -> BottomSheet
pub fn header_action<W>(self, action: W) -> BottomSheetwhere
W: Widget + 'static,
pub fn action<W>(self, action: W) -> BottomSheetwhere
W: Widget + 'static,
pub fn primary_action<F>(
self,
label: impl Into<String>,
on_press: F,
) -> BottomSheetwhere
F: FnMut() + 'static,
pub fn secondary_action<F>(
self,
label: impl Into<String>,
on_press: F,
) -> BottomSheetwhere
F: FnMut() + 'static,
pub fn on_dismiss<F>(self, on_dismiss: F) -> BottomSheetwhere
F: FnMut() + 'static,
Sourcepub fn on_dismiss_with_ctx<F>(self, on_dismiss: F) -> BottomSheet
pub fn on_dismiss_with_ctx<F>(self, on_dismiss: F) -> BottomSheet
Self::on_dismiss, with the event context first.
Trait Implementations§
Source§impl Widget for BottomSheet
impl Widget for BottomSheet
Source§fn command(&mut self, ctx: &mut EventCtx, command: &Command<'_>)
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.
fn event(&mut self, ctx: &mut EventCtx, event: &Event)
fn debug_name(&self) -> &'static str
fn measure(&mut self, ctx: &mut MeasureCtx, constraints: Constraints) -> Size
fn arrange(&mut self, ctx: &mut ArrangeCtx, bounds: Rect)
fn paint(&self, ctx: &mut PaintCtx)
fn layer_options(&self) -> LayerOptions
fn layer_properties(&self) -> LayerProperties
fn stack_surface_options(&self) -> Option<StackSurfaceOptions>
Source§fn overlay_options(&self) -> Option<OverlayOptions>
fn overlay_options(&self) -> Option<OverlayOptions>
Describe this widget as the logical owner of a presented overlay. Read more
fn semantics(&self, ctx: &mut SemanticsCtx)
fn accepts_focus(&self) -> bool
fn focus_changed(&mut self, ctx: &mut EventCtx, focused: bool)
Source§fn visit_children(&self, visitor: &mut dyn WidgetPodVisitor)
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)
fn visit_children_mut(&mut self, visitor: &mut dyn WidgetPodMutVisitor)
Mutably visit this widget’s logical children. Read more
Source§fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
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
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
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
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
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_properties_at(&self, frame_time: f64) -> LayerProperties
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.fn stack_host_options(&self) -> Option<StackHostOptions>
Source§fn hit_test_self(&self) -> bool
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.Auto Trait Implementations§
impl !Freeze for BottomSheet
impl !RefUnwindSafe for BottomSheet
impl !Send for BottomSheet
impl !Sync for BottomSheet
impl !UnwindSafe for BottomSheet
impl Forget for BottomSheet
impl Move for BottomSheet
impl Unpin for BottomSheet
impl UnsafeUnpin for BottomSheet
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn 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.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
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)
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.