API Guide Home (Online version only) |

# PalmGoLCDCommon.h File Reference

## Detailed Description

Public common header file for the GoLCD Library.

Version:
  1.0

This file contains the library constants and structures that hold different states of the fullscreen feature, graffiti indicators, inking and the colors.

Definition in file PalmGoLCDCommon.h.

Include dependency graph for PalmGoLCDCommon.h:

Go to the source code of this file.

## Defines

- #define goLcdCreator 'GAny'
- #define goLcdFtrNumVersion 0
- #define goLcdNotifyStatusEvent 'GAny'
- #define goLcdGraffitiMode 0
- #define goLcdPenTapMode 1
- #define goLcdModeCount 2
- #define goLcdGsiNormal 0
- #define goLcdGsiOverride 1
- #define goLcdColorDefault 0
- #define goLcdColorOverride 1
- #define goLcdColorInverted 2
- #define GoLcdLibAPIVersion (sysMakeROMVersion(3, 6, 0, sysROMStageBeta, 0))

Library Constants

- #define goLcdLibName "GoLcdLib"
- #define goLcdLibType 'libr'
- #define goLcdLibCreator 'GAny'
- #define goLcdLibFtrNum 0

Feature Status

- #define goLcdNotAvailable -1
- #define goLcdDisabled 0
- #define goLcdEnabled 1

Ink States

- #define goLcdInkDisabled 0
- #define goLcdInkEnabled 1

Function Traps

- #define kGoLcdLibTrapOpen sysLibTrapOpen
- #define kGoLcdLibTrapClose sysLibTrapClose
- #define kGoLcdLibTrapGetStatus (sysLibTrapCustom)
- #define kGoLcdLibTrapSetStatus (sysLibTrapCustom+1)
- #define kGoLcdLibTrapGetInkState (sysLibTrapCustom+2)
- #define kGoLcdLibTrapSetInkState (sysLibTrapCustom+3)
- #define kGoLcdLibTrapGetTimeout (sysLibTrapCustom+4)
- #define kGoLcdLibTrapSetTimeout (sysLibTrapCustom+5)
- #define kGoLcdLibTrapGetBounds (sysLibTrapCustom+6)
- #define kGoLcdLibTrapSetBounds (sysLibTrapCustom+7)
- #define kGoLcdLibTrapGetGsiState (sysLibTrapCustom+8)
- #define kGoLcdLibTrapSetGsiState (sysLibTrapCustom+9)

## Typedefs

- typedef Int32 GoLcdStatusType
- typedef Int32 GoLcdInkStateType
- typedef UInt32 GoLcdModeType
- typedef UInt32 GoLcdGsiStateType
- typedef UInt32 GoLcdColorModeType

## Define Documentation

#define goLcdColorDefault 0

Use the default color scheme.

Definition at line 145 of file PalmGoLCDCommon.h.

#define goLcdColorInverted 2

Use only with ink color. Inverts the color of the display area beneath the Graffiti 2 stroke.

Definition at line 147 of file PalmGoLCDCommon.h.

#define goLcdColorOverride 1

Use the specified color (passed in as a separate argument).

Definition at line 146 of file PalmGoLCDCommon.h.

#define goLcdCreator 'GAny'

Feature creator ID

Definition at line 53 of file PalmGoLCDCommon.h.

#define goLcdDisabled 0

GoLCD functionality is disabled.

Definition at line 74 of file PalmGoLCDCommon.h.

#define goLcdEnabled 1

GoLCD functionality is enabled.

Definition at line 75 of file PalmGoLCDCommon.h.

#define goLcdFtrNumVersion 0

Current version of the supported features

Definition at line 54 of file PalmGoLCDCommon.h.

#define goLcdGraffitiMode 0

When it enters goLcdGraffitiMode, GoLCD continuously interprets all pen events as Graffiti 2 strokes. There is a timeout value associated with goLcdGraffitiMode, however. If it does not receive a new pen event within the allotted time, it returns to goLcdPenTapMode.
The default time-out value for goLcdGraffitiMode is 150 system ticks, or 1500 milliseconds.

Definition at line 108 of file PalmGoLCDCommon.h.

#define goLcdGsiNormal 0

GSI is handled as normal.

Definition at line 135 of file PalmGoLCDCommon.h.

#define goLcdGsiOverride 1

GoLCD overrides the GSI with its own control.

Definition at line 136 of file PalmGoLCDCommon.h.

#define goLcdInkDisabled 0

GoLCD inking is disabled.

Definition at line 88 of file PalmGoLCDCommon.h.

#define goLcdInkEnabled 1

GoLCD inking is enabled.

