Struct iced_widget::container::Container

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

An element decorating some content.

It is normally used for alignment purposes.

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>>) -> Self

Creates a Container with the given content.

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

Sets the Id of the Container.

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

Sets the Padding of the Container.

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

Sets the width of the Container.

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

Sets the height of the Container.

pub fn fill_x(self) -> Self

Sets the Container to fill the available space in the horizontal axis.

This can be useful to quickly position content when chained with alignment functions—like center_x.

Calling this method is equivalent to calling width with a Length::Fill.

pub fn fill_y(self) -> Self

Sets the Container to fill the available space in the vetical axis.

This can be useful to quickly position content when chained with alignment functions—like center_y.

Calling this method is equivalent to calling height with a Length::Fill.

pub fn fill(self) -> Self

Sets the Container to fill all the available space.

This can be useful to quickly position content when chained with alignment functions—like center.

Calling this method is equivalent to chaining fill_x and fill_y.

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

Sets the maximum width of the Container.

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

Sets the maximum height of the Container.

pub fn align_x(self, alignment: Horizontal) -> Self

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

pub fn align_y(self, alignment: Vertical) -> Self

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

pub fn center_x(self) -> Self

Sets the Container to fill the available space in the horizontal axis and centers its contents there.

pub fn center_y(self) -> Self

Sets the Container to fill the available space in the vertical axis and centers its contents there.

pub fn center(self) -> Self

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 clip(self, clip: bool) -> Self

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

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

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

Sets the style of the Container.

pub fn class(self, class: impl Into<Theme::Class<'a>>) -> Self

Available on crate feature advanced only.

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, Theme, Renderer> Widget<Message, Theme, Renderer> for Container<'a, Message, Theme, Renderer>

where Theme: Catalog, Renderer: Renderer,

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)

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<Message> )

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 size_hint(&self) -> Size<Length>

Returns a Size hint for laying out the Widget.