Struct BoxElem

pub struct BoxElem { /* private fields */ }

An inline-level container that sizes content.

All elements except inline math, text, and boxes are block-level and cannot occur inside of a paragraph. The box function can be used to integrate such elements into a paragraph. Boxes take the size of their contents by default but can also be sized explicitly.

Example

Refer to the docs
#box(
  height: 9pt,
  image("docs.svg")
)
for more information.

Implementations

impl BoxElem

pub fn new() -> Self

Create a new instance of the element.

pub fn with_width(self, width: Sizing) -> Self

Builder-style setter for the width field.

pub fn with_height(self, height: Smart<Rel<Length>>) -> Self

Builder-style setter for the height field.

pub fn with_baseline(self, baseline: Rel<Length>) -> Self

Builder-style setter for the baseline field.

pub fn with_fill(self, fill: Option<Paint>) -> Self

Builder-style setter for the fill field.

pub fn with_stroke(self, stroke: Sides<Option<Option<Stroke>>>) -> Self

Builder-style setter for the stroke field.

pub fn with_radius(self, radius: Corners<Option<Rel<Length>>>) -> Self

Builder-style setter for the radius field.

pub fn with_inset(self, inset: Sides<Option<Rel<Length>>>) -> Self

Builder-style setter for the inset field.

pub fn with_outset(self, outset: Sides<Option<Rel<Length>>>) -> Self

Builder-style setter for the outset field.

pub fn with_clip(self, clip: bool) -> Self

Builder-style setter for the clip field.

pub fn with_body(self, body: Option<Content>) -> Self

Builder-style setter for the body field.

pub fn push_width(&mut self, width: Sizing)

Setter for the width field.

pub fn push_height(&mut self, height: Smart<Rel<Length>>)

Setter for the height field.

pub fn push_baseline(&mut self, baseline: Rel<Length>)

Setter for the baseline field.

pub fn push_fill(&mut self, fill: Option<Paint>)

Setter for the fill field.

pub fn push_stroke(&mut self, stroke: Sides<Option<Option<Stroke>>>)

Setter for the stroke field.

pub fn push_radius(&mut self, radius: Corners<Option<Rel<Length>>>)

Setter for the radius field.

pub fn push_inset(&mut self, inset: Sides<Option<Rel<Length>>>)

Setter for the inset field.

pub fn push_outset(&mut self, outset: Sides<Option<Rel<Length>>>)

Setter for the outset field.

pub fn push_clip(&mut self, clip: bool)

Setter for the clip field.

pub fn push_body(&mut self, body: Option<Content>)

Setter for the body field.

