input_method_unstable_v1 Module¶
ZwpInputMethodContextV1¶
-
class
pywayland.protocol.input_method_unstable_v1.
ZwpInputMethodContextV1
¶ 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.
-
destroy
() → 'None'¶ Request – opcode 0 (attached to
Resource
instance)destroy
-
commit_string
(serial: 'int', text: 'str') → 'None'¶ Request – opcode 1 (attached to
Resource
instance)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.
Parameters: - serial (ArgumentType.Uint) – serial of the latest known text input state
- text (ArgumentType.String) –
-
preedit_string
(serial: 'int', text: 'str', commit: 'str') → 'None'¶ Request – opcode 2 (attached to
Resource
instance)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.
Parameters: - serial (ArgumentType.Uint) – serial of the latest known text input state
- text (ArgumentType.String) –
- commit (ArgumentType.String) –
-
preedit_styling
(index: 'int', length: 'int', style: 'int') → 'None'¶ Request – opcode 3 (attached to
Resource
instance)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.
Parameters: - index (ArgumentType.Uint) –
- length (ArgumentType.Uint) –
- style (ArgumentType.Uint) –
-
preedit_cursor
(index: 'int') → 'None'¶ Request – opcode 4 (attached to
Resource
instance)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.
Parameters: index (ArgumentType.Int) –
-
delete_surrounding_text
(index: 'int', length: 'int') → 'None'¶ Request – opcode 5 (attached to
Resource
instance)Delete text
Remove the surrounding text.
This request will be handled on the text_input side directly following a commit_string request.
Parameters: - index (ArgumentType.Int) –
- length (ArgumentType.Uint) –
-
cursor_position
(index: 'int', anchor: 'int') → 'None'¶ Request – opcode 6 (attached to
Resource
instance)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.
Parameters: - index (ArgumentType.Int) –
- anchor (ArgumentType.Int) –
-
modifiers_map
(map: 'list') → 'None'¶ Request – opcode 7 (attached to
Resource
instance)modifiers_map
Parameters: map (ArgumentType.Array) –
-
keysym
(serial: 'int', time: 'int', sym: 'int', state: 'int', modifiers: 'int') → 'None'¶ Request – opcode 8 (attached to
Resource
instance)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
WlKeyboard
key event convention. Sym is an XKB keysym, state is aWlKeyboard
key_state.Parameters: - serial (ArgumentType.Uint) – serial of the latest known text input state
- time (ArgumentType.Uint) –
- sym (ArgumentType.Uint) –
- state (ArgumentType.Uint) –
- modifiers (ArgumentType.Uint) –
-
grab_keyboard
() → 'Proxy[WlKeyboard]'¶ Request – opcode 9 (attached to
Resource
instance)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.
Returns: WlKeyboard
-
key
(serial: 'int', time: 'int', key: 'int', state: 'int') → 'None'¶ Request – opcode 10 (attached to
Resource
instance)Forward key event
Forward a
WlKeyboard
::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 theWlKeyboard
::key event.For generating custom key events use the keysym request instead.
Parameters: - serial (ArgumentType.Uint) – serial from
WlKeyboard
::key - time (ArgumentType.Uint) – time from
WlKeyboard
::key - key (ArgumentType.Uint) – key from
WlKeyboard
::key - state (ArgumentType.Uint) – state from
WlKeyboard
::key
- serial (ArgumentType.Uint) – serial from
-
modifiers
(serial: 'int', mods_depressed: 'int', mods_latched: 'int', mods_locked: 'int', group: 'int') → 'None'¶ Request – opcode 11 (attached to
Resource
instance)Forward modifiers event
Forward a
WlKeyboard
::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 theWlKeyboard
::modifiers event.Parameters: - serial (ArgumentType.Uint) – serial from
WlKeyboard
::modifiers - mods_depressed (ArgumentType.Uint) – mods_depressed from
WlKeyboard
::modifiers - mods_latched (ArgumentType.Uint) – mods_latched from
WlKeyboard
::modifiers - mods_locked (ArgumentType.Uint) – mods_locked from
WlKeyboard
::modifiers - group (ArgumentType.Uint) – group from
WlKeyboard
::modifiers
- serial (ArgumentType.Uint) – serial from
-
language
(serial: 'int', language: 'str') → 'None'¶ Request – opcode 12 (attached to
Resource
instance)language
Parameters: - serial (ArgumentType.Uint) – serial of the latest known text input state
- language (ArgumentType.String) –
-
text_direction
(serial: 'int', direction: 'int') → 'None'¶ Request – opcode 13 (attached to
Resource
instance)text_direction
Parameters: - serial (ArgumentType.Uint) – serial of the latest known text input state
- direction (ArgumentType.Uint) –
-
surrounding_text
(text: 'str', cursor: 'int', anchor: 'int') → 'None'¶ Event – opcode 0 (attached to
Proxy
instance)Surrounding text event
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.
Parameters: - text (ArgumentType.String) –
- cursor (ArgumentType.Uint) –
- anchor (ArgumentType.Uint) –
-
reset
() → 'None'¶ Event – opcode 1 (attached to
Proxy
instance)reset
-
content_type
(hint: 'int', purpose: 'int') → 'None'¶ Event – opcode 2 (attached to
Proxy
instance)content_type
Parameters: - hint (ArgumentType.Uint) –
- purpose (ArgumentType.Uint) –
-
invoke_action
(button: 'int', index: 'int') → 'None'¶ Event – opcode 3 (attached to
Proxy
instance)invoke_action
Parameters: - button (ArgumentType.Uint) –
- index (ArgumentType.Uint) –
-
commit_state
(serial: 'int') → 'None'¶ Event – opcode 4 (attached to
Proxy
instance)commit_state
Parameters: serial (ArgumentType.Uint) – serial of text input state
-
preferred_language
(language: 'str') → 'None'¶ Event – opcode 5 (attached to
Proxy
instance)preferred_language
Parameters: language (ArgumentType.String) –
-
ZwpInputPanelV1¶
-
class
pywayland.protocol.input_method_unstable_v1.
ZwpInputPanelV1
¶ Interface for implementing keyboards
Only one client can bind this interface at a time.
-
get_input_panel_surface
(surface: 'WlSurface') → 'Proxy[ZwpInputPanelSurfaceV1]'¶ Request – opcode 0 (attached to
Resource
instance)get_input_panel_surface
Parameters: surface ( WlSurface
) –Returns: ZwpInputPanelSurfaceV1
-
ZwpInputMethodV1¶
-
class
pywayland.protocol.input_method_unstable_v1.
ZwpInputMethodV1
¶ Input method
An input method object is responsible for composing text in response to input from hardware or virtual keyboards. There is one input method object per seat. On activate there is a new input method context object created which allows the input method to communicate with the text input.
-
activate
(id: 'ZwpInputMethodContextV1') → 'None'¶ Event – opcode 0 (attached to
Proxy
instance)Activate event
A text input was activated. Creates an input method context object which allows communication with the text input.
Parameters: id ( ZwpInputMethodContextV1
) –
-
deactivate
(context: 'ZwpInputMethodContextV1') → 'None'¶ Event – opcode 1 (attached to
Proxy
instance)Deactivate event
The text input corresponding to the context argument was deactivated. The input method context should be destroyed after deactivation is handled.
Parameters: context ( ZwpInputMethodContextV1
) –
-
ZwpInputPanelSurfaceV1¶
-
class
pywayland.protocol.input_method_unstable_v1.
ZwpInputPanelSurfaceV1
¶ -
set_toplevel
(output: 'WlOutput', position: 'int') → 'None'¶ Request – opcode 0 (attached to
Resource
instance)Set the surface type as a keyboard
Set the input_panel_surface type to keyboard.
A keyboard surface is only shown when a text input is active.
Parameters: - output (
WlOutput
) – - position (ArgumentType.Uint) –
- output (
-
set_overlay_panel
() → 'None'¶ Request – opcode 1 (attached to
Resource
instance)Set the surface type as an overlay panel
Set the input_panel_surface to be an overlay panel.
This is shown near the input cursor above the application window when a text input is active.
-