pub struct SideSheet { /* private fields */ }Expand description
An overlay panel anchored to a viewport edge.
SideSheet is suitable for responsive inspectors, conversation drawers,
and focused configuration flows. It shares SUI’s dialog surface, spacing,
elevation, motion, focus, and semantic contracts while using a horizontal
reveal appropriate to a drawer.
Implementations§
Source§impl SideSheet
impl SideSheet
pub fn new<W>(title: impl Into<String>, body: W) -> SideSheetwhere
W: Widget + 'static,
pub fn theme(self, theme: DefaultTheme) -> SideSheet
pub fn theme_when<F>(self, theme: F) -> SideSheetwhere
F: Fn() -> DefaultTheme + 'static,
pub fn description(self, description: impl Into<String>) -> SideSheet
Sourcepub fn open(self, open: bool) -> SideSheet
pub fn open(self, open: bool) -> SideSheet
Whether the sheet is open; it is open from the start. When the user
asks to close it, the sheet calls Self::on_dismiss and stays open
until the app closes it, unless it follows a SheetState, which it
hides itself.
Sourcepub fn open_when<F>(self, open: F) -> SideSheet
pub fn open_when<F>(self, open: F) -> SideSheet
Self::open, read each time the sheet lays out.
Sourcepub fn open_from<O>(self, open: O) -> SideSheetwhere
O: Observable<bool> + 'static,
pub fn open_from<O>(self, open: O) -> SideSheetwhere
O: Observable<bool> + 'static,
Self::open, following an observable and laying out again when it
changes.
pub fn is_open(&self) -> bool
Sourcepub fn set_open(&mut self, shown: bool) -> bool
pub fn set_open(&mut self, shown: bool) -> bool
Open or close a built sheet, returning whether that changed it.
pub fn state(self, state: SheetState) -> SideSheet
pub fn modal(self, modal: bool) -> SideSheet
pub fn dismiss_on_scrim(self, dismiss_on_scrim: bool) -> SideSheet
pub fn placement(self, placement: SideSheetPlacement) -> SideSheet
pub fn width(self, width: f32) -> SideSheet
Sourcepub fn height(self, height: f32) -> SideSheet
pub fn height(self, height: f32) -> SideSheet
Set the panel height when placed at SideSheetPlacement::Bottom.
pub fn header_action<W>(self, action: W) -> SideSheetwhere
W: Widget + 'static,
pub fn action<W>(self, action: W) -> SideSheetwhere
W: Widget + 'static,
pub fn primary_action<F>(
self,
label: impl Into<String>,
on_press: F,
) -> SideSheetwhere
F: FnMut() + 'static,
pub fn secondary_action<F>(
self,
label: impl Into<String>,
on_press: F,
) -> SideSheetwhere
F: FnMut() + 'static,
pub fn on_dismiss<F>(self, on_dismiss: F) -> SideSheetwhere
F: FnMut() + 'static,
Sourcepub fn on_dismiss_with_ctx<F>(self, on_dismiss: F) -> SideSheet
pub fn on_dismiss_with_ctx<F>(self, on_dismiss: F) -> SideSheet
Self::on_dismiss, with the event context first.
Trait Implementations§
Source§impl Widget for SideSheet
impl Widget for SideSheet
Source§fn command(&mut self, ctx: &mut EventCtx, command: &Command<'_>)
fn command(&mut self, ctx: &mut EventCtx, command: &Command<'_>)
fn event(&mut self, ctx: &mut EventCtx, event: &Event)
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 stack_surface_options(&self) -> Option<StackSurfaceOptions>
Source§fn overlay_options(&self) -> Option<OverlayOptions>
fn overlay_options(&self) -> Option<OverlayOptions>
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)
Source§fn visit_children_mut(&mut self, visitor: &mut dyn WidgetPodMutVisitor)
fn visit_children_mut(&mut self, visitor: &mut dyn WidgetPodMutVisitor)
fn debug_name(&self) -> &'static str
Source§fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
Source§fn measure_size(
&mut self,
ctx: &mut MeasureCtx,
constraints: Constraints,
) -> Size
fn measure_size( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, ) -> Size
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
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
Source§fn supports_output_reuse(&self) -> bool
fn supports_output_reuse(&self) -> bool
fn layer_properties(&self) -> LayerProperties
Source§fn layer_properties_at(&self, frame_time: f64) -> LayerProperties
fn layer_properties_at(&self, frame_time: f64) -> LayerProperties
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
false so those points reach what is behind
them.Auto Trait Implementations§
impl !Freeze for SideSheet
impl !RefUnwindSafe for SideSheet
impl !Send for SideSheet
impl !Sync for SideSheet
impl !UnwindSafe for SideSheet
impl Forget for SideSheet
impl Move for SideSheet
impl Unpin for SideSheet
impl UnsafeUnpin for SideSheet
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
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>
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>
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)
&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)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.