API Guide Home (Online version only) |

# HsExtCommon.h File Reference

## Detailed Description

Common defines shared between HsExt.h (include for 68K programs) and HsExtArm.h (include for ARM programs).

Definition in file HsExtCommon.h.

Go to the source code of this file.

## Defines

- #define hsVersionStringSize 32
- #define hsAttrRingSwitchMute 0
- #define hsAttrRingSwitchLoud 0x8000
- #define hsWordCorrectMaxWordLen 25
- #define hsMaxSaveAsNameSize 32
- #define hsDeviceIDTreo600 kPalmOneDeviceIDTreo600
- #define hsDeviceIDTreo600Sim kPalmOneDeviceIDTreo600Sim
- #define hsDeviceIDOs5Device1 kPalmOneDeviceIDTreo600
- #define hsDeviceIDOs5Device1Sim kPalmOneDeviceIDTreo600Sim

- #define hsAttrSysActiveHotSync 0x0001
- #define hsAttrSysActiveProgress 0x0002
- #define hsAttrSysActiveBeamProgress 0x0004
- #define hsAttrPhoneTypeCDMA 0x0001
- #define hsAttrPhoneTypeGSM 0x0002

- #define hsOLDErrorClass (appErrorClass+0x0100)
- #define hsErrNotSupported (hsOLDErrorClass | 0x01)
- #define hsErrInvalidCardNum (hsOLDErrorClass | 0x02)
- #define hsErrReadOnly (hsOLDErrorClass | 0x03)
- #define hsErrInvalidParam (hsOLDErrorClass | 0x04)
- #define hsErrBufferTooSmall (hsOLDErrorClass | 0x05)
- #define hsErrInvalidCardHdr (hsOLDErrorClass | 0x06)
- #define hsErrCardPatchAlreadyInstalled (hsOLDErrorClass | 0x07)
- #define hsErrCardPatchNotInstalled (hsOLDErrorClass | 0x08)
- #define hsErrNotEnoughPower (hsOLDErrorClass | 0x09)
- #define hsErrCardNotInstalled (hsOLDErrorClass | 0x0A)
- #define hsErrInvalidPeriod (hsOLDErrorClass | 0x0B)
- #define hsErrPeriodicNotInstalled (hsOLDErrorClass | 0x0C)
- #define hsErrFixedStorageRequired (hsOLDErrorClass | 0x0D)
- #define hsErrPeriodicAlreadyInstalled (hsOLDErrorClass | 0x0E)
- #define hsErrInUse (hsOLDErrorClass | 0x0F)
- #define hsErrIndicatorInvalidSequence (hsOLDErrorClass | 0x10)
- #define hsErrIndicatorInvalidCap (hsOLDErrorClass | 0x11)
- #define hsErrIndicatorDisabled (hsOLDErrorClass | 0x12)
- #define hsErrUnderflow (hsExtErrorClass | 0x13)
- #define hsErrUserNoRadio (hsExtErrorClass | 0x14)
- #define hsErrOutOfCoverage (hsExtErrorClass | 0x15)
- #define hsErrAppStopEvent (hsExtErrorClass | 0x16)
- #define hsErrOutOfMemory (hsExtErrorClass | 0x17)
- #define hsErrSIMMissing (hsExtErrorClass | 0x18)
- #define hsErrGPRSNotAttached (hsExtErrorClass | 0x19)
- #define hsErrTimeOut (hsExtErrorClass | 0x1A)
- #define hsErrUserInterrupted (hsExtErrorClass | 0x1B)

- #define hsLibAliasDefault "Serial Library"
- #define hsLibAliasHotSyncLocal "*HsLoc SerLib"
- #define hsLibAliasHotSyncModem "*HsMdm SerLib"
- #define hsLibAliasIrda "*Irda SerLib"
- #define hsLibAliasConsole "*Cons SerLib"
- #define hsLibNameBuiltInSerial "BuiltIn SerLib"
- #define hsFtrCreator 'hsEx'
- #define hsFtrIDVersion 0
- #define hsFtrIDModDate 1
- #define hsFtrIDLdbMgrLibRefNum 2
- #define hsFtrIDNoMemSemaphore 3
- #define hsFtrIDBugsFixed 4
- #define hsFtrIDTypeOfKeyboard 5
- #define hsFtrValKeyboardBasic 0x0001
- #define hsFtrValKeyboardQwerty 0x0002
- #define hsFtrValKeyboardJog 0x0004
- #define hsFtrValKeyboardCommCentric 0x0008
- #define hsFtrValKeyboardCustomApps 0x0010
- #define hsFtrIDRadioAttributes 6
- #define hsFtrValRadioAvailable 0x0001
- #define hsFtrValRadioBuiltin 0x0002
- #define hsFtrIDPowerKeyResponse 7
- #define hsFtrValPowerKeyDoubleClkBacklight 0x0001
- #define hsFtrValPowerKeyTripleClkInvert 0x0002
- #define hsFtrValPowerKeyHoldRadioPower 0x0004
- #define hsFtrIDStatusGadgetRev 8
- #define hsFtrValStatusGadgetRev1 0x0001
- #define hsFtrIDGrfAreaDisabled 9
- #define hsFtrIDKeyboardLayout 10
- #define hsFtrValKeyboardLayout_enUS 0x0001
- #define hsFtrValKeyboardLayout_deDE 0x0002
- #define hsFtrValKeyboardLayout_frFR 0x0003
- #define hsFtrIDToneOnLidOpen 11
- #define hsFtrIDCurrentAppOnSleep 12
- #define hsFtrValCurrentAppOnSleepPhoneAppSpeedDialView 0x0001
- #define hsFtrIDTestingBootMode 13
- #define hsFtrIDNavigationSupported 14
- #define hsFtrIDHardwareApiRevision 15
- #define hsDispFtrCreator 'DisA'
- #define hsDispFtrIDDisplayAttributes 0

Values for the display attributes, which is a bitfield.

- #define hsDispFtrValLCDControllerTypeMask 0x000000FF
- #define hsDispFtrValDragonballVZ 0x00000000
- #define hsDispFtrValSed1375 0x00000001
- #define hsDispFtrValSed1376 0x00000002
- #define hsDispFtrValSed13A3 0x00000003
- #define hsDispFtrValOmapX10 0x00000004
- #define hsDispFtrValBulverdePxa27X 0x00000005
- #define hsDispFtrValLCDDisplayTypeMask 0x0000FF00
- #define hsDispFtrValBwStn 0x00000100
- #define hsDispFtrValColorStn 0x00000200
- #define hsDispFtrValColorTft 0x00000300
- #define hsDispFtrValColorOled 0x00000400

Available Shades
This feature contains the number of shades of gray, red, green, and blue available on this display. Note that this will _never_ be bigger than the number of shades available on the controller, since the display is fundamentally limited by what you can set the controller to. See masks below for accessing...

- #define hsDispFtrIDDisplayShades 1
- #define hsDispFtrIDControllerShades 2
- #define hsDispFtrValGrayOffset 24
- #define hsDispFtrValRedOffset 16
- #define hsDispFtrValGreenOffset 8
- #define hsDispFtrValBlueOffset 0

Special values for hsPrefKeyguardAutoEnableTime

- #define hsKeyguardAutoDisabled 0
- #define hsKeyguardAutoPowerOff 0xFFFF

Values for hsPrefKeyguardFlags

- #define hsKeyguardFlagPowerOnDialog 0x0001

Bit definitions for hsPrefTouchscreenDisableFlags

- #define hsTouchscreenDisableFlagIncomingCall 0x0001
- #define hsTouchscreenDisableFlagDuringCall 0x0002

Bit Flag for Light Circumstances
application may call HsCurrentLightCircumstance() to get current enabled light circumstances

test bit to see if light circumstance is enabled or disabled

- #define hsLightCircumstanceAlertWokeDeviceFlagBit 0x0001
- #define hsLightCircumstanceQuickTypingFlagBit 0x0002
- #define hsLightCircumstanceUserNotLookingFlagBit 0x0004
- #define hsLightCircumstanceUserNotLookingLongTimeFlagBit 0x0008
- #define hsLightCircumstanceKeylightOffFlagBit 0x0010

HAL IDs
Handspring generally doesn't differentiate different HALs and uses the same ID in multiple places... Use the device ID to figure out which devide you're on. If you're looking to see which version of HsExtensions is available, see the HsExtensions feature (hsFtrIDVersion)...

