Struct Popup 

pub struct Popup<W: Widget> {
    pub inner: W,
    /* 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.

Fields

inner: W

The inner widget

Implementations

impl<W: Widget> Popup<W>

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

Construct a popup over a W: Widget

Popup placement is determined by direction and alignment (see Self::align).

pub fn direction(&self) -> Direction

Get direction

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

Set direction

The popup is placed next to a reference Rect in this direction, if possible; otherwise it is placed in the opposite direction. See also Self::align.

pub fn alignment(&self) -> Align

Get alignment

pub fn align(self, align: Align) -> Self

Set alignment (inline)

After the popup is placed to one side of a reference Rect (see Self::set_direction), it is aligned according to align:

• Align::Default, Align::TL: align with the top/left edge of the reference Rect
• Align::BR: align with the bottom/right edge of the reference Rect
• Align::Center: center relative to the reference Rect
• Align::Stretch: align like Align::Default but ensuring the popup is no shorter than the reference Rect on the touching side

pub fn is_open(&self) -> bool

Query whether the popup is open

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

Open or reposition the popup

The popup is positioned next to the parent’s rect (see Self::set_direction, Self::align).

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: Widget> Events for Popup<W>

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

Configure children

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

Update children

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

Handle an Event

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

Handler for scrolling

const REDRAW_ON_MOUSE_OVER: bool = false

Does this widget have a different appearance on mouse over?

fn mouse_over_icon(&self) -> Option<CursorIcon>

The mouse cursor icon to use on mouse over

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

Make an identifier for a child

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

Configure self

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

Update self using input data

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

Mouse focus handler

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

Handler for messages from children/descendants

impl<W: Widget> Layout for Popup<W>

fn rect(&self) -> Rect

Get the widget’s region

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, hints: AlignHints)

Set size and position

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

Probe a coordinate for a widget’s Id

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

Draw a widget and its children

impl<W: Widget> MacroDefinedLayout for Popup<W>

fn rect(&self) -> Rect

Get the widget’s region

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, hints: AlignHints)

Set size and position

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

Probe a coordinate for a widget’s Id

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

Draw a widget and its children

impl<W: Widget> Tile for Popup<W>

fn child_indices(&self) -> ChildIndices

Get child indices available to recursion

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

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

fn as_tile(&self) -> &dyn Tile

Get as a dyn Tile

fn id_ref(&self) -> &Id

Get a reference to the widget’s identifier

fn identify(&self) -> IdentifyWidget<'_>

Return a Display-able widget identifier

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

Access a child as a dyn Tile, if available

fn role(&self, _: &mut dyn RoleCx) -> Role<'_>

Describe the widget’s role

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

Navigation in spatial order

fn probe(&self, coord: Coord) -> Id

Probe a coordinate for a widget’s Id

fn id(&self) -> Id

Get the widget’s identifier

fn navigable(&self) -> bool

Whether this widget supports navigation focus

fn tooltip(&self) -> Option<&str>

Tooltip

fn role_child_properties(&self, cx: &mut dyn RoleCx, index: usize)

Specify additional role properties for child index

fn translation(&self, index: usize) -> Offset

Get translation of child index relative to this widget

impl<W: Widget> Widget for Popup<W>

type Data = <W as Widget>::Data

Input data type

fn as_node<'__a>(&'__a mut self, data: &'__a Self::Data) -> Node<'__a>

Erase type

fn child_node<'__n>( &'__n mut self, data: &'__n Self::Data, index: usize, ) -> Option<Node<'__n>>

Access a child as a Node, if available