xkbvirtualmodstoreal(3) [x11r4 man page]
XkbVirtualModsToReal(3) XKB FUNCTIONS XkbVirtualModsToReal(3) NAME
XkbVirtualModsToReal - Determines the mapping of virtual modifiers to core X protocol modifiers SYNOPSIS
Bool XkbVirtualModsToReal ( xkb, virtual_mask, mask_rtrn ) XkbDescPtr xkb ; unsigned int virtual_mask ; unsigned int * mask_rtrn ; ARGUMENTS
- xkb keyboard description for input device - virtual_mask virtual modifier mask to translate - mask_rtrn backfilled with real modifiers DESCRIPTION
Xkb maintains a virtual modifier mapping, which lists the virtual modifiers associated with, or bound to, each key. The real modifiers bound to a virtual modifier always include all of the modifiers bound to any of the keys that specify that virtual modifier in their vir- tual modifier mapping. The server.vmodmap array indicates which virtual modifiers are bound to each key; each entry is a bitmask for the virtual modifier bits. The server.vmodmap array is indexed by keycode. The vmodmap and vmods members of the server map are the "master" virtual modifier definitions. Xkb automatically propagates any changes to these fields to all other fields that use virtual modifier mappings. For example, if Mod3 is bound to the Num_Lock key by the core protocol modifier mapping, and the NumLock virtual modifier is bound to they Num_Lock key by the virtual modifier mapping, Mod3 is added to the set of modifiers associated with NumLock. The virtual modifier mapping is normally updated whenever actions are automatically applied to symbols and few applications should need to change the virtual modifier mapping explicitly. Use XkbGetMap to get the virtual modifiers from the server or use XkbGetVirtualMods to update a local copy of the virtual modifiers bind- ings from the server. To set the binding of a virtual modifier to a real modifier, use XkbGetVirtualMods If the keyboard description defined by xkb includes bindings for virtual modifiers, XkbVirtualModsToReal uses those bindings to determine the set of real modifiers that correspond to the set of virtual modifiers specified in virtual_mask. The virtual_mask parameter is a mask specifying the virtual modifiers to translate; the i-th bit (0 relative) of the mask represents the i-th virtual modifier. If mask_rtrn is non-NULL, XkbVirtualModsToReal backfills it with the resulting real modifier mask. If the keyboard description in xkb does not include vir- tual modifier bindings, XkbVirtualModsToReal returns False; otherwise, it returns True. RETURN VALUES
True The XkbVirtualModsToReal function returns True if the keyboard description in xkb does include virtual modifier bindings. False The XkbVirtualModsToReal function returns False if the keyboard description in xkb does not include virtual modifier bind- ings. SEE ALSO
XkbGetMap(3), XkbGetVirtualMods(3) NOTES
It is possible for a local (client-side) keyboard description (the xkb parameter) to not contain any virtual modifier information (simply because the client has not requested it) while the server's corresponding definition may contain virtual modifier information. X Version 11 libX11 1.2.1 XkbVirtualModsToReal(3)
Check Out this Related Man Page
XkbGetVirtualMods(3) XKB FUNCTIONS XkbGetVirtualMods(3) NAME
XkbGetVirtualMods - Obtain a subset of the virtual modifier bindings (the vmods array) in a keyboard description SYNOPSIS
Status XkbGetVirtualMods ( dpy, which, xkb ) Display * dpy; unsigned int which; XkbDescPtr xkb; ARGUMENTS
- dpy connection to server - which mask indicating virtual modifier bindings to get - xkb Xkb description where results will be placed DESCRIPTION
XkbGetVirtualMods sends a request to the server to obtain the vmods entries for the virtual modifiers specified in the mask, which, and waits for a reply. Virtual modifiers are named by converting their string name to an X Atom and storing the Atom in the names.vmods array in an XkbDescRec structure. The position of a name Atom in the names.vmods array defines the bit position used to represent the virtual modifier and also the index used when accessing virtual modifier information in arrays: the name in the i-th (0 relative) entry of names.vmods is the i-th virtual modifier, represented by the mask (1<<i). Throughout Xkb, various functions have a parameter that is a mask representing virtual modifier choices. In each case, the i-th bit (0 relative) of the mask represents the i-th virtual modifier. To set the name of a virtual modifier, use XkbSetNames, using XkbVirtualModNamesMask in which and the name in the xkb argument; to retrieve indicator names, use XkbGetNames. For each bit set in which, XkbGetVirtualMods updates the corresponding virtual modifier definition in the server->vmods array of xkb. The xkb parameter must be a pointer to a valid Xkb keyboard description. If successful, XkbGetVirtualMods returns Success. Virtual Modifier Names and Masks Virtual modifiers are named by converting their string name to an X Atom and storing the Atom in the names.vmods array in an XkbDescRec structure. The position of a name Atom in the names.vmods array defines the bit position used to represent the virtual modifier and also the index used when accessing virtual modifier information in arrays: the name in the i-th (0 relative) entry of names.vmods is the i-th virtual modifier, represented by the mask (1<<i). Throughout Xkb, various functions have a parameter that is a mask representing virtual modifier choices. In each case, the i-th bit (0 relative) of the mask represents the i-th virtual modifier. To set the name of a virtual modifier, use XkbSetNames, using XkbVirtualModNamesMask in which and the name in the xkb argument; to retrieve indicator names, use XkbGetNames. If the server map has not been allocated in the xkb parameter, XkbGetVirtualMods allocates and initializes it before obtaining the virtual modifier bindings. If the server does not have a compatible version of Xkb, or the Xkb extension has not been properly initialized, XkbGetVirtualMods returns BadMatch. Any errors in allocation cause XkbGetVirtualMods to return BadAlloc. RETURN VALUES
Success The XkbGetVirtualMods function returns Success when it successfully updates the corresponding virtual modifier definition in the server->vmods array of xkb. 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 display field points to an X display structure. The flags field is private to the library: modifying flags may yield unpredictable results. The device_spec field specifies the device identifier of the keyboard input device, or XkbUseCoreKeyboard, which specifies the core keyboard device. The min_key_code and max_key_code fields 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 1. Table 1 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) DIAGNOSTICS
BadAlloc Unable to allocate storage BadMatch A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid SEE ALSO
XkbGetNames(3), XkbSetNames(3) X Version 11 libX11 1.2.1 XkbGetVirtualMods(3)