Enum AttrType

#[non_exhaustive]
pub enum AttrType {
    Invalid,
    Language,
    Family,
    Style,
    Weight,
    Variant,
    Stretch,
    Size,
    FontDesc,
    Foreground,
    Background,
    Underline,
    Strikethrough,
    Rise,
    Shape,
    Scale,
    Fallback,
    LetterSpacing,
    UnderlineColor,
    StrikethroughColor,
    AbsoluteSize,
    Gravity,
    GravityHint,
    FontFeatures,
    ForegroundAlpha,
    BackgroundAlpha,
    AllowBreaks,
    Show,
    InsertHyphens,
    Overline,
    OverlineColor,
    LineHeight,
    AbsoluteLineHeight,
    TextTransform,
    Word,
    Sentence,
    BaselineShift,
    FontScale,
}

The AttrType distinguishes between different types of attributes.

Along with the predefined values, it is possible to allocate additional values for custom attributes using register(). The predefined values are given below. The type of structure used to store the attribute is listed in parentheses after the description.

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.

Invalid

does not happen

Language

language (AttrLanguage)

Family

font family name list (AttrString)

Style

font slant style (AttrInt)

Weight

font weight (AttrInt)

Variant

font variant (normal or small caps) (AttrInt)

Stretch

font stretch (AttrInt)

Size

font size in points scaled by PANGO_SCALE (AttrInt)

FontDesc

font description (AttrFontDesc)

Foreground

foreground color (AttrColor)

Background

background color (AttrColor)

Underline

whether the text has an underline (AttrInt)

Strikethrough

whether the text is struck-through (AttrInt)

Rise

baseline displacement (AttrInt)

Shape

shape (AttrShape)

Scale

font size scale factor (AttrFloat)

Fallback

whether fallback is enabled (AttrInt)

LetterSpacing

letter spacing (AttrInt)

UnderlineColor

underline color (AttrColor)

StrikethroughColor

strikethrough color (AttrColor)

AbsoluteSize

font size in pixels scaled by PANGO_SCALE (AttrInt)

Gravity

base text gravity (AttrInt)

GravityHint

gravity hint (AttrInt)

FontFeatures

OpenType font features (AttrFontFeatures). Since 1.38

ForegroundAlpha

foreground alpha (AttrInt). Since 1.38

BackgroundAlpha

background alpha (AttrInt). Since 1.38

AllowBreaks

whether breaks are allowed (AttrInt). Since 1.44

Show

how to render invisible characters (AttrInt). Since 1.44

InsertHyphens

whether to insert hyphens at intra-word line breaks (AttrInt). Since 1.44

Overline

whether the text has an overline (AttrInt). Since 1.46

OverlineColor

overline color (AttrColor). Since 1.46

LineHeight

Available on crate feature v1_50 only.

line height factor (AttrFloat). Since: 1.50

AbsoluteLineHeight

Available on crate feature v1_50 only.

line height (AttrInt). Since: 1.50

TextTransform

Available on crate feature v1_50 only.

Word

Available on crate feature v1_50 only.

override segmentation to classify the range of the attribute as a single word (AttrInt). Since 1.50

Sentence

Available on crate feature v1_50 only.

override segmentation to classify the range of the attribute as a single sentence (AttrInt). Since 1.50

BaselineShift

Available on crate feature v1_50 only.

baseline displacement (AttrInt). Since 1.50

FontScale

Available on crate feature v1_50 only.

font-relative size change (AttrInt). Since 1.50

Implementations

impl AttrType

pub fn name(self) -> Option<GString>

Trait Implementations

impl Clone for AttrType

fn clone(&self) -> AttrType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AttrType

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

Formats the value using the given formatter.

impl From<AttrType> for Value

fn from(v: AttrType) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for AttrType

type Checker = GenericValueTypeChecker<AttrType>

Value type checker.

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

Get the contained value from a Value.

impl HasParamSpec for AttrType

type ParamSpec = ParamSpecEnum

type SetValue = AttrType

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for AttrType

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 AttrType

fn cmp(&self, other: &AttrType) -> 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 AttrType

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

fn partial_cmp(&self, other: &AttrType) -> 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 AttrType

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for AttrType

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 AttrType

type Type = AttrType

Type to get the Type from.

impl Copy for AttrType

impl Eq for AttrType

impl StructuralPartialEq for AttrType