Struct SmartQuoteElem

pub struct SmartQuoteElem { /* private fields */ }

A language-aware quote that reacts to its context.

Automatically turns into an appropriate opening or closing quote based on the active text language.

Example

"This is in quotes."

#set text(lang: "de")
"Das ist in Anführungszeichen."

#set text(lang: "fr")
"C'est entre guillemets."

Syntax

This function also has dedicated syntax: The normal quote characters (' and "). Typst automatically makes your quotes smart.

Implementations

impl SmartQuoteElem

pub fn new() -> Self

Create a new instance of the element.

pub fn with_double(self, double: bool) -> Self

Builder-style setter for the double field.

pub fn with_enabled(self, enabled: bool) -> Self

Builder-style setter for the enabled field.

pub fn with_alternative(self, alternative: bool) -> Self

Builder-style setter for the alternative field.

pub fn with_quotes(self, quotes: Smart<SmartQuoteDict>) -> Self

Builder-style setter for the quotes field.

pub fn push_double(&mut self, double: bool)

Setter for the double field.

pub fn push_enabled(&mut self, enabled: bool)

Setter for the enabled field.

pub fn push_alternative(&mut self, alternative: bool)

Setter for the alternative field.

pub fn push_quotes(&mut self, quotes: Smart<SmartQuoteDict>)

Setter for the quotes field.

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

Whether this should be a double quote.

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

Whether smart quotes are enabled.

To disable smartness for a single quote, you can also escape it with a backslash.

#set smartquote(enabled: false)

These are "dumb" quotes.

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

Whether to use alternative quotes.

Does nothing for languages that don’t have alternative quotes, or if explicit quotes were set.

#set text(lang: "de")
#set smartquote(alternative: true)

"Das ist in anderen Anführungszeichen."

pub fn quotes<'a>(&'a self, styles: StyleChain<'a>) -> &'a Smart<SmartQuoteDict>

The quotes to use.

• When set to {auto}, the appropriate single quotes for the text language will be used. This is the default.
• Custom quotes can be passed as a string, array, or dictionary of either
  • string: a string consisting of two characters containing the opening and closing double quotes (characters here refer to Unicode grapheme clusters)
  • [array]: an array containing the opening and closing double quotes
  • [dictionary]: an array containing the double and single quotes, each specified as either {auto}, string, or array

#set text(lang: "de")
'Das sind normale Anführungszeichen.'

#set smartquote(quotes: "()")
"Das sind eigene Anführungszeichen."

#set smartquote(quotes: (single: ("[[", "]]"),  double: auto))
'Das sind eigene Anführungszeichen.'

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

Access the double field in the given style chain.

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

Access the enabled field in the given style chain.

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

Access the alternative field in the given style chain.

pub fn quotes_in(styles: StyleChain<'_>) -> &Smart<SmartQuoteDict>

Access the quotes field in the given style chain.

pub fn set_double(double: bool) -> Property

Create a style property for the double field.

pub fn set_enabled(enabled: bool) -> Property

Create a style property for the enabled field.

pub fn set_alternative(alternative: bool) -> Property

Create a style property for the alternative field.

pub fn set_quotes(quotes: Smart<SmartQuoteDict>) -> Property

Create a style property for the quotes field.

Trait Implementations

impl Capable for SmartQuoteElem

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

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

impl Clone for SmartQuoteElem

fn clone(&self) -> SmartQuoteElem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for SmartQuoteElem

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

Construct an element from the arguments.

impl Debug for SmartQuoteElem

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

Formats the value using the given formatter.

impl Fields for SmartQuoteElem

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 SmartQuoteElem

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 SmartQuoteElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for SmartQuoteElem

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 SmartQuoteElem

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 SmartQuoteElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for SmartQuoteElem

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

Parse relevant arguments into style properties for this element.