.TH "wayland::zwp_text_input_v1_t" 3 "Wed May 3 2023" "Version 1.0.0" "Wayland++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
wayland::zwp_text_input_v1_t \- text input  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <wayland\-client\-protocol\-unstable\&.hpp>\fP
.PP
Inherits \fBwayland::proxy_t\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum class \fBwrapper_type\fP { \fBstandard\fP, \fBdisplay\fP, \fBforeign\fP, \fBproxy_wrapper\fP }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "void \fBactivate\fP (\fBseat_t\fP const &seat, \fBsurface_t\fP const &surface)"
.br
.RI "request activation "
.ti -1c
.RI "void \fBdeactivate\fP (\fBseat_t\fP const &seat)"
.br
.RI "request deactivation "
.ti -1c
.RI "void \fBshow_input_panel\fP ()"
.br
.RI "show input panels "
.ti -1c
.RI "void \fBhide_input_panel\fP ()"
.br
.RI "hide input panels "
.ti -1c
.RI "void \fBreset\fP ()"
.br
.RI "reset "
.ti -1c
.RI "void \fBset_surrounding_text\fP (std::string const &text, uint32_t cursor, uint32_t anchor)"
.br
.RI "sets the surrounding text "
.ti -1c
.RI "void \fBset_content_type\fP (\fBzwp_text_input_v1_content_hint\fP const &hint, zwp_text_input_v1_content_purpose const &purpose)"
.br
.RI "set content purpose and hint "
.ti -1c
.RI "void \fBset_cursor_rectangle\fP (int32_t x, int32_t y, int32_t width, int32_t height)"
.br
.ti -1c
.RI "void \fBset_preferred_language\fP (std::string const &language)"
.br
.RI "sets preferred language "
.ti -1c
.RI "void \fBcommit_state\fP (uint32_t serial)"
.br
.ti -1c
.RI "void \fBinvoke_action\fP (uint32_t button, uint32_t index)"
.br
.ti -1c
.RI "std::function< void(\fBsurface_t\fP)> & \fBon_enter\fP ()"
.br
.RI "enter event "
.ti -1c
.RI "std::function< void()> & \fBon_leave\fP ()"
.br
.RI "leave event "
.ti -1c
.RI "std::function< void(array_t)> & \fBon_modifiers_map\fP ()"
.br
.RI "modifiers map "
.ti -1c
.RI "std::function< void(uint32_t)> & \fBon_input_panel_state\fP ()"
.br
.RI "state of the input panel "
.ti -1c
.RI "std::function< void(uint32_t, std::string, std::string)> & \fBon_preedit_string\fP ()"
.br
.RI "pre-edit "
.ti -1c
.RI "std::function< void(uint32_t, uint32_t, zwp_text_input_v1_preedit_style)> & \fBon_preedit_styling\fP ()"
.br
.RI "pre-edit styling "
.ti -1c
.RI "std::function< void(int32_t)> & \fBon_preedit_cursor\fP ()"
.br
.RI "pre-edit cursor "
.ti -1c
.RI "std::function< void(uint32_t, std::string)> & \fBon_commit_string\fP ()"
.br
.RI "commit "
.ti -1c
.RI "std::function< void(int32_t, int32_t)> & \fBon_cursor_position\fP ()"
.br
.RI "set cursor to new position "
.ti -1c
.RI "std::function< void(int32_t, uint32_t)> & \fBon_delete_surrounding_text\fP ()"
.br
.RI "delete surrounding text "
.ti -1c
.RI "std::function< void(uint32_t, uint32_t, uint32_t, keyboard_key_state, uint32_t)> & \fBon_keysym\fP ()"
.br
.RI "keysym "
.ti -1c
.RI "std::function< void(uint32_t, std::string)> & \fBon_language\fP ()"
.br
.RI "language "
.ti -1c
.RI "std::function< void(uint32_t, zwp_text_input_v1_text_direction)> & \fBon_text_direction\fP ()"
.br
.RI "text direction "
.ti -1c
.RI "uint32_t \fBget_id\fP () const"
.br
.RI "Get the id of a proxy object\&. "
.ti -1c
.RI "std::string \fBget_class\fP () const"
.br
.RI "Get the interface name (class) of a proxy object\&. "
.ti -1c
.RI "uint32_t \fBget_version\fP () const"
.br
.RI "Get the protocol object version of a proxy object\&. "
.ti -1c
.RI "\fBwrapper_type\fP \fBget_wrapper_type\fP () const"
.br
.RI "Get the type of a proxy object\&. "
.ti -1c
.RI "void \fBset_queue\fP (\fBevent_queue_t\fP queue)"
.br
.RI "Assign a proxy to an event queue\&. "
.ti -1c
.RI "wl_proxy * \fBc_ptr\fP () const"
.br
.RI "Get a pointer to the underlying C struct\&. "
.ti -1c
.RI "bool \fBproxy_has_object\fP () const"
.br
.RI "Check whether this wrapper actually wraps an object\&. "
.ti -1c
.RI "\fBoperator bool\fP () const"
.br
.RI "Check whether this wrapper actually wraps an object\&. "
.ti -1c
.RI "bool \fBoperator==\fP (const \fBproxy_t\fP &right) const"
.br
.RI "Check whether two wrappers refer to the same object\&. "
.ti -1c
.RI "bool \fBoperator!=\fP (const \fBproxy_t\fP &right) const"
.br
.RI "Check whether two wrappers refer to different objects\&. "
.ti -1c
.RI "void \fBproxy_release\fP ()"
.br
.RI "Release the wrapped object (if any), making this an empty wrapper\&. "
.in -1c
.SS "Static Public Attributes"

