.
1. NAME▲
XkbGetUpdatedMap - Update the client or server map information in an existing keyboard description
2. SYNOPSIS ▲
Status XkbGetUpdatedMap (Display * display , unsigned int which , XkbDescPtr xkb );
3. ARGUMENTS ▲
- - display
connection to X server - - which
mask selecting subcomponents to populate - - xkb
keyboard description to be updated
4. DESCRIPTION ▲
The whichparameter is a bitwise inclusive OR of the masks in Table 1. If the needed components of the xkbstructure are not already allocated, XkbGetUpdatedMapallocates them. XkbGetUpdatedMapfetches the requested information for the device specified in the XkbDescRec passed in the xkbparameter.
| c s s s s | ||||
| c s s s s | ||||
| l l l l l | ||||
| l l l l l | ||||
| lw(3i) l l lw(1i) lw(3i). | ||||
| Table 1 Xkb Mapping Component Masks | ||||
| and Convenience Functions | ||||
| _ | ||||
| Mask | Value | Map | Fields | Convenience |
| Functions | ||||
| _ | ||||
| T{ | ||||
| XkbKeyTypesMask | ||||
| T} | (1<<0) | client | T{ | |
| types | ||||
| .br | ||||
| size_types | ||||
| .br | ||||
| num_types | ||||
| T} | T{ | |||
| XkbGetKeyTypes | ||||
| .br | ||||
| XkbResizeKeyType | ||||
| .br | ||||
| XkbCopyKeyType | ||||
| .br | ||||
| XkbCopyKeyTypes | ||||
| T} | ||||
| T{ | ||||
| XkbKeySymsMask | ||||
| T} | (1<<1) | client | T{ | |
| syms | ||||
| .br | ||||
| size_syms | ||||
| .br | ||||
| num_syms | ||||
| .br | ||||
| key_sym_map | ||||
| T} | T{ | |||
| XkbGetKeySyms | ||||
| .br | ||||
| XkbResizeKeySyms | ||||
| .br | ||||
| XkbChangeTypesOfKey | ||||
| T} | ||||
| T{ | ||||
| XkbModifierMapMask | ||||
| T} | (1<<2) | client | modmap | T{ |
| XkbGetKeyModifierMap | ||||
| T} | ||||
| T{ | ||||
| XkbExplicitComponentsMask | ||||
| T} | (1<<3) | server | T{ | |
| explicit | ||||
| T} | T{ | |||
| XkbGetKeyExplicitComponents | ||||
| T} | ||||
| T{ | ||||
| XkbKeyActionsMask | ||||
| T} | (1<<4) | server | T{ | |
| key_acts | ||||
| .br | ||||
| acts | ||||
| .br | ||||
| num_acts | ||||
| .br | ||||
| size_acts | ||||
| T} | T{ | |||
| XkbGetKeyActions | ||||
| .br | ||||
| XkbResizeKeyActions | ||||
| T} | ||||
| T{ | ||||
| XkbKeyBehaviorsMask | ||||
| T} | (1<<5) | server | T{ | |
| behaviors | ||||
| T} | T{ | |||
| XkbGetKeyBehaviors | ||||
| T} | ||||
| T{ | ||||
| XkbVirtualModsMask | ||||
| T} | (1<<6) | server | T{ | |
| vmods | ||||
| T} | T{ | |||
| XkbGetVirtualMods | ||||
| T} | ||||
| T{ | ||||
| XkbVirtualModMapMask | ||||
| T} | (1<<7) | server | T{ | |
| vmodmap | ||||
| T} | T{ | |||
| XkbGetVirtualModMap | ||||
| T} |
XkbGetUpdatedMapis synchronous; it queries the server for the desired information, waits for a reply, and then returns. If successful, XkbGetUpdatedMapreturns Success. If unsuccessful, XkbGetUpdatedMapreturns one of the following: BadAlloc (unable to allocate a component in the XkbDescRec structure), BadValue (some mask bits in whichare undefined), BadImplementation (a compatible version of the Xkb extension is not available in the server or the reply from the server was invalid).
5. RETURN VALUES ▲
- Success
The XkbGetUpdatedMapfunction returns Success if a reply is received to the server query for the desired information.
6. STRUCTURES ▲
The complete description of an Xkb keyboard is given by an XkbDescRec. The component structures in the XkbDescRec represent the major Xkb components.
typedef struct {
struct _XDisplay * display; /(** connection to X server */
unsigned short flags; /(** private to Xkb, do not modify */
unsigned short device_spec; /(** device of interest */
KeyCode min_key_code; /(** minimum keycode for device */
KeyCode max_key_code; /(** maximum keycode for device */
XkbControlsPtr ctrls; /(** controls */
XkbServerMapPtr server; /(** server keymap */
XkbClientMapPtr map; /(** client keymap */
XkbIndicatorPtr indicators; /(** indicator map */
XkbNamesPtr names; /(** names for all components */
XkbCompatMapPtr compat; /(** compatibility map */
XkbGeometryPtr geom; /(** physical geometry of keyboard */
} XkbDescRec, *XkbDescPtr;The displayfield points to an X display structure. The flagsfield is private to the library: modifying flagsmay yield unpredictable results. The device_specfield specifies the device identifier of the keyboard input device, or XkbUseCoreKeyboard, which specifies the core keyboard device. The min_key_codeand max_key_codefields specify the least and greatest keycode that can be returned by the keyboard. Each structure component has a corresponding mask bit that is used in function calls to indicate that the structure should be manipulated in some manner, such as allocating it or freeing it. These masks and their relationships to the fields in the XkbDescRec are shown in Table 2.
| c s s | ||
| l l l | ||
| Table 2 Mask Bits for XkbDescRec | ||
| _ | ||
| Mask Bit | XkbDescRec Field | Value |
| _ | ||
| XkbControlsMask | ctrls | (1L<<0) |
| XkbServerMapMask | server | (1L<<1) |
| XkbIClientMapMask | map | (1L<<2) |
| XkbIndicatorMapMask | indicators | (1L<<3) |
| XkbNamesMask | names | (1L<<4) |
| XkbCompatMapMask | compat | (1L<<5) |
| XkbGeometryMask | geom | (1L<<6) |
| XkbAllComponentsMask | All Fields | (0x7f) |
7. DIAGNOSTICS ▲
BadAlloc
Unable to allocate storage
BadImplementation
Invalid reply from server
BadValue
An argument is out of range
8. SEE ALSO ▲
R XkbChangeTypesOfKey (3),
R XkbCopyKeyType (3),
R XkbCopyKeyTypes (3),
R XkbGetKeyActions (3),
R XkbGetKeyBehaviors (3),
R XkbGetKeyExplicitComponents (3),
R XkbGetKeyModifierMap (3),
R XkbGetKeySyms (3),
R XkbGetKeyTypes (3),
R XkbResizeKeyActions (3),
R XkbResizeKeySyms (3),
R XkbResizeKeyType (3),
R XkbGetVirtualModMap (3),
R XkbGetVirtualMods (3)
