pub struct ZwpTextInputV2 {
id: ObjectId,
version: u32,
data: Option<Arc<dyn ObjectData>>,
backend: WeakBackend,
}
Expand description
text input
The zwp_text_input_v2 interface represents text input and input methods associated with a seat. It provides enter/leave events to follow the text input focus for a seat.
Requests are used to enable/disable the text-input object and set state information like surrounding and selected text or the content type. The information about the entered text is sent to the text-input object via the pre-edit and commit events. Using this interface removes the need for applications to directly process hardware key events and compose text out of them.
Text is valid UTF-8 encoded, indices and lengths are in bytes. Indices have to always point to the first byte of an UTF-8 encoded code point. Lengths are not allowed to contain just a part of an UTF-8 encoded code point.
State is sent by the state requests (set_surrounding_text, set_content_type, set_cursor_rectangle and set_preferred_language) and an update_state request. After an enter or an input_method_change event all state information is invalidated and needs to be resent from the client. A reset or entering a new widget on client side also invalidates all current state information.
See also the Event enum for this interface.
Fields§
§id: ObjectId
§version: u32
§data: Option<Arc<dyn ObjectData>>
§backend: WeakBackend
Implementations§
source§impl ZwpTextInputV2
impl ZwpTextInputV2
sourcepub fn destroy(&self)
pub fn destroy(&self)
Destroy the wp_text_input
Destroy the wp_text_input object. Also disables all surfaces enabled through this wp_text_input object
sourcepub fn enable(&self, surface: &WlSurface)
pub fn enable(&self, surface: &WlSurface)
enable text input for surface
Enable text input in a surface (usually when a text entry inside of it has focus).
This can be called before or after a surface gets text (or keyboard) focus via the enter event. Text input to a surface is only active when it has the current text (or keyboard) focus and is enabled.
sourcepub fn disable(&self, surface: &WlSurface)
pub fn disable(&self, surface: &WlSurface)
disable text input for surface
Disable text input in a surface (typically when there is no focus on any text entry inside the surface).
sourcepub fn show_input_panel(&self)
pub fn show_input_panel(&self)
show input panels
Requests input panels (virtual keyboard) to show.
This should be used for example to show a virtual keyboard again (with a tap) after it was closed by pressing on a close button on the keyboard.
sourcepub fn hide_input_panel(&self)
pub fn hide_input_panel(&self)
hide input panels
Requests input panels (virtual keyboard) to hide.
sourcepub fn set_surrounding_text(&self, text: String, cursor: i32, anchor: i32)
pub fn set_surrounding_text(&self, text: String, cursor: i32, anchor: i32)
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 is the same as cursor.
Make sure to always send some text before and after the cursor except when the cursor is at the beginning or end of text.
When there was a configure_surrounding_text event take the before_cursor and after_cursor arguments into account for picking how much surrounding text to send.
There is a maximum length of wayland messages so text can not be longer than 4000 bytes.
sourcepub fn set_content_type(&self, hint: ContentHint, purpose: ContentPurpose)
pub fn set_content_type(&self, hint: ContentHint, purpose: ContentPurpose)
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 none hint should be assumed.
sourcepub fn set_cursor_rectangle(&self, x: i32, y: i32, width: i32, height: i32)
pub fn set_cursor_rectangle(&self, x: i32, y: i32, width: i32, height: i32)
set cursor position
Sets the cursor outline as a x, y, width, height rectangle in surface local coordinates.
Allows the compositor to put a window with word suggestions near the cursor.
sourcepub fn set_preferred_language(&self, language: String)
pub fn set_preferred_language(&self, language: String)
sets preferred language
Sets a specific language. This allows for example a virtual keyboard to show a language specific layout. The “language” argument is a RFC-3066 format language tag.
It could be used for example in a word processor to indicate language of currently edited document or in an instant message application which tracks languages of contacts.
sourcepub fn update_state(&self, serial: u32, reason: UpdateState)
pub fn update_state(&self, serial: u32, reason: UpdateState)
update state
Allows to atomically send state updates from client.
This request should follow after a batch of state updating requests like set_surrounding_text, set_content_type, set_cursor_rectangle and set_preferred_language.
The flags field indicates why an updated state is sent to the input method.
Reset should be used by an editor widget after the text was changed outside of the normal input method flow.
For “change” it is enough to send the changed state, else the full state should be send.
Serial should be set to the serial from the last enter or input_method_changed event.
To make sure to not receive outdated input method events after a reset or switching to a new widget wl_display_sync() should be used after update_state in these cases.
Trait Implementations§
source§impl Borrow<ObjectId> for ZwpTextInputV2
impl Borrow<ObjectId> for ZwpTextInputV2
source§impl Clone for ZwpTextInputV2
impl Clone for ZwpTextInputV2
source§fn clone(&self) -> ZwpTextInputV2
fn clone(&self) -> ZwpTextInputV2
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ZwpTextInputV2
impl Debug for ZwpTextInputV2
source§impl Hash for ZwpTextInputV2
impl Hash for ZwpTextInputV2
source§impl PartialEq<Weak<ZwpTextInputV2>> for ZwpTextInputV2
impl PartialEq<Weak<ZwpTextInputV2>> for ZwpTextInputV2
source§impl PartialEq for ZwpTextInputV2
impl PartialEq for ZwpTextInputV2
source§impl Proxy for ZwpTextInputV2
impl Proxy for ZwpTextInputV2
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 ZwpTextInputV2
Auto Trait Implementations§
impl Freeze for ZwpTextInputV2
impl !RefUnwindSafe for ZwpTextInputV2
impl Send for ZwpTextInputV2
impl Sync for ZwpTextInputV2
impl Unpin for ZwpTextInputV2
impl !UnwindSafe for ZwpTextInputV2
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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.