Wrap

Struct Wrap 

Source
pub struct Wrap<'a, Message, Direction, Theme = Theme, Renderer = Renderer> {
    pub elements: Vec<Element<'a, Message, Theme, Renderer>>,
    pub alignment: Alignment,
    pub width: Length,
    pub height: Length,
    pub max_width: f32,
    pub max_height: f32,
    pub padding: Padding,
    pub spacing: Pixels,
    pub line_spacing: Pixels,
    pub line_minimal_length: f32,
    /* private fields */
}
Expand description

A container that distributes its contents horizontally.

Fields§

§elements: Vec<Element<'a, Message, Theme, Renderer>>

The elements to distribute.

§alignment: Alignment

The alignment of the Wrap.

§width: Length

The width of the Wrap.

§height: Length

The height of the Wrap.

§max_width: f32

The maximum width of the Wrap.

§max_height: f32

The maximum height of the Wrap.

§padding: Padding

The padding of each element of the Wrap.

§spacing: Pixels

The spacing between each element of the Wrap.

§line_spacing: Pixels

The spacing between each line of the Wrap.

§line_minimal_length: f32

The minimal length of each line of the Wrap.

Implementations§

Source§

impl<'a, Message, Theme, Renderer> Wrap<'a, Message, Horizontal, Theme, Renderer>

Source

pub fn new() -> Self

Creates an empty horizontal Wrap.

Source

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

Creates a Wrap with the given elements.

It expects: * the vector containing the Elements for this Wrap.

Source§

impl<'a, Message, Theme, Renderer> Wrap<'a, Message, Vertical, Theme, Renderer>

Source

pub fn new_vertical() -> Self

Creates an empty vertical Wrap.

Source

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

Creates a Wrap with the given elements.

It expects: * the vector containing the Elements for this Wrap.

Source§

impl<'a, Message, Renderer, Direction, Theme> Wrap<'a, Message, Direction, Theme, Renderer>

Source

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

Sets the spacing of the Wrap.

Source

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

Sets the spacing of the lines of the Wrap.

Source

pub const fn line_minimal_length(self, units: f32) -> Self

Sets the minimal length of the lines of the Wrap.

Source

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

Sets the padding of the elements in the Wrap.

Source

pub const fn width_items(self, width: Length) -> Self

Sets the width of the Wrap.

Source

pub const fn height_items(self, height: Length) -> Self

Sets the height of the Wrap.

Source

pub const fn max_width(self, max_width: f32) -> Self

Sets the maximum width of the Wrap.

Source

pub const fn max_height(self, max_height: f32) -> Self

Sets the maximum height of the Wrap.

Source

pub const fn align_items(self, align: Alignment) -> Self

Sets the alignment of the Wrap.

Source

pub fn push<E>(self, element: E) -> Self
where E: Into<Element<'a, Message, Theme, Renderer>>,

Pushes an Element to the Wrap.

Trait Implementations§

Source§

impl<Message, Renderer, Direction, Theme> Default for Wrap<'_, Message, Direction, Theme, Renderer>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'a, Message, Theme, Renderer> From<Wrap<'a, Message, Horizontal, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>
where Renderer: 'a + Renderer, Message: 'a, Theme: 'a,

Source§

fn from(wrap: Wrap<'a, Message, Horizontal, Theme, Renderer>) -> Self

Converts to this type from the input type.
Source§

impl<'a, Message, Theme, Renderer> From<Wrap<'a, Message, Vertical, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>
where Renderer: 'a + Renderer, Message: 'a, Theme: 'a,

Source§

fn from(wrap: Wrap<'a, Message, Vertical, Theme, Renderer>) -> Self

Converts to this type from the input type.
Source§

impl<Message, Renderer, Direction, Theme> Widget<Message, Theme, Renderer> for Wrap<'_, Message, Direction, Theme, Renderer>
where Self: WrapLayout<Renderer>, Renderer: Renderer,

Source§

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

Returns the state Tree of the children of the Widget.
Source§

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

Reconciles the Widget with the provided Tree.
Source§

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

Returns the Size of the Widget in lengths.
Source§

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

Returns the layout::Node of the Widget. Read more
Source§

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

Processes a runtime Event. Read more
Source§

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.
Source§

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

Returns the current mouse::Interaction of the Widget. Read more
Source§

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

Draws the Widget using the associated Renderer.
Source§

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

Applies an Operation to the Widget.
Source§

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

Returns a Size hint for laying out the Widget. Read more
Source§

fn tag(&self) -> Tag

Returns the Tag of the Widget.
Source§

fn state(&self) -> State

Returns the State of the Widget.
Source§

impl<'a, Message, Theme, Renderer> WrapLayout<Renderer> for Wrap<'a, Message, Horizontal, Theme, Renderer>
where Renderer: Renderer + 'a,

Source§

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

A inner layout of the Wrap.
Source§

impl<'a, Message, Theme, Renderer> WrapLayout<Renderer> for Wrap<'a, Message, Vertical, Theme, Renderer>
where Renderer: Renderer + 'a,

Source§

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

A inner layout of the Wrap.

Auto Trait Implementations§

§

impl<'a, Message, Direction, Theme, Renderer> Freeze for Wrap<'a, Message, Direction, Theme, Renderer>

§

impl<'a, Message, Direction, Theme = Theme, Renderer = Renderer<Renderer, Renderer>> !RefUnwindSafe for Wrap<'a, Message, Direction, Theme, Renderer>

§

impl<'a, Message, Direction, Theme = Theme, Renderer = Renderer<Renderer, Renderer>> !Send for Wrap<'a, Message, Direction, Theme, Renderer>

§

impl<'a, Message, Direction, Theme = Theme, Renderer = Renderer<Renderer, Renderer>> !Sync for Wrap<'a, Message, Direction, Theme, Renderer>

§

impl<'a, Message, Direction, Theme, Renderer> Unpin for Wrap<'a, Message, Direction, Theme, Renderer>
where Direction: Unpin,

§

impl<'a, Message, Direction, Theme = Theme, Renderer = Renderer<Renderer, Renderer>> !UnwindSafe for Wrap<'a, Message, Direction, Theme, Renderer>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more