.in +1c
.ti -1c
.RI "static constexpr std::uint32_t \fBactivate_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBactivate\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBdeactivate_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBdeactivate\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBshow_input_panel_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBshow_input_panel\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBhide_input_panel_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBhide_input_panel\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBreset_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBreset\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBset_surrounding_text_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBset_surrounding_text\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBset_content_type_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBset_content_type\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBset_cursor_rectangle_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBset_cursor_rectangle\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBset_preferred_language_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBset_preferred_language\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBcommit_state_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBcommit_state\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBinvoke_action_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBinvoke_action\fP function\&. "
.in -1c
.SH "Detailed Description"
.PP 
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\&.
.PP
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\&.
.PP
Text is generally UTF-8 encoded, indices and lengths are in bytes\&.
.PP
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)\&.
.PP
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\&. 
.PP
Definition at line \fB5624\fP of file \fBwayland\-client\-protocol\-unstable\&.hpp\fP\&.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum class \fBwayland::proxy_t::wrapper_type\fP\fC [strong]\fP, \fC [inherited]\fP"
Underlying wl_proxy type and properties of a \fBproxy_t\fP that affect construction, destruction, and event handling 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIstandard \fP\fP
C pointer is a standard type compatible with wl_proxy*\&. Events are dispatched and it is destructed when the \fBproxy_t\fP is destructed\&. User data is set\&. 
.TP
\fB\fIdisplay \fP\fP
C pointer is a wl_display*\&. No events are dispatched, wl_display_disconnect is called when the \fBproxy_t\fP is destructed\&. User data is set\&. 
.TP
\fB\fIforeign \fP\fP
C pointer is a standard type compatible with wl_proxy*, but another library owns it and it should not be touched in a way that could affect the operation of the other library\&. No events are dispatched, wl_proxy_destroy is not called when the \fBproxy_t\fP is destructed, user data is not touched\&. Consequently, there is no reference counting for the \fBproxy_t\fP\&. Lifetime of such wrappers should preferably be short to minimize the chance that the owning library decides to destroy the wl_proxy\&. 
.TP
\fB\fIproxy_wrapper \fP\fP
C pointer is a wl_proxy* that was constructed with wl_proxy_create_wrapper\&. No events are dispatched, wl_proxy_wrapper_destroy is called when the \fBproxy_t\fP is destroyed\&. Reference counting is active\&. A reference to the \fBproxy_t\fP creating this proxy wrapper is held to extend its lifetime until after the proxy wrapper is destroyed\&. 
.PP
Definition at line \fB115\fP of file \fBwayland\-client\&.hpp\fP\&.
.SH "Member Function Documentation"
.PP 
.SS "void zwp_text_input_v1_t::activate (\fBseat_t\fP const & seat, \fBsurface_t\fP const & surface)"

