Enum atk::TextBoundary

#[non_exhaustive]
pub enum TextBoundary {
    Char,
    WordStart,
    WordEnd,
    SentenceStart,
    SentenceEnd,
    LineStart,
    LineEnd,
    // some variants omitted
}

Text boundary types used for specifying boundaries for regions of text. This enumeration is deprecated since 2.9.4 and should not be used. Use AtkTextGranularity with atk_text_get_string_at_offset instead.

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.

Char

Boundary is the boundary between characters (including non-printing characters)

WordStart

Boundary is the start (i.e. first character) of a word.

WordEnd

Boundary is the end (i.e. last character) of a word.

SentenceStart

Boundary is the first character in a sentence.

SentenceEnd

Boundary is the last (terminal) character in a sentence; in languages which use “sentence stop” punctuation such as English, the boundary is thus the ‘.’, ‘?’, or similar terminal punctuation character.

LineStart

Boundary is the initial character of the content or a character immediately following a newline, linefeed, or return character.

LineEnd

Boundary is the linefeed, or return character.

Trait Implementations

impl Clone for TextBoundary

fn clone(&self) -> TextBoundary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextBoundary

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

Formats the value using the given formatter.

impl Display for TextBoundary

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

Formats the value using the given formatter.

impl<'a> FromValue<'a> for TextBoundary

type Checker = GenericValueTypeChecker<TextBoundary>

Value type checker.

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

Get the contained value from a Value.

impl Hash for TextBoundary

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,

Feeds a slice of this type into the given Hasher.

impl Ord for TextBoundary

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<TextBoundary> for TextBoundary

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<TextBoundary> for TextBoundary

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for TextBoundary

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for TextBoundary

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.

impl ValueType for TextBoundary

type Type = TextBoundary

Type to get the Type from.

impl Copy for TextBoundary

impl Eq for TextBoundary

impl StructuralEq for TextBoundary

impl StructuralPartialEq for TextBoundary