Enum wayland_protocols::misc::zwp_input_method_v2::server::zwp_input_method_v2::Request [−][src]
#[non_exhaustive]
pub enum Request {
CommitString {
text: String,
},
SetPreeditString {
text: String,
cursor_begin: i32,
cursor_end: i32,
},
DeleteSurroundingText {
before_length: u32,
after_length: u32,
},
Commit {
serial: u32,
},
GetInputPopupSurface {
id: Main<ZwpInputPopupSurfaceV2>,
surface: WlSurface,
},
GrabKeyboard {
keyboard: Main<ZwpInputMethodKeyboardGrabV2>,
},
Destroy,
}
Variants (Non-exhaustive)
This enum is marked as non-exhaustive
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.
Fields of CommitString
text: String
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.
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.
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:
- Replace existing preedit string with the cursor.
- Delete requested surrounding text.
- Insert commit string with the cursor at its end.
- Calculate surrounding text to send.
- Insert new preedit text in cursor position.
- 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.
Fields of Commit
serial: u32
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.
Fields of GetInputPopupSurface
id: Main<ZwpInputPopupSurfaceV2>
surface: WlSurface
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.
Fields of GrabKeyboard
keyboard: Main<ZwpInputMethodKeyboardGrabV2>
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, once received this object cannot be used any longer.
Trait Implementations
Wire representation of this MessageGroup
type Map = ResourceMap
type Map = ResourceMap
The wrapper type for ObjectMap allowing the mapping of Object and NewId arguments to the object map during parsing. Read more
Whether this message is a destructor Read more
Retrieve the child Object
associated with this message if any
Construct a message from its raw representation
Construct a message of this group from its C representation Read more
Auto Trait Implementations
impl !RefUnwindSafe for Request
impl !UnwindSafe for Request
Blanket Implementations
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more