.PP
request activation 
.PP
\fBParameters\fP
.RS 4
\fIseat\fP 
.br
\fIsurface\fP 
.RE
.PP
Requests the text_input object to be activated (typically when the text entry gets focus)\&.
.PP
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\&. 
.PP
Definition at line \fB8136\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "wl_proxy * wayland::proxy_t::c_ptr () const\fC [inherited]\fP"

.PP
Get a pointer to the underlying C struct\&. 
.PP
\fBReturns\fP
.RS 4
The underlying wl_proxy wrapped by this \fBproxy_t\fP if it exists, otherwise an exception is thrown 
.RE
.PP

.SS "void zwp_text_input_v1_t::commit_state (uint32_t serial)"

.PP
\fBParameters\fP
.RS 4
\fIserial\fP used to identify the known state 
.RE
.PP

.PP
Definition at line \fB8190\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "void zwp_text_input_v1_t::deactivate (\fBseat_t\fP const & seat)"

.PP
request deactivation 
.PP
\fBParameters\fP
.RS 4
\fIseat\fP 
.RE
.PP
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\&. 
.PP
Definition at line \fB8142\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "std::string wayland::proxy_t::get_class () const\fC [inherited]\fP"

.PP
Get the interface name (class) of a proxy object\&. 
.PP
\fBReturns\fP
.RS 4
The interface name of the object associated with the proxy 
.RE
.PP

.SS "uint32_t wayland::proxy_t::get_id () const\fC [inherited]\fP"

.PP
Get the id of a proxy object\&. 
.PP
\fBReturns\fP
.RS 4
The id the object associated with the proxy 
.RE
.PP

.SS "uint32_t wayland::proxy_t::get_version () const\fC [inherited]\fP"

.PP
Get the protocol object version of a proxy object\&. Gets the protocol object version of a proxy object, or 0 if the proxy was created with unversioned API\&.
.PP
A returned value of 0 means that no version information is available, so the caller must make safe assumptions about the object's real version\&.
.PP
\fBdisplay_t\fP will always return version 0\&.
.PP
\fBReturns\fP
.RS 4
The protocol object version of the proxy or 0 
.RE
.PP

.SS "\fBwrapper_type\fP wayland::proxy_t::get_wrapper_type () const\fC [inline]\fP, \fC [inherited]\fP"

.PP
Get the type of a proxy object\&. 
.PP
Definition at line \fB301\fP of file \fBwayland\-client\&.hpp\fP\&.
.SS "void zwp_text_input_v1_t::hide_input_panel ()"

.PP
hide input panels Requests input panels (virtual keyboard) to hide\&. 
.PP
Definition at line \fB8154\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "void zwp_text_input_v1_t::invoke_action (uint32_t button, uint32_t index)"

.PP
\fBParameters\fP
.RS 4
\fIbutton\fP 
.br
\fIindex\fP 
.RE
.PP

.PP
Definition at line \fB8196\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void(uint32_t, std::string)> & zwp_text_input_v1_t::on_commit_string ()"

.PP
commit 
.PP
\fBParameters\fP
.RS 4
\fIserial\fP serial of the latest known text input state 
.br
\fItext\fP 
.RE
.PP
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)\&. It could also be an empty text when some text should be removed (see delete_surrounding_text) or when the input cursor should be moved (see cursor_position)\&.
.PP
Any previously set composing text should be removed\&. 
.PP
Definition at line \fB8237\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void(int32_t, int32_t)> & zwp_text_input_v1_t::on_cursor_position ()"

