Struct StackElem

pub struct StackElem {
    pub children: Vec<StackChild>,
    /* private fields */
}

Arranges content and spacing horizontally or vertically.

The stack places a list of items along an axis, with optional spacing between each item.

Example

#stack(
  dir: ttb,
  rect(width: 40pt),
  rect(width: 120pt),
  rect(width: 90pt),
)

Fields

children: Vec<StackChild>

Implementations

impl StackElem

pub fn new(children: Vec<StackChild>) -> Self

Create a new instance of the element.

pub fn with_dir(self, dir: Dir) -> Self

Builder-style setter for the dir field.

pub fn with_spacing(self, spacing: Option<Spacing>) -> Self

Builder-style setter for the spacing field.

pub fn with_children(self, children: Vec<StackChild>) -> Self

Builder-style setter for the children field.

pub fn push_dir(&mut self, dir: Dir)

Setter for the dir field.

pub fn push_spacing(&mut self, spacing: Option<Spacing>)

Setter for the spacing field.

pub fn push_children(&mut self, children: Vec<StackChild>)

Setter for the children field.

pub fn dir(&self, styles: StyleChain<'_>) -> Dir

The direction along which the items are stacked. Possible values are:

• {ltr}: Left to right.
• {rtl}: Right to left.
• {ttb}: Top to bottom.
• {btt}: Bottom to top.

You can use the start and end methods to obtain the initial and final points (respectively) of a direction, as alignment. You can also use the axis method to determine whether a direction is {"horizontal"} or {"vertical"}. The inv method returns a direction’s inverse direction.

For example, {ttb.start()} is top, {ttb.end()} is bottom, {ttb.axis()} is {"vertical"} and {ttb.inv()} is equal to btt.

pub fn spacing(&self, styles: StyleChain<'_>) -> Option<Spacing>

Spacing to insert between items where no explicit spacing was provided.

pub fn children(&self) -> &Vec<StackChild>

The children to stack along the axis.

pub fn dir_in(styles: StyleChain<'_>) -> Dir

Access the dir field in the given style chain.

pub fn spacing_in(styles: StyleChain<'_>) -> Option<Spacing>

Access the spacing field in the given style chain.

pub fn set_dir(dir: Dir) -> Property

Create a style property for the dir field.

pub fn set_spacing(spacing: Option<Spacing>) -> Property

Create a style property for the spacing field.

Trait Implementations

impl Capable for StackElem

fn vtable(capability: TypeId) -> Option<NonNull<()>>

Get the pointer to the vtable for the given capability / trait.

impl Clone for StackElem

fn clone(&self) -> StackElem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for StackElem

fn construct(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Content>

Construct an element from the arguments.

impl Debug for StackElem

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

Formats the value using the given formatter.

impl Fields for StackElem

type Enum = Fields

An enum with the fields of the element.

fn has(&self, id: u8) -> bool

Whether the element has the given field set.

fn field(&self, id: u8) -> Result<Value, FieldAccessError>

Get the field with the given field ID.

fn field_with_styles( &self, id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID in the presence of styles.

fn field_from_styles( id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID from the styles.

fn materialize(&mut self, styles: StyleChain<'_>)

Resolve all fields with the styles and save them in-place.

fn fields(&self) -> Dict

Get the fields of the element.

impl Hash for StackElem

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 IntoValue for StackElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for StackElem

fn data() -> &'static NativeElementData

Get the element data for the native Rust element.

fn elem() -> Element

where Self: Sized,

Get the element for the native Rust element.

fn pack(self) -> Content

where Self: Sized,

Pack the element into type-erased content.

impl PartialEq for StackElem

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Repr for StackElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for StackElem

fn set(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Styles>

Parse relevant arguments into style properties for this element.