Struct wayland_protocols::wp::input_method::zv1::generated::client::zwp_input_method_context_v1::ZwpInputMethodContextV1
source · pub struct ZwpInputMethodContextV1 {
id: ObjectId,
version: u32,
data: Option<Arc<dyn ObjectData>>,
backend: WeakBackend,
}
Expand description
input method context
Corresponds to a text input on the input method side. An input method context is created on text input activation on the input method side. It allows receiving information about the text input from the application via events. Input method contexts do not keep state after deactivation and should be destroyed after deactivation is handled.
Text is generally UTF-8 encoded, indices and lengths are in bytes.
Serials are used to synchronize the state between the text input and an input method. New serials are sent by the text input in the commit_state request and are used by the input method to indicate the known text input state in events like preedit_string, commit_string, and keysym. The text input can then ignore events from the input method which are based on an outdated state (for example after a reset).
Warning! The protocol described in this file is experimental and backward incompatible changes may be made. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes are done by bumping the version number in the protocol and interface names and resetting the interface version. Once the protocol is to be declared stable, the ‘z’ prefix and the version number in the protocol and interface names are removed and the interface version number is reset.
See also the Event enum for this interface.
Fields§
§id: ObjectId
§version: u32
§data: Option<Arc<dyn ObjectData>>
§backend: WeakBackend
Implementations§
source§impl ZwpInputMethodContextV1
impl ZwpInputMethodContextV1
pub fn destroy(&self)
sourcepub fn commit_string(&self, serial: u32, text: String)
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.
sourcepub fn preedit_string(&self, serial: u32, text: String, commit: String)
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.
sourcepub fn preedit_styling(&self, index: u32, length: u32, style: u32)
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.
sourcepub fn preedit_cursor(&self, index: i32)
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.
sourcepub fn delete_surrounding_text(&self, index: i32, length: u32)
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.
sourcepub fn cursor_position(&self, index: i32, anchor: i32)
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>)
sourcepub fn keysym(
&self,
serial: u32,
time: u32,
sym: u32,
state: u32,
modifiers: u32,
)
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.
sourcepub fn grab_keyboard<U: Send + Sync + 'static, D: Dispatch<WlKeyboard, U> + 'static>(
&self,
qh: &QueueHandle<D>,
udata: U,
) -> WlKeyboard
pub fn grab_keyboard<U: Send + Sync + 'static, D: Dispatch<WlKeyboard, U> + 'static>( &self, qh: &QueueHandle<D>, udata: U, ) -> 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.
sourcepub fn key(&self, serial: u32, time: u32, key: u32, state: u32)
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.
sourcepub fn modifiers(
&self,
serial: u32,
mods_depressed: u32,
mods_latched: u32,
mods_locked: u32,
group: u32,
)
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§
source§impl Borrow<ObjectId> for ZwpInputMethodContextV1
impl Borrow<ObjectId> for ZwpInputMethodContextV1
source§impl Clone for ZwpInputMethodContextV1
impl Clone for ZwpInputMethodContextV1
source§fn clone(&self) -> ZwpInputMethodContextV1
fn clone(&self) -> ZwpInputMethodContextV1
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ZwpInputMethodContextV1
impl Debug for ZwpInputMethodContextV1
source§impl Hash for ZwpInputMethodContextV1
impl Hash for ZwpInputMethodContextV1
source§impl PartialEq<Weak<ZwpInputMethodContextV1>> for ZwpInputMethodContextV1
impl PartialEq<Weak<ZwpInputMethodContextV1>> for ZwpInputMethodContextV1
source§impl PartialEq for ZwpInputMethodContextV1
impl PartialEq for ZwpInputMethodContextV1
source§fn eq(&self, other: &ZwpInputMethodContextV1) -> bool
fn eq(&self, other: &ZwpInputMethodContextV1) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl Proxy for ZwpInputMethodContextV1
impl Proxy for ZwpInputMethodContextV1
source§fn data<U: Send + Sync + 'static>(&self) -> Option<&U>
fn data<U: Send + Sync + 'static>(&self) -> Option<&U>
source§fn object_data(&self) -> Option<&Arc<dyn ObjectData>>
fn object_data(&self) -> Option<&Arc<dyn ObjectData>>
source§fn backend(&self) -> &WeakBackend
fn backend(&self) -> &WeakBackend
source§fn send_request(&self, req: Self::Request<'_>) -> Result<(), InvalidId>
fn send_request(&self, req: Self::Request<'_>) -> Result<(), InvalidId>
source§fn send_constructor<I: Proxy>(
&self,
req: Self::Request<'_>,
data: Arc<dyn ObjectData>,
) -> Result<I, InvalidId>
fn send_constructor<I: Proxy>( &self, req: Self::Request<'_>, data: Arc<dyn ObjectData>, ) -> Result<I, InvalidId>
source§fn from_id(conn: &Connection, id: ObjectId) -> Result<Self, InvalidId>
fn from_id(conn: &Connection, id: ObjectId) -> Result<Self, InvalidId>
source§fn inert(backend: WeakBackend) -> Self
fn inert(backend: WeakBackend) -> Self
source§fn parse_event(
conn: &Connection,
msg: Message<ObjectId, OwnedFd>,
) -> Result<(Self, Self::Event), DispatchError>
fn parse_event( conn: &Connection, msg: Message<ObjectId, OwnedFd>, ) -> Result<(Self, Self::Event), DispatchError>
source§fn write_request<'a>(
&self,
conn: &Connection,
msg: Self::Request<'a>,
) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>
fn write_request<'a>( &self, conn: &Connection, msg: Self::Request<'a>, ) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>
impl Eq for ZwpInputMethodContextV1
Auto Trait Implementations§
impl Freeze for ZwpInputMethodContextV1
impl !RefUnwindSafe for ZwpInputMethodContextV1
impl Send for ZwpInputMethodContextV1
impl Sync for ZwpInputMethodContextV1
impl Unpin for ZwpInputMethodContextV1
impl !UnwindSafe for ZwpInputMethodContextV1
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.