xkbinitcanonicalkeytypes(3) [debian man page]

XkbInitCanonicalKeyTypes(3)					   XKB FUNCTIONS				       XkbInitCanonicalKeyTypes(3)

NAME

       XkbInitCanonicalKeyTypes - Set the definitions of the canonical key types in a client map to their default values

SYNOPSIS

       Status XkbInitCanonicalKeyTypes (XkbDescPtr xkb, unsigned int which, int keypadVMod);

ARGUMENTS

       - xkb  keyboard description containing client map to initialize

       - which
	      mask of types to initialize

       - keypadVMod
	      index of NumLock virtual modifier

DESCRIPTION

       XkbInitCanonicalKeyTypes  initializes  the  first  XkbNumRequiredTypes  key  types  of the keyboard specified by the xkb parameter to their
       default values. The which parameter specifies what canonical key types to initialize and is a bitwise inclusive OR of the following  masks:
       XkbOneLevelMask, XkbTwoLevelMask, XkbAlphabeticMask, and XkbKeypadMask. Only those canonical types specified by the which mask are initial-
       ized.

       If XkbKeypadMask is set in the which parameter, XkbInitCanonicalKeyTypes looks up the NumLock named virtual  modifier  to  determine  which
       virtual	modifier  to  use  when initializing the KEYPAD key type. If the NumLock virtual modifier does not exist, XkbInitCanonicalKeyTypes
       creates it.

       XkbInitCanonicalKeyTypes normally returns Success. It returns BadAccess if the Xkb extension has not been properly initialized, and  BadAc-
       cess if the xkb parameter is not valid.

RETURN VALUES

       Success	      The XkbInitCanonicalKeyTypes funtion return Success if the Xkb extension has been properly initialized and the xkb parameter
		      is valid.

DIAGNOSTICS

       BadAccess      The Xkb extension has not been properly initialized

X Version 11							   libX11 1.5.0 				       XkbInitCanonicalKeyTypes(3)

XkbGetKeyVirtualModMap(3)					   XKB FUNCTIONS					 XkbGetKeyVirtualModMap(3)

NAME

       XkbGetKeyVirtualModMap - Obtain the virtual modifier map (the vmodmap array) for a subset of the keys in a keyboard description

SYNOPSIS

       Status XkbGetKeyVirtualModMap (Display *dpy, unsigned int first, unsigned int num, XkbDescPtr xkb);

ARGUMENTS

       - dpy  connection to server

       - first
	      keycode of first key to fetch

       - num  number of keys for which virtual mod maps are desired

       - xkb  Xkb description where results will be placed

DESCRIPTION

       XkbGetKeyVirutalModmap sends a request to the server to obtain the virtual modifier mappings for num keys on the keyboard starting with key
       first.  It waits for a reply and returns the virtual modifier mappings in the server->vmodmap array of xkb.  If	successful,  XkbGetKeyVir-
       tualModMap returns Success. The xkb parameter must be a pointer to a valid Xkb keyboard description.

       If  the	server	map  in the xkb parameter has not been allocated, XkbGetKeyVirtualModMap allocates and initializes it before obtaining the
       virtual modifier mappings.

       If the server does not have a compatible version of Xkb, or the Xkb extension has not  been  properly  initialized,  XkbGetKeyVirtualModMap
       returns	BadMatch.  If num is less than 1 or greater than XkbMaxKeyCount, XkbGetKeyVirtualModMap returns BadValue. If any allocation errors
       occur, XkbGetKeyVirtualModMap returns BadAlloc.

RETURN VALUES

       Success	      The XkbGetKeyVirutalModmap function returns Success following a successful reply from the server to obtain the virtual modi-
		      fier mappings for num keys on the keyboard starting with key first.

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

       BadValue       An argument is out of range

X Version 11							   libX11 1.6.0 					 XkbGetKeyVirtualModMap(3)