Enum ImePurpose

#[non_exhaustive]
pub enum ImePurpose {
    Normal,
    Password,
    Terminal,
}

Generic IME purposes for use in Window::set_ime_purpose.

The purpose may improve UX by optimizing the IME for the specific use case, if winit can express the purpose to the platform and the platform reacts accordingly.

Platform-specific

• iOS / Android / Web / Windows / X11 / macOS / Orbital: Unsupported.

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.

Normal

No special hints for the IME (default).

Password

The IME is used for password input.

Terminal

The IME is used to input into a terminal.

For example, that could alter OSK on Wayland to show extra buttons.

Trait Implementations

impl Clone for ImePurpose

fn clone(&self) -> ImePurpose

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImePurpose

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

Formats the value using the given formatter.

impl Default for ImePurpose

fn default() -> ImePurpose

Returns the “default value” for a type.

impl Hash for ImePurpose

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 PartialEq for ImePurpose

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

impl Eq for ImePurpose

impl StructuralPartialEq for ImePurpose