- #define hsHALIDHandspringOs35_40 'Hs01'
- #define hsHALIDHandspringOs5Rev1 'H5_1'
- #define hsHALIDHandspringOs5Rev1Sim 'H5s1'
- #define hsHALIDHandspringOs5Rev2 'H5_2'
- #define hsHALIDHandspringOs5Rev2Sim 'H5s2'
- #define hsHALIDHandspringOs5Rev3 'P052'
- #define hsHALIDHandspringOs5Rev3Sim 'S052'
- #define hsHALIDHandspringOs5Rev4 'P053'
- #define hsHALIDHandspringOs5Rev4Sim 'S053'

Device IDs
Older devices don't use 4-character constants; newer devices do. Sometimes devices will have the same ID if they are extremely similar. You may need to use alternate means to differentiate between such products.

- #define hsDeviceIDVisor 0x00
- #define hsDeviceIDVisorPlatinum 0x08
- #define hsDeviceIDVisorEdge 0x09
- #define hsDeviceIDVisorPrism 0x0A
- #define hsDeviceIDTreo180 0x0B
- #define hsDeviceIDTreo270 0x0D
- #define hsDeviceIDTreo300 0x0E
- #define hsDeviceIDVisorNeo 0x8A
- #define hsDeviceIDVisorPro 0x8B
- #define hsDeviceIDTreo90 0x8C

## Enumerations

- enum HsVerStrEnum {
  hsVerStrComplete,
  hsVerStrSerialNo,
  hsVerStrHardware,
  hsVerStrProductName,
  hsVerStrCarrierID,
  hsVerStrProductRev,
  hsVerStrROMBuild,
  hsVerStrFirmwareVer,
  hsVerStrPalmOSVer,
  hsVerStrLifeTime
  }
- enum HsAttrEnum {
  hsAttr68KLidOpen,
  hsAttr68KSysSleepReason,
  hsAttr68KDisplayOn,
  hsAttr68KRingSwitch,
  hsAttr68KPostProcessRsc,
  hsAttr68KSysActive,
  hsAttr68KActiveCalls,
  hsAttr68KPhoneType,
  hsAttr68KKeyboardLocked,
  hsAttr68KKeyLockNextWakeTicks,
  hsAttrLidOpen = 0x80,
  hsAttrSysSleepReason,
  hsAttrDisplayOn,
  hsAttrRingSwitch,
  hsAttrPostProcessRsc,
  hsAttrSysActive,
  hsAttrActiveCalls,
  hsAttrPhoneType,
  hsAttrKeyboardLocked,
  hsAttrKeyLockNextWakeTicks,
  hsAttrKeyboardDB,
  hsAttrDigitizerLock,
  hsAttrE911Mode,
  hsAttrDitherSuppress,
  hsAttrHotSyncSuppress,
  hsAttrPhoneRadioPowerState,
  hsAttrAllKeysWakeFromSleep,
  hsForcePrefAutoOffDurationSecs,
  hsAttrKeyguardDialogOn,
  hsAttrReserved_SDK20_1,
  hsAttrReserved_SDK20_2,
  hsAttrReserved_SDK20_3,
  hsAttrReserved_SDK20_4,
  hsAttrReserved_SDK20_5,
  hsAttrReserved_SDK20_6,
  hsAttrReserved_SDK20_7
  }
- enum HsPrefEnum {
  hsPrefSerialLibDef,
  hsPrefSerialLibHotSyncLocal,
  hsPrefSerialLibHotSyncModem,
  hsPrefSerialLibIrda,
  hsPrefSerialLibConsole,
  hsPrefJogScanCharAppCreator,
  hsPrefLidStatusChgCharAppCreator,
  hsPrefOptHard1CharAppCreator,
  hsPrefOptHard2CharAppCreator,
  hsPrefOptHard3CharAppCreator,
  hsPrefOptHard4CharAppCreator,
  hsPrefTempShiftTimeOut,
  hsPrefLidClosedAutoOffSeconds,
  hsPrefLCDRefreshRate,
  hsPrefNetworkTimeSelected,
  hsPrefKeyguardAutoEnableTime,
  hsPrefKeyguardAutoEnableAutoOffExtraTime,
  hsPrefKeyguardFlags,
  hsPrefTouchscreenDisableFlags,
  hsPrefOptHardPowerCharAppCreator,
  hsPrefOptReservedCharAppCreator,
  hsPrefPowerOnAppCreator,
  hsPrefSideHardCharAppCreator,
  hsPrefBlinkGreenLEDInCoverage,
  hsPrefHard11CharAppCreator,
  hsPrefOptHard11CharAppCreator,
  hsPrefUserNotLookingTime,
  hsPrefNetworkTZSelected,
  hsPrefShortSideHardCharAppCreator,
  hsPrefPowerSaveMode,
  hsPrefLast
  }
- enum HsStatusGadgetTypeEnum {
  hsStatusGadgetBattery = 1,
  hsStatusGadgetSignal = 2
  }
- enum HsLightModeEnum {
  hsLightModeNormal = 0,
  hsLightModeNight = 1,
  hsLightModeNumPresets,
  hsLightModeReserved = 0x7FFF
  }
- enum HsLightCircumstanceEnum {
  hsLightCircumstanceFirst = 0,
  hsLightCircumstanceAlertWokeDevice = 0,
  hsLightCircumstanceQuickTyping = 1,
  hsLightCircumstanceUserNotLooking = 2,
  hsLightCircumstanceUserNotLookingLongTime = 3,
  hsLightCircumstanceKeylightOff = 4,
  hsLightCircumstanceNumCircumstances,
  hsLightCircumstanceReserved = 0x7FFF
  }
- enum HsIndicatorTypeEnum {
  kIndicatorTypeLed,
  kIndicatorTypeVibrator,
  kIndicatorTypeCount
  }
- enum HsIndicatorCountEnum {
  kIndicatorCountGetState = 0,
  kIndicatorCountForever = 0xFFFF
  }
- enum HsIndicatorStateEnum {
  kIndicatorStateNull = 0x0000,
  kIndicatorForceNone = 0x0100,
  kIndicatorForceOn = 0x0101,
  kIndicatorForceRed = 0x0101,
  kIndicatorForceGreen,
  kIndicatorForceRedGreen,
  kIndicatorForceOff = 0x0180,
  kIndicatorRingNone = 0x0200,
  kIndicatorRingActive,
  kIndicatorRingContact,
  kIndicatorRingRoam,
  kIndicatorAlertNone = 0x0300,
  kIndicatorAlertAlert,
  kIndicatorAlertMail,
  kIndicatorAlertCalendar,
  kIndicatorAlertSMS,
  kIndicatorAlertVoicemail,
  kIndicatorAlertPending,
  kIndicatorBattNone = 0x0400,
  kIndicatorBattCharge,
  kIndicatorBattTrickle,
  kIndicatorBattFull,
  kIndicatorBattLow,
  kIndicatorUsageNone = 0x0600,
  kIndicatorUsageVoiceCall,
  kIndicatorUsageDataCall,
  kIndicatorSignalNone = 0x0500,
  kIndicatorSignalBad,
  kIndicatorSignalGood,
  kIndicatorSignalRoam
  }

## Define Documentation

#define hsAttrPhoneTypeCDMA 0x0001

Type of phone. Possible values of hsAttrPhoneType CDMA Phone

Definition at line 66 of file HsExtCommon.h.

#define hsAttrPhoneTypeGSM 0x0002

GSM Phone

Definition at line 67 of file HsExtCommon.h.

#define hsAttrRingSwitchLoud 0x8000

Sounds-on position

Definition at line 76 of file HsExtCommon.h.

#define hsAttrRingSwitchMute 0

Possible values of hsAttrRingSwitch For now there are only two values, but it's left open to have a control that works more like a volume control and has a range of settings. The value of the "loud" setting was chosen so that it can be decided later to make this a bit field or a scalar value. Silent position

Definition at line 75 of file HsExtCommon.h.

#define hsAttrSysActiveBeamProgress 0x0004

Beam Progress dialog is up

Definition at line 59 of file HsExtCommon.h.

#define hsAttrSysActiveHotSync 0x0001

Current system activity. Possible bits for hsAttrSysActivity Hot sync in progress

Definition at line 57 of file HsExtCommon.h.

