Struct kas::Popup

pub struct Popup<W>
where
    W: Widget,
{ /* private fields */ }

A popup (e.g. menu or tooltip)

A pop-up is a box used for things like tool-tips and menus which escapes the parent’s rect. This widget is the root of any popup UI.

This widget must be excluded from the parent’s layout.

Depending on the platform, the pop-up may be a special window or emulate this with a layer drawn in an existing window. Both approaches should exhibit similar behaviour except that the former approach allows the popup to escape the bounds of the parent window. NOTE: currently only the emulated approach is implemented.

A popup receives input data from its parent like any other widget.

Implementations

impl<W> Popup<W>

where W: Widget,

pub fn new(inner: W, direction: Direction) -> Popup<W>

Construct a popup over a W: Widget

pub fn direction(&self) -> Direction

Get direction

pub fn set_direction(&mut self, direction: Direction)

Set direction

pub fn is_open(&self) -> bool

Query whether the popup is open

pub fn open( &mut self, cx: &mut EventCx<'_>, data: &<W as Widget>::Data, parent: Id ) -> bool

Open the popup

The popup is positioned next to the parent’s rect in the specified direction (if this is not possible, the direction may be reversed).

The parent is marked as depressed (pushed down) while the popup is open.

Returns true when the popup is newly opened. In this case, the caller may wish to call EventState::next_nav_focus next.

pub fn close(&mut self, cx: &mut EventCx<'_>)

Close the popup

Navigation focus will return to whichever widget had focus before the popup was open.

Trait Implementations

impl<W> AutoLayout for Popup<W>

where W: Widget,

fn size_rules(&mut self, sizer: SizeCx<'_>, axis: AxisInfo) -> SizeRules

Get size rules for the given axis

fn set_rect(&mut self, cx: &mut ConfigCx<'_>, rect: Rect)

Set size and position

fn find_id(&mut self, coord: Coord) -> Option<Id>

Translate a coordinate to an Id

fn draw(&mut self, draw: DrawCx<'_>)

Draw a widget and its children

impl<W> Deref for Popup<W>

where W: Widget,

type Target = W

The resulting type after dereferencing.

fn deref(&self) -> &<Popup<W> as Deref>::Target

Dereferences the value.

impl<W> DerefMut for Popup<W>

where W: Widget,

fn deref_mut(&mut self) -> &mut <Popup<W> as Deref>::Target

Mutably dereferences the value.

impl<W> Events for Popup<W>

where W: Widget,

fn configure(&mut self, cx: &mut ConfigCx<'_>)

Configure self

fn configure_recurse( &mut self, cx: &mut ConfigCx<'_>, data: &<Popup<W> as Widget>::Data )

Configure children

fn update_recurse( &mut self, cx: &mut ConfigCx<'_>, data: &<Popup<W> as Widget>::Data )

Update children

fn handle_event( &mut self, cx: &mut EventCx<'_>, _: &<W as Widget>::Data, event: Event ) -> IsUsed

Handle an Event

fn handle_scroll( &mut self, cx: &mut EventCx<'_>, _: &<Popup<W> as Widget>::Data, _: Scroll )

Handler for scrolling

fn steal_event( &mut self, _: &mut EventCx<'_>, _: &<Popup<W> as Widget>::Data, _: &Id, _: &Event ) -> IsUsed

Potentially steal an event before it reaches a child

fn make_child_id(&mut self, index: usize) -> Id

Make an identifier for a child

fn update(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Update self using input data

fn navigable(&self) -> bool

Is this widget navigable via Tab key?

fn handle_hover(&mut self, cx: &mut EventCx<'_>, state: bool) -> IsUsed

Mouse focus handler

fn handle_messages(&mut self, cx: &mut EventCx<'_>, data: &Self::Data)

Handler for messages from children/descendants

impl<W> Layout for Popup<W>

where W: Widget,

fn as_layout(&self) -> &dyn Layout

Get as a dyn Layout

fn id_ref(&self) -> &Id

Get the widget’s identifier

fn rect(&self) -> Rect

Get the widget’s region, relative to its parent.

fn widget_name(&self) -> &'static str

Get the name of the widget struct

fn num_children(&self) -> usize

Get the number of child widgets

fn get_child(&self, index: usize) -> Option<&dyn Layout>

Access a child as a dyn Layout

fn size_rules(&mut self, sizer: SizeCx<'_>, axis: AxisInfo) -> SizeRules

Get size rules for the given axis

fn set_rect(&mut self, cx: &mut ConfigCx<'_>, rect: Rect)

Set size and position

fn nav_next(&self, reverse: bool, from: Option<usize>) -> Option<usize>

Navigation in spatial order

fn find_id(&mut self, coord: Coord) -> Option<Id>

Translate a coordinate to an Id

fn draw(&mut self, draw: DrawCx<'_>)

Draw a widget and its children

fn find_child_index(&self, id: &Id) -> Option<usize>

Find the child which is an ancestor of this id, if any

fn translation(&self) -> Offset

Get translation of children relative to this widget

impl<W> Widget for Popup<W>

where W: Widget,

type Data = <W as Widget>::Data

Input data type

fn as_node<'a>(&'a mut self, data: &'a <Popup<W> as Widget>::Data) -> Node<'a>

Erase type

fn for_child_node( &mut self, data: &<Popup<W> as Widget>::Data, index: usize, closure: Box<dyn FnOnce(Node<'_>) + '_> )

Call closure on child with given index, if index < self.num_children().