Enum wayland_protocols::unstable::input_method::v1::server::zwp_input_method_context_v1::Request

pub enum Request {
    Destroy,
    CommitString {
        serial: u32,
        text: String,
    },
    PreeditString {
        serial: u32,
        text: String,
        commit: String,
    },
    PreeditStyling {
        index: u32,
        length: u32,
        style: u32,
    },
    PreeditCursor {
        index: i32,
    },
    DeleteSurroundingText {
        index: i32,
        length: u32,
    },
    CursorPosition {
        index: i32,
        anchor: i32,
    },
    ModifiersMap {
        map: Vec<u8>,
    },
    Keysym {
        serial: u32,
        time: u32,
        sym: u32,
        state: u32,
        modifiers: u32,
    },
    GrabKeyboard {
        keyboard: NewResource<WlKeyboard>,
    },
    Key {
        serial: u32,
        time: u32,
        key: u32,
        state: u32,
    },
    Modifiers {
        serial: u32,
        mods_depressed: u32,
        mods_latched: u32,
        mods_locked: u32,
        group: u32,
    },
    Language {
        serial: u32,
        language: String,
    },
    TextDirection {
        serial: u32,
        direction: u32,
    },
}

Variants

Destroy

This is a destructor, once received this object cannot be used any longer.

CommitString

Fields

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.

PreeditString

Fields

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.

PreeditStyling

Fields

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.

PreeditCursor

Fields

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.

DeleteSurroundingText

Fields

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.

CursorPosition

Fields

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.

ModifiersMap

Fields

map: Vec<u8>

Keysym

Fields

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.

GrabKeyboard

Fields

keyboard: NewResource<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.

Key

Fields

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.

Modifiers

Fields

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.

Language

Fields

serial: u32

language: String

TextDirection

Fields

serial: u32

direction: u32

Trait Implementations

impl MessageGroup for Request

const MESSAGES: &'static [MessageDesc] = _

Wire representation of this MessageGroup

type Map = ResourceMap

The wrapper type for ObjectMap allowing the mapping of Object and NewId arguments to the object map during parsing.

fn is_destructor(&self) -> bool

Whether this message is a destructor

fn opcode(&self) -> u16

The opcode of this message

fn child<Meta: ObjectMetadata>(
    opcode: u16,
    version: u32,
    meta: &Meta
) -> Option<Object<Meta>>

Retrieve the child Object associated with this message if any

fn from_raw(msg: Message, map: &mut Self::Map) -> Result<Self, ()>

Construct a message from its raw representation

fn into_raw(self, sender_id: u32) -> Message

Turn this message into its raw representation

unsafe fn from_raw_c(
    obj: *mut c_void,
    opcode: u32,
    args: *const wl_argument
) -> Result<Request, ()>

Construct a message of this group from its C representation

fn as_raw_c_in<F, T>(self, f: F) -> Twhere
    F: FnOnce(u32, &mut [wl_argument]) -> T,

Build a C representation of this message