#define hsAttrSysActiveProgress 0x0002

Progress dialog is up (any progress dialog)

Definition at line 58 of file HsExtCommon.h.

#define hsDeviceIDOs5Device1 kPalmOneDeviceIDTreo600

Definition at line 951 of file HsExtCommon.h.

#define hsDeviceIDOs5Device1Sim kPalmOneDeviceIDTreo600Sim

Definition at line 952 of file HsExtCommon.h.

#define hsDeviceIDTreo180 0x0B

Treo 180

Definition at line 936 of file HsExtCommon.h.

#define hsDeviceIDTreo270 0x0D

Treo 270

Definition at line 937 of file HsExtCommon.h.

#define hsDeviceIDTreo300 0x0E

Treo 300

Definition at line 938 of file HsExtCommon.h.

#define hsDeviceIDTreo600 kPalmOneDeviceIDTreo600

Treo 600

Definition at line 947 of file HsExtCommon.h.

#define hsDeviceIDTreo600Sim kPalmOneDeviceIDTreo600Sim

Treo 600 Simulator

Definition at line 948 of file HsExtCommon.h.

#define hsDeviceIDTreo90 0x8C

Treo 90

Definition at line 941 of file HsExtCommon.h.

#define hsDeviceIDVisor 0x00

Visor, Visor Deluxe

Definition at line 932 of file HsExtCommon.h.

#define hsDeviceIDVisorEdge 0x09

Visor Edge

Definition at line 934 of file HsExtCommon.h.

#define hsDeviceIDVisorNeo 0x8A

Visor Neo (some Neos may have 0x08)

Definition at line 939 of file HsExtCommon.h.

#define hsDeviceIDVisorPlatinum 0x08

Visor Platinum, some Visor Neos

Definition at line 933 of file HsExtCommon.h.

#define hsDeviceIDVisorPrism 0x0A

Visor Prism

Definition at line 935 of file HsExtCommon.h.

#define hsDeviceIDVisorPro 0x8B

Visor Pro

Definition at line 940 of file HsExtCommon.h.

#define hsDispFtrCreator 'DisA'

Display Attribute Features

Definition at line 347 of file HsExtCommon.h.

#define hsDispFtrIDControllerShades 2

This feature contains the number of shades of gray, red, green, and blue available on this controller. This can be larger than the number of shades that the display can show, since the controller can do hardware dithering to deal with the fact that the display can't show all the shades.

Software dithering is handled separately. If there is software dithering, it can be suppressed. See hsAttrDitherSuppress

Definition at line 392 of file HsExtCommon.h.

#define hsDispFtrIDDisplayAttributes 0

Attributes about the display / controller combination...

Definition at line 350 of file HsExtCommon.h.

#define hsDispFtrIDDisplayShades 1

Definition at line 381 of file HsExtCommon.h.

#define hsDispFtrValBlueOffset 0

Definition at line 402 of file HsExtCommon.h.

#define hsDispFtrValBulverdePxa27X 0x00000005

Intel Bulverde PXA 270, 271, etc.

Definition at line 363 of file HsExtCommon.h.

#define hsDispFtrValBwStn 0x00000100

The black and white STN used in black and white Visors and Treos.

Definition at line 366 of file HsExtCommon.h.

#define hsDispFtrValColorOled 0x00000400

Organic LED

Definition at line 369 of file HsExtCommon.h.

#define hsDispFtrValColorStn 0x00000200

Color STN

Definition at line 367 of file HsExtCommon.h.

#define hsDispFtrValColorTft 0x00000300

Color TFT (used in Prism)

Definition at line 368 of file HsExtCommon.h.

#define hsDispFtrValDragonballVZ 0x00000000

Definition at line 358 of file HsExtCommon.h.

#define hsDispFtrValGrayOffset 24

You can use these bitmasks to get the number of shades ...note that the actual number of shades is the (value+1). This is needed so in the future we can support displays/controllers that can have 256 shades.

Definition at line 399 of file HsExtCommon.h.

#define hsDispFtrValGreenOffset 8

Definition at line 401 of file HsExtCommon.h.

#define hsDispFtrValLCDControllerTypeMask 0x000000FF

Definition at line 357 of file HsExtCommon.h.

#define hsDispFtrValLCDDisplayTypeMask 0x0000FF00

Definition at line 365 of file HsExtCommon.h.

#define hsDispFtrValOmapX10 0x00000004

TI OMAP 1510/310

Definition at line 362 of file HsExtCommon.h.

#define hsDispFtrValRedOffset 16

Definition at line 400 of file HsExtCommon.h.

#define hsDispFtrValSed1375 0x00000001

Definition at line 359 of file HsExtCommon.h.

#define hsDispFtrValSed1376 0x00000002

Definition at line 360 of file HsExtCommon.h.

#define hsDispFtrValSed13A3 0x00000003

Definition at line 361 of file HsExtCommon.h.

#define hsErrAppStopEvent (hsExtErrorClass | 0x16)

The blocking call was interrupted by AppStop event

Definition at line 134 of file HsExtCommon.h.

#define hsErrBufferTooSmall (hsOLDErrorClass | 0x05)

Error codes

Definition at line 102 of file HsExtCommon.h.

#define hsErrCardNotInstalled (hsOLDErrorClass | 0x0A)

Error codes

Definition at line 107 of file HsExtCommon.h.

#define hsErrCardPatchAlreadyInstalled (hsOLDErrorClass | 0x07)

Error codes

Definition at line 104 of file HsExtCommon.h.

#define hsErrCardPatchNotInstalled (hsOLDErrorClass | 0x08)

Error codes

Definition at line 105 of file HsExtCommon.h.

#define hsErrFixedStorageRequired (hsOLDErrorClass | 0x0D)

Error codes

Definition at line 110 of file HsExtCommon.h.

#define hsErrGPRSNotAttached (hsExtErrorClass | 0x19)

Failed to attach GPRS, or timed out while waiting to register

Definition at line 144 of file HsExtCommon.h.

#define hsErrIndicatorDisabled (hsOLDErrorClass | 0x12)

Error codes

Definition at line 115 of file HsExtCommon.h.

#define hsErrIndicatorInvalidCap (hsOLDErrorClass | 0x11)

Error codes

Definition at line 114 of file HsExtCommon.h.

#define hsErrIndicatorInvalidSequence (hsOLDErrorClass | 0x10)

Error codes

Definition at line 113 of file HsExtCommon.h.

#define hsErrInUse (hsOLDErrorClass | 0x0F)

Error codes

Definition at line 112 of file HsExtCommon.h.

#define hsErrInvalidCardHdr (hsOLDErrorClass | 0x06)

Error codes

Definition at line 103 of file HsExtCommon.h.

#define hsErrInvalidCardNum (hsOLDErrorClass | 0x02)

Error codes

Definition at line 99 of file HsExtCommon.h.

#define hsErrInvalidParam (hsOLDErrorClass | 0x04)

Error codes

Definition at line 101 of file HsExtCommon.h.

#define hsErrInvalidPeriod (hsOLDErrorClass | 0x0B)

Error codes

Definition at line 108 of file HsExtCommon.h.

#define hsErrNotEnoughPower (hsOLDErrorClass | 0x09)

Error codes

Definition at line 106 of file HsExtCommon.h.

#define hsErrNotSupported (hsOLDErrorClass | 0x01)

Error codes

Definition at line 98 of file HsExtCommon.h.

#define hsErrOutOfCoverage (hsExtErrorClass | 0x15)

Failed to register on carrier's network, or timed out while waiting to register.

Definition at line 131 of file HsExtCommon.h.

#define hsErrOutOfMemory (hsExtErrorClass | 0x17)

Request failed because of insufficient memory

Definition at line 137 of file HsExtCommon.h.

#define hsErrPeriodicAlreadyInstalled (hsOLDErrorClass | 0x0E)

Error codes

Definition at line 111 of file HsExtCommon.h.

#define hsErrPeriodicNotInstalled (hsOLDErrorClass | 0x0C)

Error codes

Definition at line 109 of file HsExtCommon.h.

#define hsErrReadOnly (hsOLDErrorClass | 0x03)

Error codes

Definition at line 100 of file HsExtCommon.h.

#define hsErrSIMMissing (hsExtErrorClass | 0x18)

The SIM is missing, invalid, wrong unlock code, or some other SIM problem detected that prevented network registration from completing.

