Struct ZwpInputMethodContextV1 

pub struct ZwpInputMethodContextV1 { /* private fields */ }

Available on crate feature input-method-unstable-v1 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 Event for the list of possible events.

Implementations

impl ZwpInputMethodContextV1

pub fn commit_string<D>( self, conn: &mut Connection<D>, serial: u32, text: CString, )

commit string

Send the commit string text for insertion to the application.

The text to commit could be either just a single character after a key press or the result of some composing (pre-edit). It could be also an empty text when some text should be removed (see delete_surrounding_text) or when the input cursor should be moved (see cursor_position).

Any previously set composing text will be removed.

Since version 1.

pub fn preedit_string<D>( self, conn: &mut Connection<D>, serial: u32, text: CString, commit: CString, )

pre-edit string

Send the pre-edit string text to the application text input.

The commit text can be used to replace the pre-edit text on reset (for example on unfocus).

Previously sent preedit_style and preedit_cursor requests are also processed by the text_input.

Since version 1.

pub fn preedit_styling<D>( self, conn: &mut Connection<D>, index: u32, length: u32, style: u32, )

pre-edit styling

Set the styling information on composing text. The style is applied for length in bytes from index relative to the beginning of the composing text (as byte offset). Multiple styles can be applied to a composing text.

This request should be sent before sending a preedit_string request.

Since version 1.

pub fn preedit_cursor<D>(self, conn: &mut Connection<D>, index: i32)

pre-edit cursor

Set the cursor position inside the composing text (as byte offset) relative to the start of the composing text.

When index is negative no cursor should be displayed.

This request should be sent before sending a preedit_string request.

Since version 1.

pub fn delete_surrounding_text<D>( self, conn: &mut Connection<D>, index: i32, length: u32, )

delete text

Remove the surrounding text.

This request will be handled on the text_input side directly following a commit_string request.

Since version 1.

pub fn cursor_position<D>( self, conn: &mut Connection<D>, index: i32, anchor: i32, )

set cursor to a new position

Set the cursor and anchor to a new position. Index is the new cursor position in bytes (when >= 0 this is relative to the end of the inserted text, otherwise it is relative to the beginning of the inserted text). Anchor is the new anchor position in bytes (when >= 0 this is relative to the end of the inserted text, otherwise it is relative to the beginning of the inserted text). When there should be no selected text, anchor should be the same as index.

This request will be handled on the text_input side directly following a commit_string request.

Since version 1.

pub fn modifiers_map<D>(self, conn: &mut Connection<D>, map: Vec<u8>)

Since version 1.

pub fn keysym<D>( self, conn: &mut Connection<D>, serial: u32, time: u32, sym: u32, state: u32, modifiers: u32, )

keysym

Notify when a key event was sent. Key events should not be used for normal text input operations, which should be done with commit_string, delete_surrounding_text, etc. The key event follows the wl_keyboard key event convention. Sym is an XKB keysym, state is a wl_keyboard key_state.

Since version 1.

pub fn grab_keyboard<D>(self, conn: &mut Connection<D>) -> WlKeyboard

grab hardware keyboard

Allow an input method to receive hardware keyboard input and process key events to generate text events (with pre-edit) over the wire. This allows input methods which compose multiple key events for inputting text like it is done for CJK languages.

Since version 1.

pub fn grab_keyboard_with_cb<D>( self, conn: &mut Connection<D>, cb: impl FnMut(EventCtx<'_, D, WlKeyboard>) + Send + 'static, ) -> WlKeyboard

grab hardware keyboard

Allow an input method to receive hardware keyboard input and process key events to generate text events (with pre-edit) over the wire. This allows input methods which compose multiple key events for inputting text like it is done for CJK languages.

Since version 1.

pub fn key<D>( self, conn: &mut Connection<D>, serial: u32, time: u32, key: u32, state: u32, )

forward key event

Forward a wl_keyboard::key event to the client that was not processed by the input method itself. Should be used when filtering key events with grab_keyboard. The arguments should be the ones from the wl_keyboard::key event.

For generating custom key events use the keysym request instead.

Since version 1.

pub fn modifiers<D>( self, conn: &mut Connection<D>, serial: u32, mods_depressed: u32, mods_latched: u32, mods_locked: u32, group: u32, )

forward modifiers event

Forward a wl_keyboard::modifiers event to the client that was not processed by the input method itself. Should be used when filtering key events with grab_keyboard. The arguments should be the ones from the wl_keyboard::modifiers event.

Since version 1.

pub fn language<D>( self, conn: &mut Connection<D>, serial: u32, language: CString, )

Since version 1.

pub fn text_direction<D>( self, conn: &mut Connection<D>, serial: u32, direction: u32, )

Since version 1.

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

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

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<ObjectId> for ZwpInputMethodContextV1

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

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

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

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Proxy for ZwpInputMethodContextV1

const INTERFACE: &'static Interface

type Event = Event

fn id(&self) -> ObjectId

fn version(&self) -> u32

impl TryFrom<Object> for ZwpInputMethodContextV1

type Error = WrongObject

The type returned in the event of a conversion error.

fn try_from(object: Object) -> Result<Self, WrongObject>

Performs the conversion.

impl Copy for ZwpInputMethodContextV1

impl Eq for ZwpInputMethodContextV1