xkballoccompatmap(3) [centos man page]

XkbAllocCompatMap(3)						   XKB FUNCTIONS					      XkbAllocCompatMap(3)

NAME

       XkbAllocCompatMap - Allocate a new compatibility map if you do not already have one available

SYNOPSIS

       Status XkbAllocCompatMap (XkbDescPtr xkb, unsigned int which, unsigned int num_si);

ARGUMENTS

       - xkb  keyboard description in which to allocate compat map

       - which
	      mask of compatibility map components to allocate

       - num_si
	      number of symbol interpretations to allocate

DESCRIPTION

       xkb  specifies the keyboard description for which compatibility maps are to be allocated. The compatibility map is the compat field in this
       structure.

       which specifies the compatibility map components to be allocated (see XkbGetCompatMap).	which is an inclusive OR of the bits shown in  Ta-
       ble 1.

		 Table 1 Compatibility Map Component Masks
       ---------------------------------------------------------------
       Mask		    Value    Affecting
       ---------------------------------------------------------------
       XkbSymInterpMask     (1<<0)   Symbol interpretations
       XkbGroupCompatMask   (1<<1)   Group maps
       XkbAllCompatMask     (0x3)    All compatibility map components

       num_si specifies the total number of entries to allocate in the symbol interpretation vector (xkb.compat.sym_interpret).

       XkbAllocCompatMap returns Success if successful, BadMatch if xkb is NULL, or BadAlloc if errors are encountered when attempting to allocate
       storage.

STRUCTURES

	   typedef struct {
	       KeySym		 sym;	       /* keysym of interest or NULL */
	       unsigned char	 flags;        /* XkbSI_AutoRepeat, XkbSI_LockingKey */
	       unsigned char	 match;        /* specifies how mods is interpreted */
	       unsigned char	 mods;	       /* modifier bits, correspond to eight real modifiers */
	       unsigned char	 virtual_mod;  /* 1 modifier to add to key virtual mod map */
	       XkbAnyAction	 act;	       /* action to bind to symbol position on key */
	   } XkbSymInterpretRec,*XkbSymInterpretPtr;

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

       XkbGetCompatMap(3)

NOTES

       Note  that  symbol  interpretations  in	a compatibility map (the sym_interpret vector of XkbSymInterpretRec structures) are also allocated
       using this same function. To ensure that there is sufficient space in the symbol interpretation vector for entries to be added, use  XkbAl-
       locCompatMap specifying which as XkbSymInterpretMask and the number of free symbol interpretations needed in num_si.

X Version 11							   libX11 1.6.0 					      XkbAllocCompatMap(3)

XkbGetCompatMap(3)						   XKB FUNCTIONS						XkbGetCompatMap(3)

NAME

       XkbGetCompatMap - Fetch any combination of the current compatibility map components from the server

SYNOPSIS

       Status XkbGetCompatMap ( display, which, xkb )
	     Display * display;
	     unsigned int which;
	     XkbDescRec * xkb;

ARGUMENTS

       - display
	      connection to server

       - which
	      mask of compatibility map components to fetch

       - xkb  keyboard description where results placed

DESCRIPTION

       When  another  client modifies the compatibility map, you are notified if you have selected for XkbCompatMapNotify events.  XkbGetCompatMap
       is particularly useful when you receive an event of this type, as it allows you to update your program's version of the	compatibility  map
       to match the modified version now in the server. If your program is dealing with multiple servers and needs to configure them all in a sim-
       ilar manner, the updated compatibility map may be used to reconfigure other servers.

       XkbGetCompatMap fetches the components of the compatibility map specified in which from the server specified by display and places them	in
       the compat structure of the keyboard description xkb.  Valid values for which are an inclusive OR of the values shown in Table 1.

		 Table 1 Compatibility Map Component Masks
       ---------------------------------------------------------------
       Mask		    Value    Affecting
       ---------------------------------------------------------------
       XkbSymInterpMask     (1<<0)   Symbol interpretations
       XkbGroupCompatMask   (1<<1)   Group maps
       XkbAllCompatMask     (0x3)    All compatibility map components

       If  no  compatibility  map structure is allocated in xkb upon entry, XkbGetCompatMap allocates one. If one already exists, its contents are
       overwritten with the returned results.

       XkbGetCompatMap fetches compatibility map information for the device specified by the device_spec field of xkb.	Unless you  have  specifi-
       cally  modified	this field, it is the default keyboard device.	XkbGetCompatMap returns Success if successful, BadAlloc if it is unable to
       obtain necessary storage for either the return values or work space, BadMatch if the dpy field of the xkb argument is non-NULL and does not
       match the display argument, and BadLength under certain conditions caused by server or Xkb implementation errors.

DIAGNOSTICS

       BadAlloc       Unable to allocate storage

       BadLength      The length of a request is shorter or longer than that required to minimally contain the arguments

       BadMatch       A  compatible  version  of  Xkb  was not available in the server or an argument has correct type and range, but is otherwise
		      invalid

X Version 11							   libX11 1.2.1 						XkbGetCompatMap(3)