Definition at line 141 of file HsExtCommon.h.

#define hsErrTimeOut (hsExtErrorClass | 0x1A)

The requiested operation timed out, without completing its objective

Definition at line 147 of file HsExtCommon.h.

#define hsErrUnderflow (hsExtErrorClass | 0x13)

Unexpected numerical underflow encountered

Definition at line 124 of file HsExtCommon.h.

#define hsErrUserInterrupted (hsExtErrorClass | 0x1B)

The requiested operation was interrupted or cancelled by user, before completing its objective

Definition at line 151 of file HsExtCommon.h.

#define hsErrUserNoRadio (hsExtErrorClass | 0x14)

The user replied "No" when prompted to turn on wireless mode

Definition at line 127 of file HsExtCommon.h.

#define hsFtrCreator 'hsEx'

This is the Handspring feature id. Apps can tell if they're on a handspring device if they get 0 err back from: err = FtrGet (hsFtrCreator, hsFtrIDVersion, &value)

Definition at line 198 of file HsExtCommon.h.

#define hsFtrIDBugsFixed 4

This features contains boolean flags to let developers know that a bug present in older devices has been fixed.

Definition at line 237 of file HsExtCommon.h.

#define hsFtrIDCurrentAppOnSleep 12

This feature and value (s) is used to see if PhoneApp should be relaunched when waking up.

THIS FEATURE IS DEPRICATED

Definition at line 318 of file HsExtCommon.h.

#define hsFtrIDGrfAreaDisabled 9

If this feature is set, the graffiti area is disabled

Definition at line 287 of file HsExtCommon.h.

#define hsFtrIDHardwareApiRevision 15

This feature can be used to determine the hardware "API" revision. It changes when there's a revision of the hardware, but the device is otherwise the same. Very few apps should ever need this. Drivers should generally ask the HAL directly for this info (though HALAttr) since that's more efficient.

Definition at line 340 of file HsExtCommon.h.

#define hsFtrIDKeyboardLayout 10

This feature tells which keyboard layout is being used

Definition at line 292 of file HsExtCommon.h.

#define hsFtrIDLdbMgrLibRefNum 2

Feature number indicating that the Launcher Database Mgr library is loaded. The value of the feature is the refNum of the loaded library. Call FtrGet (hsFtrCreator, hsFtrIDLdbMgrLibRefNum, ...) to get this feature.

THIS FEATURE IS DEPRICATED

Definition at line 226 of file HsExtCommon.h.

#define hsFtrIDModDate 1

Library alias names that SysLibFind maps to a real library name according to the appropriate hsPrefSerialLibXXX setting.

By Convention, library alias names start with a '*'. The exception is the "Serial Library" name which is mapped in order to be compatible with pre-existing applications that already use it. hsPrefSerialLibDef

Definition at line 216 of file HsExtCommon.h.

#define hsFtrIDNavigationSupported 14

If this feature exists, then our navigation support exists. The version of the navigation support is stored in the feature's value.

Definition at line 331 of file HsExtCommon.h.

#define hsFtrIDNoMemSemaphore 3

If this feature is present, then we won't use the optimization to grab the memory semaphore before doing multiple data manager calls.

Definition at line 232 of file HsExtCommon.h.

#define hsFtrIDPowerKeyResponse 7

This feature defines how the power putton behaves Note: In HsExtensions 1.0 for PalmOS 5.2.1 this feature is set, but ignored

Definition at line 271 of file HsExtCommon.h.

#define hsFtrIDRadioAttributes 6

This feature describes the radio hardware available

Definition at line 260 of file HsExtCommon.h.

#define hsFtrIDStatusGadgetRev 8

This feature indicates the functionality of the status gadgets API

Definition at line 280 of file HsExtCommon.h.

#define hsFtrIDTestingBootMode 13

This feature indicates whether the Manufacturing test app is present on the device.

Definition at line 325 of file HsExtCommon.h.

#define hsFtrIDToneOnLidOpen 11

This features contains the DB Id to open and play the resource with type 'smfr' with resource id 1 when the lid opens

THIS FEATURE IS DEPRICATED

Definition at line 310 of file HsExtCommon.h.

#define hsFtrIDTypeOfKeyboard 5

This feature tells what type of hardware keys a device has.

Definition at line 244 of file HsExtCommon.h.

#define hsFtrIDVersion 0

Version of Handspring extensions 0xMMmfsHHh, where:

MM.mm.f are the major, minor, and fix revs of PalmOS which is modified by this version of HsExtensions

s is the release stage (3-release,2-beta,1-alpha,0-development)

HH.h are the major and minor rev of HsExtensions for the relevant version of PalmOS

Definition at line 213 of file HsExtCommon.h.

#define hsFtrValCurrentAppOnSleepPhoneAppSpeedDialView 0x0001

PhoneApp current view is Speed dial

Definition at line 319 of file HsExtCommon.h.

#define hsFtrValKeyboardBasic 0x0001

The masks used to interpret the hardware keyboard feature Basic keys (pwr/scroll/app)

Definition at line 249 of file HsExtCommon.h.

#define hsFtrValKeyboardCommCentric 0x0008

DEPRICATED - Communicator centric buttons

Definition at line 253 of file HsExtCommon.h.

#define hsFtrValKeyboardCustomApps 0x0010

Non-standard app keys (Standard is: date/addr/todo/memo) replaces hsFtrValKeyboardCommCentric

Definition at line 254 of file HsExtCommon.h.

#define hsFtrValKeyboardJog 0x0004

Jog keys (jog-up, jog-down,jog-scan)

Definition at line 252 of file HsExtCommon.h.

#define hsFtrValKeyboardLayout_deDE 0x0002

German

Definition at line 299 of file HsExtCommon.h.

#define hsFtrValKeyboardLayout_enUS 0x0001

The values used to interpret the keyboard layout feature English

Definition at line 298 of file HsExtCommon.h.

#define hsFtrValKeyboardLayout_frFR 0x0003

French

Definition at line 300 of file HsExtCommon.h.

#define hsFtrValKeyboardQwerty 0x0002

Qwerty keys (A-Z, Period, Space, Backspace, Enter, Menu, Option, Shift)

Definition at line 250 of file HsExtCommon.h.

#define hsFtrValPowerKeyDoubleClkBacklight 0x0001

Double click for backlight

Definition at line 272 of file HsExtCommon.h.

#define hsFtrValPowerKeyHoldRadioPower 0x0004

Hold for radio power

Definition at line 274 of file HsExtCommon.h.

#define hsFtrValPowerKeyTripleClkInvert 0x0002

Triple click for invers (requires DblClkBacklight)

Definition at line 273 of file HsExtCommon.h.

#define hsFtrValRadioAvailable 0x0001

Radio is present and available for use

Definition at line 263 of file HsExtCommon.h.

#define hsFtrValRadioBuiltin 0x0002

Radio is part of the base hardware and not on a module

Definition at line 264 of file HsExtCommon.h.

#define hsFtrValStatusGadgetRev1 0x0001

Revision 1 of API

Definition at line 282 of file HsExtCommon.h.

#define hsHALIDHandspringOs35_40 'Hs01'

Used by all Handspring OS 3.5 HALs and 4.0 HALs

Definition at line 910 of file HsExtCommon.h.

#define hsHALIDHandspringOs5Rev1 'H5_1'

Used by Handspring's 5.0 HALs

Definition at line 912 of file HsExtCommon.h.

#define hsHALIDHandspringOs5Rev1Sim 'H5s1'

Used by Handspring's 5.0 Simulator HALs

Definition at line 913 of file HsExtCommon.h.

#define hsHALIDHandspringOs5Rev2 'H5_2'

Used by Handspring's 5.2 HALs

Definition at line 915 of file HsExtCommon.h.

#define hsHALIDHandspringOs5Rev2Sim 'H5s2'

Used by Handspring's 5.2 Simulator HALs

Definition at line 916 of file HsExtCommon.h.

#define hsHALIDHandspringOs5Rev3 'P052'

Used by Handspring's 5.3 HALs

Definition at line 918 of file HsExtCommon.h.

#define hsHALIDHandspringOs5Rev3Sim 'S052'

Used by Handspring's 5.3 Simulator HALs

Definition at line 919 of file HsExtCommon.h.

#define hsHALIDHandspringOs5Rev4 'P053'

Used by Handspring's 5.4 HALs

