Struct Drawer 

pub struct Drawer { /* private fields */ }

A panel anchored to one side of the window.

Implementations

impl Drawer

pub fn new( ident: impl Into<Ident>, _window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

pub fn edge(self, edge: Edge) -> Self

Which side the panel hangs from and slides in from.

pub fn size(self, size: f32) -> Self

The width of a left or right drawer, or the height of a top or bottom one.

pub fn title(self, title: impl Into<SharedString>) -> Self

pub fn description(self, description: impl Into<SharedString>) -> Self

pub fn content( self, body: impl Fn(&mut Window, &mut App) -> AnyElement + 'static, ) -> Self

Supplies the body, rebuilt on every frame the drawer is on screen.

pub fn footer( self, footer: impl Fn(&mut Window, &mut App) -> AnyElement + 'static, ) -> Self

Supplies the footer, rebuilt on every frame the drawer is on screen.

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

Whether escape and the scrim close the drawer. A drawer that is not dismissable installs neither handler.

pub fn focus_stops(self, stops: impl IntoIterator<Item = FocusHandle>) -> Self

The controls tab walks between while the drawer is open.

The body is the caller’s, so the caller is the only one that knows which of its handles are focus stops.

pub fn set_focus_stops( &mut self, stops: impl IntoIterator<Item = FocusHandle>, cx: &mut Context<'_, Self>, )

pub fn is_open(&self) -> bool

pub fn is_dismissable(&self) -> bool

pub fn is_rendered(&self) -> bool

True while the panel must stay in the tree, including for the whole slide out.

pub fn set_title( &mut self, title: impl Into<SharedString>, cx: &mut Context<'_, Self>, )

pub fn open(&mut self, window: &mut Window, cx: &mut Context<'_, Self>)

pub fn close(&mut self, _window: &mut Window, cx: &mut Context<'_, Self>)

Starts the slide out. The drawer stays on screen until it finishes.

pub fn dismiss(&mut self, window: &mut Window, cx: &mut Context<'_, Self>)

Reports a wave-away. A drawer that is not dismissable cannot be waved away even by a host calling this directly.

pub fn settle(&mut self, cx: &mut Context<'_, Self>)

Finishes the slide that is running, for a host that wants the panel where it is going without the frames in between.

Trait Implementations

impl Debug for Drawer

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

Formats the value using the given formatter.

impl EventEmitter<DrawerEvent> for Drawer

impl Focusable for Drawer

fn focus_handle(&self, _cx: &App) -> FocusHandle

Returns the focus handle associated with this view.

impl Render for Drawer

fn render( &mut self, window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.