Enum GravityHint

#[non_exhaustive]
pub enum GravityHint {
    Natural,
    Strong,
    Line,
}

GravityHint defines how horizontal scripts should behave in a vertical context.

That is, English excerpts in a vertical paragraph for example.

See also Gravity

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.

Natural

scripts will take their natural gravity based on the base gravity and the script. This is the default.

Strong

always use the base gravity set, regardless of the script.

Line

for scripts not in their natural direction (eg. Latin in East gravity), choose per-script gravity such that every script respects the line progression. This means, Latin and Arabic will take opposite gravities and both flow top-to-bottom for example.

Trait Implementations

impl Clone for GravityHint

fn clone(&self) -> GravityHint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GravityHint

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

Formats the value using the given formatter.

impl From<GravityHint> for Value

fn from(v: GravityHint) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for GravityHint

type Checker = GenericValueTypeChecker<GravityHint>

Value type checker.

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

Get the contained value from a Value.

impl HasParamSpec for GravityHint

type ParamSpec = ParamSpecEnum

type SetValue = GravityHint

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for GravityHint

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 GravityHint

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

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

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

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for GravityHint

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 GravityHint

type Type = GravityHint

Type to get the Type from.

impl Copy for GravityHint

impl Eq for GravityHint

impl StructuralPartialEq for GravityHint