Definition at line 921 of file HsExtCommon.h.

#define hsHALIDHandspringOs5Rev4Sim 'S053'

Used by Handspring's 5.4 Simulator HALs

Definition at line 922 of file HsExtCommon.h.

#define hsKeyguardAutoDisabled 0

Never

Definition at line 672 of file HsExtCommon.h.

#define hsKeyguardAutoPowerOff 0xFFFF

When device powers off

Definition at line 673 of file HsExtCommon.h.

#define hsKeyguardFlagPowerOnDialog 0x0001

Show keyguard dialog at power-on

Definition at line 681 of file HsExtCommon.h.

#define hsLibAliasConsole "*Cons SerLib"

hsPrefSerialLibConsole

Definition at line 175 of file HsExtCommon.h.

#define hsLibAliasDefault "Serial Library"

Library alias names that SysLibFind maps to a real library name according to the appropriate hsPrefSerialLibXXX setting.

By Convention, library alias names start with a '*'. The exception is the "Serial Library" name which is mapped in order to be compatible with pre-existing applications that already use it. hsPrefSerialLibDef

Definition at line 171 of file HsExtCommon.h.

#define hsLibAliasHotSyncLocal "*HsLoc SerLib"

hsPrefSerialLibHotSyncLocal

Definition at line 172 of file HsExtCommon.h.

#define hsLibAliasHotSyncModem "*HsMdm SerLib"

hsPrefSerialLibHotSyncModem

Definition at line 173 of file HsExtCommon.h.

#define hsLibAliasIrda "*Irda SerLib"

hsPrefSerialLibIrda

Definition at line 174 of file HsExtCommon.h.

#define hsLibNameBuiltInSerial "BuiltIn SerLib"

Actual library name of the Dragonball's built-in serial library. This is the default value of the hsPrefDefSerialLib pref setting which SysLibFind uses to map an incoming library name to an actual library name.

Definition at line 184 of file HsExtCommon.h.

#define hsLightCircumstanceAlertWokeDeviceFlagBit 0x0001

Definition at line 785 of file HsExtCommon.h.

#define hsLightCircumstanceKeylightOffFlagBit 0x0010

Definition at line 789 of file HsExtCommon.h.

#define hsLightCircumstanceQuickTypingFlagBit 0x0002

Definition at line 786 of file HsExtCommon.h.

#define hsLightCircumstanceUserNotLookingFlagBit 0x0004

Definition at line 787 of file HsExtCommon.h.

#define hsLightCircumstanceUserNotLookingLongTimeFlagBit 0x0008

Definition at line 788 of file HsExtCommon.h.

#define hsMaxSaveAsNameSize 32

This is the buffer size that should be sent to HsExtDoSaveAsDialog()

Definition at line 431 of file HsExtCommon.h.

#define hsOLDErrorClass (appErrorClass+0x0100)

Error codes

Definition at line 97 of file HsExtCommon.h.

#define hsTouchscreenDisableFlagDuringCall 0x0002

Definition at line 690 of file HsExtCommon.h.

#define hsTouchscreenDisableFlagIncomingCall 0x0001

Definition at line 689 of file HsExtCommon.h.

#define hsVersionStringSize 32

Definition at line 44 of file HsExtCommon.h.

#define hsWordCorrectMaxWordLen 25

Max length (in bytes) of a word (corrected or not) in the word correction dictionary. With null, word can be 26 bytes.

Definition at line 83 of file HsExtCommon.h.

## Enumeration Type Documentation

enum HsAttrEnum

Parameters to HsAttrGet/Set calls

Enumerator:

  hsAttr68KLidOpen | UInt16 See also: hsAttrLidOpen
  hsAttr68KSysSleepReason | UInt16 See also: hsAttrSysSleepReason
  hsAttr68KDisplayOn | UInt16 See also: hsAttrDisplayOn
  hsAttr68KRingSwitch | UInt16 See also: hsAttrRingSwitch
  hsAttr68KPostProcessRsc | UInt32 See also: hsAttrPostProcessRsc
  hsAttr68KSysActive | UInt16 See also: hsAttrSysActive
  hsAttr68KActiveCalls | UInt16 See also: hsAttrActiveCalls
  hsAttr68KPhoneType | UInt32 See also: hsAttrPhoneType
  hsAttr68KKeyboardLocked | Boolean See also: hsAttrKeyboardLocked
  hsAttr68KKeyLockNextWakeTicks | UInt32 See also: hsAttrKeyLockNextWakeTicks
  hsAttrLidOpen | false=lid closed, true=lid open (returns hsErrNotSupported if no lid)
  hsAttrSysSleepReason | Same as the SleepEventParamType.reason from the last sysNotifySleepRequestEvent unless the real reason is different (e.g. hsSysSleepLid)
  hsAttrDisplayOn | true = display is on, false = dispay is off
  hsAttrRingSwitch | State of ring switch, can be either hsAttrRingSwitchMute or hsAttrRingSwitchLoud
  hsAttrPostProcessRsc | Pointer to resource containing the post-processing lists
  hsAttrSysActive | Bits representing various system activity. Current implementation sets only the hsAttrSysActiveHotSync bit if the HotSync dialog is active
  hsAttrActiveCalls | Number of active voice calls
  hsAttrPhoneType | returns hsAttrPhoneTypeCDMA if a CDMA phone or hsAttrPhoneTypeGSM if a GSM phone
  hsAttrKeyboardLocked | true = keyguard active
  hsAttrKeyLockNextWakeTicks | deprecated
  hsAttrKeyboardDB | DmOpenRef of database containing keyboard layout resources
  hsAttrDigitizerLock | true = digitizer is locked
  hsAttrE911Mode | true = phone is in 911 mode
  hsAttrDitherSuppress | count of requests to supress dithering Set to non-zero to increment, set to zero to decrement
  hsAttrHotSyncSuppress | count of requests to suppress HotSync Set to non-zero to increment, set to zero to decrement
  hsAttrPhoneRadioPowerState | notifies HsExt that cell phone radio was just powered on or off; non-zero if cell phone radio was powered on, zero if powered down. Power on does *not* imply completion of SIM detection or registration
  hsAttrAllKeysWakeFromSleep | (Refcount) sets the device in a mode where _all_ keys wake the device from sleep and are processed. This is intended in special cases where we've powered off the screen to save power (or something similar), but the user still thinks the device of the device as on. As a side effect, this will stop 'keyboard lock' from starting when the device turns off. Set to non-zero to increment, set to zero to decrement
  hsForcePrefAutoOffDurationSecs |
  hsAttrKeyguardDialogOn |
  hsAttrReserved_SDK20_1 |
  hsAttrReserved_SDK20_2 |
  hsAttrReserved_SDK20_3 |
  hsAttrReserved_SDK20_4 |
  hsAttrReserved_SDK20_5 |
  hsAttrReserved_SDK20_6 |
  hsAttrReserved_SDK20_7 |

