Struct FigureElem 

pub struct FigureElem {
    pub body: Content,
    pub alt: Settable<Self, 1u8>,
    pub placement: Settable<Self, 2u8>,
    pub scope: Settable<Self, 3u8>,
    pub caption: Settable<Self, 4u8>,
    pub kind: Settable<Self, 5u8>,
    pub supplement: Settable<Self, 6u8>,
    pub numbering: Settable<Self, 7u8>,
    pub gap: Settable<Self, 8u8>,
    pub outlined: Settable<Self, 9u8>,
    pub counter: Option<Option<Counter>>,
    pub locale: Option<Locale>,
}

A figure with an optional caption.

Fields

body: Content

alt: Settable<Self, 1u8>

placement: Settable<Self, 2u8>

scope: Settable<Self, 3u8>

caption: Settable<Self, 4u8>

kind: Settable<Self, 5u8>

supplement: Settable<Self, 6u8>

numbering: Settable<Self, 7u8>

gap: Settable<Self, 8u8>

outlined: Settable<Self, 9u8>

counter: Option<Option<Counter>>

locale: Option<Locale>

Implementations

impl FigureElem

pub fn new(body: Content) -> Self

Create a new instance of the element.

pub fn with_alt(self, alt: Option<EcoString>) -> Self

Builder-style setter for the alt field.

pub fn with_placement(self, placement: Option<Smart<VAlignment>>) -> Self

Builder-style setter for the placement field.

pub fn with_scope(self, scope: PlacementScope) -> Self

Builder-style setter for the scope field.

pub fn with_caption(self, caption: Option<Packed<FigureCaption>>) -> Self

Builder-style setter for the caption field.

pub fn with_kind(self, kind: Smart<FigureKind>) -> Self

Builder-style setter for the kind field.

pub fn with_supplement(self, supplement: Smart<Option<Supplement>>) -> Self

Builder-style setter for the supplement field.

pub fn with_numbering(self, numbering: Option<Numbering>) -> Self

Builder-style setter for the numbering field.

pub fn with_gap(self, gap: Length) -> Self

Builder-style setter for the gap field.

pub fn with_outlined(self, outlined: bool) -> Self

Builder-style setter for the outlined field.

pub fn with_counter(self, counter: Option<Counter>) -> Self

Builder-style setter for the counter field.

pub fn with_locale(self, locale: Locale) -> Self

Builder-style setter for the locale field.

impl FigureElem

pub const body: Field<Self, 0u8>

pub const alt: Field<Self, 1u8>

pub const placement: Field<Self, 2u8>

pub const scope: Field<Self, 3u8>

pub const caption: Field<Self, 4u8>

pub const kind: Field<Self, 5u8>

pub const supplement: Field<Self, 6u8>

pub const numbering: Field<Self, 7u8>

pub const gap: Field<Self, 8u8>

pub const outlined: Field<Self, 9u8>

pub const counter: Field<Self, 10u8>

pub const locale: Field<Self, 11u8>

impl FigureElem

pub fn resolve_separator(&self, styles: StyleChain<'_>) -> Content

Retrieves the locale separator.

Trait Implementations

impl Clone for FigureElem

fn clone(&self) -> FigureElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for FigureElem

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

Construct an element from the arguments.

impl Debug for FigureElem

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

Formats the value using the given formatter.

impl Hash for FigureElem

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 FigureElem

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

impl NativeScope for FigureElem

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

The constructor function for the type, if any.

fn scope() -> Scope

Get the associated scope for the type.

impl RefableProperty<1> for FigureElem

impl RefableProperty<2> for FigureElem

impl RefableProperty<3> for FigureElem

impl RefableProperty<4> for FigureElem

impl RefableProperty<5> for FigureElem

impl RefableProperty<6> for FigureElem

impl RefableProperty<7> for FigureElem

impl RefableProperty<8> for FigureElem

impl RefableProperty<9> for FigureElem

impl RequiredField<0> for FigureElem

const FIELD: RequiredFieldData<Self, 0u8>

type Type = Content

impl Set for FigureElem

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

Parse relevant arguments into style properties for this element.

impl SettableField<1> for FigureElem

const FIELD: SettableFieldData<Self, 1u8>

type Type = Option<EcoString>

impl SettableField<2> for FigureElem

const FIELD: SettableFieldData<Self, 2u8>

type Type = Option<Smart<VAlignment>>

impl SettableField<3> for FigureElem

const FIELD: SettableFieldData<Self, 3u8>

type Type = PlacementScope

impl SettableField<4> for FigureElem

const FIELD: SettableFieldData<Self, 4u8>

type Type = Option<Packed<FigureCaption>>

impl SettableField<5> for FigureElem

const FIELD: SettableFieldData<Self, 5u8>

type Type = Smart<FigureKind>

impl SettableField<6> for FigureElem

const FIELD: SettableFieldData<Self, 6u8>

type Type = Smart<Option<Supplement>>

impl SettableField<7> for FigureElem

const FIELD: SettableFieldData<Self, 7u8>

type Type = Option<Numbering>

impl SettableField<8> for FigureElem

const FIELD: SettableFieldData<Self, 8u8>

type Type = Length

impl SettableField<9> for FigureElem

const FIELD: SettableFieldData<Self, 9u8>

type Type = bool

impl SynthesizedField<10> for FigureElem

const FIELD: SynthesizedFieldData<Self, 10u8>

type Type = Option<Counter>

impl SynthesizedField<11> for FigureElem

const FIELD: SynthesizedFieldData<Self, 11u8>

type Type = Locale