Skip to main content

GridConfig

Struct GridConfig 

Source
pub struct GridConfig { /* private fields */ }
Expand description

The tracks, gaps, flow and named areas of a Grid. Compose’s GridConfigurationScope: a track call adds the next row or column, and the last gap call for an axis sets it.

Implementations§

Source§

impl GridConfig

Source

pub fn new() -> Self

A grid with no explicit tracks or gaps, whose children fill rows.

Source

pub fn column(self, size: GridTrackSize) -> Self

Adds a column.

Source

pub fn columns(self, sizes: impl IntoIterator<Item = GridTrackSize>) -> Self

Adds a column for each size, in order.

Source

pub fn row(self, size: GridTrackSize) -> Self

Adds a row.

Source

pub fn rows(self, sizes: impl IntoIterator<Item = GridTrackSize>) -> Self

Adds a row for each size, in order.

Source

pub fn gap(self, all: f32) -> Self

Sets the gap between rows and between columns, in dp.

Source

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

Sets the gap between rows, in dp.

Source

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

Sets the gap between columns, in dp.

Source

pub fn flow(self, flow: GridFlow) -> Self

Sets the way children without a cell fill the grid.

Source

pub fn area( self, name: &'static str, row: i32, column: i32, row_span: u32, column_span: u32, ) -> Self

Names an area that children take with GridItem::area. Rows and columns count from 1, and from the last explicit track when negative. With GRID_INDEX_UNSPECIFIED on one axis the area is that whole row or column, and its children fill it one after another. Naming an area again moves it.

Source

pub fn area_ranges( self, name: &'static str, rows: RangeInclusive<i32>, columns: RangeInclusive<i32>, ) -> Self

Names the area of the rows and columns of two ranges: area_ranges("footer", 2..=3, 1..=2) is area("footer", 2, 1, 2, 2).

Trait Implementations§

Source§

impl Clone for GridConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GridConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GridConfig

Source§

fn default() -> Self

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

impl PartialEq for GridConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for GridConfig

Auto Trait Implementations§

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> AnyEq for T
where T: Any + PartialEq,

Source§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

Source§

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

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> LayoutData for T
where T: Any + Debug + PartialEq,

Source§

fn same_as(&self, other: &(dyn LayoutData + 'static)) -> bool

Whether other holds the same data, so a parent can keep its last measure.
Source§

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

The data as Any, to read it by its type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.