Definition at line 474 of file HsExtCommon.h.

    00475   { /*
    00476      *  These attributes with various sizes are defined
    00477      *  only for compatability with existing 68K code, and
    00478      *  are explicitly marshalled by the 68K/ARM shim for
    00479      *  the HsAttrGet() and HsAttrSet() functions.
    00480      *
    00481      *  Note: The definitions for hsAttrE911Mode in the
    00482      *  OS 3.5 headers, and for hsAttrKeyboardLocked in
    00483      *  the OS 4.0 headers both had an enum value of 8.
    00484      *  Apps using hsAttrE911Mode will probably have to be
    00485      *  recompiled anyway so backward compatability has
    00486      *  been maintained hsAttrKeyboardLocked.
    00487      */
    00488     hsAttr68KLidOpen,               /**< UInt16 @see hsAttrLidOpen */
    00489     hsAttr68KSysSleepReason,        /**< UInt16 @see hsAttrSysSleepReason */
    00490     hsAttr68KDisplayOn,             /**< UInt16  @see hsAttrDisplayOn */
    00491     hsAttr68KRingSwitch,            /**< UInt16 @see hsAttrRingSwitch */
    00492     hsAttr68KPostProcessRsc,        /**< UInt32 @see hsAttrPostProcessRsc */
    00493     hsAttr68KSysActive,             /**< UInt16 @see hsAttrSysActive */
    00494     hsAttr68KActiveCalls,           /**< UInt16 @see hsAttrActiveCalls */
    00495     hsAttr68KPhoneType,             /**< UInt32 @see hsAttrPhoneType */
    00496     hsAttr68KKeyboardLocked,        /**< Boolean @see hsAttrKeyboardLocked */
    00497     hsAttr68KKeyLockNextWakeTicks,  /**< UInt32 @see hsAttrKeyLockNextWakeTicks */
    00498
    00499     /*
    00500      * All new 68K and ARM code shall use only the following
    00501      * attributes, all of which take a 32-bit value parameter.
    00502      */
    00503     hsAttrLidOpen = 0x80,       /**< false=lid closed, true=lid open
    00504                                     (returns hsErrNotSupported if no lid) */
    00505     hsAttrSysSleepReason,       /**< Same as the SleepEventParamType.reason
    00506                                        from the last sysNotifySleepRequestEvent
    00507                                        unless the real reason is different
    00508                                        (e.g. hsSysSleepLid) */
    00509     hsAttrDisplayOn,            /**< true = display is on, false = dispay is off */
    00510     hsAttrRingSwitch,       /**< State of ring switch, can be either hsAttrRingSwitchMute or hsAttrRingSwitchLoud */
    00511     hsAttrPostProcessRsc,       /**< Pointer to resource containing the post-processing lists */
    00512     hsAttrSysActive,            /**< Bits representing various system activity. Current
    00513                                      implementation sets only the hsAttrSysActiveHotSync
    00514                                      bit if the HotSync dialog is active*/
    00515     hsAttrActiveCalls,          /**< Number of active voice calls */
    00516     hsAttrPhoneType,            /**< returns hsAttrPhoneTypeCDMA if a CDMA phone
    00517                                      or hsAttrPhoneTypeGSM if a GSM phone */
    00518     hsAttrKeyboardLocked,       /**< true = keyguard active */
    00519     hsAttrKeyLockNextWakeTicks, /**< deprecated */
    00520     hsAttrKeyboardDB,           /**< DmOpenRef of database containing keyboard layout resources */
    00521     hsAttrDigitizerLock,        /**< true = digitizer is locked */
    00522     hsAttrE911Mode,             /**< true = phone is in 911 mode */
    00523     hsAttrDitherSuppress,       /**< count of requests to supress dithering
    00524                                         Set to non-zero to increment, set to zero to decrement */
    00525     hsAttrHotSyncSuppress,      /**< count of requests to suppress HotSync
    00526                                         Set to non-zero to increment, set to zero to decrement */
    00527
    00528     hsAttrPhoneRadioPowerState, /**< notifies HsExt that cell phone radio was just powered on
    00529                                         or off; non-zero if cell phone radio was powered on, zero if
    00530                                         powered down.  Power on does *not* imply completion of SIM
    00531                                         detection or registration */
    00532
    00533     hsAttrAllKeysWakeFromSleep, /**< (Refcount) sets the device in a mode where _all_ keys wake
    00534                                         the device from sleep and are processed.  This is intended in
    00535                                         special cases where we've powered off the screen to save power
    00536                                         (or something similar), but the user still thinks the device of
    00537                                         the device as on.  As a side effect, this will stop 'keyboard lock'
    00538                                         from starting when the device turns off.
    00539                                         Set to non-zero to increment, set to zero to decrement */
    00540
    00541     hsForcePrefAutoOffDurationSecs, //  Forces the Keyguard dialog to have a timeout period of prefAutoOffDurationSecs
    00542     hsAttrKeyguardDialogOn,         //  Denotes if the Keyguard dialog is On or not.
    00543
    00544     // This section is reserved so that if we need to add adds more attributes in "SDK 2.0"
    00545     // products that they won't conflict with attributes added in "SDK 2.1"
    00546     hsAttrReserved_SDK20_1,
    00547     hsAttrReserved_SDK20_2,
    00548     hsAttrReserved_SDK20_3,
    00549     hsAttrReserved_SDK20_4,
    00550     hsAttrReserved_SDK20_5,
    00551     hsAttrReserved_SDK20_6,
    00552     hsAttrReserved_SDK20_7
    00553
    00554     /*
    00555      * Attributes greater than 0x9000 are defined for internal use
    00556      * in Prv/HsExtAttr.h
    00557      */
    00558   } HsAttrEnum;

enum HsIndicatorCountEnum

Pass a numeric count or one of these special values to HsIndicatorState()

Enumerator:

  kIndicatorCountGetState | retrieve the current state
  kIndicatorCountForever | run forever

Definition at line 814 of file HsExtCommon.h.

    00815   {
    00816     kIndicatorCountGetState = 0,        /**< retrieve the current state */
    00817     kIndicatorCountForever  = 0xFFFF    /**< run forever */
    00818   }

enum HsIndicatorStateEnum

There are several different sources of turning on the indicator, (Charge, Signal, Ring, App) with each source being in exactly one state at any moment. The high byte of these enum values indicates the source, and the low byte indicates which state that source is in. Each source has a hard-coded priority, so only the indication of the highest priority source not in its "None" state will appear on the indicator. The value of the high byte does not represent the priority.

A virtual state that is used to get the state that is currently active on the indicator (the highest priority active source). This value is also the result when there is no active source. (States with * aren't used at present)

Enumerator:

  kIndicatorStateNull |
  kIndicatorForceNone | Don't force anything
  kIndicatorForceOn | Force the indicator on
  kIndicatorForceRed | Force the red led on
  kIndicatorForceGreen | Force the green led on
  kIndicatorForceRedGreen | Force both leds on (orange)
  kIndicatorForceOff | Force both leds off
  kIndicatorRingNone | Phone not ringing
  kIndicatorRingActive | Phone ringing
  kIndicatorRingContact | *Phone ringing, CID recognized
  kIndicatorRingRoam | *Phone ringing, roaming
  kIndicatorAlertNone | Alert not active
  kIndicatorAlertAlert | Generic alert
  kIndicatorAlertMail | Incoming mail
  kIndicatorAlertCalendar | Datebook alarm
  kIndicatorAlertSMS | Incoming SMS
  kIndicatorAlertVoicemail | Voicemail waiting
  kIndicatorAlertPending | Attention alert pending
  kIndicatorBattNone | Not connected to a charger
  kIndicatorBattCharge | Battery is charging
  kIndicatorBattTrickle | Battery is topping off
  kIndicatorBattFull | Battery is fully charged
  kIndicatorBattLow | *Battery is low (and not on a charger)
  kIndicatorUsageNone | Not in use
  kIndicatorUsageVoiceCall | Phone on an active voice call
  kIndicatorUsageDataCall | Phone on an active data call
  kIndicatorSignalNone | Radio turned off
  kIndicatorSignalBad | Out of coverage
  kIndicatorSignalGood | In coverage
  kIndicatorSignalRoam | *In coverage, roaming

Definition at line 837 of file HsExtCommon.h.

    00838   {
    00839
    00840     kIndicatorStateNull   = 0x0000,
    00841
    00842     kIndicatorForceNone   = 0x0100,     /**< Don't force anything */
    00843     kIndicatorForceOn     = 0x0101,     /**< Force the indicator on */
    00844     kIndicatorForceRed    = 0x0101,     /**< Force the red led on */
    00845     kIndicatorForceGreen,               /**< Force the green led on */
    00846     kIndicatorForceRedGreen,            /**< Force both leds on (orange) */
    00847     kIndicatorForceOff    = 0x0180,     /**< Force both leds off */
    00848
    00849     kIndicatorRingNone    = 0x0200,     /**< Phone not ringing */
    00850     kIndicatorRingActive,               /**< Phone ringing */
    00851     kIndicatorRingContact,              /**< *Phone ringing, CID recognized */
    00852     kIndicatorRingRoam,                 /**< *Phone ringing, roaming */
    00853
    00854     kIndicatorAlertNone   = 0x0300,     /**< Alert not active */
    00855     kIndicatorAlertAlert,               /**< Generic alert */
    00856     kIndicatorAlertMail,                /**< Incoming mail */
    00857     kIndicatorAlertCalendar,            /**< Datebook alarm */
    00858     kIndicatorAlertSMS,                 /**< Incoming SMS */
    00859     kIndicatorAlertVoicemail,           /**< Voicemail waiting */
    00860     kIndicatorAlertPending,             /**< Attention alert pending */
    00861
    00862     kIndicatorBattNone    = 0x0400,     /**< Not connected to a charger */
    00863     kIndicatorBattCharge,               /**< Battery is charging */
    00864     kIndicatorBattTrickle,              /**< Battery is topping off */
    00865     kIndicatorBattFull,                 /**< Battery is fully charged */
    00866     kIndicatorBattLow,                  /**< *Battery is low (and not on a charger) */
    00867
    00868     kIndicatorUsageNone   = 0x0600,     /**< Not in use */
    00869     kIndicatorUsageVoiceCall,           /**< Phone on an active voice call */
    00870     kIndicatorUsageDataCall,            /**< Phone on an active data call */
    00871
    00872     kIndicatorSignalNone  = 0x0500,         /**< Radio turned off */
    00873     kIndicatorSignalBad,                /**< Out of coverage */
    00874     kIndicatorSignalGood,               /**< In coverage */
    00875     kIndicatorSignalRoam                /**< *In coverage, roaming */
    00876   }

enum HsIndicatorTypeEnum

Enumerator:

  kIndicatorTypeLed |
  kIndicatorTypeVibrator |
  kIndicatorTypeCount |

Definition at line 801 of file HsExtCommon.h.

    00802   {
    00803     kIndicatorTypeLed,
    00804     kIndicatorTypeVibrator,
    00805
    00806     // This must be last
    00807     kIndicatorTypeCount
    00808   }

enum HsLightCircumstanceEnum

These circumstances modify the mode and allow us to handle different logical circumstances on devices with different hardware.

- These are applied in the following order: 1. Alert woke device 2. keylight off 3. Quick typing 4. User not looking 5. User not looking for a long time

Enumerator:

  hsLightCircumstanceFirst |
  hsLightCircumstanceAlertWokeDevice | An important alert woke the device up from sleep.
  hsLightCircumstanceQuickTyping | We want the user to be able to access the keyboard easily
  hsLightCircumstanceUserNotLooking | We suspect the user isn't looking at the device if they're not actively using the device, so we'll dim the screen (but we don't actually want to turn it off).
  hsLightCircumstanceUserNotLookingLongTime | similar to above, but if the inactivity persists then we want to turn the screen off
  hsLightCircumstanceKeylightOff |
  hsLightCircumstanceNumCircumstances | Num circumstances. SUBJECT TO CHANGE.
  hsLightCircumstanceReserved | Reserved circumstance to force compiler to use 16-bit for enum...

