Struct ImeOptions 

pub struct ImeOptions(/* private fields */);

Flags for [AndroidApp::set_ime_editor_info] as per the android.view.inputmethod.EditorInfo Java API

Implementations

impl ImeOptions

pub const IME_MASK_ACTION: Self

The mask of bits that configure alternative actions for the “enter” key. This helps the IME provide clear feedback for what the key will do and provide alternative mechanisms for taking the same action.

pub const IME_FLAG_FORCE_ASCII: Self

Indicates that ascii input is a priority (such as for entering an account ID)

pub const IME_FLAG_NAVIGATE_NEXT: Self

Indicates that it’s possible to navigate focus forwards to something.

This is similar to using IME_ACTION_NEXT except it allows for multi-line input with an enter key in addition to forward navigation for focus.

This may not be supported by all IMEs (especially on small screens)

pub const IME_FLAG_NAVIGATE_PREVIOUS: Self

Similar to IME_FLAG_NAVIGATE_NEXT, except it indicates that it’s possible to navigate focus backwards to something.

pub const IME_FLAG_NO_ACCESSORY_ACTION: Self

This requests that the IME should not show any accessory actions next to the extracted text UI, when it is in fullscreen mode.

The implication is that you think it’s more important to prioritize having room for previewing more text, instead of showing accessory actions.

Note: In some cases this can make the action unavailable.

pub const IME_FLAG_NO_ENTER_ACTION: Self

If this flag is not set, IMEs will normally replace the “enter” key with the action supplied. This flag indicates that the action should not be available in-line as a replacement for the “enter” key. Typically this is because the action has such a significant impact or is not recoverable enough that accidentally hitting it should be avoided, such as sending a message.

pub const IMG_FLAG_NO_EXTRACT_UI: Self

Don’t show any “extracted-text UI” as part of the on-screen IME.

Some keyboards may show an additional text box above the keyboard for previewing what you type (referred to as the extracted text UI) and it can sometimes be quite large.

The exact semantics of this flag can be unclear sometimes and the UI that becomes visible may not respond to input as you would expect.

This flag may be deprecated in the future and it’s recommend to use IME_FLAG_NO_FULLSCREEN instead, to avoid having the extracted text UI appear to cover the full screen.

pub const IME_FLAG_NO_FULLSCREEN: Self

Request that the IME should avoid ever entering a fullscreen mode and should always leave some room for the application UI.

Note: It’s not guaranteed that an IME will honor this state

pub const IME_FLAG_NO_PERSONALIZED_LEARNING: Self

Request that the IME should not update personalized data, such as typing history.

Note: It’s not guaranteed that an IME will honor this state

pub const IME_NULL: Self

Generic unspecified type for ImeOptions

impl ImeOptions

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

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

Convert from a bits value.

This method will return None if any unknown bits are set.

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

Convert from a bits value, unsetting any unknown bits.

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

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl ImeOptions

pub const fn iter(&self) -> Iter<ImeOptions>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<ImeOptions>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl ImeOptions

pub fn set_action(&mut self, action: TextInputAction)

Specify what action the IME’s “enter” key should perform.

This helps the IME provide clear feedback for what the key will do and provide alternative mechanisms for taking the same action.

pub fn action(&self) -> TextInputAction

Get the current action of the IME’s “enter” key.

Trait Implementations

impl Binary for ImeOptions

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

Formats the value using the given formatter.

impl BitAnd for ImeOptions

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

The bitwise and (&) of the bits in two flags values.

type Output = ImeOptions

The resulting type after applying the & operator.

impl BitAndAssign for ImeOptions

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for ImeOptions

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

The bitwise or (|) of the bits in two flags values.

type Output = ImeOptions

The resulting type after applying the | operator.

impl BitOrAssign for ImeOptions

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for ImeOptions

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = ImeOptions

The resulting type after applying the ^ operator.

impl BitXorAssign for ImeOptions

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for ImeOptions

fn clone(&self) -> ImeOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImeOptions

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

Formats the value using the given formatter.

impl Extend<ImeOptions> for ImeOptions

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

The bitwise or (|) of the bits in each flags value.

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 Flags for ImeOptions

const FLAGS: &'static [Flag<ImeOptions>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> ImeOptions

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<ImeOptions> for ImeOptions

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

The bitwise or (|) of the bits in each flags value.

impl Hash for ImeOptions

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 IntoIterator for ImeOptions

type Item = ImeOptions

The type of the elements being iterated over.

type IntoIter = Iter<ImeOptions>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for ImeOptions

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

Formats the value using the given formatter.

impl Not for ImeOptions

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = ImeOptions

The resulting type after applying the ! operator.

impl Octal for ImeOptions

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

Formats the value using the given formatter.

impl PartialEq for ImeOptions

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

type Primitive = u32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for ImeOptions

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = ImeOptions

The resulting type after applying the - operator.

impl SubAssign for ImeOptions

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for ImeOptions

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

Formats the value using the given formatter.

impl Copy for ImeOptions

impl Eq for ImeOptions

impl StructuralPartialEq for ImeOptions