API Guide Home
(Online version only)

common/system/palmOneChars.h

Go to the documentation of this file.
00001 /******************************************************************************
00002  * Copyright (c) 2005 palmOne, Inc. or its subsidiaries.
00003  * All rights reserved.
00004  *****************************************************************************/
00005 /**
00006  *@ingroup System
00007  *
00008  */
00009 
00010 /**
00011  * @file    palmOneChars.h
00012  * @version 1.0
00013  * @date    03/03/2004
00014  *
00015  * @brief Contains palmOne-specific virtual characters.
00016  *
00017  *    Five-way navigation macros and values for key states are included
00018  *    in this file.
00019  *
00020  * <hr>
00021  */
00022 
00023 
00024 #ifndef __PALMONECHARS_H__
00025 #define __PALMONECHARS_H__
00026 
00027 #include <Chars.h>
00028 
00029 
00030 
00031 #if (vchrPalmMin != 0x0500) || (vchrPalmMax != 0x05FF)
00032 #error "please check Palm vchr range or update the above assertion"
00033 #endif
00034 
00035 #ifndef vchrHard5
00036 #define vchrHard5               0x0214      /**< To match PalmOS 5.1 definition in Chars.h. */
00037 #endif
00038 
00039 #ifndef vchrHard6
00040 #define vchrHard6                   0x0215
00041 #endif
00042 
00043 #ifndef keyBitHard5
00044 #define keyBitHard5             0x2000      /**< The keyBit mask used for polling the 5th hard key. */
00045 #endif
00046 
00047 /**
00048  * @name
00049  *
00050  */
00051 /*@{*/
00052 #define vchrSilkClock               (vchrPalmMin + 0)   /**< Silk screen clock button virtual character.
00053                                   *< When handled by the system, it will launch the clock pop-up dialog.
00054                                                                   */
00055 
00056 #define vchrClock                   (vchrPalmMin + 1)   /**< Clock virtual character.
00057                                   *< When handled by the system, it will launch the clock pop-up dialog.
00058                                                                   */
00059 
00060 #define vchrPopupBrightness         (vchrPalmMin + 2)   /**< Pop-up brightness virtual character.
00061                                   *< When handled by the system, it will launch the brightness pop-up dialog.
00062                                                                   */
00063 
00064 #define vchrNavChange               (vchrPalmMin + 3)   /**< Five way navigation virtual character.
00065                                   *< This character indicates that the five way navigation states have changed.
00066                                                                   */
00067 
00068 #define vchrCameraShutter       (vchrPalmMin + 8)   /**< Camera shutter virtual character.
00069                                   *< Generated by the camera shutter button. Currently only available on Zire71.
00070                                                                   */
00071 
00072 #define vchrHardRecord              (vchrHard5) /**< Record button virtual character.
00073                                   *< On Tungsten T, this button is located below the microphone. On Tungsten W
00074                                   *< and Tungsten C, the button is generally placed on the headset.
00075                                                                   */
00076 /*@}*/
00077 
00078 /**
00079  * @name The following group of characters are specific for Tungsten W
00080  *
00081  */
00082 /*@{*/
00083 #define vchrDeviceSpecificChar      (vchrPalmMin+20)            /**<        */
00084 
00085 #define vchrHard3Down           (vchrDeviceSpecificChar + 0)        /**< Tungsten W virtual character.
00086                                           *< This character indicates that 3rd Hard key is down.  Used to check for press and hold event.
00087                                                                                   */
00088 
00089 #define vchrHard4Down           (vchrDeviceSpecificChar + 1)        /**< Tungsten W virtual character.
00090                                           *< This character indicates that 4th Hard key is down.  Used to check for press and hold event.
00091                                                                                   */
00092 
00093 #define vchrDeviceIncomingCall      (vchrDeviceSpecificChar + 2)        /**< Tungsten W virtual character.
00094                                           *< This character indicates that there is an incoming call.
00095                                                                                   */
00096 
00097 #define vchrTelDevicePowerOn        (vchrDeviceSpecificChar + 3)        /**< Tungsten W virtual character.
00098                                           *< This character indicates that the phone has been powered on
00099                                                                                   */
00100 
00101 #define vchrMyFavoriteApplication       (vchrDeviceSpecificChar + 4)            /**< Tungsten W virtual character.
00102                                           *< This character indicates that the Favorite Application button has been pressed.
00103                                           *< The button is UP at this point.
00104                                                                                   */
00105 
00106 #define vchrTelDevicePowerFinished  (vchrDeviceSpecificChar + 5)        /**< Tungsten W virtual character.
00107                                           *< This character indicates that the backlight has been toggled.
00108                                                                                   */
00109 
00110 #define vchrBacklightToggled            (vchrDeviceSpecificChar + 6)        /**< Tungsten W virtual character.
00111                                           *< This character indicates that the backlight has been toggled.
00112                                                                                   */
00113 
00114 #define vchrKeyboardSymbol      (vchrDeviceSpecificChar + 9)        /**< Tungsten W virtual character.
00115                                           *< This character indicates that the space key has been pressed with the function key.
00116                                                                                   */
00117 
00118 #define vchrReplaceLastChar     (vchrDeviceSpecificChar + 10)       /**< Tungsten W virtual character.
00119                                           *< This character indicates that a replace last char event has been triggered.
00120                                           *< This occurs when an alpha numeric key is pressed and held.
00121                                                                                   */
00122 
00123 #define vchrFunctionFiveWay     (vchrDeviceSpecificChar + 11)       /**< Tungsten W virtual character.
00124                                           *< This character indicates that a 5-way event has been triggered.
00125                                                                                   */
00126 
00127 #define vchrEmergencyCall       (vchrDeviceSpecificChar + 12)       /**< Tungsten W virtual character.
00128                                           *< This character indicates that an emergency call is being placed.
00129                                           *< This occurs when the 4 hard keys are all pressed at once.
00130                                                                                   */
00131 
00132 #define vchrPowerOnPhone        (vchrDeviceSpecificChar + 14)       /**< Tungsten W virtual character.
00133                                           *< This character indicates that a request to toggle the phone on or off has been made.
00134                                                                                   */
00135 /*@}*/
00136 
00137 /**
00138  * From Handspring ARM SDK, System/HsKey.h
00139  * Most of these will be moved into the PalmSource SDK as of R3 and later,
00140  * but we still need to compile on earlier SDKs, so here are guarded definitions.
00141  *
00142  * The following vchrThumbWheel/Rocker values exist to allow all hardware
00143  * that has these (optional) control clusters to emit the same key codes.
00144  **/
00145 
00146 #ifndef vchrThumbWheelUp
00147 /**
00148  * @name Character codes for thumb-wheel keys
00149  *
00150  */
00151 /*@{*/
00152 #define vchrThumbWheelUp            0x012E      /**< optional thumb-wheel up */
00153 #define vchrThumbWheelDown          0x012F      /**< optional thumb-wheel down */
00154 #define vchrThumbWheelPush          0x0130      /**< optional thumb-wheel press/center */
00155 #define vchrThumbWheelBack          0x0131      /**< optional thumb-wheel cluster back */
00156 /*@}*/
00157 #endif // ndef vchrThumbWheelUp
00158 
00159 
00160 #ifndef vchrRockerUp
00161 /**
00162  * @name Character codes for rocker keys
00163  *
00164  */
00165 /*@{*/
00166 #define vchrRockerUp                0x0132      /**< 5-way rocker up */
00167 #define vchrRockerDown              0x0133      /**< 5-way rocker down */
00168 #define vchrRockerLeft              0x0134      /**< 5-way rocker left */
00169 #define vchrRockerRight             0x0135      /**< 5-way rocker right */
00170 #define vchrRockerCenter            0x0136      /**< 5-way rocker center/press */
00171 /*@}*/
00172 #endif // ndef vchrRockerUp
00173 
00174 // End from Handspring ARM SDK, System/HsKey.h
00175 
00176 #define vchrRockerSelect            vchrRockerCenter
00177 
00178 #endif // __PALMONECHARS_H__

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