Definition at line 752 of file HsExtCommon.h.

    00753   {
    00754     hsLightCircumstanceFirst        = 0,    /**<        */
    00755     hsLightCircumstanceAlertWokeDevice  = 0,    /**< An important alert woke the  device up from sleep.*/
    00756     hsLightCircumstanceQuickTyping      = 1,    /**< We want the user to be able  to access the keyboard easily */
    00757     hsLightCircumstanceUserNotLooking   = 2,    /**< We suspect the user isn't looking at the device if they're
    00758                                  not actively using the device, so we'll dim the screen (but we don't
    00759                                                   actually want to turn it off).*/
    00760     hsLightCircumstanceUserNotLookingLongTime = 3,  /**< similar to above, but if the inactivity persists then
    00761                                we want to turn the screen off **/
    00762
    00763     hsLightCircumstanceKeylightOff      = 4,    /* turn keylight off */
    00764
    00765     hsLightCircumstanceNumCircumstances,        /**< Num circumstances.   SUBJECT TO CHANGE.*/
    00766
    00767     /**
    00768      *  Reserved circumstance to force compiler to use 16-bit for enum...
    00769      **/
    00770     hsLightCircumstanceReserved = 0x7FFF
    00771   }

enum HsLightModeEnum

These are different modes that can be used to affect the light manager, which is in charge of temporary changes in the lighting situation.

Enumerator:

  hsLightModeNormal | Light mode is at normal presets
  hsLightModeNight | Light mode is at night-mode presets
  hsLightModeNumPresets | Num presets. SUBJECT TO CHANGE.
  hsLightModeReserved | Reserved mode to force compiler to use 16-bit for enum...

Definition at line 725 of file HsExtCommon.h.

    00726   {
    00727     // Preset modes
    00728     // ------------
    00729     // These modes have saved values associated with them...
    00730     hsLightModeNormal = 0,      /**< Light mode is at normal presets */
    00731     hsLightModeNight  = 1,      /**< Light mode is at night-mode presets */
    00732
    00733     hsLightModeNumPresets,  /**< Num presets.  SUBJECT TO CHANGE. */
    00734
    00735     /** Reserved mode to force compiler to use 16-bit for enum... */
    00736     hsLightModeReserved = 0x7FFF
    00737   }

enum HsPrefEnum

Equates for the HsPrefGet/Set calls

Enumerator:

  hsPrefSerialLibDef | Char[] : Name of serial library to substitute for hsLibAliasDefault
  hsPrefSerialLibHotSyncLocal | Char[] : Name of serial library to substitute for hsLibAliasHotSyncLocal
  hsPrefSerialLibHotSyncModem | Char[] : Name of serial library to substitute for hsLibAliasHotSyncModem
  hsPrefSerialLibIrda | Char[] : Name of serial library to substitute for hsLibAliasIrda
  hsPrefSerialLibConsole | Char[] : Name of serial library to substitute for hsLibAliasConsole
  hsPrefJogScanCharAppCreator | UInt32 : Creator type of app to launch in response to hsChrJogScan
  hsPrefLidStatusChgCharAppCreator | UInt32 : Creator type of app to launch in response to hsChrLidStatusChg
  hsPrefOptHard1CharAppCreator | UInt32 : Creator type of app to launch n response to hsChrOptHard1
  hsPrefOptHard2CharAppCreator | UInt32 : Creator type of app to launch in response to hsChrOptHard2
  hsPrefOptHard3CharAppCreator | UInt32 : Creator type of app to launch in response to hsChrOptHard3
  hsPrefOptHard4CharAppCreator | UInt32 : Creator type of app to launch in response to hsChrOptHard4
  hsPrefTempShiftTimeOut | UInt32 : Number of ticks until a temporary shift state (upper shift or option shift) times out.
  hsPrefLidClosedAutoOffSeconds | UInt16 : Number of seconds for auto-off when the lid is closed
  hsPrefLCDRefreshRate | UInt16 : Type of refresh rate for lighting see HsLCDRefreshRateEnum
  hsPrefNetworkTimeSelected | UInt16: used by CDMA devices - should it read the time from the network
  hsPrefKeyguardAutoEnableTime | UInt16: How many seconds to wait before enabling keyguard
  hsPrefKeyguardAutoEnableAutoOffExtraTime | UInt16 : How many seconds to wait before enabling keyguard when hsPrefKeyguardAutoEnableTime is set to hsKeyguardAutoPowerOff and the device powers off due to the auto-off timer
  hsPrefKeyguardFlags | UInt16 : Flags controlling keyguard's behaviour
  hsPrefTouchscreenDisableFlags | UInt16: Used by the phone app to determine when to disable touchscreen
  hsPrefOptHardPowerCharAppCreator | UInt32 : Creator type of app to launch in response to hsChrOptHardPower
  hsPrefOptReservedCharAppCreator | UInt32 : Creator type of app to launch in response to hsChrOptReserved (for future use)
  hsPrefPowerOnAppCreator | UInt32 : Creator type of app to launch instead of the normally mapped app when the app key turned the power on
  hsPrefSideHardCharAppCreator | UInt32 : Creator type of app to launch instead of the normally mapped app when the side key is pressed
  hsPrefBlinkGreenLEDInCoverage | UInt16 : Set to true if we want the green LED to blink when the device is in coverage
  hsPrefHard11CharAppCreator | UInt32 : Creator type of app to launch in response to vchrHard11
  hsPrefOptHard11CharAppCreator | UInt32 : Creator type of app to launch in response to hsChrOptHard11
  hsPrefUserNotLookingTime | Int32 : After this many seconds since the last action, the user has stopped looking at the device. (auto display/kbd dim)
  hsPrefNetworkTZSelected | UInt16: used by phones - should it read the time zone from the network
  hsPrefShortSideHardCharAppCreator | UInt32: Creator ID of app to launch on short press of side button
  hsPrefPowerSaveMode | Int32 : tied to the hsPrefUserNotLookingTime to turn off the backlight rather than just dim it. LCD remains on.
  hsPrefLast |

