Struct GridArea 

#[non_exhaustive]
pub struct GridArea {
    pub id: SharedString,
    pub col: usize,
    pub row: usize,
    pub col_span: usize,
    pub row_span: usize,
    pub min_col_span: usize,
    pub min_row_span: usize,
    pub max_col_span: Option<usize>,
    pub max_row_span: Option<usize>,
    pub locked: bool,
}

Where one item sits in a grid layout, in zero-based grid cells.

col and row are the item’s leading column and top row, counted from zero; col_span and row_span are how many columns and rows it covers. Unlike GPUI’s col_start, which names a one-based CSS grid line, col is a cell index, so a layout reads the same in code and in its saved form.

A layout is a list of areas keyed by id, which is what an application persists to restore a user’s arrangement. Every field after the place has a serde default, so a layout saved with only the place still loads.

GridArea::new("revenue").col_span(6).row_span(4).min_span(3, 2)

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: SharedString

The stable identity that pairs this area with its GridItem.

col: usize

The leading column, from zero.

row: usize

The top row, from zero.

col_span: usize

The number of columns covered; at least 1.

row_span: usize

The number of rows covered; at least 1.

min_col_span: usize

The fewest columns a resize may leave the item.

min_row_span: usize

The fewest rows a resize may leave the item.

max_col_span: Option<usize>

The most columns a resize may give the item; None allows the full width.

max_row_span: Option<usize>

The most rows a resize may give the item; None is unbounded.

locked: bool

A locked item is neither dragged, resized nor pushed; other items flow around it.

Implementations

impl GridArea

pub fn new(id: impl Into<SharedString>) -> Self

A one-cell area at the top-leading corner; place and size it with the builders.

pub fn col(self, col: usize) -> Self

The leading column, from zero.

pub fn row(self, row: usize) -> Self

The top row, from zero.

pub fn col_span(self, col_span: usize) -> Self

How many columns the item covers.

pub fn row_span(self, row_span: usize) -> Self

How many rows the item covers.

pub fn min_span(self, col_span: usize, row_span: usize) -> Self

The fewest columns and rows a resize may leave the item.

pub fn max_span(self, col_span: usize, row_span: usize) -> Self

The most columns and rows a resize may give the item.

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

Lock the item in place; see GridArea::locked.

Trait Implementations

impl Clone for GridArea

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GridArea

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GridArea

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for GridArea

impl Hash for GridArea

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for GridArea

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for GridArea

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GridArea