Struct gtk4::InputHints

pub struct InputHints { /* private fields */ }

Describes hints that might be taken into account by input methods or applications.

Note that input methods may already tailor their behaviour according to the InputPurpose of the entry.

Some common sense is expected when using these flags - mixing LOWERCASE with any of the uppercase hints makes no sense.

This enumeration may be extended in the future; input methods should ignore unknown values.

Implementations

impl InputHints

pub const NONE: Self = _

No special behaviour suggested

pub const SPELLCHECK: Self = _

Suggest checking for typos

pub const NO_SPELLCHECK: Self = _

Suggest not checking for typos

pub const WORD_COMPLETION: Self = _

Suggest word completion

pub const LOWERCASE: Self = _

Suggest to convert all text to lowercase

pub const UPPERCASE_CHARS: Self = _

Suggest to capitalize all text

pub const UPPERCASE_WORDS: Self = _

Suggest to capitalize the first character of each word

pub const UPPERCASE_SENTENCES: Self = _

Suggest to capitalize the first word of each sentence

pub const INHIBIT_OSK: Self = _

Suggest to not show an onscreen keyboard (e.g for a calculator that already has all the keys).

pub const VERTICAL_WRITING: Self = _

The text is vertical

pub const EMOJI: Self = _

Suggest offering Emoji support

pub const NO_EMOJI: Self = _

Suggest not offering Emoji support

pub const PRIVATE: Self = _

Request that the input method should not update personalized data (like typing history)

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u32) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> Self

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Self) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: Self) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

pub const fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

pub const fn union(self, other: Self) -> Self

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

pub const fn difference(self, other: Self) -> Self

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations

impl Binary for InputHints

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

Formats the value using the given formatter.

impl BitAnd<InputHints> for InputHints

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

Returns the intersection between the two sets of flags.

type Output = InputHints

The resulting type after applying the & operator.

impl BitAndAssign<InputHints> for InputHints

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<InputHints> for InputHints

fn bitor(self, other: InputHints) -> Self

Returns the union of the two sets of flags.

type Output = InputHints

The resulting type after applying the | operator.

impl BitOrAssign<InputHints> for InputHints

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<InputHints> for InputHints

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

Returns the left flags, but with all the right flags toggled.

type Output = InputHints

The resulting type after applying the ^ operator.

impl BitXorAssign<InputHints> for InputHints

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for InputHints

fn clone(&self) -> InputHints

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputHints

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

Formats the value using the given formatter.

impl Display for InputHints

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

Formats the value using the given formatter.

impl Extend<InputHints> for InputHints

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<InputHints> for InputHints

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator.

impl<'a> FromValue<'a> for InputHints

type Checker = GenericValueTypeChecker<InputHints>

Value type checker.

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

Get the contained value from a Value.

impl Hash for InputHints

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 LowerHex for InputHints

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

Formats the value using the given formatter.

impl Not for InputHints

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = InputHints

The resulting type after applying the ! operator.

impl Octal for InputHints

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

Formats the value using the given formatter.

impl Ord for InputHints

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<InputHints> for InputHints

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

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

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<InputHints> for InputHints

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

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

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

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

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

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

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

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

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 InputHints

fn static_type() -> Type

Returns the type identifier of Self.

impl Sub<InputHints> for InputHints

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

Returns the set difference of the two sets of flags.

type Output = InputHints

The resulting type after applying the - operator.

impl SubAssign<InputHints> for InputHints

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl ToValue for InputHints

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.

impl UpperHex for InputHints

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

Formats the value using the given formatter.

impl ValueType for InputHints

type Type = InputHints

Type to get the Type from.

impl Copy for InputHints

impl Eq for InputHints

impl StructuralEq for InputHints

impl StructuralPartialEq for InputHints