Struct wayland_protocols_plasma::text_input::v1::client::wl_text_input::WlTextInput
source · pub struct WlTextInput {
id: ObjectId,
version: u32,
data: Option<Arc<dyn ObjectData>>,
backend: WeakBackend,
}
Expand description
text input
An object used for text input. Adds support for text input and input methods to applications. A text-input object is created from a wl_text_input_manager and corresponds typically to a text entry in an application. Requests are used to activate/deactivate the text-input object and set state information like surrounding and selected text or the content type. The information about 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 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).
See also the Event enum for this interface.
Fields§
§id: ObjectId
§version: u32
§data: Option<Arc<dyn ObjectData>>
§backend: WeakBackend
Implementations§
source§impl WlTextInput
impl WlTextInput
sourcepub fn activate(&self, seat: &WlSeat, surface: &WlSurface)
pub fn activate(&self, seat: &WlSeat, surface: &WlSurface)
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.
sourcepub fn deactivate(&self, seat: &WlSeat)
pub fn deactivate(&self, seat: &WlSeat)
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.
sourcepub fn show_input_panel(&self)
pub fn show_input_panel(&self)
show input panels
Requests input panels (virtual keyboard) to show.
sourcepub fn hide_input_panel(&self)
pub fn hide_input_panel(&self)
hide input panels
Requests input panels (virtual keyboard) to hide.
sourcepub fn reset(&self)
pub fn reset(&self)
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.
sourcepub fn set_surrounding_text(&self, text: String, cursor: u32, anchor: u32)
pub fn set_surrounding_text(&self, text: String, cursor: u32, anchor: u32)
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.
sourcepub fn set_content_type(&self, hint: u32, purpose: u32)
pub fn set_content_type(&self, hint: u32, purpose: u32)
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.
pub fn set_cursor_rectangle(&self, x: i32, y: i32, width: i32, height: i32)
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.
pub fn commit_state(&self, serial: u32)
pub fn invoke_action(&self, button: u32, index: u32)
Trait Implementations§
source§impl Borrow<ObjectId> for WlTextInput
impl Borrow<ObjectId> for WlTextInput
source§impl Clone for WlTextInput
impl Clone for WlTextInput
source§fn clone(&self) -> WlTextInput
fn clone(&self) -> WlTextInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for WlTextInput
impl Debug for WlTextInput
source§impl Hash for WlTextInput
impl Hash for WlTextInput
source§impl PartialEq<Weak<WlTextInput>> for WlTextInput
impl PartialEq<Weak<WlTextInput>> for WlTextInput
source§impl PartialEq for WlTextInput
impl PartialEq for WlTextInput
source§impl Proxy for WlTextInput
impl Proxy for WlTextInput
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 WlTextInput
Auto Trait Implementations§
impl Freeze for WlTextInput
impl !RefUnwindSafe for WlTextInput
impl Send for WlTextInput
impl Sync for WlTextInput
impl Unpin for WlTextInput
impl !UnwindSafe for WlTextInput
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.