Definition at line 89 of file PalmGoLCDCommon.h.

#define GoLcdLibAPIVersion (sysMakeROMVersion(3, 6, 0, sysROMStageBeta, 0))

Current library version

Definition at line 170 of file PalmGoLCDCommon.h.

#define goLcdLibCreator 'GAny'

GoLCD creator ID.

Definition at line 49 of file PalmGoLCDCommon.h.

#define goLcdLibFtrNum 0

GoLCd feature number.

Definition at line 50 of file PalmGoLCDCommon.h.

#define goLcdLibName "GoLcdLib"

GoLCD library name.

Definition at line 47 of file PalmGoLCDCommon.h.

#define goLcdLibType 'libr'

GoLCD library type.

Definition at line 48 of file PalmGoLCDCommon.h.

#define goLcdModeCount 2

Two modes are currently supported

Definition at line 126 of file PalmGoLCDCommon.h.

#define goLcdNotAvailable -1

GoLCD not available on this device.

Definition at line 73 of file PalmGoLCDCommon.h.

#define goLcdNotifyStatusEvent 'GAny'

Notification code that applications can register for when the status of Full Screen Writing (GoLCD) is changed.

Definition at line 60 of file PalmGoLCDCommon.h.

#define goLcdPenTapMode 1

GoLCD starts in goLcdPenTapMode. When a penDownEvent is received, a timer is started. If a penUpEvent is received before the timer reaches the time-out value for this mode, the pen events are passed on to the event-handler for the application control. Otherwise, if the pen events exceed the time-out value and the x, y coordinates change significantly, GoLCD enters goLcdGraffitiMode and treats the pen events as a Graffiti 2 stroke.
The default time-out value for goLcdPenTapMode is 15 system ticks, or 150 milliseconds.

Definition at line 123 of file PalmGoLCDCommon.h.

#define kGoLcdLibTrapClose sysLibTrapClose

Definition at line 155 of file PalmGoLCDCommon.h.

#define kGoLcdLibTrapGetBounds (sysLibTrapCustom+6)

Definition at line 163 of file PalmGoLCDCommon.h.

#define kGoLcdLibTrapGetGsiState (sysLibTrapCustom+8)

Definition at line 165 of file PalmGoLCDCommon.h.

#define kGoLcdLibTrapGetInkState (sysLibTrapCustom+2)

Definition at line 159 of file PalmGoLCDCommon.h.

#define kGoLcdLibTrapGetStatus (sysLibTrapCustom)

Definition at line 157 of file PalmGoLCDCommon.h.

#define kGoLcdLibTrapGetTimeout (sysLibTrapCustom+4)

Definition at line 161 of file PalmGoLCDCommon.h.

#define kGoLcdLibTrapOpen sysLibTrapOpen

Definition at line 154 of file PalmGoLCDCommon.h.

#define kGoLcdLibTrapSetBounds (sysLibTrapCustom+7)

Definition at line 164 of file PalmGoLCDCommon.h.

#define kGoLcdLibTrapSetGsiState (sysLibTrapCustom+9)

Definition at line 166 of file PalmGoLCDCommon.h.

#define kGoLcdLibTrapSetInkState (sysLibTrapCustom+3)

Definition at line 160 of file PalmGoLCDCommon.h.

#define kGoLcdLibTrapSetStatus (sysLibTrapCustom+1)

Definition at line 158 of file PalmGoLCDCommon.h.

#define kGoLcdLibTrapSetTimeout (sysLibTrapCustom+5)

Definition at line 162 of file PalmGoLCDCommon.h.

## Typedef Documentation

typedef UInt32 GoLcdColorModeType

GoLCD Color Mode. One of the following: goLcdColorDefault, goLcdColorOverride, goLcdColorInverted

Definition at line 143 of file PalmGoLCDCommon.h.

typedef UInt32 GoLcdGsiStateType

GoLCD GSI State. One of the following: goLcdGsiNormal, goLcdGsiOverride

Definition at line 133 of file PalmGoLCDCommon.h.

typedef Int32 GoLcdInkStateType

GoLCD Ink State. One of the following: goLcdInkDisabled, goLcdInkEnabled

Definition at line 82 of file PalmGoLCDCommon.h.

typedef UInt32 GoLcdModeType

GoLCD Timeout Mode. One of the following: goLcdGraffitiMode, goLcdPenTapMode

Definition at line 96 of file PalmGoLCDCommon.h.

typedef Int32 GoLcdStatusType

GoLCD Status. One of the following: goLcdNotAvailable, goLcdDisabled, goLcdEnabled

Definition at line 67 of file PalmGoLCDCommon.h.

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