.PP
set cursor to new position 
.PP
\fBParameters\fP
.RS 4
\fIindex\fP 
.br
\fIanchor\fP 
.RE
.PP
Notify when the cursor or anchor position should be modified\&.
.PP
This event should be handled as part of a following commit_string event\&. 
.PP
Definition at line \fB8242\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void(int32_t, uint32_t)> & zwp_text_input_v1_t::on_delete_surrounding_text ()"

.PP
delete surrounding text 
.PP
\fBParameters\fP
.RS 4
\fIindex\fP 
.br
\fIlength\fP 
.RE
.PP
Notify when the text around the current cursor position should be deleted\&.
.PP
Index is relative to the current cursor (in bytes)\&. Length is the length of deleted text (in bytes)\&.
.PP
This event should be handled as part of a following commit_string event\&. 
.PP
Definition at line \fB8247\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void(\fBsurface_t\fP)> & zwp_text_input_v1_t::on_enter ()"

.PP
enter event 
.PP
\fBParameters\fP
.RS 4
\fIsurface\fP 
.RE
.PP
Notify the text_input object when it received focus\&. Typically in response to an activate request\&. 
.PP
Definition at line \fB8202\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void(uint32_t)> & zwp_text_input_v1_t::on_input_panel_state ()"

.PP
state of the input panel 
.PP
\fBParameters\fP
.RS 4
\fIstate\fP 
.RE
.PP
Notify when the visibility state of the input panel changed\&. 
.PP
Definition at line \fB8217\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void(uint32_t, uint32_t, uint32_t, keyboard_key_state, uint32_t)> & zwp_text_input_v1_t::on_keysym ()"

.PP
keysym 
.PP
\fBParameters\fP
.RS 4
\fIserial\fP serial of the latest known text input state 
.br
\fItime\fP 
.br
\fIsym\fP 
.br
\fIstate\fP 
.br
\fImodifiers\fP 
.RE
.PP
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 a wl_keyboard key_state\&. Modifiers are a mask for effective modifiers (where the modifier indices are set by the modifiers_map event) 
.PP
Definition at line \fB8252\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void(uint32_t, std::string)> & zwp_text_input_v1_t::on_language ()"

.PP
language 
.PP
\fBParameters\fP
.RS 4
\fIserial\fP serial of the latest known text input state 
.br
\fIlanguage\fP 
.RE
.PP
Sets the language of the input text\&. The 'language' argument is an RFC-3066 format language tag\&. 
.PP
Definition at line \fB8257\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void()> & zwp_text_input_v1_t::on_leave ()"

.PP
leave event Notify the text_input object when it lost focus\&. Either in response to a deactivate request or when the assigned surface lost focus or was destroyed\&. 
.PP
Definition at line \fB8207\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void(array_t)> & zwp_text_input_v1_t::on_modifiers_map ()"

.PP
modifiers map 
.PP
\fBParameters\fP
.RS 4
\fImap\fP 
.RE
.PP
Transfer an array of 0-terminated modifier names\&. The position in the array is the index of the modifier as used in the modifiers bitmask in the keysym event\&. 
.PP
Definition at line \fB8212\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void(int32_t)> & zwp_text_input_v1_t::on_preedit_cursor ()"

.PP
pre-edit cursor 
.PP
\fBParameters\fP
.RS 4
\fIindex\fP 
.RE
.PP
Sets the cursor position inside the composing text (as byte offset) relative to the start of the composing text\&. When index is a negative number no cursor is shown\&.
.PP
This event is handled as part of a following preedit_string event\&. 
.PP
Definition at line \fB8232\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void(uint32_t, std::string, std::string)> & zwp_text_input_v1_t::on_preedit_string ()"

