API Guide Home (Online version only) |

# PmKeyLibCommon.h File Reference

## Detailed Description

Public 68k common header file for system library that exports key-related APIs.

This library is based on key APIs from HsExtensions and was broken apart from HsExtensions so the APIs could be ported to other platforms.

Definition in file PmKeyLibCommon.h.

Include dependency graph for PmKeyLibCommon.h:

Go to the source code of this file.

## Defines

- #define kPmKeyLibType sysFileTLibrary
- #define kPmKeyLibCreator pmFileCKeyLib
- #define kPmKeyLibName "PmKeyLib-PmKe"
- #define kPmKeyLibAPIMajorVersion 3
- #define kPmKeyLibAPIMinorVersion 0
- #define kPmKeyLibAPIVersion sysMakeLibAPIVersion(kPmKeyLibAPIMajorVersion, kPmKeyLibAPIMinorVersion)

Feature values

- #define kPmKeyLibFtrValAPIVersion 0

Function Traps

- #define kPmKeyLibTrapOpen sysLibTrapOpen
- #define kPmKeyLibTrapClose sysLibTrapClose
- #define kPmKeyLibTrapKeysPressed (sysLibTrapCustom)
- #define kPmKeyLibTrapStop (sysLibTrapCustom+1)
- #define kPmKeyLibTrapEnableKey (sysLibTrapCustom+2)
- #define kPmKeyLibTrapChrCodeToKeyCode (sysLibTrapCustom+3)
- #define kPmKeyLibTrapKeyCodeToChrCode (sysLibTrapCustom+4)
- #define kPmKeyLibTrapEventIsFromKeyboard (sysLibTrapCustom+5)
- #define kPmKeyLibTrapAttrGet (sysLibTrapCustom+6)
- #define kPmKeyLibTrapAttrSet (sysLibTrapCustom+7)

## Typedefs

- typedef UInt16 PmKeyAttrEnum

## Enumerations

- enum PmKeyAttrEnumTag {
  pmKeyAttrPagingMode,
  pmKeyAttrGetLauncherKeyCode,
  pmKeyAttrGetMenuKeyCode,
  pmKeyAttrGetSendKeyCode,
  pmKeyAttrGetEndKeyCode,
  pmKeyAttrGetPhoneKeyCode
  }

## Define Documentation

#define kPmKeyLibAPIMajorVersion 3

Major version incremented when API changes

Definition at line 41 of file PmKeyLibCommon.h.

#define kPmKeyLibAPIMinorVersion 0

Minor version incremented with each release of library that doesn't change the API

Definition at line 43 of file PmKeyLibCommon.h.

#define kPmKeyLibAPIVersion sysMakeLibAPIVersion(kPmKeyLibAPIMajorVersion, kPmKeyLibAPIMinorVersion)

Definition at line 46 of file PmKeyLibCommon.h.

#define kPmKeyLibCreator pmFileCKeyLib

PmKeyLib creator ID

Definition at line 39 of file PmKeyLibCommon.h.

#define kPmKeyLibFtrValAPIVersion 0

Feature value used to get/set library API version (kPmKeyLibAPIVersion). Note that the first release of the library did not set this feature. Therefore, if the library does exist but the feature does not, you can assume the major version of the library is 1. Note also that the feature is not set until library is loaded so you must load PmKeyLib before getting the feature

Definition at line 53 of file PmKeyLibCommon.h.

#define kPmKeyLibName "PmKeyLib-PmKe"

PmKeyLib database name

Definition at line 40 of file PmKeyLibCommon.h.

#define kPmKeyLibTrapAttrGet (sysLibTrapCustom+6)

Definition at line 118 of file PmKeyLibCommon.h.

#define kPmKeyLibTrapAttrSet (sysLibTrapCustom+7)

Definition at line 119 of file PmKeyLibCommon.h.

#define kPmKeyLibTrapChrCodeToKeyCode (sysLibTrapCustom+3)

Definition at line 115 of file PmKeyLibCommon.h.

#define kPmKeyLibTrapClose sysLibTrapClose

Definition at line 111 of file PmKeyLibCommon.h.

#define kPmKeyLibTrapEnableKey (sysLibTrapCustom+2)

Definition at line 114 of file PmKeyLibCommon.h.

#define kPmKeyLibTrapEventIsFromKeyboard (sysLibTrapCustom+5)

Definition at line 117 of file PmKeyLibCommon.h.

#define kPmKeyLibTrapKeyCodeToChrCode (sysLibTrapCustom+4)

Definition at line 116 of file PmKeyLibCommon.h.

#define kPmKeyLibTrapKeysPressed (sysLibTrapCustom)

Definition at line 112 of file PmKeyLibCommon.h.

#define kPmKeyLibTrapOpen sysLibTrapOpen

Definition at line 110 of file PmKeyLibCommon.h.

#define kPmKeyLibTrapStop (sysLibTrapCustom+1)

Definition at line 113 of file PmKeyLibCommon.h.

#define kPmKeyLibType sysFileTLibrary

standard library type

Definition at line 38 of file PmKeyLibCommon.h.

## Typedef Documentation

typedef UInt16 PmKeyAttrEnum

Definition at line 100 of file PmKeyLibCommon.h.

## Enumeration Type Documentation

enum PmKeyAttrEnumTag

Enumerator:

  pmKeyAttrPagingMode | Whether currently pressed key is in page mode
  pmKeyAttrGetLauncherKeyCode | Returns the key code for the Launcher key
  pmKeyAttrGetMenuKeyCode | Returns the key code for the Menu key
  pmKeyAttrGetSendKeyCode | Returns the key code for the Send key
  pmKeyAttrGetEndKeyCode | Returns the key code for the End key
  pmKeyAttrGetPhoneKeyCode | Returns the key code for the Phone key

Definition at line 71 of file PmKeyLibCommon.h.

    00072 {
    00073   /*
    00074    * End of enums in API version 1 (no enums defined in version 1)
    00075    */
    00076
    00077
    00078   pmKeyAttrPagingMode,          /**< Whether currently pressed key is in page mode */
    00079
    00080   /*
    00081    * End of enums in API version 2
    00082    */
    00083
    00084   pmKeyAttrGetLauncherKeyCode,  /**< Returns the key code for the Launcher key */
    00085   pmKeyAttrGetMenuKeyCode,      /**< Returns the key code for the Menu key */
    00086   pmKeyAttrGetSendKeyCode,      /**< Returns the key code for the Send key */
    00087   pmKeyAttrGetEndKeyCode,       /**< Returns the key code for the End key */
    00088   pmKeyAttrGetPhoneKeyCode      /**< Returns the key code for the Phone key */
    00089
    00090   /*
    00091    * End of enums in API version 3
    00092    */
    00093
    00094
    00095   /*
    00096    * Attributes greater than 0x9000 are defined for internal use
    00097    * in Prv/PmPrvKeyLibCommon.h
    00098    */
    00099 };

Top | Palm Developer Network © 2004-2008, Palm, Inc. All rights reserved. Generated on Fri Jun 13 10:08:01 2008 for Palm API Guide