Struct TermsElem

pub struct TermsElem {
    pub children: Vec<Packed<TermItem>>,
    /* private fields */
}

A list of terms and their descriptions.

Displays a sequence of terms and their descriptions vertically. When the descriptions span over multiple lines, they use hanging indent to communicate the visual hierarchy.

Example

/ Ligature: A merged glyph.
/ Kerning: A spacing adjustment
  between two adjacent letters.

Syntax

This function also has dedicated syntax: Starting a line with a slash, followed by a term, a colon and a description creates a term list item.

Fields

children: Vec<Packed<TermItem>>

Implementations

impl TermsElem

pub fn new(children: Vec<Packed<TermItem>>) -> Self

Create a new instance of the element.

pub fn with_tight(self, tight: bool) -> Self

Builder-style setter for the tight field.

pub fn with_separator(self, separator: Content) -> Self

Builder-style setter for the separator field.

pub fn with_indent(self, indent: Length) -> Self

Builder-style setter for the indent field.

pub fn with_hanging_indent(self, hanging_indent: Length) -> Self

Builder-style setter for the hanging-indent field.

pub fn with_spacing(self, spacing: Smart<Length>) -> Self

Builder-style setter for the spacing field.

pub fn push_tight(&mut self, tight: bool)

Setter for the tight field.

pub fn push_separator(&mut self, separator: Content)

Setter for the separator field.

pub fn push_indent(&mut self, indent: Length)

Setter for the indent field.

pub fn push_hanging_indent(&mut self, hanging_indent: Length)

Setter for the hanging-indent field.

pub fn push_spacing(&mut self, spacing: Smart<Length>)

Setter for the spacing field.

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

Defines the default spacing of the term list. If it is {false}, the items are spaced apart with paragraph spacing. If it is {true}, they use paragraph leading instead. This makes the list more compact, which can look better if the items are short.

In markup mode, the value of this parameter is determined based on whether items are separated with a blank line. If items directly follow each other, this is set to {true}; if items are separated by a blank line, this is set to {false}. The markup-defined tightness cannot be overridden with set rules.

/ Fact: If a term list has a lot
  of text, and maybe other inline
  content, it should not be tight
  anymore.

/ Tip: To make it wide, simply
  insert a blank line between the
  items.

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

The separator between the item and the description.

If you want to just separate them with a certain amount of space, use {h(2cm, weak: true)} as the separator and replace {2cm} with your desired amount of space.

#set terms(separator: [: ])

/ Colon: A nice separator symbol.

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

The indentation of each item.

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

The hanging indent of the description.

This is in addition to the whole item’s indent.

#set terms(hanging-indent: 0pt)
/ Term: This term list does not
  make use of hanging indents.

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

The spacing between the items of the term list.

If set to {auto}, uses paragraph leading for tight term lists and paragraph spacing for wide (non-tight) term lists.

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

Access the tight field in the given style chain.

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

Access the separator field in the given style chain.

pub fn indent_in(styles: StyleChain<'_>) -> Length

Access the indent field in the given style chain.

pub fn hanging_indent_in(styles: StyleChain<'_>) -> Length

Access the hanging-indent field in the given style chain.

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

Access the spacing field in the given style chain.

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

Access the within field in the given style chain.

pub fn set_tight(tight: bool) -> Property

Create a style property for the tight field.

pub fn set_separator(separator: Content) -> Property

Create a style property for the separator field.

pub fn set_indent(indent: Length) -> Property

Create a style property for the indent field.

pub fn set_hanging_indent(hanging_indent: Length) -> Property

Create a style property for the hanging-indent field.

pub fn set_spacing(spacing: Smart<Length>) -> Property

Create a style property for the spacing field.

pub fn set_within(within: bool) -> Property

Create a style property for the within field.

Trait Implementations

impl Capable for TermsElem

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

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

impl Clone for TermsElem

fn clone(&self) -> TermsElem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for TermsElem

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

Construct an element from the arguments.

impl Debug for TermsElem

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

Formats the value using the given formatter.

impl Fields for TermsElem

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 TermsElem

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 TermsElem

fn into_value(self) -> Value

Cast this type into a value.

impl ListLike for TermsElem

type Item = TermItem

The kind of list item this list is composed of.

fn create(children: Vec<Packed<Self::Item>>, tight: bool) -> Self

Create this kind of list from its children and tightness.

impl NativeElement for TermsElem

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 NativeScope for TermsElem

fn constructor() -> Option<&'static NativeFuncData>

The constructor function for the type, if any.

fn scope() -> Scope

Get the associated scope for the type.

impl PartialEq for TermsElem

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 TermsElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for TermsElem

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

Parse relevant arguments into style properties for this element.