Struct ZwpInputMethodV2

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

Implementations

impl ZwpInputMethodV2

pub fn commit_string(&self, text: String)

commit string

Send the commit string text for insertion to the application.

Inserts a string at current cursor position (see commit event sequence). The string to commit could be either just a single character after a key press or the result of some composing.

The argument text is a buffer containing the string to insert. There is a maximum length of wayland messages, so text can not be longer than 4000 bytes.

Values set with this event are double-buffered. They must be applied and reset to initial on the next zwp_text_input_v3.commit request.

The initial value of text is an empty string.

pub fn set_preedit_string( &self, text: String, cursor_begin: i32, cursor_end: i32, )

pre-edit string

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

Place a new composing text (pre-edit) at the current cursor position. Any previously set composing text must be removed. Any previously existing selected text must be removed. The cursor is moved to a new position within the preedit string.

The argument text is a buffer containing the preedit string. There is a maximum length of wayland messages, so text can not be longer than 4000 bytes.

The arguments cursor_begin and cursor_end are counted in bytes relative to the beginning of the submitted string buffer. Cursor should be hidden by the text input when both are equal to -1.

cursor_begin indicates the beginning of the cursor. cursor_end indicates the end of the cursor. It may be equal or different than cursor_begin.

Values set with this event are double-buffered. They must be applied on the next zwp_input_method_v2.commit event.

The initial value of text is an empty string. The initial value of cursor_begin, and cursor_end are both 0.

pub fn delete_surrounding_text(&self, before_length: u32, after_length: u32)

delete text

Remove the surrounding text.

before_length and after_length are the number of bytes before and after the current cursor index (excluding the preedit text) to delete.

If any preedit text is present, it is replaced with the cursor for the purpose of this event. In effect before_length is counted from the beginning of preedit text, and after_length from its end (see commit event sequence).

Values set with this event are double-buffered. They must be applied and reset to initial on the next zwp_input_method_v2.commit request.

The initial values of both before_length and after_length are 0.

pub fn commit(&self, serial: u32)

apply state

Apply state changes from commit_string, set_preedit_string and delete_surrounding_text requests.

The state relating to these events is double-buffered, and each one modifies the pending state. This request replaces the current state with the pending state.

The connected text input is expected to proceed by evaluating the changes in the following order:

1. Replace existing preedit string with the cursor.
2. Delete requested surrounding text.
3. Insert commit string with the cursor at its end.
4. Calculate surrounding text to send.
5. Insert new preedit text in cursor position.
6. Place cursor inside preedit text.

The serial number reflects the last state of the zwp_input_method_v2 object known to the client. The value of the serial argument must be equal to the number of done events already issued by that object. When the compositor receives a commit request with a serial different than the number of past done events, it must proceed as normal, except it should not change the current state of the zwp_input_method_v2 object.

pub fn get_input_popup_surface( &self, surface: &WlSurface, ) -> Main<ZwpInputPopupSurfaceV2>

create popup surface

Creates a new zwp_input_popup_surface_v2 object wrapping a given surface.

The surface gets assigned the “input_popup” role. If the surface already has an assigned role, the compositor must issue a protocol error.

pub fn grab_keyboard(&self) -> Main<ZwpInputMethodKeyboardGrabV2>

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.

The compositor should send all keyboard events on the seat to the grab holder via the returned wl_keyboard object. Nevertheless, the compositor may decide not to forward any particular event. The compositor must not further process any event after it has been forwarded to the grab holder.

Releasing the resulting wl_keyboard object releases the grab.

pub fn destroy(&self)

destroy the text input

Destroys the zwp_text_input_v2 object and any associated child objects, i.e. zwp_input_popup_surface_v2 and zwp_input_method_keyboard_grab_v2.

This is a destructor, you cannot send requests to this object any longer once this method is called.

Trait Implementations

impl AsRef<Proxy<ZwpInputMethodV2>> for ZwpInputMethodV2

fn as_ref(&self) -> &Proxy<Self>

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ZwpInputMethodV2

fn clone(&self) -> ZwpInputMethodV2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZwpInputMethodV2

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

Formats the value using the given formatter.

impl From<Proxy<ZwpInputMethodV2>> for ZwpInputMethodV2

fn from(value: Proxy<Self>) -> Self

Converts to this type from the input type.

impl From<ZwpInputMethodV2> for Proxy<ZwpInputMethodV2>

fn from(value: ZwpInputMethodV2) -> Self

Converts to this type from the input type.

impl Interface for ZwpInputMethodV2

const NAME: &'static str = "zwp_input_method_v2"

Name of this interface

const VERSION: u32 = 1u32

Maximum supported version of this interface

type Request = Request

Set of requests associated to this interface

type Event = Event

Set of events associated to this interface

fn c_interface() -> *const wl_interface

Pointer to the C representation of this interface

impl PartialEq for ZwpInputMethodV2

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

impl StructuralPartialEq for ZwpInputMethodV2