Enum Underline

#[non_exhaustive]
pub enum Underline {
    None,
    Single,
    Double,
    Low,
    Error,
    SingleLine,
    DoubleLine,
    ErrorLine,
}

The Underline enumeration is used to specify whether text should be underlined, and if so, the type of underlining.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

None

no underline should be drawn

Single

a single underline should be drawn

Double

a double underline should be drawn

Low

a single underline should be drawn at a position beneath the ink extents of the text being underlined. This should be used only for underlining single characters, such as for keyboard accelerators. Single should be used for extended portions of text.

Error

an underline indicating an error should be drawn below. The exact style of rendering is up to the Renderer in use, but typical styles include wavy or dotted lines. This underline is typically used to indicate an error such as a possible mispelling; in some cases a contrasting color may automatically be used. This type of underlining is available since Pango 1.4.

SingleLine

Like @PANGO_UNDERLINE_SINGLE, but drawn continuously across multiple runs. This type of underlining is available since Pango 1.46.

DoubleLine

Like @PANGO_UNDERLINE_DOUBLE, but drawn continuously across multiple runs. This type of underlining is available since Pango 1.46.

ErrorLine

Like @PANGO_UNDERLINE_ERROR, but drawn continuously across multiple runs. This type of underlining is available since Pango 1.46.

Trait Implementations

impl Clone for Underline

fn clone(&self) -> Underline

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Underline

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

Formats the value using the given formatter.

impl From<Underline> for Value

fn from(v: Underline) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for Underline

type Checker = GenericValueTypeChecker<Underline>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl HasParamSpec for Underline

type ParamSpec = ParamSpecEnum

type SetValue = Underline

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str, _: Underline) -> ParamSpecEnumBuilder<'_, Underline>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Underline

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 Ord for Underline

fn cmp(&self, other: &Underline) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Underline

fn eq(&self, other: &Underline) -> 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 PartialOrd for Underline

fn partial_cmp(&self, other: &Underline) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Underline

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for Underline

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifier of self.

impl ValueType for Underline

type Type = Underline

Type to get the Type from.

impl Copy for Underline

impl Eq for Underline

impl StructuralPartialEq for Underline