Struct BoxElem 

pub struct BoxElem {
    pub width: Settable<Self, 0u8>,
    pub height: Settable<Self, 1u8>,
    pub baseline: Settable<Self, 2u8>,
    pub fill: Settable<Self, 3u8>,
    pub stroke: Settable<Self, 4u8>,
    pub radius: Settable<Self, 5u8>,
    pub inset: Settable<Self, 6u8>,
    pub outset: Settable<Self, 7u8>,
    pub clip: Settable<Self, 8u8>,
    pub body: Settable<Self, 9u8>,
}

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.

Fields

width: Settable<Self, 0u8>

height: Settable<Self, 1u8>

baseline: Settable<Self, 2u8>

fill: Settable<Self, 3u8>

stroke: Settable<Self, 4u8>

radius: Settable<Self, 5u8>

inset: Settable<Self, 6u8>

outset: Settable<Self, 7u8>

clip: Settable<Self, 8u8>

body: Settable<Self, 9u8>

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.

impl BoxElem

pub const width: Field<Self, 0u8>

pub const height: Field<Self, 1u8>

pub const baseline: Field<Self, 2u8>

pub const fill: Field<Self, 3u8>

pub const stroke: Field<Self, 4u8>

pub const radius: Field<Self, 5u8>

pub const inset: Field<Self, 6u8>

pub const outset: Field<Self, 7u8>

pub const clip: Field<Self, 8u8>

pub const body: Field<Self, 9u8>

Trait Implementations

impl Clone for BoxElem

fn clone(&self) -> BoxElem

Returns a duplicate 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 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 NativeElement for BoxElem

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

impl Set for BoxElem

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

Parse relevant arguments into style properties for this element.

impl SettableField<0> for BoxElem

const FIELD: SettableFieldData<Self, 0u8>

type Type = Sizing

impl SettableField<1> for BoxElem

const FIELD: SettableFieldData<Self, 1u8>

type Type = Smart<Rel>

impl SettableField<2> for BoxElem

const FIELD: SettableFieldData<Self, 2u8>

type Type = Rel

impl SettableField<3> for BoxElem

const FIELD: SettableFieldData<Self, 3u8>

type Type = Option<Paint>

impl SettableField<4> for BoxElem

const FIELD: SettableFieldData<Self, 4u8>

type Type = Sides<Option<Option<Stroke>>>

impl SettableField<5> for BoxElem

const FIELD: SettableFieldData<Self, 5u8>

type Type = Corners<Option<Rel>>

impl SettableField<6> for BoxElem

const FIELD: SettableFieldData<Self, 6u8>

type Type = Sides<Option<Rel>>

impl SettableField<7> for BoxElem

const FIELD: SettableFieldData<Self, 7u8>

type Type = Sides<Option<Rel>>

impl SettableField<8> for BoxElem

const FIELD: SettableFieldData<Self, 8u8>

type Type = bool

impl SettableField<9> for BoxElem

const FIELD: SettableFieldData<Self, 9u8>

type Type = Option<Content>

impl RefableProperty<0> for BoxElem

impl RefableProperty<1> for BoxElem

impl RefableProperty<2> for BoxElem

impl RefableProperty<3> for BoxElem

impl RefableProperty<8> for BoxElem

impl RefableProperty<9> for BoxElem