voidzwp_input_method_context_v1_t::commit_state(uint32_tserial,boolpost=true)Parametersserial serial of text input state
Definition at line 4523 of file wayland-server-protocol-unstable.cpp.
voidzwp_input_method_context_v1_t::content_type(zwp_text_input_v1_content_hintconst&hint,zwp_text_input_v1_content_purposeconst&purpose,boolpost=true)Parametershintpurpose
Definition at line 4513 of file wayland-server-protocol-unstable.cpp.
std::stringwayland::server::resource_t::get_class()[inherited]
Retrieve the interface name (class) of a resource object.
Returns
Interface name of the resource object.
client_twayland::server::resource_t::get_client()const[inherited]
Get the associated client
Returns
the client that owns the resource.
uint32_twayland::server::resource_t::get_id()const[inherited]
Get the internal ID of the resource
Returns
the internal ID of the resource
unsignedintwayland::server::resource_t::get_version()const[inherited]
Get interface version
Returns
Interface version this resource has been constructed with.
voidzwp_input_method_context_v1_t::invoke_action(uint32_tbutton,uint32_tindex,boolpost=true)Parametersbuttonindex
Definition at line 4518 of file wayland-server-protocol-unstable.cpp.
std::function<void(uint32_t,std::string)>&zwp_input_method_context_v1_t::on_commit_string()
commit string
Parametersserial serial of the latest known text input state
text
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.
Definition at line 4425 of file wayland-server-protocol-unstable.cpp.
std::function<void(int32_t,int32_t)>&zwp_input_method_context_v1_t::on_cursor_position()
set cursor to a new position
Parametersindexanchor
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.
Definition at line 4455 of file wayland-server-protocol-unstable.cpp.
std::function<void(int32_t,uint32_t)>&zwp_input_method_context_v1_t::on_delete_surrounding_text()
delete text
Parametersindexlength
Remove the surrounding text.
This request will be handled on the text_input side directly following a commit_string request.
Definition at line 4449 of file wayland-server-protocol-unstable.cpp.
std::function<void(keyboard_t)>&zwp_input_method_context_v1_t::on_grab_keyboard()
grab hardware keyboard
Parameterskeyboard
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.
Definition at line 4473 of file wayland-server-protocol-unstable.cpp.
std::function<void(uint32_t,uint32_t,uint32_t,keyboard_key_state)>&zwp_input_method_context_v1_t::on_key()
forward key event
Parametersserial serial from wl_keyboard::key
time time from wl_keyboard::key
key key from wl_keyboard::key
state state from wl_keyboard::key
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.
Definition at line 4479 of file wayland-server-protocol-unstable.cpp.
std::function<void(uint32_t,uint32_t,uint32_t,keyboard_key_state,uint32_t)>&zwp_input_method_context_v1_t::on_keysym()
keysym
Parametersserial serial of the latest known text input state
timesymstatemodifiers
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.
Definition at line 4467 of file wayland-server-protocol-unstable.cpp.
std::function<void(uint32_t,std::string)>&zwp_input_method_context_v1_t::on_language()Parametersserial serial of the latest known text input state
language
Definition at line 4491 of file wayland-server-protocol-unstable.cpp.
std::function<void(uint32_t,uint32_t,uint32_t,uint32_t,uint32_t)>&zwp_input_method_context_v1_t::on_modifiers()
forward modifiers event
Parametersserial serial from wl_keyboard::modifiers
mods_depressed mods_depressed from wl_keyboard::modifiers
mods_latched mods_latched from wl_keyboard::modifiers
mods_locked mods_locked from wl_keyboard::modifiers
group group from wl_keyboard::modifiers
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.
Definition at line 4485 of file wayland-server-protocol-unstable.cpp.
std::function<void(array_t)>&zwp_input_method_context_v1_t::on_modifiers_map()Parametersmap
Definition at line 4461 of file wayland-server-protocol-unstable.cpp.
std::function<void(int32_t)>&zwp_input_method_context_v1_t::on_preedit_cursor()
pre-edit cursor
Parametersindex
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.
Definition at line 4443 of file wayland-server-protocol-unstable.cpp.
std::function<void(uint32_t,std::string,std::string)>&zwp_input_method_context_v1_t::on_preedit_string()
pre-edit string
Parametersserial serial of the latest known text input state
textcommit
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.
Definition at line 4431 of file wayland-server-protocol-unstable.cpp.
std::function<void(uint32_t,uint32_t,zwp_text_input_v1_preedit_style)>&zwp_input_method_context_v1_t::on_preedit_styling()
pre-edit styling
Parametersindexlengthstyle
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.
Definition at line 4437 of file wayland-server-protocol-unstable.cpp.
std::function<void(uint32_t,uint32_t)>&zwp_input_method_context_v1_t::on_text_direction()Parametersserial serial of the latest known text input state
direction
Definition at line 4497 of file wayland-server-protocol-unstable.cpp.
voidwayland::server::resource_t::post_no_memory()const[inherited]
Post 'not enough memory' error to the client
If the compositor has not enough memory to fulfill a certail request of the client, this function can be
called to notify the client of this circumstance.
voidzwp_input_method_context_v1_t::preferred_language(std::stringconst&language,boolpost=true)Parameterslanguage
Definition at line 4528 of file wayland-server-protocol-unstable.cpp.
boolwayland::server::resource_t::proxy_has_object()const[inherited]
Check whether this wrapper actually wraps an object.
Returns
true if there is an underlying object, false if this wrapper is empty
voidzwp_input_method_context_v1_t::surrounding_text(std::stringconst&text,uint32_tcursor,uint32_tanchor,boolpost=true)
surrounding text event
Parameterstextcursoranchor
The plain surrounding text around the input position. Cursor is the position in bytes within the
surrounding text relative to the beginning of the text. Anchor is the position in bytes of the selection
anchor within the surrounding text relative to the beginning of the text. If there is no selected text
then anchor is the same as cursor.
Definition at line 4503 of file wayland-server-protocol-unstable.cpp.