Struct Ribbon 

pub struct Ribbon<'a, Id, Message, Theme = Theme, Renderer = Renderer>
where
    Id: Clone + Eq,
    Theme: Catalog + Catalog + Catalog,
    Renderer: Renderer + Renderer,
{ /* private fields */ }

Available on crate feature ribbon only.

A horizontal collection of Groups which change their appearance and layout when the Ribbon is resized.

Implementations

impl<'a, Id, Message, Theme, Renderer> Ribbon<'a, Id, Message, Theme, Renderer>

where Id: Clone + Eq, Message: 'a + Clone, Theme: 'a + Catalog + Catalog + Catalog + Catalog, <Theme as Catalog>::Class<'a>: From<StyleFn<'a, Theme>>, Renderer: 'a + Renderer + Renderer + Renderer, <Renderer as Renderer>::Font: From<Font>, <Renderer as Renderer>::Paragraph: Clone,

pub fn new( groups: impl IntoIterator<Item = Group<'a, Id, Message, Theme, Renderer>>, ) -> Self

Creates a new Ribbon which the provided Groups.

pub fn width(self, width: impl Into<Length>) -> Self

Sets the width of the Ribbon.

pub fn height(self, height: impl Into<Length>) -> Self

Sets the height of the Ribbon.

pub fn spacing(self, amount: impl Into<Pixels>) -> Self

Sets the spacing between Groups.

pub fn padding<P: Into<Padding>>(self, padding: P) -> Self

Sets the Padding of the Ribbon.

pub fn open_group(self, id: Id) -> Self

Opens the Group as a dropdown when collapsed.

Panics

Panics if no Group in the Ribbon has the provided id.

pub fn on_group_dropdown_dismiss(self, on_dismiss: Message) -> Self

Sets the message that will be sent when the Group collapsed dropdown is dismissed.

pub fn on_group_dropdown_dismiss_with( self, on_dismiss: impl Fn() -> Message + 'a, ) -> Self

Sets the message that will be sent when the Group collapsed dropdown is dismissed.

This is analogous to Ribbon::on_group_dropdown_dismiss, but using a closure to produce the message.

pub fn style(self, style: impl Fn(&Theme) -> Style + 'a) -> Self

where <Theme as Catalog>::Class<'a>: From<StyleFn<'a, Theme>>,

Sets the style of the Ribbon.

Trait Implementations

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

where Id: 'a + Clone + Eq, Message: 'a + Clone, Theme: 'a + Catalog + Catalog + Catalog + Catalog, Renderer: 'a + Renderer + Renderer, <Renderer as Renderer>::Font: From<Font>, <Theme as Catalog>::Class<'a>: From<StyleFn<'a, Theme>>, <Renderer as Renderer>::Paragraph: Clone,

fn from(ribbon: Ribbon<'a, Id, Message, Theme, Renderer>) -> Self

Converts to this type from the input type.

impl<'a, Id, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Ribbon<'a, Id, Message, Theme, Renderer>

where Id: Clone + Eq, Message: 'a + Clone, Theme: 'a + Catalog + Catalog + Catalog + Catalog, Renderer: 'a + Renderer + Renderer, <Renderer as Renderer>::Font: From<Font>, <Theme as Catalog>::Class<'a>: From<StyleFn<'a, Theme>>, <Renderer as Renderer>::Paragraph: Clone,

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

fn children(&self) -> Vec<Tree>

Returns the state Tree of the children of the Widget.

fn diff(&self, tree: &mut Tree)

Reconciles the Widget with the provided Tree.

fn size(&self) -> IcedSize<Length>

Returns the Size of the Widget in lengths.

fn layout( &mut self, tree: &mut Tree, renderer: &Renderer, limits: &Limits, ) -> Node

Returns the layout::Node of the Widget.

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

Applies an Operation to the Widget.

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

Processes a runtime Event.

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

Draws the Widget using the associated Renderer.

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

Returns the current mouse::Interaction of the Widget.

fn overlay<'b>( &'b mut self, tree: &'b mut Tree, layout: Layout<'b>, renderer: &Renderer, viewport: &Rectangle, translation: Vector, ) -> Option<Element<'b, Message, Theme, Renderer>>

Returns the overlay of the Widget, if there is any.

fn size_hint(&self) -> Size<Length>

Returns a Size hint for laying out the Widget.