Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
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 ini-
       tialize and is a	bitwise	inclusive  OR  of  the	following  masks:  Xk-
       bOneLevelMask,  XkbTwoLevelMask,	 XkbAlphabeticMask, and	XkbKeypadMask.
       Only those canonical types specified by the which mask are initialized.

       If XkbKeypadMask	is set in the  which  parameter,  XkbInitCanonicalKey-
       Types  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 cre-
       ates it.

       XkbInitCanonicalKeyTypes	normally returns Success. It returns BadAccess
       if  the	Xkb extension has not been properly initialized, and BadAccess
       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.6.5	   XkbInitCanonicalKeyTypes(3)

NAME | SYNOPSIS | ARGUMENTS | DESCRIPTION | RETURN VALUES | DIAGNOSTICS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=XkbInitCanonicalKeyTypes&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help