Struct UnderlineElem

pub struct UnderlineElem {
    pub body: Content,
    /* private fields */
}

Underlines text.

Example

This is #underline[important].

Fields

body: Content

Implementations

impl UnderlineElem

pub fn new(body: Content) -> Self

Create a new instance of the element.

pub fn with_stroke(self, stroke: Smart<Stroke>) -> Self

Builder-style setter for the stroke field.

pub fn with_offset(self, offset: Smart<Length>) -> Self

Builder-style setter for the offset field.

pub fn with_extent(self, extent: Length) -> Self

Builder-style setter for the extent field.

pub fn with_evade(self, evade: bool) -> Self

Builder-style setter for the evade field.

pub fn with_background(self, background: bool) -> Self

Builder-style setter for the background field.

pub fn push_stroke(&mut self, stroke: Smart<Stroke>)

Setter for the stroke field.

pub fn push_offset(&mut self, offset: Smart<Length>)

Setter for the offset field.

pub fn push_extent(&mut self, extent: Length)

Setter for the extent field.

pub fn push_evade(&mut self, evade: bool)

Setter for the evade field.

pub fn push_background(&mut self, background: bool)

Setter for the background field.

pub fn stroke( &self, styles: StyleChain<'_>, ) -> <Smart<Stroke> as Resolve>::Output

How to [stroke] the line.

If set to {auto}, takes on the text’s color and a thickness defined in the current font.

Take #underline(
  stroke: 1.5pt + red,
  offset: 2pt,
  [care],
)

pub fn offset( &self, styles: StyleChain<'_>, ) -> <Smart<Length> as Resolve>::Output

The position of the line relative to the baseline, read from the font tables if {auto}.

#underline(offset: 5pt)[
  The Tale Of A Faraway Line I
]

pub fn extent(&self, styles: StyleChain<'_>) -> <Length as Resolve>::Output

The amount by which to extend the line beyond (or within if negative) the content.

#align(center,
  underline(extent: 2pt)[Chapter 1]
)

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

Whether the line skips sections in which it would collide with the glyphs.

This #underline(evade: true)[is great].
This #underline(evade: false)[is less great].

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

Whether the line is placed behind the content it underlines.

#set underline(stroke: (thickness: 1em, paint: maroon, cap: "round"))
#underline(background: true)[This is stylized.] \
#underline(background: false)[This is partially hidden.]

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

Access the stroke field in the given style chain.

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

Access the offset field in the given style chain.

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

Access the extent field in the given style chain.

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

Access the evade field in the given style chain.

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

Access the background field in the given style chain.

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

Create a style property for the stroke field.

pub fn set_offset(offset: Smart<Length>) -> Property

Create a style property for the offset field.

pub fn set_extent(extent: Length) -> Property

Create a style property for the extent field.

pub fn set_evade(evade: bool) -> Property

Create a style property for the evade field.

pub fn set_background(background: bool) -> Property

Create a style property for the background field.

Trait Implementations

impl Capable for UnderlineElem

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

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

impl Clone for UnderlineElem

fn clone(&self) -> UnderlineElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for UnderlineElem

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

Construct an element from the arguments.

impl Debug for UnderlineElem

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

Formats the value using the given formatter.

impl Fields for UnderlineElem

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 UnderlineElem

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 UnderlineElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for UnderlineElem

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 UnderlineElem

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 UnderlineElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for UnderlineElem

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

Parse relevant arguments into style properties for this element.