Struct bevy::ui::GridPlacement

pub struct GridPlacement { /* private fields */ }

Represents the position of a grid item in a single axis.

There are 3 fields which may be set:

• start: which grid line the item should start at
• end: which grid line the item should end at
• span: how many tracks the item should span

The default span is 1. If neither start or end is set then the item will be placed automatically.

Generally, at most two fields should be set. If all three fields are specified then span will be ignored. If end specifies an earlier grid line than start then end will be ignored and the item will have a span of 1.

https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Grid_Layout/Line-based_Placement_with_CSS_Grid

Implementations

impl GridPlacement

pub const DEFAULT: GridPlacement = _

pub fn auto() -> GridPlacement

Place the grid item automatically (letting the span default to 1).

pub fn span(span: u16) -> GridPlacement

Place the grid item automatically, specifying how many tracks it should span.

Panics

Panics if span is 0.

pub fn start(start: i16) -> GridPlacement

Place the grid item specifying the start grid line (letting the span default to 1).

Panics

Panics if start is 0.

pub fn end(end: i16) -> GridPlacement

Place the grid item specifying the end grid line (letting the span default to 1).

Panics

Panics if end is 0.

pub fn start_span(start: i16, span: u16) -> GridPlacement

Place the grid item specifying the start grid line and how many tracks it should span.

Panics

Panics if start or span is 0.

pub fn start_end(start: i16, end: i16) -> GridPlacement

Place the grid item specifying start and end grid lines (span will be inferred)

Panics

Panics if start or end is 0.

pub fn end_span(end: i16, span: u16) -> GridPlacement

Place the grid item specifying the end grid line and how many tracks it should span.

Panics

Panics if end or span is 0.

pub fn set_start(self, start: i16) -> GridPlacement

Mutate the item, setting the start grid line

Panics

Panics if start is 0.

pub fn set_end(self, end: i16) -> GridPlacement

Mutate the item, setting the end grid line

Panics

Panics if end is 0.

pub fn set_span(self, span: u16) -> GridPlacement

Mutate the item, setting the number of tracks the item should span

Panics

Panics if span is 0.

pub fn get_start(self) -> Option<i16>

Returns the grid line at which the item should start, or None if not set.

pub fn get_end(self) -> Option<i16>

Returns the grid line at which the item should end, or None if not set.

pub fn get_span(self) -> Option<u16>

Returns span for this grid item, or None if not set.

Trait Implementations

impl Clone for GridPlacement

fn clone(&self) -> GridPlacement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GridPlacement

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

Formats the value using the given formatter.

impl Default for GridPlacement

fn default() -> GridPlacement

Returns the “default value” for a type.

impl From<GridPlacement> for Line<GenericGridPlacement<GridLine>>

fn from(value: GridPlacement) -> Line<GenericGridPlacement<GridLine>>

Converts to this type from the input type.

impl FromReflect for GridPlacement

where GridPlacement: Any + Send + Sync, Option<NonZeroI16>: FromReflect + TypePath, Option<NonZeroU16>: FromReflect + TypePath,

fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<GridPlacement>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for GridPlacement

where GridPlacement: Any + Send + Sync, Option<NonZeroI16>: FromReflect + TypePath, Option<NonZeroU16>: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl PartialEq for GridPlacement

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for GridPlacement

where GridPlacement: Any + Send + Sync, Option<NonZeroI16>: FromReflect + TypePath, Option<NonZeroU16>: FromReflect + TypePath,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

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

Returns the value as a Box<dyn Any>.

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

Returns the value as a &dyn Any.

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

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<GridPlacement>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<GridPlacement>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for GridPlacement

where GridPlacement: Any + Send + Sync, Option<NonZeroI16>: FromReflect + TypePath, Option<NonZeroU16>: FromReflect + TypePath,

fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for GridPlacement

where GridPlacement: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for GridPlacement

where GridPlacement: Any + Send + Sync, Option<NonZeroI16>: FromReflect + TypePath, Option<NonZeroU16>: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for GridPlacement

impl Eq for GridPlacement

impl StructuralEq for GridPlacement

impl StructuralPartialEq for GridPlacement