Struct WrapStyle 

pub struct WrapStyle {
    pub axis: Axis,
    pub align: Align,
    pub column_gap: f32,
    pub row_gap: f32,
    pub columns: Option<usize>,
    pub rows: Option<usize>,
}

Wrapping configuration for children along a main axis.

Fields

axis: Axis

Main axis along which children are placed.

align: Align

Cross-axis alignment of the items within each line.

column_gap: f32

Gap between items on the same line.

row_gap: f32

Gap between wrapped lines.

columns: Option<usize>

Explicit number of columns, overriding width-based wrapping.

rows: Option<usize>

Explicit number of rows, overriding width-based wrapping.

Implementations

impl WrapStyle

pub fn new(axis: Axis) -> WrapStyle

Creates a wrapping style for the given main axis.

pub fn main_gap(self) -> f32

Returns the gap used between items along the main axis.

pub fn cross_gap(self) -> f32

Returns the gap used between wrapped lines.

pub fn gap(self, gap: f32) -> WrapStyle

Sets both the column and row gap.

pub fn column_gap(self, gap: f32) -> WrapStyle

Sets the gap between items on the same line.

pub fn row_gap(self, gap: f32) -> WrapStyle

Sets the gap between wrapped lines.

pub fn align(self, align: Align) -> WrapStyle

Sets the cross-axis alignment of items within a line.

pub fn axis(self, axis: Axis) -> WrapStyle

Sets the main axis and reinterprets the main and cross gaps.

pub fn columns(self, columns: usize) -> WrapStyle

Forces the layout to use exactly columns columns.

Values below one are clamped to one. For a horizontal axis this is the number of items per line; for a vertical axis it is the number of lines.

pub fn rows(self, rows: usize) -> WrapStyle

Forces the layout to use exactly rows rows.

Values below one are clamped to one. For a vertical axis this is the number of items per line; for a horizontal axis it is the number of lines.

pub fn clear_columns(self) -> WrapStyle

Removes the explicit column count and restores width-based wrapping.

pub fn clear_rows(self) -> WrapStyle

Removes the explicit row count and restores width-based wrapping.

pub fn items_per_line(self, count: usize) -> Option<usize>

Returns how many items fit on one line when an explicit count is set.

The count matching the main axis wins: columns for a horizontal axis and rows for a vertical axis. The other count is treated as the desired number of lines.

pub fn lines(self, main_sizes: &[f32], avail_main: f32) -> Vec<(usize, usize)>

Splits main_sizes into lines using the explicit counts when present.

Trait Implementations

impl Clone for WrapStyle

fn clone(&self) -> WrapStyle

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for WrapStyle

impl Debug for WrapStyle

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for WrapStyle

fn default() -> WrapStyle

Returns the “default value” for a type.

impl PartialEq for WrapStyle

fn eq(&self, other: &WrapStyle) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for WrapStyle