Skip to main content

SplitPaneScope

Struct SplitPaneScope 

Source
pub struct SplitPaneScope { /* private fields */ }
Expand description

A SplitPane and its builder.

Implementations§

Source§

impl SplitPaneScope

Source

pub fn value(self, dp: f32) -> Self

The side pane’s width in dp, or 0 to open it folded.

Source

pub fn min(self, dp: f32) -> Self

Source

pub fn max(self, dp: f32) -> Self

Source

pub fn collapsible(self, collapsible: bool) -> Self

Source

pub fn collapse_below(self, dp: f32) -> Self

The split pane’s own width in dp below which it shows one pane at a time, the one selected_index names. At or above it the panes are never stacked, and the design system still decides between two columns and a side pane laid over the body.

Without it the line is the size class’s: stacked below 600 dp. 0 is the same as not calling this. The width is measured on the Renderer, so crossing the line sends the Host nothing. A negative or non-finite width is reported as a protocol error and the split pane is drawn as if it had none.

Source

pub fn selected_index(self, index: usize) -> Self

Which pane shows when only one fits: 0 the side pane, 1 the body.

Source

pub fn label(self, label: impl Into<String>) -> Self

What a screen reader calls the divider.

Source

pub fn on_change(self, handler: impl FnMut(f32) + 'static) -> Self

Source

pub fn on_dismiss(self, handler: impl FnMut() + 'static) -> Self

Source§

impl SplitPaneScope

Source

pub fn modifier(self, modifier: Modifier) -> Self

What sits around it. Compose’s modifier parameter.

Source§

impl SplitPaneScope

Source

pub fn content(self, content: impl FnOnce())

Composes this widget with content as its children.

Source§

impl SplitPaneScope

Source

pub fn on_motion_finished( self, handler: impl FnMut(MotionFinished) + 'static, ) -> Self

Runs once when this node’s size motion comes to rest, with the size it settled at in dp. The node needs Modifier::motion for its size to move; without it nothing is reported. A run interrupted by a newer size is not reported, only the one that settles, and under reduced motion it arrives in the frame the size changes in.

Trait Implementations§

Source§

impl Drop for SplitPaneScope

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.