Enum wayland_protocols::unstable::text_input::v1::server::zwp_text_input_v1::Request

#[non_exhaustive]pub enum Request {
    Activate {
        seat: WlSeat,
        surface: WlSurface,
    },
    Deactivate {
        seat: WlSeat,
    },
    ShowInputPanel,
    HideInputPanel,
    Reset,
    SetSurroundingText {
        text: String,
        cursor: u32,
        anchor: u32,
    },
    SetContentType {
        hint: u32,
        purpose: u32,
    },
    SetCursorRectangle {
        x: i32,
        y: i32,
        width: i32,
        height: i32,
    },
    SetPreferredLanguage {
        language: String,
    },
    CommitState {
        serial: u32,
    },
    InvokeAction {
        button: u32,
        index: u32,
    },
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Activate

request activation

Requests the text_input object to be activated (typically when the text entry gets focus).

The seat argument is a wl_seat which maintains the focus for this activation. The surface argument is a wl_surface assigned to the text_input object and tracked for focus lost. The enter event is emitted on successful activation.

Fields of Activate

seat: WlSeatsurface: WlSurface

Deactivate

request deactivation

Requests the text_input object to be deactivated (typically when the text entry lost focus). The seat argument is a wl_seat which was used for activation.

Fields of Deactivate

seat: WlSeat

ShowInputPanel

show input panels

Requests input panels (virtual keyboard) to show.

HideInputPanel

hide input panels

Requests input panels (virtual keyboard) to hide.

Reset

reset

Should be called by an editor widget when the input state should be reset, for example after the text was changed outside of the normal input method flow.

SetSurroundingText

sets the surrounding text

Sets the plain surrounding text around the input position. Text is UTF-8 encoded. Cursor is the byte offset within the surrounding text. Anchor is the byte offset of the selection anchor within the surrounding text. If there is no selected text anchor, then it is the same as cursor.

Fields of SetSurroundingText

text: Stringcursor: u32anchor: u32

SetContentType

set content purpose and hint

Sets the content purpose and content hint. While the purpose is the basic purpose of an input field, the hint flags allow to modify some of the behavior.

When no content type is explicitly set, a normal content purpose with default hints (auto completion, auto correction, auto capitalization) should be assumed.

Fields of SetContentType

hint: u32purpose: u32

SetCursorRectangle

Fields of SetCursorRectangle

x: i32y: i32width: i32height: i32

SetPreferredLanguage

sets preferred language

Sets a specific language. This allows for example a virtual keyboard to show a language specific layout. The "language" argument is an RFC-3066 format language tag.

It could be used for example in a word processor to indicate the language of the currently edited document or in an instant message application which tracks languages of contacts.

Fields of SetPreferredLanguage

language: String

CommitState

Fields of CommitState

serial: u32

InvokeAction

Fields of InvokeAction

button: u32index: u32

Trait Implementations

impl Debug for Request

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

Formats the value using the given formatter.

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 since(&self) -> u32

The minimal object version for which this message exists

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) -> T where
    F: FnOnce(u32, &mut [wl_argument]) -> T, 

Build a C representation of this message