Struct Group

pub struct Group<'a, Message, Theme, Renderer> { /* private fields */ }

An Overlay container that displays multiple overlay overlay::Element children.

Implementations

impl<'a, Message, Theme, Renderer> Group<'a, Message, Theme, Renderer>

where Message: 'a, Theme: 'a, Renderer: 'a + Renderer,

pub fn new() -> Self

Creates an empty Group.

pub fn with_children( children: Vec<Element<'a, Message, Theme, Renderer>>, ) -> Self

Creates a Group with the given elements.

pub fn push( self, child: impl Into<Element<'a, Message, Theme, Renderer>>, ) -> Self

Adds an overlay::Element to the Group.

pub fn overlay(self) -> Element<'a, Message, Theme, Renderer>

Turns the Group into an overlay overlay::Element.

Trait Implementations

impl<'a, Message, Theme, Renderer> Default for Group<'a, Message, Theme, Renderer>

where Message: 'a, Theme: 'a, Renderer: 'a + Renderer,

fn default() -> Self

Returns the “default value” for a type.

impl<'a, Message, Theme, Renderer> From<Group<'a, Message, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>

where Message: 'a, Theme: 'a, Renderer: 'a + Renderer,

fn from(group: Group<'a, Message, Theme, Renderer>) -> Self

Converts to this type from the input type.

impl<'a, Message, Theme, Renderer> Overlay<Message, Theme, Renderer> for Group<'a, Message, Theme, Renderer>

where Renderer: Renderer,

fn layout(&mut self, renderer: &Renderer, bounds: Size) -> Node

Returns the layout Node of the Overlay.

fn update( &mut self, event: Event, layout: Layout<'_>, cursor: Cursor, renderer: &Renderer, clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, )

Processes a runtime Event.

fn draw( &self, renderer: &mut Renderer, theme: &Theme, style: &Style, layout: Layout<'_>, cursor: Cursor, )

Draws the Overlay using the associated Renderer.

fn mouse_interaction( &self, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, renderer: &Renderer, ) -> Interaction

Returns the current mouse::Interaction of the Overlay.

fn operate( &mut self, layout: Layout<'_>, renderer: &Renderer, operation: &mut dyn Operation, )

Applies a widget::Operation to the Overlay.

fn is_over( &self, layout: Layout<'_>, renderer: &Renderer, cursor_position: Point, ) -> bool

Returns true if the cursor is over the Overlay.

fn overlay<'b>( &'b mut self, layout: Layout<'_>, renderer: &Renderer, ) -> Option<Element<'b, Message, Theme, Renderer>>

Returns the nested overlay of the Overlay, if there is any.