Struct wayland_protocols::unstable::text_input::v3::server::zwp_text_input_v3::ZwpTextInputV3

pub struct ZwpTextInputV3(_);

Implementations

impl ZwpTextInputV3

pub fn enter(&self, surface: &WlSurface)

enter event

Notification that this seat's text-input focus is on a certain surface.

When the seat has the keyboard capability the text-input focus follows the keyboard focus. This event sets the current surface for the text-input object.

pub fn leave(&self, surface: &WlSurface)

leave event

Notification that this seat's text-input focus is no longer on a certain surface. The client should reset any preedit string previously set.

The leave notification clears the current surface. It is sent before the enter notification for the new focus.

When the seat has the keyboard capability the text-input focus follows the keyboard focus.

pub fn preedit_string(
    &self,
    text: Option<String>,
    cursor_begin: i32,
    cursor_end: i32
)

pre-edit

Notify when a new composing text (pre-edit) should be set at the current cursor position. Any previously set composing text must be removed. Any previously existing selected text must be removed.

The argument text contains the pre-edit string buffer.

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

They could be represented by the client as a line if both values are the same, or as a text highlight otherwise.

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

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

pub fn commit_string(&self, text: Option<String>)

text commit

Notify when text should be inserted into the editor widget. The text to commit could be either just a single character after a key press or the result of some composing (pre-edit).

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

The initial value of text is an empty string.

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

delete surrounding text

Notify when the text around the current cursor position should be deleted.

Before_length and after_length are the number of bytes before and after the current cursor index (excluding the selection) to delete.

If a preedit text is present, in effect before_length is counted from the beginning of it, and after_length from its end (see done event sequence).

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

The initial values of both before_length and after_length are 0.

pub fn done(&self, serial: u32)

apply changes

Instruct the application to apply changes to state requested by the preedit_string, commit_string and delete_surrounding_text events. The state relating to these events is double-buffered, and each one modifies the pending state. This event replaces the current state with the pending state.

The application must 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_text_input_v3 object known to the compositor. The value of the serial argument must be equal to the number of commit requests already issued on that object. When the client receives a done event with a serial different than the number of past commit requests, it must proceed as normal, except it should not change the current state of the zwp_text_input_v3 object.

Trait Implementations

impl AsRef<Resource<ZwpTextInputV3>> for ZwpTextInputV3

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

Performs the conversion.

impl Clone for ZwpTextInputV3

fn clone(&self) -> ZwpTextInputV3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ZwpTextInputV3

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

Formats the value using the given formatter.

impl Eq for ZwpTextInputV3

impl From<Resource<ZwpTextInputV3>> for ZwpTextInputV3

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

Performs the conversion.

impl From<ZwpTextInputV3> for Resource<ZwpTextInputV3>

fn from(value: ZwpTextInputV3) -> Self

Performs the conversion.

impl Interface for ZwpTextInputV3

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<ZwpTextInputV3> for ZwpTextInputV3

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

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

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

This method tests for !=.

impl StructuralEq for ZwpTextInputV3

impl StructuralPartialEq for ZwpTextInputV3