Definition at line 570 of file HsExtCommon.h.

    00571   {
    00572
    00573     // The following are used by SysLibFind() to resolve a virtual library
    00574     //  name to an actual one.  They are also used directly by SrmOpen()
    00575     //  to figure out whether to override a new-style driver w/ an old-style
    00576     //  driver.
    00577     hsPrefSerialLibDef,     /**< Char[] : Name of serial library to substitute for hsLibAliasDefault */
    00578     hsPrefSerialLibHotSyncLocal,    /**< Char[] : Name of serial library to substitute for hsLibAliasHotSyncLocal */
    00579     hsPrefSerialLibHotSyncModem,    /**< Char[] : Name of serial library to substitute for hsLibAliasHotSyncModem */
    00580     hsPrefSerialLibIrda,        /**< Char[] : Name of serial library to substitute for hsLibAliasIrda */
    00581     hsPrefSerialLibConsole,     /**< Char[] : Name of serial library to substitute for hsLibAliasConsole */
    00582
    00583     /**** End of prefs recognized by Visor, Visor Deluxe, Platnium, Prism, Edge ****/
    00584
    00585     // The following are used in SysHandleEvent() to launch apps in response
    00586     //  to associated virtual characters.
    00587     hsPrefJogScanCharAppCreator,      /**< UInt32 : Creator type of app to launch in response to hsChrJogScan */
    00588     hsPrefLidStatusChgCharAppCreator, /**< UInt32 : Creator type of app to launch in response to hsChrLidStatusChg */
    00589     hsPrefOptHard1CharAppCreator,     /**< UInt32 : Creator type of app to launch n response to hsChrOptHard1 */
    00590     hsPrefOptHard2CharAppCreator,     /**< UInt32 : Creator type of app to launch in response to hsChrOptHard2 */
    00591     hsPrefOptHard3CharAppCreator,     /**< UInt32 : Creator type of app to launch in response to hsChrOptHard3 */
    00592     hsPrefOptHard4CharAppCreator,     /**< UInt32 : Creator type of app to launch in response to hsChrOptHard4 */
    00593
    00594     // The following are used to set Key Manager preferences
    00595     hsPrefTempShiftTimeOut,           /**< UInt32 : Number of ticks until a temporary
    00596                         shift state (upper shift or option shift) times out. */
    00597
    00598     hsPrefLidClosedAutoOffSeconds,    /**< UInt16 : Number of seconds for auto-off when the lid is closed */
    00599
    00600     hsPrefLCDRefreshRate,         /**< UInt16 : Type of refresh rate for lighting see HsLCDRefreshRateEnum */
    00601
    00602     /**** End of prefs recognized by Treo 90, 180, 270, 300 ****/
    00603
    00604     hsPrefNetworkTimeSelected,    /**< UInt16: used by CDMA devices - should it read the time from the network*/
    00605
    00606     hsPrefKeyguardAutoEnableTime,     /**< UInt16: How many seconds to wait before enabling keyguard*/
    00607
    00608
    00609     hsPrefKeyguardAutoEnableAutoOffExtraTime, /**< UInt16 : How many seconds to wait before enabling
    00610                                                       keyguard when hsPrefKeyguardAutoEnableTime is
    00611                                                       set to hsKeyguardAutoPowerOff and the device
    00612                                                       powers off due to the auto-off timer */
    00613
    00614     hsPrefKeyguardFlags,              /**< UInt16 : Flags controlling keyguard's behaviour */
    00615
    00616     hsPrefTouchscreenDisableFlags,    /**< UInt16: Used by the phone app to determine when to disable touchscreen */
    00617
    00618     // The following are used in SysHandleEvent() to launch apps in response
    00619     //  to associated virtual characters.
    00620     hsPrefOptHardPowerCharAppCreator, /**< UInt32 : Creator type of app to launch in response to hsChrOptHardPower */
    00621
    00622     hsPrefOptReservedCharAppCreator,  /**< UInt32 : Creator type of app to launch in response to hsChrOptReserved (for future use) */
    00623
    00624     hsPrefPowerOnAppCreator,              /**< UInt32 : Creator type of app to launch
    00625                                               instead of the normally mapped app when
    00626                                               the app key turned the power on */
    00627
    00628     /**** End of prefs recognized by Treo 600 ****/
    00629
    00630     hsPrefSideHardCharAppCreator,       /**< UInt32 : Creator type of app to launch
    00631                                               instead of the normally mapped app when
    00632                                               the side key is pressed */
    00633
    00634     hsPrefBlinkGreenLEDInCoverage,      /**< UInt16 : Set to true if we want the green
    00635                                               LED to blink when the device is in coverage */
    00636
    00637     /**** End of prefs recognized by Treo 650 ****/
    00638
    00639     hsPrefHard11CharAppCreator,       /**< UInt32 : Creator type of app to launch
    00640                                               in response to vchrHard11 */
    00641
    00642     hsPrefOptHard11CharAppCreator,    /**< UInt32 : Creator type of app to launch
    00643                                               in response to hsChrOptHard11 */
    00644
    00645     hsPrefUserNotLookingTime,           /**< Int32 : After this many seconds since the last
    00646                                                 action, the user has stopped looking
    00647                                                 at the device. (auto display/kbd dim) */
    00648
    00649     // <chg 2005-DEC-14 Monte Benaresh> Added next pref
    00650
    00651     hsPrefNetworkTZSelected,            /**< UInt16: used by phones - should it read
    00652                                                 the time zone from the network*/
    00653
    00654     // RJS 22May06 Added next pref for PTT
    00655     hsPrefShortSideHardCharAppCreator,      /**< UInt32: Creator ID of app to launch on short press of side button */
    00656
    00657     // RTS April 06 Added pref for Gnome/Gandalf
    00658     hsPrefPowerSaveMode,            /**< Int32 : tied to the hsPrefUserNotLookingTime to turn off the backlight
    00659                              rather than just dim it.  LCD remains on.*/
    00660
    00661     // Leave this one at end!!!
    00662     hsPrefLast
    00663
    00664   } HsPrefEnum;

enum HsStatusGadgetTypeEnum

Equates for supporting system handled status gadgets

Enumerator:

  hsStatusGadgetBattery | Status gadget is a battery meter
  hsStatusGadgetSignal | Status gadget is a signal strength indicator

Definition at line 702 of file HsExtCommon.h.

    00703   {
    00704     hsStatusGadgetBattery = 1,          /**< Status gadget is a battery meter */
    00705     hsStatusGadgetSignal = 2            /**< Status gadget is a signal strength indicator */
    00706   } HsStatusGadgetTypeEnum;

enum HsVerStrEnum

Enumerator:

  hsVerStrComplete | Composite, formatted for display in info dialog
  hsVerStrSerialNo | Complete serial number (ROM token 'snum' is limited to 12 digits)
  hsVerStrHardware | Revision of the hardware
  hsVerStrProductName | Like, "Treo 600"
  hsVerStrCarrierID | Carrier ID code for carrier branding
  hsVerStrProductRev | Complete product; covering hardware, radio firmware and software
  hsVerStrROMBuild | ROM buld number (not the same as the build number in sysFtrNumROMVersion)
  hsVerStrFirmwareVer | Version of the radio firmware
  hsVerStrPalmOSVer | See sysFtrNumROMVersion
  hsVerStrLifeTime | Radio life timer

Definition at line 449 of file HsExtCommon.h.

    00450   {
    00451     hsVerStrComplete,       /**< Composite, formatted for display in info dialog */
    00452     hsVerStrSerialNo,       /**< Complete serial number (ROM token 'snum' is limited to 12 digits) */
    00453     hsVerStrHardware,       /**< Revision of the hardware */
    00454     hsVerStrProductName,        /**< Like, "Treo 600" */
    00455     hsVerStrCarrierID,      /**< Carrier ID code for carrier branding */
    00456     hsVerStrProductRev,     /**< Complete product; covering hardware, radio firmware and software */
    00457     hsVerStrROMBuild,       /**< ROM buld number (not the same as the build number in sysFtrNumROMVersion) */
    00458     hsVerStrFirmwareVer,        /**< Version of the radio firmware */
    00459     hsVerStrPalmOSVer,      /**< See sysFtrNumROMVersion */
    00460     hsVerStrLifeTime        /**< Radio life timer */
    00461   } HsVerStrEnum;

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