Struct gtk4::InputHints
source · pub struct InputHints { /* private fields */ }
Expand description
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§
source§impl InputHints
impl InputHints
sourcepub const SPELLCHECK: Self = _
pub const SPELLCHECK: Self = _
Suggest checking for typos
sourcepub const NO_SPELLCHECK: Self = _
pub const NO_SPELLCHECK: Self = _
Suggest not checking for typos
sourcepub const WORD_COMPLETION: Self = _
pub const WORD_COMPLETION: Self = _
Suggest word completion
sourcepub const UPPERCASE_CHARS: Self = _
pub const UPPERCASE_CHARS: Self = _
Suggest to capitalize all text
sourcepub const UPPERCASE_WORDS: Self = _
pub const UPPERCASE_WORDS: Self = _
Suggest to capitalize the first character of each word
sourcepub const UPPERCASE_SENTENCES: Self = _
pub const UPPERCASE_SENTENCES: Self = _
Suggest to capitalize the first word of each sentence
sourcepub const INHIBIT_OSK: Self = _
pub const INHIBIT_OSK: Self = _
Suggest to not show an onscreen keyboard (e.g for a calculator that already has all the keys).
sourcepub const VERTICAL_WRITING: Self = _
pub const VERTICAL_WRITING: Self = _
The text is vertical
sourcepub const PRIVATE: Self = _
pub const PRIVATE: Self = _
Request that the input method should not update personalized data (like typing history)
sourcepub const fn from_bits(bits: u32) -> Option<Self>
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.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
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
.
sourcepub const fn union(self, other: Self) -> Self
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
.
sourcepub const fn difference(self, other: Self) -> Self
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
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
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
.
sourcepub const fn complement(self) -> Self
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§
source§impl Binary for InputHints
impl Binary for InputHints
source§impl BitAnd<InputHints> for InputHints
impl BitAnd<InputHints> for InputHints
source§impl BitAndAssign<InputHints> for InputHints
impl BitAndAssign<InputHints> for InputHints
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<InputHints> for InputHints
impl BitOr<InputHints> for InputHints
source§fn bitor(self, other: InputHints) -> Self
fn bitor(self, other: InputHints) -> Self
Returns the union of the two sets of flags.
§type Output = InputHints
type Output = InputHints
|
operator.source§impl BitOrAssign<InputHints> for InputHints
impl BitOrAssign<InputHints> for InputHints
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<InputHints> for InputHints
impl BitXor<InputHints> for InputHints
source§impl BitXorAssign<InputHints> for InputHints
impl BitXorAssign<InputHints> for InputHints
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for InputHints
impl Clone for InputHints
source§fn clone(&self) -> InputHints
fn clone(&self) -> InputHints
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for InputHints
impl Debug for InputHints
source§impl Display for InputHints
impl Display for InputHints
source§impl Extend<InputHints> for InputHints
impl Extend<InputHints> for InputHints
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl From<InputHints> for Value
impl From<InputHints> for Value
source§fn from(v: InputHints) -> Self
fn from(v: InputHints) -> Self
source§impl FromIterator<InputHints> for InputHints
impl FromIterator<InputHints> for InputHints
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl<'a> FromValue<'a> for InputHints
impl<'a> FromValue<'a> for InputHints
§type Checker = GenericValueTypeChecker<InputHints>
type Checker = GenericValueTypeChecker<InputHints>
source§unsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Value
. Read moresource§impl HasParamSpec for InputHints
impl HasParamSpec for InputHints
type ParamSpec = ParamSpecFlags
§type SetValue = InputHints
type SetValue = InputHints
type BuilderFn = fn(_: &str) -> ParamSpecFlagsBuilder<'_, InputHints>
fn param_spec_builder() -> Self::BuilderFn
source§impl Hash for InputHints
impl Hash for InputHints
source§impl LowerHex for InputHints
impl LowerHex for InputHints
source§impl Not for InputHints
impl Not for InputHints
source§impl Octal for InputHints
impl Octal for InputHints
source§impl Ord for InputHints
impl Ord for InputHints
source§fn cmp(&self, other: &InputHints) -> Ordering
fn cmp(&self, other: &InputHints) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<InputHints> for InputHints
impl PartialEq<InputHints> for InputHints
source§fn eq(&self, other: &InputHints) -> bool
fn eq(&self, other: &InputHints) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<InputHints> for InputHints
impl PartialOrd<InputHints> for InputHints
source§fn partial_cmp(&self, other: &InputHints) -> Option<Ordering>
fn partial_cmp(&self, other: &InputHints) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl StaticType for InputHints
impl StaticType for InputHints
source§fn static_type() -> Type
fn static_type() -> Type
Self
.source§impl Sub<InputHints> for InputHints
impl Sub<InputHints> for InputHints
source§impl SubAssign<InputHints> for InputHints
impl SubAssign<InputHints> for InputHints
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl ToValue for InputHints
impl ToValue for InputHints
source§impl UpperHex for InputHints
impl UpperHex for InputHints
source§impl ValueType for InputHints
impl ValueType for InputHints
§type Type = InputHints
type Type = InputHints
Type
from. Read moreimpl Copy for InputHints
impl Eq for InputHints
impl StructuralEq for InputHints
impl StructuralPartialEq for InputHints
Auto Trait Implementations§
impl RefUnwindSafe for InputHints
impl Send for InputHints
impl Sync for InputHints
impl Unpin for InputHints
impl UnwindSafe for InputHints
Blanket Implementations§
source§impl<T> IntoClosureReturnValue for Twhere
T: Into<Value>,
impl<T> IntoClosureReturnValue for Twhere T: Into<Value>,
fn into_closure_return_value(self) -> Option<Value>
source§impl<T> PropertyGet for Twhere
T: HasParamSpec,
impl<T> PropertyGet for Twhere T: HasParamSpec,
source§impl<T> StaticTypeExt for Twhere
T: StaticType,
impl<T> StaticTypeExt for Twhere T: StaticType,
source§fn ensure_type()
fn ensure_type()
source§impl<T> ToSendValue for Twhere
T: Send + ToValue + ?Sized,
impl<T> ToSendValue for Twhere T: Send + ToValue + ?Sized,
source§fn to_send_value(&self) -> SendValue
fn to_send_value(&self) -> SendValue
SendValue
clone of self
.