|
libxkbcommon 1.13.0
Library implementing the XKB specification for parsing keyboard descriptions and handling keyboard state
|
Data Structures | |
| struct | xkb_state_components_update |
| struct | xkb_layout_policy_update |
| struct | xkb_state_update |
| struct | xkb_machine |
| struct | xkb_state |
| struct | xkb_event |
| struct | xkb_events |
| struct | xkb_machine_options |
Creating, destroying and manipulating keyboard state objects.
There are two distinct actors in most window-system architectures:
For example: a Wayland compositor, an X11 server or an evdev listener.
Servers maintain the XKB state for a device according to input events from the device, such as key presses and releases, and out-of-band events from the user, like UI layout switchers.
For example: a Wayland client or an X11 client.
Clients do not listen to input from the device; instead, whenever the server state changes, the server serializes the state and notifies the clients that the state has changed; the clients then update the state from the serialization.
There are two corresponding APIs:
xkb_machine: the server API This is the recommended API for server applications. It enables the full feature set that libxkbcommon supports.
xkb_machine is a Mealy machine: it is a finite-state machine that takes a stream of raw key events – a pair (keycode, direction) – as input, and produces a stream of atomic XKB events as output. The observable state of the machine is exposed via a companion xkb_state object updated with xkb_state::xkb_state_update_event().
Note that the xkb_machine API supports events other than state components changes, such as key press/release events, so that it enables to handle most of the XKB key actions.
See the example for a Wayland server in the quick guide.
xkb_state: the client API (and legacy server API) This is the API for client applications and the legacy API for server applications.
xkb_state API are only meant for servers and some are only meant for clients, and the two should generally not be mixed.xkb_machine API, which supports more features.See the examples for clients in the quick guide.
Some functions, like xkb_state::xkb_state_key_get_syms(), look at the state of the modifiers in the keymap and derive from it the correct shift level to use for the key. For example, in a US layout, pressing the key labeled <A> while the Shift modifier is active, generates the keysym A. In this case, the Shift modifier is said to be consumed. However, the Num Lock modifier does not affect this translation at all, even if it is active, so it is not consumed by this translation.
It may be desirable for some application to not reuse consumed modifiers for further processing, e.g. for hotkeys or keyboard shortcuts. To understand why, consider some requirements from a standard shortcut mechanism, and how they are implemented:
<Alt><Tab> and to <Alt><Shift><Tab>. Further, if only <Alt><Tab> is bound to an action, pressing <Alt><Shift><Tab> should not trigger the shortcut. Effectively, this means that the modifiers are compared using the equality operator (==).<Alt><Tab> against the state, it does not matter whether Num Lock is active or not. These relevant, or significant, modifiers usually include Alt, Control, Shift, Super and similar. Effectively, this means that non-significant modifiers are masked out, before doing the comparison as described above.<Plus> (+) symbol is found on the first level on some layouts, but requires holding Shift on others. If you simply bind the action to the <Plus> keysym, it would work for the unshifted kind, but not for the others, because the match against Shift would fail. If you bind the action to <Shift><Plus>, only the shifted kind would work. So what is needed is to recognize that Shift is used up in the translation of the keysym itself, and therefore should not be included in the matching. Effectively, this means that consumed modifiers (Shift in this example) are masked out as well, before doing the comparison.In summary, this is approximately how the matching would be performed:
state_mods are the modifiers reported by xkb_state::xkb_state_mod_index_is_active() and similar functions. consumed_mods are the modifiers reported by xkb_state::xkb_state_mod_index_is_consumed() and similar functions. significant_mods are decided upon by the application/toolkit/user; it is up to them to decide whether these are configurable or hard-coded.
| enum xkb_event_type |
Denotes the type of a state event.
| enum xkb_state_component |
Component types for state objects, which belong to the following categories:
This enum is bitmaskable, e.g. (XKB_STATE_MODS_DEPRESSED | XKB_STATE_MODS_LATCHED) is valid to exclude locked modifiers.
In XKB, the DEPRESSED components are also known as base.
| Enumerator | |
|---|---|
| XKB_STATE_MODS_DEPRESSED | Depressed modifiers, i.e. a key is physically holding them. |
| XKB_STATE_MODS_LATCHED | Latched modifiers, i.e. will be unset after the next non-modifier key press. |
| XKB_STATE_MODS_LOCKED | Locked modifiers, i.e. will be unset after the key provoking the lock has been pressed again. |
| XKB_STATE_MODS_EFFECTIVE | Effective modifiers, i.e. currently active and affect key processing (derived from the other state components). Use this unless you explicitly care how the state came about. |
| XKB_STATE_LAYOUT_DEPRESSED | Depressed layout, i.e. a key is physically holding it. |
| XKB_STATE_LAYOUT_LATCHED | Latched layout, i.e. will be unset after the next non-modifier key press. |
| XKB_STATE_LAYOUT_LOCKED | Locked layout, i.e. will be unset after the key provoking the lock has been pressed again. |
| XKB_STATE_LAYOUT_EFFECTIVE | Effective layout, i.e. currently active and affects key processing (derived from the other state components). Use this unless you explicitly care how the state came about. |
| XKB_STATE_LEDS | LEDs (derived from the other state components). |
| XKB_STATE_CONTROLS | Effective keyboard controls.
|
Boolean global keyboard controls, which affect the way libxkbcommon handles the keyboard as a whole.
This enumeration is bit-maskable.
| Enumerator | |
|---|---|
| XKB_KEYBOARD_CONTROL_NO_FLAGS | Do not apply any control.
|
| XKB_KEYBOARD_CONTROL_A11Y_STICKY_KEYS | Sticky keys is an accessibility feature primarily aimed at helping people that find it difficult or impossible to press two keys at once. The
|
| XKB_KEYBOARD_CONTROL_OVERLAY1 | Enable the keyboard overlay 1.
|
| XKB_KEYBOARD_CONTROL_OVERLAY2 | Enable the keyboard overlay 2.
|
| XKB_KEYBOARD_CONTROL_OVERLAY3 | Enable the keyboard overlay 3.
|
| XKB_KEYBOARD_CONTROL_OVERLAY4 | Enable the keyboard overlay 4.
|
| XKB_KEYBOARD_CONTROL_OVERLAY5 | Enable the keyboard overlay 5.
|
| XKB_KEYBOARD_CONTROL_OVERLAY6 | Enable the keyboard overlay 6.
|
| XKB_KEYBOARD_CONTROL_OVERLAY7 | Enable the keyboard overlay 7.
|
| XKB_KEYBOARD_CONTROL_OVERLAY8 | Enable the keyboard overlay 8.
|
| enum xkb_events_flags |
Flags for xkb_events::xkb_events_new_batch().
| Enumerator | |
|---|---|
| XKB_EVENTS_NO_FLAGS | Do not apply any flags.
|
| enum xkb_a11y_flags |
Flags for xkb_machine_options::xkb_machine_options_update_a11y_flags().
These flags configure the accessibility (a11y) features.
| Enumerator | |
|---|---|
| XKB_A11Y_NO_FLAGS | Do not apply any flags.
|
| XKB_A11Y_LATCH_TO_LOCK | If both The user can press a latch modifier twice in a row to lock it, and then unlock it by pressing it one more time.
|
| XKB_A11Y_LATCH_SIMULTANEOUS_KEYS | Without this option, the latch keys are only triggers if keys are strictly sequentially tapped, e.g.:
If one wants multiple active latches, they must be tapped in sequence: e.g.:
This option relaxes the strict sequence requirement and enable to operate keys that do not break latches simultaneously with a latch key, e.g.:
This is an extension to the X11 XKB protocol and is enabled by default when using
|
| enum xkb_key_direction |
Policies defining how to bring out-of-range layout indices into range.
| Enumerator | |
|---|---|
| XKB_LAYOUT_OUT_OF_RANGE_WRAP | Wrap into range using integer modulus (default).
|
| XKB_LAYOUT_OUT_OF_RANGE_CLAMP | Clamp into range, i.e. invalid indices are corrected to the closest valid bound (0 or highest layout index).
|
| XKB_LAYOUT_OUT_OF_RANGE_REDIRECT | Redirect to a specific layout index.
|
| enum xkb_state_match |
Match flags for xkb_state::xkb_state_mod_indices_are_active() and xkb_state::xkb_state_mod_names_are_active(), specifying the conditions for a successful match.
XKB_STATE_MATCH_NON_EXCLUSIVE is bitmaskable with the other modes.
| enum xkb_consumed_mode |
Consumed modifiers mode.
There are several possible methods for deciding which modifiers are consumed and which are not, each applicable for different systems or situations. The mode selects the method to use.
Keep in mind that in all methods, the keymap may decide to preserve a modifier, meaning it is not reported as consumed even if it would have otherwise.
| Enumerator | |
|---|---|
| XKB_CONSUMED_MODE_XKB | This is the mode defined in the XKB specification and used by libX11. A modifier is consumed if and only if it may affect key translation. For example, if |
| XKB_CONSUMED_MODE_GTK | This is the mode used by the GTK+ toolkit. The mode consists of the following two independent heuristics:
|
| XKB_EXPORT enum xkb_event_type xkb_event_get_type | ( | const struct xkb_event * | event | ) |
| XKB_EXPORT xkb_keycode_t xkb_event_get_keycode | ( | const struct xkb_event * | event | ) |
Get the keycode associated to a state event of type XKB_EVENT_TYPE_KEY_DOWN, XKB_EVENT_TYPE_KEY_REPEATED or XKB_EVENT_TYPE_KEY_UP.
| event | The event to process. |
XKB_EVENT_TYPE_KEY_DOWN or XKB_EVENT_TYPE_KEY_REPEATED or XKB_EVENT_TYPE_KEY_UP, returns the corresponding keycode. | XKB_EXPORT enum xkb_state_component xkb_event_get_changed_components | ( | const struct xkb_event * | event | ) |
Get the state components changes corresponding to a state event of type XKB_EVENT_TYPE_COMPONENTS_CHANGE .
| event | The event to process. |
XKB_EVENT_TYPE_COMPONENTS_CHANGE, returns the corresponding mask of state components that have changed. If nothing in the state has changed, returns 0. | XKB_EXPORT enum xkb_keyboard_control_flags xkb_event_serialize_enabled_controls | ( | const struct xkb_event * | event, |
| enum xkb_state_component | components | ||
| ) |
Serialization of the boolean global keyboard controls corresponding to a state event of type XKB_EVENT_TYPE_COMPONENTS_CHANGE .
| event | The state event. |
| components | A mask of the keyboard control state components to serialize. State components other than XKB_STATE_CONTROLS are ignored. |
XKB_EVENT_TYPE_COMPONENTS_CHANGE returns the corresponding xkb_keyboard_control_flags mask. | XKB_EXPORT xkb_mod_mask_t xkb_event_serialize_mods | ( | const struct xkb_event * | event, |
| enum xkb_state_component | components | ||
| ) |
Serialization of the modifiers corresponding to a state event of type XKB_EVENT_TYPE_COMPONENTS_CHANGE .
| event | The state event. |
| components | A mask of the modifier state components to serialize. State components other than XKB_STATE_MODS_* are ignored. If XKB_STATE_MODS_EFFECTIVE is included, all other state components are ignored. |
XKB_EVENT_TYPE_COMPONENTS_CHANGE returns the corresponding xkb_mod_mask_t mask representing the given components of the modifier state. | XKB_EXPORT xkb_layout_index_t xkb_event_serialize_layout | ( | const struct xkb_event * | event, |
| enum xkb_state_component | components | ||
| ) |
Serialization of the layout corresponding to a state event of type XKB_EVENT_TYPE_COMPONENTS_CHANGE .
| event | The state event. |
| components | A mask of the layout state components to serialize. State components other than XKB_STATE_LAYOUT_* are ignored. If XKB_STATE_LAYOUT_EFFECTIVE is included, all other state components are ignored. |
XKB_EVENT_TYPE_COMPONENTS_CHANGE returns the corresponding layout index representing the given components of the layout state. | XKB_EXPORT struct xkb_events * xkb_events_new_batch | ( | struct xkb_context * | context, |
| enum xkb_events_flags | flags | ||
| ) |
Create a new event batch.
| context | The context in which to create the batch. |
| flags | Optional flags for the batch, or 0. |
NULL on failure.| XKB_EXPORT void xkb_events_destroy | ( | struct xkb_events * | events | ) |
Free an event collection.
| events | The event collection to free. If it is NULL, this function does nothing. |
xkb_events_new_batch() | XKB_EXPORT const struct xkb_event * xkb_events_next | ( | struct xkb_events * | events | ) |
Get the next event from an event collection.
| events | The event collection. |
NULL if there are no more events to read.| XKB_EXPORT struct xkb_machine_options * xkb_machine_options_new | ( | struct xkb_context * | context | ) |
Create a new xkb_machine options object.
| context | The context in which to create the options. |
xkb_machine options object, or NULL on failure.| XKB_EXPORT void xkb_machine_options_destroy | ( | struct xkb_machine_options * | options | ) |
Free a xkb_machine options object.
| options | The xkb_machine options. If it is NULL, this function does nothing. |
| XKB_EXPORT enum xkb_error_code xkb_machine_options_update_a11y_flags | ( | struct xkb_machine_options * | options, |
| enum xkb_a11y_flags | affect, | ||
| enum xkb_a11y_flags | flags | ||
| ) |
Update the accessibility flags of an xkb_machine_options object.
| options | The state_machine options object to modify. |
| affect | Accessibility flags to modify. |
| flags | Accessibility flags to set or unset. Only the flags in affect are considered. |
XKB_SUCCESS on success, otherwise an error code.| XKB_EXPORT enum xkb_error_code xkb_machine_options_remap_mods | ( | struct xkb_machine_options * | options, |
| xkb_mod_mask_t | source, | ||
| xkb_mod_mask_t | target | ||
| ) |
Remap a modifier combination, e.g.
to make Control+Alt act as LevelThree (AltGr). This help improving compatibility across platforms.
The remapping takes effect only using xkb_machine::xkb_machine_process_key() and under certain conditions:
Control+Alt has priority over Control.| options | The state_machine options object to modify. |
| source | Modifier combination to remap, using their encoding. Must be non-zero, unless both source and target are 0 to clear all entries. |
| target | Modifier combination to remap to, using their encoding, or 0 to remove the entry for source. If both source and target are 0, all entries are cleared. |
XKB_SUCCESS on success, otherwise an error code.Example:
| XKB_EXPORT enum xkb_error_code xkb_machine_options_update_shortcut_mods | ( | struct xkb_machine_options * | options, |
| xkb_mod_mask_t | affect, | ||
| xkb_mod_mask_t | mask | ||
| ) |
Set the modifiers that trigger shortcuts keyboard layout override.
When any of the specified modifiers is active, the effective layout is substituted according to the mapping set by xkb_machine_options_remap_shortcut_layout(). This ensures a consistent user experience with keyboard shortcuts across the layouts.
| [in,out] | options | The state_machine options object to modify. |
| [in] | affect | Modifiers to consider, using their encoding. Only modifiers present in this mask are modified by mask. |
| [in] | mask | Modifiers to set, using their encoding. Only the modifiers in affect are considered. |
XKB_SUCCESS on success, otherwise an error code.| XKB_EXPORT enum xkb_error_code xkb_machine_options_remap_shortcut_layout | ( | struct xkb_machine_options * | options, |
| xkb_layout_index_t | source, | ||
| xkb_layout_index_t | target | ||
| ) |
Set a layout substitution for the shortcut layout override.
When any modifier set via xkb_machine_options_update_shortcut_mods() is active, the effective layout source is substituted with layout target in key processing. This allows shortcuts defined in layout target (typically a Latin layout) to remain reachable when layout source is active.
| [in,out] | options | The state_machine options object to modify. |
| [in] | source | Source layout to substitute. |
| [in] | target | Target layout to use instead of source. |
XKB_SUCCESS on success, otherwise an error code.| XKB_EXPORT struct xkb_machine * xkb_machine_new | ( | struct xkb_keymap * | keymap, |
| const struct xkb_machine_options * | options | ||
| ) |
Create a new keyboard state machine object.
This entry point is intended for server applications; client applications should not run a state machine locally: instead they should use the xkb_state API and process server state update using xkb_state::xkb_state_update_mask(). See Server State and Client State for further information.
| keymap | The keymap which the state machine will use. |
| options | The options to configure the state machine, or NULL to use the defaults. |
NULL on failure.| XKB_EXPORT struct xkb_machine * xkb_machine_ref | ( | struct xkb_machine * | machine | ) |
Take a new reference on a xkb_machine object.
| machine | The state machine. |
| XKB_EXPORT void xkb_machine_unref | ( | struct xkb_machine * | machine | ) |
Release a reference on a xkb_machine object, and possibly free it.
| machine | The state machine. If it is NULL, this function does nothing. |
| XKB_EXPORT struct xkb_keymap * xkb_machine_get_keymap | ( | const struct xkb_machine * | machine | ) |
Get the keymap which a xkb_machine object is using.
| machine | The state machine. |
xkb_machine_new() when creating this xkb_machine object.xkb_machine object.| XKB_EXPORT enum xkb_error_code xkb_machine_process_key | ( | struct xkb_machine * | machine, |
| xkb_keycode_t | key, | ||
| enum xkb_key_direction | direction, | ||
| struct xkb_events * | events | ||
| ) |
Process a key event – a pair (keycode, direction) – through the XKB state machine, and collect the resulting keyboard events into an event batch.
The produced events form a single frame.
Use this function for in-band (device) inputs. Use xkb_machine_update_synthetic() instead to update the state machine in response to out-of-band (non-device) inputs, such as UI layout switchers or accessibility settings changes.
A series of calls to this function should be consistent; that is, a call with XKB_KEY_DOWN for a key should be matched by an XKB_KEY_UP; if a key is pressed twice, it should be released twice; etc. Otherwise (e.g. due to missed input events), situations like “stuck modifiers” may occur.
| [in,out] | machine | The XKB state machine object. |
| [in] | key | The keycode of the key being operated. |
| [in] | direction | The direction of the key operation. |
| [out] | events | The event batch to collect events into. It will be reset before collecting. |
XKB_SUCCESS on success, otherwise an error code.xkb_machine_update_synthetic() | XKB_EXPORT enum xkb_error_code xkb_machine_process_synthetic | ( | struct xkb_machine * | machine, |
| const struct xkb_state_update * | update, | ||
| struct xkb_events * | events | ||
| ) |
Process a synthetic (out-of-band) atomic update through the XKB state machine, and collect the resulting keyboard events into an event batch.
Use this function to update the state machine in response to out-of-band (non-device) inputs, such as UI layout switchers or accessibility settings changes. Use xkb_machine_process_key() instead for in-band (device) inputs.
All changes specified in update are applied atomically as a single frame: the resulting events reflect the net state change at the end of the frame, not intermediate steps. In particular, a XKB_EVENT_TYPE_COMPONENTS_CHANGE event in the batch represents the cumulative state change for the entire frame — individual intermediate state transitions are not observable.
Only latched, locked and control components can be updated out-of-band; depressed components can only change through key presses via xkb_machine_process_key().
xkb_layout_out_of_range_policy). | [in,out] | machine | The XKB state machine object. |
| [in] | update | The update to apply. Must have xkb_state_update::size set. |
| [out] | events | The event batch to collect events into. It will be reset before collecting. |
XKB_SUCCESS on success, otherwise an error code.| XKB_EXPORT struct xkb_state * xkb_state_new | ( | struct xkb_keymap * | keymap | ) |
Create a new keyboard state object.
This entry point is intended for both server and client applications.
| keymap | The keymap which the state will use. |
NULL on failure. Take a new reference on a keyboard state object.
| XKB_EXPORT void xkb_state_unref | ( | struct xkb_state * | state | ) |
Release a reference on a keyboard state object, and possibly free it.
| state | The state. If it is NULL, this function does nothing. |
| XKB_EXPORT struct xkb_keymap * xkb_state_get_keymap | ( | struct xkb_state * | state | ) |
Get the keymap which a keyboard state object is using.
xkb_state_new() when creating this state object.| XKB_EXPORT enum xkb_state_component xkb_state_update_key | ( | struct xkb_state * | state, |
| xkb_keycode_t | key, | ||
| enum xkb_key_direction | direction | ||
| ) |
Update the keyboard state to reflect a given key being pressed or released.
This entry point is intended for server applications and should not be used by client applications; see Server State and Client State for details.
A series of calls to this function should be consistent; that is, a call with XKB_KEY_DOWN for a key should be matched by an XKB_KEY_UP; if a key is pressed twice, it should be released twice; etc. Otherwise (e.g. due to missed input events), situations like “stuck modifiers” may occur.
This function is often used in conjunction with the function xkb_state_key_get_syms() (or xkb_state_key_get_one_sym()), for example, when handling a key event. In this case, you should prefer to get the keysyms before updating the key, such that the keysyms reported for the key event are not affected by the event itself. This is the conventional behavior.
xkb_machine for new server applications to enable the full feature set.| state | The keyboard state object. |
| key | The key being operated. |
| direction | The direction of the key operation. |
xkb_state_update_mask() | XKB_EXPORT enum xkb_error_code xkb_state_update_synthetic | ( | struct xkb_state * | state, |
| const struct xkb_state_update * | update, | ||
| enum xkb_state_component * | changed | ||
| ) |
Apply a synthetic (out-of-band) atomic update to the keyboard state.
This entry point is intended for server applications and should not be used by client applications; see Server State and Client State for details.
xkb_state_update_key() instead for in-band (device) inputs.xkb_state_update_event() instead when updating from an event produced by xkb_machine.Only latched, locked and control components can be updated out-of-band; depressed components can only change through key presses via xkb_state_update_key().
xkb_layout_out_of_range_policy). | [in,out] | state | The keyboard state object. |
| [in] | update | The update to apply. Must have xkb_state_update::size set. |
| [out] | changed | A pointer to store the mask of state components that have changed as a result of the update, or NULL to ignore. Set to 0 if nothing in the state has changed. |
XKB_SUCCESS on success, otherwise an error code.xkb_state_update_* functions), in order to align with the xkb_machine::xkb_machine_process_synthetic() API. The delta is optionally available via the changed parameter.| XKB_EXPORT enum xkb_state_component xkb_state_update_event | ( | struct xkb_state * | state, |
| const struct xkb_event * | event | ||
| ) |
Update the keyboard state components from an event.
This entry point is intended for server applications and should not be used by client applications; see Server State and Client State for details.
It enables server applications to use xkb_state as the observable state companion to an xkb_machine: feed each event produced by xkb_machine::xkb_machine_process_key() or xkb_machine::xkb_machine_process_synthetic() into this function to keep the observable state in sync.
xkb_state_update_key().| [in,out] | state | The keyboard state object. |
| [in] | event | The state event to update from. |
| XKB_EXPORT enum xkb_state_component xkb_state_update_latched_locked | ( | struct xkb_state * | state, |
| xkb_mod_mask_t | affect_latched_mods, | ||
| xkb_mod_mask_t | latched_mods, | ||
| bool | affect_latched_layout, | ||
| int32_t | latched_layout, | ||
| xkb_mod_mask_t | affect_locked_mods, | ||
| xkb_mod_mask_t | locked_mods, | ||
| bool | affect_locked_layout, | ||
| int32_t | locked_layout | ||
| ) |
Update the keyboard state to change the latched and locked state of the modifiers and layout.
This entry point is intended for server applications and should not be used by client applications; see Server State and Client State for details.
Use this function to update the latched and locked state according to out-of-band (non-device) inputs, such as UI layout switchers.
If the effective layout, after taking into account the depressed, latched and locked layout, is out of range (negative or greater than the maximum layout), it is brought into range. Currently, the layout is wrapped using integer modulus (with negative values wrapping from the end). The wrapping behavior can be configured using xkb_state_update_synthetic().
| state | The keyboard state object. |
| affect_latched_mods | See latched_mods. |
| latched_mods | Modifiers to set as latched or unlatched. Only modifiers in affect_latched_mods are considered. |
| affect_latched_layout | See latched_layout. |
| latched_layout | Layout to latch. Only considered if affect_latched_layout is true. May be out of range (including negative) – see note above. |
| affect_locked_mods | See locked_mods. |
| locked_mods | Modifiers to set as locked or unlocked. Only modifiers in affect_locked_mods are considered. |
| affect_locked_layout | See locked_layout. |
| locked_layout | Layout to lock. Only considered if affect_locked_layout is true. May be out of range (including negative) – see note above. |
xkb_state_update_synthetic() instead.xkb_state_update_mask() | XKB_EXPORT enum xkb_state_component xkb_state_update_mask | ( | struct xkb_state * | state, |
| xkb_mod_mask_t | depressed_mods, | ||
| xkb_mod_mask_t | latched_mods, | ||
| xkb_mod_mask_t | locked_mods, | ||
| xkb_layout_index_t | depressed_layout, | ||
| xkb_layout_index_t | latched_layout, | ||
| xkb_layout_index_t | locked_layout | ||
| ) |
Update a keyboard state from a set of explicit masks.
This entry point is intended for client applications; see Server State and Client State for details. Server applications should use xkb_state_update_key() instead.
All parameters must always be passed, or the resulting state may be incoherent.
| XKB_EXPORT int xkb_state_key_get_syms | ( | struct xkb_state * | state, |
| xkb_keycode_t | key, | ||
| const xkb_keysym_t ** | syms_out | ||
| ) |
Get the keysyms obtained from pressing a particular key in a given keyboard state.
Get the keysyms for a key according to the current active layout, modifiers and shift level for the key, as determined by a keyboard state.
| [in] | state | The keyboard state object. |
| [in] | key | The keycode of the key. |
| [out] | syms_out | An immutable array of keysyms corresponding the key in the given keyboard state. |
As an extension to XKB, this function can return more than one keysym. If you do not want to handle this case, you can use xkb_state_key_get_one_sym() for a simpler interface.
NULL.This function performs Capitalization Keysym Transformations.
| XKB_EXPORT int xkb_state_key_get_utf8 | ( | struct xkb_state * | state, |
| xkb_keycode_t | key, | ||
| char * | buffer, | ||
| size_t | size | ||
| ) |
Get the Unicode/UTF-8 string obtained from pressing a particular key in a given keyboard state.
| [in] | state | The keyboard state object. |
| [in] | key | The keycode of the key. |
| [out] | buffer | A buffer to write the string into. |
| [in] | size | Capacity of the buffer. |
NULL-terminated).NULL byte. If there is nothing to write, returns 0.You may check if truncation has occurred by comparing the return value with the size of buffer, similarly to the snprintf(3) function. You may safely pass NULL and 0 to buffer and size to find the required size (without the NULL-byte).
This function performs Capitalization and Control Keysym Transformations.
| XKB_EXPORT uint32_t xkb_state_key_get_utf32 | ( | struct xkb_state * | state, |
| xkb_keycode_t | key | ||
| ) |
Get the Unicode/UTF-32 codepoint obtained from pressing a particular key in a a given keyboard state.
This function performs Capitalization and Control Keysym Transformations.
| XKB_EXPORT xkb_keysym_t xkb_state_key_get_one_sym | ( | struct xkb_state * | state, |
| xkb_keycode_t | key | ||
| ) |
Get the single keysym obtained from pressing a particular key in a given keyboard state.
This function is similar to xkb_state_key_get_syms(), but intended for users which cannot or do not want to handle the case where multiple keysyms are returned (in which case this function is preferred).
XKB_KEY_NoSymbol.This function performs Capitalization Keysym Transformations.
| XKB_EXPORT xkb_layout_index_t xkb_state_key_get_layout | ( | struct xkb_state * | state, |
| xkb_keycode_t | key | ||
| ) |
Get the effective layout index for a key in a given keyboard state.
XKB_LAYOUT_INVALID.| XKB_EXPORT xkb_level_index_t xkb_state_key_get_level | ( | struct xkb_state * | state, |
| xkb_keycode_t | key, | ||
| xkb_layout_index_t | layout | ||
| ) |
Get the effective shift level for a key in a given keyboard state and layout.
| state | The keyboard state. |
| key | The keycode of the key. |
| layout | The layout for which to get the shift level. This must be smaller than: xkb_keymap_num_layouts_for_key(keymap, key)
xkb_state_key_get_layout(state, key)
|
XKB_LEVEL_INVALID.| XKB_EXPORT enum xkb_keyboard_control_flags xkb_state_serialize_enabled_controls | ( | const struct xkb_state * | state, |
| enum xkb_state_component | components | ||
| ) |
Serialization of the boolean global keyboard controls, to be used on the server side of serialization.
This entry point is intended for server applications; see Server State and Client State for details.
| state | The keyboard state. |
| components | A mask of the keyboard control state components to serialize. State components other than XKB_STATE_CONTROLS are ignored. |
xkb_keyboard_control_flags mask representing the enabled keyboard controls for the given components.| XKB_EXPORT xkb_mod_mask_t xkb_state_serialize_mods | ( | struct xkb_state * | state, |
| enum xkb_state_component | components | ||
| ) |
The counterpart to xkb_state::xkb_state_update_mask() for modifiers, to be used on the server side of serialization.
This entry point is intended for server applications; see Server State and Client State for details. Client applications should use the xkb_state_mod_*_is_active API.
| state | The keyboard state. |
| components | A mask of the modifier state components to serialize. State components other than XKB_STATE_MODS_* are ignored. If XKB_STATE_MODS_EFFECTIVE is included, all other state components are ignored. |
xkb_mod_mask_t representing the given components of the modifier state. | XKB_EXPORT xkb_layout_index_t xkb_state_serialize_layout | ( | struct xkb_state * | state, |
| enum xkb_state_component | components | ||
| ) |
The counterpart to xkb_state::xkb_state_update_mask() for layouts, to be used on the server side of serialization.
This entry point is intended for server applications; see Server State and Client State for details. Client applications should use the xkb_state_layout_*_is_active API.
| state | The keyboard state. |
| components | A mask of the layout state components to serialize. State components other than XKB_STATE_LAYOUT_* are ignored. If XKB_STATE_LAYOUT_EFFECTIVE is included, all other state components are ignored. |
| XKB_EXPORT int xkb_state_mod_name_is_active | ( | struct xkb_state * | state, |
| const char * | name, | ||
| enum xkb_state_component | type | ||
| ) |
Test whether a modifier is active in a given keyboard state by name.
| XKB_EXPORT int xkb_state_mod_names_are_active | ( | struct xkb_state * | state, |
| enum xkb_state_component | type, | ||
| enum xkb_state_match | match, | ||
| ... | |||
| ) |
Test whether a set of modifiers are active in a given keyboard state by name.
| state | The keyboard state. |
| type | The component of the state against which to match the given modifiers. |
| match | The manner by which to match the state against the given modifiers. |
| ... | The set of of modifier names to test, terminated by a NULL argument (sentinel). |
match contains invalid flags, returns -2.match flags | XKB_EXPORT int xkb_state_mod_index_is_active | ( | struct xkb_state * | state, |
| xkb_mod_index_t | idx, | ||
| enum xkb_state_component | type | ||
| ) |
Test whether a modifier is active in a given keyboard state by index.
| XKB_EXPORT int xkb_state_mod_indices_are_active | ( | struct xkb_state * | state, |
| enum xkb_state_component | type, | ||
| enum xkb_state_match | match, | ||
| ... | |||
| ) |
Test whether a set of modifiers are active in a given keyboard state by index.
| state | The keyboard state. |
| type | The component of the state against which to match the given modifiers. |
| match | The manner by which to match the state against the given modifiers. |
| ... | The set of of modifier indices to test, terminated by a XKB_MOD_INVALID argument (sentinel). |
match contains invalid flags, returns -2.match flags | XKB_EXPORT xkb_mod_mask_t xkb_state_key_get_consumed_mods2 | ( | struct xkb_state * | state, |
| xkb_keycode_t | key, | ||
| enum xkb_consumed_mode | mode | ||
| ) |
Get the mask of modifiers consumed by translating a given key.
| state | The keyboard state. |
| key | The keycode of the key. |
| mode | The consumed modifiers mode to use; see enum description. |
| XKB_EXPORT xkb_mod_mask_t xkb_state_key_get_consumed_mods | ( | struct xkb_state * | state, |
| xkb_keycode_t | key | ||
| ) |
Same as xkb_state_key_get_consumed_mods2() with mode XKB_CONSUMED_MODE_XKB.
| XKB_EXPORT int xkb_state_mod_index_is_consumed2 | ( | struct xkb_state * | state, |
| xkb_keycode_t | key, | ||
| xkb_mod_index_t | idx, | ||
| enum xkb_consumed_mode | mode | ||
| ) |
Test whether a modifier is consumed by keyboard state translation for a key.
| state | The keyboard state. |
| key | The keycode of the key. |
| idx | The index of the modifier to check. |
| mode | The consumed modifiers mode to use; see enum description. |
| XKB_EXPORT int xkb_state_mod_index_is_consumed | ( | struct xkb_state * | state, |
| xkb_keycode_t | key, | ||
| xkb_mod_index_t | idx | ||
| ) |
Same as xkb_state_mod_index_is_consumed2() with mode XKB_CONSUMED_MODE_XKB.
| XKB_EXPORT xkb_mod_mask_t xkb_state_mod_mask_remove_consumed | ( | struct xkb_state * | state, |
| xkb_keycode_t | key, | ||
| xkb_mod_mask_t | mask | ||
| ) |
Remove consumed modifiers from a modifier mask for a key.
xkb_state_key_get_consumed_mods2() instead.Takes the given modifier mask, and removes all modifiers which are consumed for that particular key (as in xkb_state_mod_index_is_consumed()).
| XKB_EXPORT int xkb_state_layout_name_is_active | ( | struct xkb_state * | state, |
| const char * | name, | ||
| enum xkb_state_component | type | ||
| ) |
Test whether a layout is active in a given keyboard state by name.
If multiple layouts in the keymap have this name, the one with the lowest index is tested.
| XKB_EXPORT int xkb_state_layout_index_is_active | ( | struct xkb_state * | state, |
| xkb_layout_index_t | idx, | ||
| enum xkb_state_component | type | ||
| ) |
Test whether a layout is active in a given keyboard state by index.
| XKB_EXPORT int xkb_state_led_name_is_active | ( | struct xkb_state * | state, |
| const char * | name | ||
| ) |
Test whether a LED is active in a given keyboard state by name.
| XKB_EXPORT int xkb_state_led_index_is_active | ( | struct xkb_state * | state, |
| xkb_led_index_t | idx | ||
| ) |
Test whether a LED is active in a given keyboard state by index.
1.9.8