.PP
pre-edit 
.PP
\fBParameters\fP
.RS 4
\fIserial\fP serial of the latest known text input state 
.br
\fItext\fP 
.br
\fIcommit\fP 
.RE
.PP
Notify when a new composing text (pre-edit) should be set around the current cursor position\&. Any previously set composing text should be removed\&.
.PP
The commit text can be used to replace the preedit text on reset (for example on unfocus)\&.
.PP
The text input should also handle all preedit_style and preedit_cursor events occurring directly before preedit_string\&. 
.PP
Definition at line \fB8222\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void(uint32_t, uint32_t, zwp_text_input_v1_preedit_style)> & zwp_text_input_v1_t::on_preedit_styling ()"

.PP
pre-edit styling 
.PP
\fBParameters\fP
.RS 4
\fIindex\fP 
.br
\fIlength\fP 
.br
\fIstyle\fP 
.RE
.PP
Sets styling information on composing text\&. The style is applied for length bytes from index relative to the beginning of the composing text (as byte offset)\&. Multiple styles can be applied to a composing text by sending multiple preedit_styling events\&.
.PP
This event is handled as part of a following preedit_string event\&. 
.PP
Definition at line \fB8227\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void(uint32_t, zwp_text_input_v1_text_direction)> & zwp_text_input_v1_t::on_text_direction ()"

.PP
text direction 
.PP
\fBParameters\fP
.RS 4
\fIserial\fP serial of the latest known text input state 
.br
\fIdirection\fP 
.RE
.PP
Sets the text direction of input text\&.
.PP
It is mainly needed for showing an input cursor on the correct side of the editor when there is no input done yet and making sure neutral direction text is laid out properly\&. 
.PP
Definition at line \fB8262\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "wayland::proxy_t::operator bool () const\fC [inherited]\fP"

.PP
Check whether this wrapper actually wraps an object\&. 
.PP
\fBReturns\fP
.RS 4
true if there is an underlying object, false if this wrapper is empty 
.RE
.PP

.SS "bool wayland::proxy_t::operator!= (const \fBproxy_t\fP & right) const\fC [inherited]\fP"

.PP
Check whether two wrappers refer to different objects\&. 
.SS "bool wayland::proxy_t::operator== (const \fBproxy_t\fP & right) const\fC [inherited]\fP"

.PP
Check whether two wrappers refer to the same object\&. 
.SS "bool wayland::proxy_t::proxy_has_object () const\fC [inherited]\fP"

.PP
Check whether this wrapper actually wraps an object\&. 
.PP
\fBReturns\fP
.RS 4
true if there is an underlying object, false if this wrapper is empty 
.RE
.PP

.SS "void wayland::proxy_t::proxy_release ()\fC [inherited]\fP"

.PP
Release the wrapped object (if any), making this an empty wrapper\&. Note that \fBdisplay_t\fP instances cannot be released this way\&. Attempts to do so are ignored\&. 
.PP
\fBExamples\fP
.in +1c
\fBforeign_display\&.cpp\fP\&.
.SS "void zwp_text_input_v1_t::reset ()"

.PP
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\&. 
.PP
Definition at line \fB8160\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "void zwp_text_input_v1_t::set_content_type (\fBzwp_text_input_v1_content_hint\fP const & hint, zwp_text_input_v1_content_purpose const & purpose)"

.PP
set content purpose and hint 
.PP
\fBParameters\fP
.RS 4
\fIhint\fP 
.br
\fIpurpose\fP 
.RE
.PP
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\&.
.PP
When no content type is explicitly set, a normal content purpose with default hints (auto completion, auto correction, auto capitalization) should be assumed\&. 
.PP
Definition at line \fB8172\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "void zwp_text_input_v1_t::set_cursor_rectangle (int32_t x, int32_t y, int32_t width, int32_t height)"

.PP
\fBParameters\fP
.RS 4
\fIx\fP 
.br
\fIy\fP 
.br
\fIwidth\fP 
.br
\fIheight\fP 
.RE
.PP

