Struct OutlineEntry

pub struct OutlineEntry {
    pub level: NonZeroUsize,
    pub element: Content,
    /* private fields */
}

Represents an entry line in an outline.

With show-set and show rules on outline entries, you can richly customize the outline’s appearance. See the section on styling the outline for details.

Fields

level: NonZeroUsize

element: Content

Implementations

impl OutlineEntry

pub fn new(level: NonZeroUsize, element: Content) -> Self

Create a new instance of the element.

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

Builder-style setter for the fill field.

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

Setter for the fill field.

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

Content to fill the space between the title and the page number. Can be set to {none} to disable filling.

The fill will be placed into a fractionally sized box that spans the space between the entry’s body and the page number. When using show rules to override outline entries, it is thus recommended to wrap the fill in a [box] with fractional width, i.e. {box(width: 1fr, it.fill}.

When using [repeat], the gap property can be useful to tweak the visual weight of the fill.

#set outline.entry(fill: line(length: 100%))
#outline()

= A New Beginning

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

Access the fill field in the given style chain.

pub fn parent_in(styles: StyleChain<'_>) -> Option<Packed<OutlineElem>>

Access the parent field in the given style chain.

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

Create a style property for the fill field.

pub fn set_parent(parent: Option<Packed<OutlineElem>>) -> Property

Create a style property for the parent field.

impl OutlineEntry

pub fn indented( &self, engine: &mut Engine<'_>, context: Tracked<'_, Context<'_>>, span: Span, prefix: Option<Content>, inner: Content, gap: Length, ) -> SourceResult<Content>

A helper function for producing an indented entry layout: Lays out a prefix and the rest of the entry in an indent-aware way.

If the parent outline’s indent is {auto}, the inner content of all entries at level N is aligned with the prefix of all entries at level N + 1, leaving at least gap space between the prefix and inner parts. Furthermore, the inner contents of all entries at the same level are aligned.

If the outline’s indent is a fixed value or a function, the prefixes are indented, but the inner contents are simply inset from the prefix by the specified gap, rather than aligning outline-wide.

pub fn prefix( &self, engine: &mut Engine<'_>, context: Tracked<'_, Context<'_>>, span: Span, ) -> SourceResult<Option<Content>>

Formats the element’s numbering (if any).

This also appends the element’s supplement in case of figures or equations. For instance, it would output 1.1 for a heading, but Figure 1 for a figure, as is usual for outlines.

pub fn inner( &self, engine: &mut Engine<'_>, context: Tracked<'_, Context<'_>>, span: Span, ) -> SourceResult<Content>

Creates the default inner content of the entry.

This includes the body, the fill, and page number.

pub fn body(&self) -> StrResult<Content>

The content which is displayed in place of the referred element at its entry in the outline. For a heading, this is its body; for a figure a caption and for equations, it is empty.

pub fn page( &self, engine: &mut Engine<'_>, context: Tracked<'_, Context<'_>>, span: Span, ) -> SourceResult<Content>

The page number of this entry’s element, formatted with the numbering set for the referenced page.

Trait Implementations

impl Capable for OutlineEntry

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

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

impl Clone for OutlineEntry

fn clone(&self) -> OutlineEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for OutlineEntry

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

Construct an element from the arguments.

impl Debug for OutlineEntry

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

Formats the value using the given formatter.

impl Fields for OutlineEntry

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 FromValue for OutlineEntry

fn from_value(value: Value) -> HintedStrResult<Self>

Try to cast the value into an instance of Self.

impl Hash for OutlineEntry

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 OutlineEntry

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for OutlineEntry

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 OutlineEntry

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 OutlineEntry

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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 Reflect for OutlineEntry

fn input() -> CastInfo

Describe what can be cast into this value.

fn output() -> CastInfo

Describe what this value can be cast into.

fn castable(value: &Value) -> bool

Whether the given value can be converted to T.

fn error(found: &Value) -> HintedString

Produce an error message for an unacceptable value type.

impl Repr for OutlineEntry

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for OutlineEntry

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

Parse relevant arguments into style properties for this element.