pub fn width(&self, styles: StyleChain<'_>) -> Sizing

The width of the box.

Boxes can have fractional widths, as the example below demonstrates.

Note: Currently, only boxes and only their widths might be fractionally sized within paragraphs. Support for fractionally sized images, shapes, and more might be added in the future.

Line in #box(width: 1fr, line(length: 100%)) between.

pub fn height(&self, styles: StyleChain<'_>) -> Smart<Rel<Length>>

The height of the box.

pub fn baseline( &self, styles: StyleChain<'_>, ) -> <Rel<Length> as Resolve>::Output

An amount to shift the box’s baseline by.

Image: #box(baseline: 40%, image("tiger.jpg", width: 2cm)).

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

The box’s background color. See the rectangle’s documentation for more details.

pub fn stroke( &self, styles: StyleChain<'_>, ) -> <Sides<Option<Option<Stroke>>> as Resolve>::Output

The box’s border color. See the rectangle’s documentation for more details.

pub fn radius( &self, styles: StyleChain<'_>, ) -> <Corners<Option<Rel<Length>>> as Resolve>::Output

How much to round the box’s corners. See the rectangle’s documentation for more details.

pub fn inset( &self, styles: StyleChain<'_>, ) -> <Sides<Option<Rel<Length>>> as Resolve>::Output

How much to pad the box’s content.

Note: When the box contains text, its exact size depends on the current text edges.

#rect(inset: 0pt)[Tight]

pub fn outset( &self, styles: StyleChain<'_>, ) -> <Sides<Option<Rel<Length>>> as Resolve>::Output

How much to expand the box’s size without affecting the layout.

This is useful to prevent padding from affecting line layout. For a generalized version of the example below, see the documentation for the raw text’s block parameter.

An inline
#box(
  fill: luma(235),
  inset: (x: 3pt, y: 0pt),
  outset: (y: 3pt),
  radius: 2pt,
)[rectangle].

pub fn clip(&self, styles: StyleChain<'_>) -> bool

Whether to clip the content inside the box.

Clipping is useful when the box’s content is larger than the box itself, as any content that exceeds the box’s bounds will be hidden.

#box(
  width: 50pt,
  height: 50pt,
  clip: true,
  image("tiger.jpg", width: 100pt, height: 100pt)
)

pub fn body<'a>(&'a self, styles: StyleChain<'a>) -> &'a Option<Content>

The contents of the box.

pub fn width_in(styles: StyleChain<'_>) -> Sizing

Access the width field in the given style chain.

pub fn height_in(styles: StyleChain<'_>) -> Smart<Rel<Length>>

Access the height field in the given style chain.

pub fn baseline_in(styles: StyleChain<'_>) -> <Rel<Length> as Resolve>::Output

Access the baseline field in the given style chain.

pub fn fill_in(styles: StyleChain<'_>) -> Option<Paint>

Access the fill field in the given style chain.

pub fn stroke_in( styles: StyleChain<'_>, ) -> <Sides<Option<Option<Stroke>>> as Resolve>::Output

Access the stroke field in the given style chain.

pub fn radius_in( styles: StyleChain<'_>, ) -> <Corners<Option<Rel<Length>>> as Resolve>::Output

Access the radius field in the given style chain.

pub fn inset_in( styles: StyleChain<'_>, ) -> <Sides<Option<Rel<Length>>> as Resolve>::Output

Access the inset field in the given style chain.

pub fn outset_in( styles: StyleChain<'_>, ) -> <Sides<Option<Rel<Length>>> as Resolve>::Output

Access the outset field in the given style chain.

pub fn clip_in(styles: StyleChain<'_>) -> bool

Access the clip field in the given style chain.

pub fn body_in(styles: StyleChain<'_>) -> &Option<Content>

Access the body field in the given style chain.

pub fn set_width(width: Sizing) -> Property

Create a style property for the width field.

pub fn set_height(height: Smart<Rel<Length>>) -> Property

Create a style property for the height field.

pub fn set_baseline(baseline: Rel<Length>) -> Property

Create a style property for the baseline field.

pub fn set_fill(fill: Option<Paint>) -> Property

Create a style property for the fill field.

pub fn set_stroke(stroke: Sides<Option<Option<Stroke>>>) -> Property

Create a style property for the stroke field.

pub fn set_radius(radius: Corners<Option<Rel<Length>>>) -> Property

Create a style property for the radius field.

pub fn set_inset(inset: Sides<Option<Rel<Length>>>) -> Property

Create a style property for the inset field.

pub fn set_outset(outset: Sides<Option<Rel<Length>>>) -> Property

Create a style property for the outset field.

pub fn set_clip(clip: bool) -> Property

Create a style property for the clip field.

pub fn set_body(body: Option<Content>) -> Property

Create a style property for the body field.

Trait Implementations

impl Capable for BoxElem

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

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

impl Clone for BoxElem

fn clone(&self) -> BoxElem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for BoxElem

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

Construct an element from the arguments.

impl Debug for BoxElem

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

Formats the value using the given formatter.

impl Fields for BoxElem

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 BoxElem

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 BoxElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for BoxElem

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 BoxElem

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 BoxElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for BoxElem

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

Parse relevant arguments into style properties for this element.