Struct Row

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

A container that distributes its contents horizontally.

Example

use iced::widget::{button, row};

#[derive(Debug, Clone)]
enum Message {
    // ...
}

fn view(state: &State) -> Element<'_, Message> {
    row![
        "I am to the left!",
        button("I am in the middle!"),
        "I am to the right!",
    ].into()
}

Implementations

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

where Renderer: Renderer,

pub fn new() -> Self

Creates an empty Row.

pub fn with_capacity(capacity: usize) -> Self

Creates a Row with the given capacity.

pub fn with_children( children: impl IntoIterator<Item = Element<'a, Message, Theme, Renderer>>, ) -> Self

Creates a Row with the given elements.

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

Creates a Row from an already allocated Vec.

Keep in mind that the Row will not inspect the Vec, which means it won’t automatically adapt to the sizing strategy of its contents.

If any of the children have a [Length::Fill] strategy, you will need to call Row::width or Row::height accordingly.

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

Sets the horizontal spacing between elements.

Custom margins per element do not exist in iced. You should use this method instead! While less flexible, it helps you keep spacing between elements consistent.

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

Sets the [Padding] of the Row.

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

Sets the width of the Row.

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

Sets the height of the Row.

pub fn align_y(self, align: impl Into<Vertical>) -> Self

Sets the vertical alignment of the contents of the Row .

pub fn clip(self, clip: bool) -> Self

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

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

Adds an [Element] to the Row.

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

Adds an element to the Row, if Some.

pub fn extend( self, children: impl IntoIterator<Item = Element<'a, Message, Theme, Renderer>>, ) -> Self

Extends the Row with the given children.

pub fn wrap(self) -> Wrapping<'a, Message, Theme, Renderer>

Turns the Row into a Wrapping row.

The original alignment of the Row is preserved per row wrapped.

Trait Implementations

impl<Message, Renderer> Default for Row<'_, Message, Renderer>

where Renderer: Renderer,

fn default() -> Self

Returns the “default value” for a type.

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

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

fn from(row: Row<'a, Message, Theme, Renderer>) -> Self

Converts to this type from the input type.

impl<'a, Message, Theme, Renderer: Renderer> FromIterator<Element<'a, Message, Theme, Renderer>> for Row<'a, Message, Theme, Renderer>

fn from_iter<T: IntoIterator<Item = Element<'a, Message, Theme, Renderer>>>( iter: T, ) -> Self

Creates a value from an iterator.

impl<Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Row<'_, Message, Theme, Renderer>

where Renderer: Renderer,

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) -> 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 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 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, 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<'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].

fn tag(&self) -> Tag

Returns the Tag of the [Widget].

fn state(&self) -> State

Returns the State of the [Widget].