Struct wayland_protocols::unstable::input_method::v1::client::zwp_input_method_context_v1::ZwpInputMethodContextV1

pub struct ZwpInputMethodContextV1(_);

Implementations

impl ZwpInputMethodContextV1

pub fn destroy(&self)

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

pub fn commit_string(&self, serial: u32, text: String)

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.

pub fn preedit_string(&self, serial: u32, text: String, commit: String)

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.

pub fn preedit_styling(&self, 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.

pub fn preedit_cursor(&self, 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.

pub fn delete_surrounding_text(&self, 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.

pub fn cursor_position(&self, 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.

pub fn modifiers_map(&self, map: Vec<u8>)

pub fn keysym(
    &self,
    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.

pub fn grab_keyboard<F>(&self, implementor: F) -> Result<WlKeyboard, ()> where
    F: FnOnce(NewProxy<WlKeyboard>) -> 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.

pub fn key(&self, 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.

pub fn modifiers(
    &self,
    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.

pub fn language(&self, serial: u32, language: String)

pub fn text_direction(&self, serial: u32, direction: u32)

Trait Implementations

impl AsRef<Proxy<ZwpInputMethodContextV1>> for ZwpInputMethodContextV1

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

Performs the conversion.

impl Clone for ZwpInputMethodContextV1

fn clone(&self) -> ZwpInputMethodContextV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for ZwpInputMethodContextV1

impl From<Proxy<ZwpInputMethodContextV1>> for ZwpInputMethodContextV1

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

Performs the conversion.

impl From<ZwpInputMethodContextV1> for Proxy<ZwpInputMethodContextV1>

fn from(value: ZwpInputMethodContextV1) -> Self

Performs the conversion.

impl<T: EventHandler> HandledBy<T> for ZwpInputMethodContextV1

fn handle(__handler: &mut T, event: Event, __object: Self)

Handles an event.

impl Interface for ZwpInputMethodContextV1

type Request = Request

Set of requests associated to this interface

type Event = Event

Set of events associated to this interface

const NAME: &'static str

Name of this interface

const VERSION: u32

Maximum supported version of this interface

fn c_interface() -> *const wl_interface

Pointer to the C representation of this interface

impl PartialEq<ZwpInputMethodContextV1> for ZwpInputMethodContextV1

fn eq(&self, other: &ZwpInputMethodContextV1) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ZwpInputMethodContextV1) -> bool

This method tests for !=.

impl StructuralEq for ZwpInputMethodContextV1

impl StructuralPartialEq for ZwpInputMethodContextV1