Struct ZwpInputMethodContextV1

pub struct ZwpInputMethodContextV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

input method context

Corresponds to a text input on the input method side. An input method context is created on text input activation on the input method side. It allows receiving information about the text input from the application via events. Input method contexts do not keep state after deactivation and should be destroyed after deactivation is handled.

Text is generally UTF-8 encoded, indices and lengths are in bytes.

Serials are used to synchronize the state between the text input and an input method. New serials are sent by the text input in the commit_state request and are used by the input method to indicate the known text input state in events like preedit_string, commit_string, and keysym. The text input can then ignore events from the input method which are based on an outdated state (for example after a reset).

Warning! The protocol described in this file is experimental and backward incompatible changes may be made. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes are done by bumping the version number in the protocol and interface names and resetting the interface version. Once the protocol is to be declared stable, the ‘z’ prefix and the version number in the protocol and interface names are removed and the interface version number is reset.

See also the Request enum for this interface.

Implementations

impl ZwpInputMethodContextV1

pub fn surrounding_text(&self, text: String, cursor: u32, anchor: u32)

surrounding text event

The plain surrounding text around the input position. Cursor is the position in bytes within the surrounding text relative to the beginning of the text. Anchor is the position in bytes of the selection anchor within the surrounding text relative to the beginning of the text. If there is no selected text then anchor is the same as cursor.

pub fn reset(&self)

pub fn content_type(&self, hint: u32, purpose: u32)

pub fn invoke_action(&self, button: u32, index: u32)

pub fn commit_state(&self, serial: u32)

pub fn preferred_language(&self, language: String)

Trait Implementations

impl Borrow<ObjectId> for ZwpInputMethodContextV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ZwpInputMethodContextV1

fn clone(&self) -> ZwpInputMethodContextV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZwpInputMethodContextV1

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

Formats the value using the given formatter.

impl Hash for ZwpInputMethodContextV1

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<Weak<ZwpInputMethodContextV1>> for ZwpInputMethodContextV1

fn eq(&self, other: &Weak<ZwpInputMethodContextV1>) -> 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 PartialEq for ZwpInputMethodContextV1

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

type Request = Request

The request enum for this interface

type Event<'event> = Event<'event>

The event enum for this interface

fn interface() -> &'static Interface

The interface description

fn id(&self) -> ObjectId

The ID of this object

fn version(&self) -> u32

The version of this object

fn data<U>(&self) -> Option<&U>

where U: 'static,

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn Any + Sync + Send>>

Access the raw data associated with this object.

fn handle(&self) -> &WeakHandle

Access the backend handle associated with this object

fn from_id( conn: &DisplayHandle, id: ObjectId, ) -> Result<ZwpInputMethodContextV1, InvalidId>

Create an object resource from its ID

fn send_event( &self, evt: <ZwpInputMethodContextV1 as Resource>::Event<'_>, ) -> Result<(), InvalidId>

Send an event to this object

fn parse_request( conn: &DisplayHandle, msg: Message<ObjectId, OwnedFd>, ) -> Result<(ZwpInputMethodContextV1, <ZwpInputMethodContextV1 as Resource>::Request), DispatchError>

Parse a event for this object

fn write_event<'a>( &self, conn: &DisplayHandle, msg: <ZwpInputMethodContextV1 as Resource>::Event<'a>, ) -> Result<Message<ObjectId, BorrowedFd<'a>>, InvalidId>

Serialize an event for this object

fn client(&self) -> Option<Client>

The client owning this object

fn is_alive(&self) -> bool

Checks if the Wayland object associated with this proxy is still alive

fn post_error(&self, code: impl Into<u32>, error: impl Into<String>)

Trigger a protocol error on this object

fn downgrade(&self) -> Weak<Self>

Creates a weak handle to this object

impl Eq for ZwpInputMethodContextV1