Struct HighlightElem

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

Highlights text with a background color.

Example

This is #highlight[important].

Fields

body: Content

Implementations

impl HighlightElem

pub fn new(body: Content) -> Self

Create a new instance of the element.

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

Builder-style setter for the fill field.

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

Builder-style setter for the stroke field.

pub fn with_top_edge(self, top_edge: TopEdge) -> Self

Builder-style setter for the top-edge field.

pub fn with_bottom_edge(self, bottom_edge: BottomEdge) -> Self

Builder-style setter for the bottom-edge field.

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

Builder-style setter for the extent field.

pub fn with_radius(self, radius: Corners<Option<Rel<Length>>>) -> Self

Builder-style setter for the radius field.

pub fn with_body(self, body: Content) -> Self

Builder-style setter for the body field.

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

Setter for the fill field.

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

Setter for the stroke field.

pub fn push_top_edge(&mut self, top_edge: TopEdge)

Setter for the top-edge field.

pub fn push_bottom_edge(&mut self, bottom_edge: BottomEdge)

Setter for the bottom-edge field.

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

Setter for the extent field.

pub fn push_radius(&mut self, radius: Corners<Option<Rel<Length>>>)

Setter for the radius field.

pub fn push_body(&mut self, body: Content)

Setter for the body field.

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

The color to highlight the text with.

This is #highlight(
  fill: blue
)[highlighted with blue].

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

The highlight’s border color. See the rectangle’s documentation for more details.

This is a #highlight(
  stroke: fuchsia
)[stroked highlighting].

pub fn top_edge(&self, styles: StyleChain<'_>) -> TopEdge

The top end of the background rectangle.

#set highlight(top-edge: "ascender")
#highlight[a] #highlight[aib]

#set highlight(top-edge: "x-height")
#highlight[a] #highlight[aib]

pub fn bottom_edge(&self, styles: StyleChain<'_>) -> BottomEdge

The bottom end of the background rectangle.

#set highlight(bottom-edge: "descender")
#highlight[a] #highlight[ap]

#set highlight(bottom-edge: "baseline")
#highlight[a] #highlight[ap]

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

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

A long #highlight(extent: 4pt)[background].

pub fn radius( &self, styles: StyleChain<'_>, ) -> <Corners<Option<Rel<Length>>> as Resolve>::Output

How much to round the highlight’s corners. See the rectangle’s documentation for more details.

Listen #highlight(
  radius: 5pt, extent: 2pt
)[carefully], it will be on the test.

pub fn body(&self) -> &Content

The content that should be highlighted.

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

Access the fill field in the given style chain.

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

Access the stroke 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 extent_in(styles: StyleChain<'_>) -> <Length as Resolve>::Output

Access the extent field in the given style chain.

pub fn radius_in( styles: StyleChain<'_>, ) -> <Corners<Option<Rel<Length>>> as Resolve>::Output

Access the radius field in the given style chain.

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

Create a style property for the fill field.

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

Create a style property for the stroke 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_extent(extent: Length) -> Property

Create a style property for the extent field.

pub fn set_radius(radius: Corners<Option<Rel<Length>>>) -> Property

Create a style property for the radius field.

Trait Implementations

impl Capable for HighlightElem

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

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

impl Clone for HighlightElem

fn clone(&self) -> HighlightElem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for HighlightElem

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

Construct an element from the arguments.

impl Debug for HighlightElem

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

Formats the value using the given formatter.

impl Fields for HighlightElem

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 HighlightElem

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 HighlightElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for HighlightElem

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 HighlightElem

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

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

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 HighlightElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for HighlightElem

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

Parse relevant arguments into style properties for this element.