Struct PageElem

pub struct PageElem {}

Layouts its child onto one or multiple pages.

Although this function is primarily used in set rules to affect page properties, it can also be used to explicitly render its argument onto a set of pages of its own.

Pages can be set to use {auto} as their width or height. In this case, the pages will grow to fit their content on the respective axis.

The Guide for Page Setup explains how to use this and related functions to set up a document with many examples.

Example

>>> #set page(margin: auto)
#set page("us-letter")

There you go, US friends!

Implementations

impl PageElem

pub fn new() -> Self

Create a new instance of the element.

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

Access the width field in the given style chain.

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

Access the height field in the given style chain.

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

Access the flipped field in the given style chain.

pub fn margin_in(styles: StyleChain<'_>) -> Margin

Access the margin field in the given style chain.

pub fn binding_in(styles: StyleChain<'_>) -> Smart<Binding>

Access the binding field in the given style chain.

pub fn columns_in(styles: StyleChain<'_>) -> NonZeroUsize

Access the columns field in the given style chain.

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

Access the fill field in the given style chain.

pub fn numbering_in(styles: StyleChain<'_>) -> &Option<Numbering>

Access the numbering field in the given style chain.

pub fn supplement_in(styles: StyleChain<'_>) -> Smart<Option<Content>>

Access the supplement field in the given style chain.

pub fn number_align_in( styles: StyleChain<'_>, ) -> SpecificAlignment<HAlignment, OuterVAlignment>

Access the number-align field in the given style chain.

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

Access the header field in the given style chain.

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

Access the header-ascent field in the given style chain.

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

Access the footer field in the given style chain.

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

Access the footer-descent field in the given style chain.

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

Access the background field in the given style chain.

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

Access the foreground field in the given style chain.

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

Create a style property for the width field.

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

Create a style property for the height field.

pub fn set_flipped(flipped: bool) -> Property

Create a style property for the flipped field.

pub fn set_margin(margin: Margin) -> Property

Create a style property for the margin field.

pub fn set_binding(binding: Smart<Binding>) -> Property

Create a style property for the binding field.

pub fn set_columns(columns: NonZeroUsize) -> Property

Create a style property for the columns field.

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

Create a style property for the fill field.

pub fn set_numbering(numbering: Option<Numbering>) -> Property

Create a style property for the numbering field.

pub fn set_supplement(supplement: Smart<Option<Content>>) -> Property

Create a style property for the supplement field.

pub fn set_number_align( number_align: SpecificAlignment<HAlignment, OuterVAlignment>, ) -> Property

Create a style property for the number-align field.

pub fn set_header(header: Smart<Option<Content>>) -> Property

Create a style property for the header field.

pub fn set_header_ascent(header_ascent: Rel<Length>) -> Property

Create a style property for the header-ascent field.

pub fn set_footer(footer: Smart<Option<Content>>) -> Property

Create a style property for the footer field.

pub fn set_footer_descent(footer_descent: Rel<Length>) -> Property

Create a style property for the footer-descent field.

pub fn set_background(background: Option<Content>) -> Property

Create a style property for the background field.

pub fn set_foreground(foreground: Option<Content>) -> Property

Create a style property for the foreground field.

Trait Implementations

impl Capable for PageElem

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

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

impl Clone for PageElem

fn clone(&self) -> PageElem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for PageElem

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

Construct an element from the arguments.

impl Debug for PageElem

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

Formats the value using the given formatter.

impl Fields for PageElem

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 PageElem

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 PageElem

fn into_value(self) -> Value

Cast this type into a value.

impl LocalName for PageElem

const KEY: &'static str = "page"

The key of an element in order to get its localized name.

fn local_name(lang: Lang, region: Option<Region>) -> &'static str

Get the name in the given language and (optionally) region.

fn local_name_in(styles: StyleChain<'_>) -> &'static str

where Self: Sized,

Gets the local name from the style chain.

impl NativeElement for PageElem

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 PageElem

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 PageElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for PageElem

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

Parse relevant arguments into style properties for this element.