Struct gtk::InputHints

pub struct InputHints { /* fields omitted */ }

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

No special behaviour suggested

pub const SPELLCHECK: InputHints

Suggest checking for typos

pub const NO_SPELLCHECK: InputHints

Suggest not checking for typos

pub const WORD_COMPLETION: InputHints

Suggest word completion

pub const LOWERCASE: InputHints

Suggest to convert all text to lowercase

pub const UPPERCASE_CHARS: InputHints

Suggest to capitalize all text

pub const UPPERCASE_WORDS: InputHints

Suggest to capitalize the first character of each word

pub const UPPERCASE_SENTENCES: InputHints

Suggest to capitalize the first word of each sentence

pub const INHIBIT_OSK: InputHints

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

pub const VERTICAL_WRITING: InputHints

The text is vertical. Since 3.18

pub const EMOJI: InputHints

Suggest offering Emoji support. Since 3.22.20

pub const NO_EMOJI: InputHints

Suggest not offering Emoji support. Since 3.22.20

pub const fn empty() -> InputHints

Returns an empty set of flags

pub const fn all() -> InputHints

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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

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

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

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

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: InputHints) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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

type Output = InputHints

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<InputHints> for InputHints

fn bitand_assign(&mut self, other: InputHints)

Disables all flags disabled in the set.

impl BitOr<InputHints> for InputHints

type Output = InputHints

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<InputHints> for InputHints

fn bitor_assign(&mut self, other: InputHints)

Adds the set of flags.

impl BitXor<InputHints> for InputHints

type Output = InputHints

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<InputHints> for InputHints

fn bitxor_assign(&mut self, other: InputHints)

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

impl Debug for InputHints

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

Formats the value using the given formatter.

impl Eq for InputHints

impl Extend<InputHints> for InputHints

fn extend<T: IntoIterator<Item = InputHints>>(&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 = InputHints>>(iterator: T) -> InputHints

Creates a value from an iterator.

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

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

Safety

impl<'a> FromValueOptional<'a> for InputHints

unsafe fn from_value_optional(value: &Value) -> Option<Self>

Safety

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, 

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

type Output = InputHints

The resulting type after applying the ! operator.

fn not(self) -> InputHints

Returns the complement of this set of flags.

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.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

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: &InputHints) -> bool

This method tests for !=.

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: &InputHints) -> bool

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

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

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

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

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

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

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

impl SetValue for InputHints

unsafe fn set_value(value: &mut Value, this: &Self)

Safety

impl StaticType for InputHints

fn static_type() -> Type

Returns the type identifier of Self.

impl StructuralEq for InputHints

impl StructuralPartialEq for InputHints

impl Sub<InputHints> for InputHints

type Output = InputHints

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<InputHints> for InputHints

fn sub_assign(&mut self, other: InputHints)

Disables all flags enabled in the set.

impl UpperHex for InputHints

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

Formats the value using the given formatter.