.PP
Definition at line \fB8178\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "void zwp_text_input_v1_t::set_preferred_language (std::string const & language)"

.PP
sets preferred language 
.PP
\fBParameters\fP
.RS 4
\fIlanguage\fP 
.RE
.PP
Sets a specific language\&. This allows for example a virtual keyboard to show a language specific layout\&. The 'language' argument is an RFC-3066 format language tag\&.
.PP
It could be used for example in a word processor to indicate the language of the currently edited document or in an instant message application which tracks languages of contacts\&. 
.PP
Definition at line \fB8184\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "void wayland::proxy_t::set_queue (\fBevent_queue_t\fP queue)\fC [inherited]\fP"

.PP
Assign a proxy to an event queue\&. 
.PP
\fBParameters\fP
.RS 4
\fIqueue\fP The event queue that will handle this proxy
.RE
.PP
Assign proxy to event queue\&. Events coming from proxy will be queued in queue instead of the display's main queue\&.
.PP
See also: \fBdisplay_t::dispatch_queue()\fP\&. 
.PP
\fBExamples\fP
.in +1c
\fBproxy_wrapper\&.cpp\fP\&.
.SS "void zwp_text_input_v1_t::set_surrounding_text (std::string const & text, uint32_t cursor, uint32_t anchor)"

.PP
sets the surrounding text 
.PP
\fBParameters\fP
.RS 4
\fItext\fP 
.br
\fIcursor\fP 
.br
\fIanchor\fP 
.RE
.PP
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, then it is the same as cursor\&. 
.PP
Definition at line \fB8166\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SS "void zwp_text_input_v1_t::show_input_panel ()"

.PP
show input panels Requests input panels (virtual keyboard) to show\&. 
.PP
Definition at line \fB8148\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "constexpr std::uint32_t wayland::zwp_text_input_v1_t::activate_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBactivate\fP function\&. 
.PP
Definition at line \fB5676\fP of file \fBwayland\-client\-protocol\-unstable\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::zwp_text_input_v1_t::commit_state_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBcommit_state\fP function\&. 
.PP
Definition at line \fB5803\fP of file \fBwayland\-client\-protocol\-unstable\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::zwp_text_input_v1_t::deactivate_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBdeactivate\fP function\&. 
.PP
Definition at line \fB5690\fP of file \fBwayland\-client\-protocol\-unstable\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::zwp_text_input_v1_t::hide_input_panel_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBhide_input_panel\fP function\&. 
.PP
Definition at line \fB5712\fP of file \fBwayland\-client\-protocol\-unstable\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::zwp_text_input_v1_t::invoke_action_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBinvoke_action\fP function\&. 
.PP
Definition at line \fB5814\fP of file \fBwayland\-client\-protocol\-unstable\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::zwp_text_input_v1_t::reset_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBreset\fP function\&. 
.PP
Definition at line \fB5725\fP of file \fBwayland\-client\-protocol\-unstable\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::zwp_text_input_v1_t::set_content_type_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBset_content_type\fP function\&. 
.PP
Definition at line \fB5762\fP of file \fBwayland\-client\-protocol\-unstable\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::zwp_text_input_v1_t::set_cursor_rectangle_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBset_cursor_rectangle\fP function\&. 
.PP
Definition at line \fB5775\fP of file \fBwayland\-client\-protocol\-unstable\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::zwp_text_input_v1_t::set_preferred_language_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBset_preferred_language\fP function\&. 
.PP
Definition at line \fB5793\fP of file \fBwayland\-client\-protocol\-unstable\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::zwp_text_input_v1_t::set_surrounding_text_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBset_surrounding_text\fP function\&. 
.PP
Definition at line \fB5743\fP of file \fBwayland\-client\-protocol\-unstable\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::zwp_text_input_v1_t::show_input_panel_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBshow_input_panel\fP function\&. 
.PP
Definition at line \fB5701\fP of file \fBwayland\-client\-protocol\-unstable\&.hpp\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Wayland++ from the source code\&.