Struct TextElem

pub struct TextElem {
    pub text: EcoString,
}

Customizes the look and layout of text in a variety of ways.

This function is used frequently, both with set rules and directly. While the set rule is often the simpler choice, calling the text function directly can be useful when passing text as an argument to another function.

Example

#set text(18pt)
With a set rule.

#emph(text(blue)[
  With a function call.
])

Fields

text: EcoString

Implementations

impl TextElem

pub fn new(text: EcoString) -> Self

Create a new instance of the element.

pub fn font_in(styles: StyleChain<'_>) -> &FontList

Access the font field in the given style chain.

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

Access the fallback field in the given style chain.

pub fn style_in(styles: StyleChain<'_>) -> FontStyle

Access the style field in the given style chain.

pub fn weight_in(styles: StyleChain<'_>) -> FontWeight

Access the weight field in the given style chain.

pub fn stretch_in(styles: StyleChain<'_>) -> FontStretch

Access the stretch field in the given style chain.

pub fn size_in(styles: StyleChain<'_>) -> <TextSize as Resolve>::Output

Access the size field in the given style chain.

pub fn fill_in(styles: StyleChain<'_>) -> Paint

Access the fill field in the given style chain.

pub fn stroke_in(styles: StyleChain<'_>) -> <Option<Stroke> as Resolve>::Output

Access the stroke field in the given style chain.

pub fn tracking_in(styles: StyleChain<'_>) -> <Length as Resolve>::Output

Access the tracking field in the given style chain.

pub fn spacing_in(styles: StyleChain<'_>) -> <Rel<Length> as Resolve>::Output

Access the spacing field in the given style chain.

pub fn cjk_latin_spacing_in(styles: StyleChain<'_>) -> Smart<Option<Never>>

Access the cjk-latin-spacing field in the given style chain.

pub fn baseline_in(styles: StyleChain<'_>) -> <Length as Resolve>::Output

Access the baseline field in the given style chain.

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

Access the overhang field in the given style chain.

pub fn top_edge_in(styles: StyleChain<'_>) -> TopEdge

Access the top-edge field in the given style chain.

pub fn bottom_edge_in(styles: StyleChain<'_>) -> BottomEdge

Access the bottom-edge field in the given style chain.

pub fn lang_in(styles: StyleChain<'_>) -> Lang

Access the lang field in the given style chain.

pub fn region_in(styles: StyleChain<'_>) -> Option<Region>

Access the region field in the given style chain.

pub fn script_in(styles: StyleChain<'_>) -> Smart<WritingScript>

Access the script field in the given style chain.

pub fn dir_in(styles: StyleChain<'_>) -> <TextDir as Resolve>::Output

Access the dir field in the given style chain.

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

Access the hyphenate field in the given style chain.

pub fn costs_in(styles: StyleChain<'_>) -> Costs

Access the costs field in the given style chain.

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

Access the kerning field in the given style chain.

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

Access the alternates field in the given style chain.

pub fn stylistic_set_in(styles: StyleChain<'_>) -> StylisticSets

Access the stylistic-set field in the given style chain.

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

Access the ligatures field in the given style chain.

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

Access the discretionary-ligatures field in the given style chain.

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

Access the historical-ligatures field in the given style chain.

pub fn number_type_in(styles: StyleChain<'_>) -> Smart<NumberType>

Access the number-type field in the given style chain.

pub fn number_width_in(styles: StyleChain<'_>) -> Smart<NumberWidth>

Access the number-width field in the given style chain.

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

Access the slashed-zero field in the given style chain.

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

Access the fractions field in the given style chain.

pub fn features_in(styles: StyleChain<'_>) -> FontFeatures

Access the features field in the given style chain.

pub fn span_offset_in(styles: StyleChain<'_>) -> usize

Access the span-offset field in the given style chain.

pub fn delta_in(styles: StyleChain<'_>) -> WeightDelta

Access the delta field in the given style chain.

pub fn emph_in(styles: StyleChain<'_>) -> ItalicToggle

Access the emph field in the given style chain.

pub fn deco_in(styles: StyleChain<'_>) -> SmallVec<[Decoration; 1]>

Access the deco field in the given style chain.

pub fn case_in(styles: StyleChain<'_>) -> Option<Case>

Access the case field in the given style chain.

pub fn smallcaps_in(styles: StyleChain<'_>) -> Option<Smallcaps>

Access the smallcaps field in the given style chain.

pub fn set_font(font: FontList) -> Property

Create a style property for the font field.

pub fn set_fallback(fallback: bool) -> Property

Create a style property for the fallback field.

pub fn set_style(style: FontStyle) -> Property

Create a style property for the style field.

pub fn set_weight(weight: FontWeight) -> Property

Create a style property for the weight field.

pub fn set_stretch(stretch: FontStretch) -> Property

Create a style property for the stretch field.

pub fn set_size(size: TextSize) -> Property

Create a style property for the size field.

pub fn set_fill(fill: Paint) -> Property

Create a style property for the fill field.

pub fn set_stroke(stroke: Option<Stroke>) -> Property

Create a style property for the stroke field.

pub fn set_tracking(tracking: Length) -> Property

Create a style property for the tracking field.

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

Create a style property for the spacing field.

pub fn set_cjk_latin_spacing( cjk_latin_spacing: Smart<Option<Never>>, ) -> Property

Create a style property for the cjk-latin-spacing field.

pub fn set_baseline(baseline: Length) -> Property

Create a style property for the baseline field.

pub fn set_overhang(overhang: bool) -> Property

Create a style property for the overhang field.

pub fn set_top_edge(top_edge: TopEdge) -> Property

Create a style property for the top-edge field.

pub fn set_bottom_edge(bottom_edge: BottomEdge) -> Property

Create a style property for the bottom-edge field.

pub fn set_lang(lang: Lang) -> Property

Create a style property for the lang field.

pub fn set_region(region: Option<Region>) -> Property

Create a style property for the region field.

pub fn set_script(script: Smart<WritingScript>) -> Property

Create a style property for the script field.

pub fn set_dir(dir: TextDir) -> Property

Create a style property for the dir field.

pub fn set_hyphenate(hyphenate: Smart<bool>) -> Property

Create a style property for the hyphenate field.

pub fn set_costs(costs: Costs) -> Property

Create a style property for the costs field.

pub fn set_kerning(kerning: bool) -> Property

Create a style property for the kerning field.

pub fn set_alternates(alternates: bool) -> Property

Create a style property for the alternates field.

pub fn set_stylistic_set(stylistic_set: StylisticSets) -> Property

Create a style property for the stylistic-set field.

pub fn set_ligatures(ligatures: bool) -> Property

Create a style property for the ligatures field.

pub fn set_discretionary_ligatures(discretionary_ligatures: bool) -> Property

Create a style property for the discretionary-ligatures field.

pub fn set_historical_ligatures(historical_ligatures: bool) -> Property

Create a style property for the historical-ligatures field.

pub fn set_number_type(number_type: Smart<NumberType>) -> Property

Create a style property for the number-type field.

pub fn set_number_width(number_width: Smart<NumberWidth>) -> Property

Create a style property for the number-width field.

pub fn set_slashed_zero(slashed_zero: bool) -> Property

Create a style property for the slashed-zero field.

pub fn set_fractions(fractions: bool) -> Property

Create a style property for the fractions field.

pub fn set_features(features: FontFeatures) -> Property

Create a style property for the features field.

pub fn set_span_offset(span_offset: usize) -> Property

Create a style property for the span-offset field.

pub fn set_delta(delta: WeightDelta) -> Property

Create a style property for the delta field.

pub fn set_emph(emph: ItalicToggle) -> Property

Create a style property for the emph field.

pub fn set_deco(deco: SmallVec<[Decoration; 1]>) -> Property

Create a style property for the deco field.

pub fn set_case(case: Option<Case>) -> Property

Create a style property for the case field.

pub fn set_smallcaps(smallcaps: Option<Smallcaps>) -> Property

Create a style property for the smallcaps field.

impl TextElem

pub fn packed(text: impl Into<EcoString>) -> Content

Create a new packed text element.

Trait Implementations

impl Capable for TextElem

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

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

impl Clone for TextElem

fn clone(&self) -> TextElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for TextElem

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

Construct an element from the arguments.

impl Debug for TextElem

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

Formats the value using the given formatter.

impl Fields for TextElem

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 TextElem

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 TextElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for TextElem

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 TextElem

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 Repr for TextElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for TextElem

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

Parse relevant arguments into style properties for this element.