Struct BottomSheet 

pub struct BottomSheet { /* private fields */ }

A sheet up from a narrow window’s foot. See the module docs.

Implementations

impl BottomSheet

pub fn new() -> BottomSheet

A sheet that opens at half the window.

pub fn detent(&self) -> SheetDetent

The detent it rests at, or is going to.

pub fn set_detent( &mut self, detent: SheetDetent, source: MotionSource, motion: EffectiveMotion, )

Send the sheet to detent on the snap motion, as source asked.

pub fn snap_to(&mut self, detent: SheetDetent)

Rest at detent at once (a capture, a test).

pub fn step( &mut self, up: bool, source: MotionSource, motion: EffectiveMotion, ) -> bool

Step a detent up or down; whether there was one to step to.

pub fn lower(&mut self, motion: EffectiveMotion) -> bool

Back’s step on the sheet: from the whole window it comes down to half, the content above it in view again; from half or peeking there is nothing lower to rest at, and the holder puts it away. Returns whether it came down.

pub fn advance(&mut self, now: Instant) -> bool

Advance the settle to now. Returns whether it is still moving.

pub fn is_moving(&self) -> bool

Whether the sheet is on its way to a detent or held by a drag.

pub fn is_dragging(&self) -> bool

Whether a drag holds the grip.

pub fn drawn(&self) -> f64

The pose drawn this frame, to tell whether a tick changed it.

pub fn geometry( &self, frame: SheetFrame, reveal: f64, open: bool, ) -> SheetGeometry

Where the sheet stands in frame with its open/close slide at reveal (0..=1); open is whether it is open or opening.

pub fn place( &mut self, frame: SheetFrame, reveal: f64, open: bool, ) -> SheetGeometry

Stand in frame this frame (see Self::geometry); events and painting use where it was placed last.

pub fn placed(&self) -> SheetGeometry

Where it was placed last.

pub fn is_focused(&self) -> bool

Whether the grip holds the keyboard.

pub fn set_focused(&mut self, focused: bool)

pub fn contains(&self, point: Point) -> bool

Whether point is on the sheet: what lands there is the sheet’s, never the content’s under it.

pub fn claims_touch(&self, point: Point) -> bool

Whether a finger landing at point takes the grip (it drags the sheet; it never scrolls).

pub fn cursor_shape(&self, point: Point) -> Option<CursorIcon>

The cursor over the grip.

pub fn handle_event( &mut self, event: &WindowEvent, ctx: &EventCtx<'_>, motion: EffectiveMotion, ) -> SheetInput

The sheet’s own events: a drag on its grip, a press on it, the arrow keys while it holds the keyboard. Place it first.

pub fn accessibility(&self, name: &str, target: &str) -> AccessNode

The sheet as a region named name, its grip a slider whose value is the detent, routed back by target (Self::perform_action).

pub fn perform_action( &mut self, action: &Action, motion: EffectiveMotion, ) -> bool

Carry out action on the grip: focus it, step it, or set it to a detent by its label. Returns whether it did.

pub fn paint( &self, scene: &mut Scene, transform: Affine, theme: &Theme, ) -> Theme

Paint the sheet where it was placed: the floating level with its two-layer shadow and inner hairline, as every floating surface stands off what is under it (crate::surface::floating_shadow, crate::surface::panel), with the panel radius along its top edge, standing on the window’s foot, and its grip. Returns the theme to draw what it holds with.

Trait Implementations

impl Clone for BottomSheet

fn clone(&self) -> BottomSheet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BottomSheet

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

Formats the value using the given formatter.

impl Default for BottomSheet

fn default() -> BottomSheet

Returns the “default value” for a type.