Struct ColbreakElem

pub struct ColbreakElem { /* private fields */ }

Forces a column break.

The function will behave like a page break when used in a single column layout or the last column on a page. Otherwise, content after the column break will be placed in the next column.

Example

#set page(columns: 2)
Preliminary findings from our
ongoing research project have
revealed a hitherto unknown
phenomenon of extraordinary
significance.

#colbreak()
Through rigorous experimentation
and analysis, we have discovered
a hitherto uncharacterized process
that defies our current
understanding of the fundamental
laws of nature.

Implementations

impl ColbreakElem

pub fn new() -> Self

Create a new instance of the element.

pub fn with_weak(self, weak: bool) -> Self

Builder-style setter for the weak field.

pub fn push_weak(&mut self, weak: bool)

Setter for the weak field.

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

If {true}, the column break is skipped if the current column is already empty.

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

Access the weak field in the given style chain.

pub fn set_weak(weak: bool) -> Property

Create a style property for the weak field.

Trait Implementations

impl Capable for ColbreakElem

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

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

impl Clone for ColbreakElem

fn clone(&self) -> ColbreakElem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for ColbreakElem

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

Construct an element from the arguments.

impl Debug for ColbreakElem

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

Formats the value using the given formatter.

impl Fields for ColbreakElem

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 ColbreakElem

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 ColbreakElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for ColbreakElem

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 ColbreakElem

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 ColbreakElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for ColbreakElem

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

Parse relevant arguments into style properties for this element.