Struct RectElem

pub struct RectElem { /* private fields */ }

A rectangle with optional content.

Example

// Without content.
#rect(width: 35%, height: 30pt)

// With content.
#rect[
  Automatically sized \
  to fit the content.
]

Implementations

impl RectElem

pub fn new() -> Self

Create a new instance of the element.

pub fn with_width(self, width: Smart<Rel<Length>>) -> Self

Builder-style setter for the width field.

pub fn with_height(self, height: Sizing) -> Self

Builder-style setter for the height field.

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

Builder-style setter for the fill field.

pub fn with_stroke(self, stroke: Smart<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_body(self, body: Option<Content>) -> Self

Builder-style setter for the body field.

pub fn push_width(&mut self, width: Smart<Rel<Length>>)

Setter for the width field.

pub fn push_height(&mut self, height: Sizing)

Setter for the height field.

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

Setter for the fill field.

pub fn push_stroke(&mut self, stroke: Smart<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_body(&mut self, body: Option<Content>)

Setter for the body field.

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

The rectangle’s width, relative to its parent container.

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

The rectangle’s height, relative to its parent container.

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

How to fill the rectangle.

When setting a fill, the default stroke disappears. To create a rectangle with both fill and stroke, you have to configure both.

#rect(fill: blue)

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

How to stroke the rectangle. This can be:

• {none} to disable stroking
• {auto} for a stroke of {1pt + black} if and if only if no fill is given.
• Any kind of [stroke]
• A dictionary describing the stroke for each side individually. The dictionary can contain the following keys in order of precedence:
  • top: The top stroke.
  • right: The right stroke.
  • bottom: The bottom stroke.
  • left: The left stroke.
  • x: The horizontal stroke.
  • y: The vertical stroke.
  • rest: The stroke on all sides except those for which the dictionary explicitly sets a size.

#stack(
  dir: ltr,
  spacing: 1fr,
  rect(stroke: red),
  rect(stroke: 2pt),
  rect(stroke: 2pt + red),
)

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

How much to round the rectangle’s corners, relative to the minimum of the width and height divided by two. This can be:

• A relative length for a uniform corner radius.
• A dictionary: With a dictionary, the stroke for each side can be set individually. The dictionary can contain the following keys in order of precedence:
  • top-left: The top-left corner radius.
  • top-right: The top-right corner radius.
  • bottom-right: The bottom-right corner radius.
  • bottom-left: The bottom-left corner radius.
  • left: The top-left and bottom-left corner radii.
  • top: The top-left and top-right corner radii.
  • right: The top-right and bottom-right corner radii.
  • bottom: The bottom-left and bottom-right corner radii.
  • rest: The radii for all corners except those for which the dictionary explicitly sets a size.

#set rect(stroke: 4pt)
#rect(
  radius: (
    left: 5pt,
    top-right: 20pt,
    bottom-right: 10pt,
  ),
  stroke: (
    left: red,
    top: yellow,
    right: green,
    bottom: blue,
  ),
)

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

How much to pad the rectangle’s content. See the box’s documentation for more details.

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

How much to expand the rectangle’s size without affecting the layout. See the box’s documentation for more details.

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

The content to place into the rectangle.

When this is omitted, the rectangle takes on a default size of at most {45pt} by {30pt}.

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

Access the width field in the given style chain.

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

Access the height 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<'_>, ) -> <Smart<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 body_in(styles: StyleChain<'_>) -> &Option<Content>

Access the body field in the given style chain.

pub fn set_width(width: Smart<Rel<Length>>) -> Property

Create a style property for the width field.

pub fn set_height(height: Sizing) -> Property

Create a style property for the height field.

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

Create a style property for the fill field.

pub fn set_stroke(stroke: Smart<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_body(body: Option<Content>) -> Property

Create a style property for the body field.

Trait Implementations

impl Capable for RectElem

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

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

impl Clone for RectElem

fn clone(&self) -> RectElem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for RectElem

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

Construct an element from the arguments.

impl Debug for RectElem

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

Formats the value using the given formatter.

impl Fields for RectElem

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 RectElem

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 RectElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for RectElem

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 RectElem

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 RectElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for RectElem

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

Parse relevant arguments into style properties for this element.