Struct cosmic::widget::container::Container

pub struct Container<'a, Message, Theme = Theme, Renderer = Renderer>
where
    Theme: Catalog,
    Renderer: Renderer,
{ /* private fields */ }

A widget that aligns its contents inside of its boundaries.

Example

use iced::widget::container;

enum Message {
    // ...
}

fn view(state: &State) -> Element<'_, Message> {
    container("This text is centered inside a rounded box!")
        .padding(10)
        .center(800)
        .style(container::rounded_box)
        .into()
}

Implementations

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

where Theme: Catalog, Renderer: Renderer,

pub fn new( content: impl Into<Element<'a, Message, Theme, Renderer>>, ) -> Container<'a, Message, Theme, Renderer>

Creates a Container with the given content.

pub fn padding<P>(self, padding: P) -> Container<'a, Message, Theme, Renderer>

where P: Into<Padding>,

Sets the Padding of the Container.

pub fn width( self, width: impl Into<Length>, ) -> Container<'a, Message, Theme, Renderer>

Sets the width of the Container.

pub fn height( self, height: impl Into<Length>, ) -> Container<'a, Message, Theme, Renderer>

Sets the height of the Container.

pub fn max_width( self, max_width: impl Into<Pixels>, ) -> Container<'a, Message, Theme, Renderer>

Sets the maximum width of the Container.

pub fn max_height( self, max_height: impl Into<Pixels>, ) -> Container<'a, Message, Theme, Renderer>

Sets the maximum height of the Container.

pub fn center_x( self, width: impl Into<Length>, ) -> Container<'a, Message, Theme, Renderer>

Sets the width of the Container and centers its contents horizontally.

pub fn center_y( self, height: impl Into<Length>, ) -> Container<'a, Message, Theme, Renderer>

Sets the height of the Container and centers its contents vertically.

pub fn center( self, length: impl Into<Length>, ) -> Container<'a, Message, Theme, Renderer>

Centers the contents in both the horizontal and vertical axes of the Container.

This is equivalent to chaining center_x and center_y.

pub fn align_left( self, width: impl Into<Length>, ) -> Container<'a, Message, Theme, Renderer>

Aligns the contents of the Container to the left.

pub fn align_right( self, width: impl Into<Length>, ) -> Container<'a, Message, Theme, Renderer>

Aligns the contents of the Container to the right.

pub fn align_top( self, height: impl Into<Length>, ) -> Container<'a, Message, Theme, Renderer>

Aligns the contents of the Container to the top.

pub fn align_bottom( self, height: impl Into<Length>, ) -> Container<'a, Message, Theme, Renderer>

Aligns the contents of the Container to the bottom.

pub fn align_x( self, alignment: impl Into<Horizontal>, ) -> Container<'a, Message, Theme, Renderer>

Sets the content alignment for the horizontal axis of the Container.

pub fn align_y( self, alignment: impl Into<Vertical>, ) -> Container<'a, Message, Theme, Renderer>

Sets the content alignment for the vertical axis of the Container.

pub fn clip(self, clip: bool) -> Container<'a, Message, Theme, Renderer>

Sets whether the contents of the Container should be clipped on overflow.

pub fn style( self, style: impl Fn(&Theme) -> Style + 'a, ) -> Container<'a, Message, Theme, Renderer>

where <Theme as Catalog>::Class<'a>: From<Box<dyn Fn(&Theme) -> Style + 'a>>,

Sets the style of the Container.

pub fn class( self, class: impl Into<<Theme as Catalog>::Class<'a>>, ) -> Container<'a, Message, Theme, Renderer>

Sets the style class of the Container.

Trait Implementations

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

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

fn from( column: Container<'a, Message, Theme, Renderer>, ) -> Element<'a, Message, Theme, Renderer>

Converts to this type from the input type.

impl<'a, Message: Clone + 'static> From<NavBar<'a, Message>> for Container<'a, Message, Theme, Renderer>

fn from(this: NavBar<'a, Message>) -> Self

Converts to this type from the input type.

impl<'a, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Container<'a, Message, Theme, Renderer>

where Theme: Catalog, Renderer: Renderer,

fn a11y_nodes( &self, layout: Layout<'_>, state: &Tree, cursor: Cursor, ) -> A11yTree

get the a11y nodes for the widget

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(&mut self, tree: &mut Tree)

Reconciliates the Widget with the provided Tree.

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

Returns the Size of the Widget in lengths.

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

Returns the layout::Node of the Widget.

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

Applies an Operation to the Widget.

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

Processes a runtime Event.

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

Returns the current mouse::Interaction of the Widget.

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

Draws the Widget using the associated Renderer.

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

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

fn drag_destinations( &self, state: &Tree, layout: Layout<'_>, renderer: &Renderer, dnd_rectangles: &mut DndDestinationRectangles, )

Adds the drag destination rectangles of the widget. Runs after the layout phase for each widget in the tree.

fn id(&self) -> Option<Id>

Returns the id of the widget

fn set_id(&mut self, id: Id)

Sets the id of the widget This may be called while diffing the widget tree

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

Returns a Size hint for laying out the Widget.