XkbGetMap.3 - Online Linux Manual Page

XkbGetMap - Online Linux Manual PageSection : 3
Updated : libX11 1.8.4
Source : X Version 11
Note : XKB FUNCTIONS

NAMEXkbGetMap − Allocate an XkbDescRec structure and populate it with the server's keyboard client map and server map

SYNOPSISXkbDescPtr XkbGetMap ( Display *display , unsigned int which , unsigned int device_spec );

ARGUMENTSdisplay connection to X server which mask selecting subcomponents to populate device_spec device_id, or XkbUseCoreKbd

DESCRIPTIONXkb provides two functions to obtain the keyboard mapping components from the server. The first function, XkbGetMap, allocates an XkbDescRec structure, retrieves mapping components from the server, and stores them in the XkbDescRec structure it just allocated. The second function, XkbGetUpdatedMap, retrieves mapping components from the server and stores them in an XkbDescRec structure that has previously been allocated. To allocate an XkbDescRec structure and populate it with the server's keyboard client map and server map, use XkbGetMap. XkbGetMap is similar to XkbGetKeyboard, but is used only for obtaining the address of an XkbDescRec structure that is populated with keyboard mapping components. It allows finer control over which substructures of the keyboard mapping components are to be populated. XkbGetKeyboard always returns fully populated components, while XkbGetMap can be instructed to return a partially populated component. The which mask is a bitwise inclusive OR of the masks defined in Table 14.1. Only those portions of the keyboard server map and the keyboard client maps that are specified in which are allocated and populated. In addition to allocating and obtaining the server map and the client map, XkbGetMap also sets the device_spec, the min_key_code, and max_key_code fields of the keyboard description. XkbGetMap is synchronous; it queries the server for the desired information, waits for a reply, and then returns. If successful, XkbGetMap returns a pointer to the XkbDescRec structure it allocated. If unsuccessful, XkbGetMap returns NULL. When unsuccessful, one of the following protocol errors is also generated: BadAlloc (unable to allocate the XkbDescRec structure), BadValue (some mask bits in which are undefined), or BadImplementation (a compatible version of the Xkb extension is not available in the server). To free the returned data, use XkbFreeKeyboard. Xkb also provides convenience functions to get partial component definitions from the server. These functions are specified in the "convenience functions" column in Table 1. Refer to the sections listed in the table for more information on these functions. Table 1 Xkb Mapping Component Masks and Convenience Functions MaskValueMapFieldsConvenience Functions XkbKeyTypesMask (1<<0)client types
size_types
num_types XkbGetKeyTypes
XkbResizeKeyType
XkbCopyKeyType
XkbCopyKeyTypes XkbKeySymsMask (1<<1)client syms
size_syms
num_syms
key_sym_map XkbGetKeySyms
XkbResizeKeySyms
XkbChangeTypesOfKey XkbModifierMapMask (1<<2)clientmodmap XkbGetKeyModifierMap XkbExplicitComponentsMask (1<<3)server explicit XkbGetKeyExplicitComponents XkbKeyActionsMask (1<<4)server key_acts
acts
num_acts
size_acts XkbGetKeyActions
XkbResizeKeyActions XkbKeyBehaviorsMask (1<<5)server behaviors XkbGetKeyBehaviors XkbVirtualModsMask (1<<6)server vmods XkbGetVirtualMods XkbVirtualModMapMask (1<<7)server vmodmap XkbGetVirtualModMap .bp Xkb defines combinations of these masks for convenience: #define XkbResizableInfoMask (XkbKeyTypesMask) #define XkbAllClientInfoMask (XkbKeyTypesMask | XkbKeySymsMask | XkbModifierMapMask) #define XkbAllServerInfoMask (XkbExplicitComponentsMask | XkbKeyActionsMask | XkbKeyBehaviorsMask | XkbVirtualModsMask | XkbVirtualModMapMask) #define XkbAllMapComponentsMask XkbAllClientInfoMask | XkbAllServerInfoMask) Key types, symbol maps, and actions are all interrelated: changes in one require changes in the others. The convenience functions make it easier to edit these components and handle the interdependencies.

STRUCTURESThe 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 2. Table 2 Mask Bits for XkbDescRec Mask BitXkbDescRec FieldValue XkbControlsMaskctrls(1L<<0) XkbServerMapMaskserver(1L<<1) XkbIClientMapMaskmap(1L<<2) XkbIndicatorMapMaskindicators(1L<<3) XkbNamesMasknames(1L<<4) XkbCompatMapMaskcompat(1L<<5) XkbGeometryMaskgeom(1L<<6) XkbAllComponentsMaskAll Fields(0x7f)

Johanes Gumabo

Data Size : 23,251 byte
man-XkbGetMap.3Build : 2024-12-05, 20:55 :
Visitor Screen : x
Visitor Counter ( page / site ) : 3 / 189,398
Visitor ID : :
Visitor IP : 3.147.69.25 :
Visitor Provider : AMAZON-02 :
Provider Position ( lat x lon ) : 39.962500 x -83.006100 : x
Provider Accuracy Radius ( km ) : 1000 :
Provider City : Columbus :
Provider Province : Ohio , : ,
Provider Country : United States :
Provider Continent : North America :
Visitor Recorder : Version :
Visitor Recorder : Library :
Online Linux Manual Page : Version : Online Linux Manual Page - Fedora.40 - march=x86-64 - mtune=generic - 24.12.05
Online Linux Manual Page : Library : lib_c - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Online Linux Manual Page : Library : lib_m - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Data Base : Version : Online Linux Manual Page Database - 24.04.13 - march=x86-64 - mtune=generic - fedora-38
Data Base : Library : lib_c - 23.02.07 - march=x86-64 - mtune=generic - fedora.36

Very long time ago, I have the best tutor, Wenzel Svojanovsky . If someone knows the email address of Wenzel Svojanovsky , please send an email to johanes_gumabo@yahoo.co.id .

If error, please print screen and send to johanes_gumabo@yahoo.co.id
Under development. Support me via PayPal.

ERROR : Need New Coding : (parse_manual_page_|249|XkbGetMap.3|215|bp|.bp )