1. NAME▲

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

2. SYNOPSIS ▲

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

3. ARGUMENTS ▲

  • - xkb
        keyboard description containing client map to initialize
  • - which
        mask of types to initialize
  • - keypadVMod
        index of NumLock virtual modifier

4. DESCRIPTION ▲

XkbInitCanonicalKeyTypesinitializes the first XkbNumRequiredTypes key types of the keyboard specified by the xkbparameter to their default values. The whichparameter 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 whichmask are initialized. If XkbKeypadMask is set in the whichparameter, XkbInitCanonicalKeyTypeslooks 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, XkbInitCanonicalKeyTypescreates it. XkbInitCanonicalKeyTypesnormally returns Success. It returns BadAccess if the Xkb extension has not been properly initialized, and BadAccess if the xkb parameter is not valid.

5. RETURN VALUES ▲

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

6. DIAGNOSTICS ▲

BadAccess

               The Xkb extension has not been properly initialized