Skip to main content

BoxStyle

Struct BoxStyle 

Source
pub struct BoxStyle {
Show 15 fields pub width: Option<Length>, pub height: Option<Length>, pub min_width: Option<Length>, pub max_width: Option<Length>, pub min_height: Option<Length>, pub max_height: Option<Length>, pub padding: Option<[Length; 4]>, pub margin: Option<[Length; 4]>, pub aspect_ratio: Option<OrderedLayoutUnit>, pub overflow: Overflow, pub alignment: BoxAlignment, pub position: Option<BoxPosition>, pub grid: Option<BoxGridPlacement>, pub flex_grow: Option<OrderedLayoutUnit>, pub flex_shrink: Option<OrderedLayoutUnit>,
}
Expand description

Typed sizing and overflow shared by common box-like widgets.

BoxStyle lets widgets expose CSS-like layout capabilities without embedding CSS or shell-specific behavior in application code.

§Example

use fission_ir::op::{BoxAlignment, BoxStyle, Length, Overflow};

let style = BoxStyle::default()
    .width(Length::clamp(
        Length::points(280.0),
        Length::percent(50.0),
        Length::points(720.0),
    ))
    .padding_symmetric(Length::points(24.0), Length::points(16.0))
    .align(BoxAlignment::Center)
    .overflow(Overflow::Clip);

Fields§

§width: Option<Length>

Preferred width.

§height: Option<Length>

Preferred height.

§min_width: Option<Length>

Minimum width constraint.

§max_width: Option<Length>

Maximum width constraint.

§min_height: Option<Length>

Minimum height constraint.

§max_height: Option<Length>

Maximum height constraint.

§padding: Option<[Length; 4]>

Inner spacing in [left, right, top, bottom] order.

§margin: Option<[Length; 4]>

Outer spacing in [left, right, top, bottom] order.

§aspect_ratio: Option<OrderedLayoutUnit>

Width-to-height ratio.

§overflow: Overflow

Whether content can paint outside this box.

§alignment: BoxAlignment

Child alignment inside the content rectangle.

§position: Option<BoxPosition>

Optional absolute positioning offsets.

§grid: Option<BoxGridPlacement>

Optional parent-grid placement.

§flex_grow: Option<OrderedLayoutUnit>

Flex grow participation for box-like widgets.

§flex_shrink: Option<OrderedLayoutUnit>

Flex shrink participation for box-like widgets.

Implementations§

Source§

impl BoxStyle

Source

pub fn width(self, value: Length) -> BoxStyle

Sets the preferred width.

Source

pub fn height(self, value: Length) -> BoxStyle

Sets the preferred height.

Source

pub fn min_width(self, value: Length) -> BoxStyle

Sets the minimum width.

Source

pub fn max_width(self, value: Length) -> BoxStyle

Sets the maximum width.

Source

pub fn min_height(self, value: Length) -> BoxStyle

Sets the minimum height.

Source

pub fn max_height(self, value: Length) -> BoxStyle

Sets the maximum height.

Source

pub fn padding(self, edges: [Length; 4]) -> BoxStyle

Sets [left, right, top, bottom] inner spacing.

Source

pub fn padding_all(self, value: Length) -> BoxStyle

Sets equal inner spacing on every edge.

Source

pub fn padding_symmetric(self, horizontal: Length, vertical: Length) -> BoxStyle

Sets horizontal and vertical inner spacing.

Source

pub fn margin(self, edges: [Length; 4]) -> BoxStyle

Sets [left, right, top, bottom] outer spacing.

Source

pub fn margin_all(self, value: Length) -> BoxStyle

Sets equal outer spacing on every edge.

Source

pub fn margin_symmetric(self, horizontal: Length, vertical: Length) -> BoxStyle

Sets horizontal and vertical outer spacing.

Source

pub fn overflow(self, overflow: Overflow) -> BoxStyle

Sets overflow visibility or clipping.

Source

pub fn align(self, alignment: BoxAlignment) -> BoxStyle

Aligns the child within the box’s content rectangle.

Source

pub fn aspect_ratio(self, ratio: f32) -> BoxStyle

Sets a non-negative width-to-height ratio.

Source

pub fn positioned(self, position: BoxPosition) -> BoxStyle

Absolutely positions the box within its positioned parent.

Source

pub fn grid(self, placement: BoxGridPlacement) -> BoxStyle

Places the box in a parent grid.

Source

pub fn flex(self, grow: f32, shrink: f32) -> BoxStyle

Sets flex grow and shrink participation.

Trait Implementations§

Source§

impl Clone for BoxStyle

Source§

fn clone(&self) -> BoxStyle

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 BoxStyle

Source§

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

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

impl Default for BoxStyle

Source§

fn default() -> BoxStyle

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

impl<'de> Deserialize<'de> for BoxStyle

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<BoxStyle, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Hash for BoxStyle

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for BoxStyle

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for BoxStyle

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for BoxStyle

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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> 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 = 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.