Struct OutlineEntry 

pub struct OutlineEntry {
    pub level: NonZeroUsize,
    pub element: Content,
    pub fill: Settable<Self, 2u8>,
}

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

fill: Settable<Self, 2u8>

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.

impl OutlineEntry

pub const level: Field<Self, 0u8>

pub const element: Field<Self, 1u8>

pub const fill: Field<Self, 2u8>

pub const parent: Field<Self, 3u8>

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 offset from the prefix by the specified gap, rather than aligning outline-wide. For a visual explanation, see [outline.indent].

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.

impl OutlineEntry

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

pub fn element_location(&self) -> HintedStrResult<Location>

Returns the location of the outlined element.

Trait Implementations

impl Clone for OutlineEntry

fn clone(&self) -> OutlineEntry

Returns a duplicate of the value.

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

const ELEM: Element

The associated element.

fn pack(self) -> Content

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 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 RequiredField<0> for OutlineEntry

const FIELD: RequiredFieldData<Self, 0u8>

type Type = NonZero<usize>

impl RequiredField<1> for OutlineEntry

const FIELD: RequiredFieldData<Self, 1u8>

type Type = Content

impl Set for OutlineEntry

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

Parse relevant arguments into style properties for this element.

impl SettableField<2> for OutlineEntry

const FIELD: SettableFieldData<Self, 2u8>

type Type = Option<Content>

impl SettableProperty<3> for OutlineEntry

const FIELD: SettablePropertyData<Self, 3u8>

type Type = Option<Packed<OutlineElem>>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl RefableProperty<2> for OutlineEntry

impl RefableProperty<3> for OutlineEntry