1XkbInitCanonicalKeyTypes(3)      XKB FUNCTIONS     XkbInitCanonicalKeyTypes(3)
2
3
4

NAME

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

SYNOPSIS

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

ARGUMENTS

14       - xkb  keyboard description containing client map to initialize
15
16       - which
17              mask of types to initialize
18
19       - keypadVMod
20              index of NumLock virtual modifier
21

DESCRIPTION

23       XkbInitCanonicalKeyTypes  initializes the first XkbNumRequiredTypes key
24       types of the keyboard specified by the xkb parameter to  their  default
25       values.  The which parameter specifies what canonical key types to ini‐
26       tialize and is a bitwise inclusive  OR  of  the  following  masks:  Xk‐
27       bOneLevelMask,  XkbTwoLevelMask,  XkbAlphabeticMask, and XkbKeypadMask.
28       Only those canonical types specified by the which mask are initialized.
29
30       If XkbKeypadMask is set in the  which  parameter,  XkbInitCanonicalKey‐
31       Types  looks  up  the NumLock named virtual modifier to determine which
32       virtual modifier to use when initializing the KEYPAD key type.  If  the
33       NumLock  virtual modifier does not exist, XkbInitCanonicalKeyTypes cre‐
34       ates it.
35
36       XkbInitCanonicalKeyTypes normally returns Success. It returns BadAccess
37       if  the  Xkb extension has not been properly initialized, and BadAccess
38       if the xkb parameter is not valid.
39

RETURN VALUES

41       Success        The XkbInitCanonicalKeyTypes function return Success  if
42                      the  Xkb extension has been properly initialized and the
43                      xkb parameter is valid.
44

DIAGNOSTICS

46       BadAccess      The Xkb extension has not been properly initialized
47
48
49
50X Version 11                     libX11 1.7.2      XkbInitCanonicalKeyTypes(3)