API Guide Home (Online version only) |

# HsNavCommon.h File Reference

## Detailed Description

Public common header file for 5-way navigation support on Treo 600.

This file contains the common constant and structures used to support 5-way navigation in an application.

Definition in file HsNavCommon.h.

Include dependency graph for HsNavCommon.h:

Go to the source code of this file.

## Data Structures

- struct FrmNavOrderEntryTag
- struct FrmNavHeaderTag

## Defines

- #define hsNavAPIVersion 2
- #define hsNavFocusRingWidth 6
- #define hsNavFocusRingWidthSingleDensity 3
- #define hsNavFocusRingNoExtraInfo ((Int16)0xFFFF)
- #define frmNavFocusRingNoExtraInfo ((Int16)0xFFFF)
- #define formNavRscType 'fnav'
- #define TxtCharIsRockerKey(m, c)
- #define sysTrapNavSelector 0xA46F
- #define NavSelectorFrmCountObjectsInNavOrder 0x0
- #define NavSelectorFrmGetNavOrder 0x1
- #define NavSelectorFrmSetNavOrder 0x2
- #define NavSelectorFrmGetNavEntry 0x3
- #define NavSelectorFrmSetNavEntry 0x4
- #define NavSelectorFrmGetNavState 0x5
- #define NavSelectorFrmSetNavState 0x6
- #define NavSelectorFrmNavDrawFocusRing 0x7
- #define NavSelectorFrmNavRemoveFocusRing 0x8
- #define NavSelectorFrmNavGetFocusRingInfo 0x9
- #define NavSelectorFrmNavObjectTakeFocus 0xA
- #define uilibErrorClass 0x3A00
- #define uilibErrInvalidParam (uilibErrorClass | 1)
- #define uilibErrCurrentFocusInvalid (uilibErrorClass | 2)
- #define uilibErrObjectFocusModeOff (uilibErrorClass | 3)
- #define uilibErrObjectNotFound (uilibErrorClass | 4)
- #define uilibErrNoNavInfoForForm (uilibErrorClass | 5)
- #define uilibErrInvalidFocusObject (uilibErrorClass | 6)
- #define uilibErrFormDoesNotHaveFocus (uilibErrorClass | 7)
- #define kFrmNavHeaderFlagsObjectFocusStartState 0x00000001
- #define kFrmNavHeaderFlagsAppFocusStartState 0x00000002
- #define kFrmNavHeaderFlagsAutoGenerated 0x80000000
- #define kFrmNavHeaderFlagsStartStateMask 0x00000003
- #define kFrmNavHeaderFlagsDefaultStartStateValue 0x00000000
- #define kFrmNavHeaderFlagsObjectFocusStartStateValue 0x00000001
- #define kFrmNavHeaderFlagsAppFocusStartStateValue 0x00000002
- #define kFrmNavHeaderFlagsInvalidStartStateValue 0x00000003
- #define kFrmNavObjectFlagsSkip 0x0001
- #define kFrmNavObjectFlagsForceInteractionMode 0x0002
- #define kFrmNavObjectFlagsIsBigButton 0x8000
- #define kFrmNavStateFlagsInteractionMode 0x00000001
- #define kFrmNavStateFlagsObjectFocusMode 0x00000002
- #define kFrmNavInfoVersion 1
- #define sysFtrNumFiveWayNavVersion 32

## Typedefs

- typedef UInt16 HsNavFocusColorEnum
- typedef UInt16 HsNavFocusRingStyleEnum
- typedef UInt16 FrmNavFocusRingStyleEnum
- typedef UInt32 FrmNavHeaderFlagsType
- typedef UInt16 FrmNavObjectFlagsType
- typedef UInt32 FrmNavStateFlagsType
- typedef FrmNavOrderEntryTag FrmNavOrderEntryType
- typedef FrmNavHeaderTag FrmNavHeaderType

## Enumerations

- enum HsNavFocusColorEnumTag {
  hsNavFocusColorInsideBottomRightRing = 0,
  hsNavFocusColorInsideTopLeftRing = 1,
  hsNavFocusColorMiddleRing = 2,
  hsNavFocusColorOutsideRing = 3,
  hsNavFocusColorSecondaryHighlight = 4,
  hsNavFocusColorRing1 = 5,
  hsNavFocusColorRing2 = 6,
  hsNavFocusColorRing3 = 7,
  hsNavFocusColorRing4 = 8,
  hsNavFocusColorRing5 = 9,
  hsNavFocusColorRing6 = 10
  }
- enum HsNavFocusRingStyleEnumTag {
  hsNavFocusRingStyleObjectTypeDefault = 0,
  hsNavFocusRingStyleSquare = 1,
  hsNavFocusRingStyleRound = 2,
  hsNavFocusRingStyleHorizontalBars = 3,
  hsNavFocusRingStyleInvalid = 0xFFFF
  }
- enum FrmNavFocusRingStyleEnumTag {
  frmNavFocusRingStyleObjectTypeDefault = 0,
  frmNavFocusRingStyleSquare = 1,
  frmNavFocusRingStyleRound = 2,
  frmNavFocusRingStyleHorizontalBars = 3,
  frmNavFocusRingStyleInvalid = 0xFFFF
  }

## Define Documentation

#define formNavRscType 'fnav'

Definition at line 112 of file HsNavCommon.h.

#define frmNavFocusRingNoExtraInfo ((Int16)0xFFFF)

Definition at line 104 of file HsNavCommon.h.

#define hsNavAPIVersion 2

Definition at line 49 of file HsNavCommon.h.

#define hsNavFocusRingNoExtraInfo ((Int16)0xFFFF)

Definition at line 57 of file HsNavCommon.h.

#define hsNavFocusRingWidth 6

Definition at line 55 of file HsNavCommon.h.

#define hsNavFocusRingWidthSingleDensity 3

Definition at line 56 of file HsNavCommon.h.

#define kFrmNavHeaderFlagsAppFocusStartState 0x00000002

Definition at line 190 of file HsNavCommon.h.

#define kFrmNavHeaderFlagsAppFocusStartStateValue 0x00000002

Definition at line 196 of file HsNavCommon.h.

#define kFrmNavHeaderFlagsAutoGenerated 0x80000000

Definition at line 191 of file HsNavCommon.h.

#define kFrmNavHeaderFlagsDefaultStartStateValue 0x00000000

Definition at line 194 of file HsNavCommon.h.

#define kFrmNavHeaderFlagsInvalidStartStateValue 0x00000003

Definition at line 197 of file HsNavCommon.h.

#define kFrmNavHeaderFlagsObjectFocusStartState 0x00000001

Definition at line 189 of file HsNavCommon.h.

#define kFrmNavHeaderFlagsObjectFocusStartStateValue 0x00000001

Definition at line 195 of file HsNavCommon.h.

#define kFrmNavHeaderFlagsStartStateMask 0x00000003

Definition at line 193 of file HsNavCommon.h.

#define kFrmNavInfoVersion 1

Definition at line 225 of file HsNavCommon.h.

#define kFrmNavObjectFlagsForceInteractionMode 0x0002

Definition at line 207 of file HsNavCommon.h.

#define kFrmNavObjectFlagsIsBigButton 0x8000

Definition at line 208 of file HsNavCommon.h.

#define kFrmNavObjectFlagsSkip 0x0001

Definition at line 206 of file HsNavCommon.h.

#define kFrmNavStateFlagsInteractionMode 0x00000001

Definition at line 217 of file HsNavCommon.h.

#define kFrmNavStateFlagsObjectFocusMode 0x00000002

Definition at line 218 of file HsNavCommon.h.

#define NavSelectorFrmCountObjectsInNavOrder 0x0

Definition at line 140 of file HsNavCommon.h.

#define NavSelectorFrmGetNavEntry 0x3

Definition at line 143 of file HsNavCommon.h.

#define NavSelectorFrmGetNavOrder 0x1

Definition at line 141 of file HsNavCommon.h.

#define NavSelectorFrmGetNavState 0x5

Definition at line 145 of file HsNavCommon.h.

#define NavSelectorFrmNavDrawFocusRing 0x7

Definition at line 147 of file HsNavCommon.h.

#define NavSelectorFrmNavGetFocusRingInfo 0x9

Definition at line 149 of file HsNavCommon.h.

#define NavSelectorFrmNavObjectTakeFocus 0xA

Definition at line 153 of file HsNavCommon.h.

#define NavSelectorFrmNavRemoveFocusRing 0x8

Definition at line 148 of file HsNavCommon.h.

#define NavSelectorFrmSetNavEntry 0x4

Definition at line 144 of file HsNavCommon.h.

#define NavSelectorFrmSetNavOrder 0x2

Definition at line 142 of file HsNavCommon.h.

#define NavSelectorFrmSetNavState 0x6

Definition at line 146 of file HsNavCommon.h.

#define sysFtrNumFiveWayNavVersion 32

Definition at line 236 of file HsNavCommon.h.

#define sysTrapNavSelector 0xA46F

Definition at line 138 of file HsNavCommon.h.

#define TxtCharIsRockerKey | ( | m,
|  | c |  | ) |

Value:

    ((((m) & commandKeyMask) != 0) && \
                                        ((((c) >= vchrRockerUp) && ((c) <= vchrRockerCenter))))

Definition at line 125 of file HsNavCommon.h.

#define uilibErrCurrentFocusInvalid (uilibErrorClass | 2)

Definition at line 168 of file HsNavCommon.h.

#define uilibErrFormDoesNotHaveFocus (uilibErrorClass | 7)

Definition at line 173 of file HsNavCommon.h.

#define uilibErrInvalidFocusObject (uilibErrorClass | 6)

Definition at line 172 of file HsNavCommon.h.

#define uilibErrInvalidParam (uilibErrorClass | 1)

Definition at line 167 of file HsNavCommon.h.

#define uilibErrNoNavInfoForForm (uilibErrorClass | 5)

Definition at line 171 of file HsNavCommon.h.

#define uilibErrObjectFocusModeOff (uilibErrorClass | 3)

Definition at line 169 of file HsNavCommon.h.

#define uilibErrObjectNotFound (uilibErrorClass | 4)

Definition at line 170 of file HsNavCommon.h.

#define uilibErrorClass 0x3A00

Definition at line 165 of file HsNavCommon.h.

## Typedef Documentation

typedef UInt16 FrmNavFocusRingStyleEnum

Definition at line 103 of file HsNavCommon.h.

typedef UInt32 FrmNavHeaderFlagsType

Definition at line 187 of file HsNavCommon.h.

typedef struct FrmNavHeaderTag FrmNavHeaderType

typedef UInt16 FrmNavObjectFlagsType

Definition at line 204 of file HsNavCommon.h.

typedef struct FrmNavOrderEntryTag FrmNavOrderEntryType

typedef UInt32 FrmNavStateFlagsType

Definition at line 215 of file HsNavCommon.h.

typedef UInt16 HsNavFocusColorEnum

Definition at line 74 of file HsNavCommon.h.

typedef UInt16 HsNavFocusRingStyleEnum

Definition at line 85 of file HsNavCommon.h.

## Enumeration Type Documentation

enum FrmNavFocusRingStyleEnumTag

Enumerator:

  frmNavFocusRingStyleObjectTypeDefault |
  frmNavFocusRingStyleSquare |
  frmNavFocusRingStyleRound |
  frmNavFocusRingStyleHorizontalBars |
  frmNavFocusRingStyleInvalid |

Definition at line 95 of file HsNavCommon.h.

    00096 {
    00097   frmNavFocusRingStyleObjectTypeDefault = 0,
    00098   frmNavFocusRingStyleSquare = 1,
    00099   frmNavFocusRingStyleRound = 2,
    00100   frmNavFocusRingStyleHorizontalBars = 3,
    00101   frmNavFocusRingStyleInvalid = 0xFFFF
    00102 };

enum HsNavFocusColorEnumTag

Enumerator:

  hsNavFocusColorInsideBottomRightRing |
  hsNavFocusColorInsideTopLeftRing |
  hsNavFocusColorMiddleRing |
  hsNavFocusColorOutsideRing |
  hsNavFocusColorSecondaryHighlight |
  hsNavFocusColorRing1 |
  hsNavFocusColorRing2 |
  hsNavFocusColorRing3 |
  hsNavFocusColorRing4 |
  hsNavFocusColorRing5 |
  hsNavFocusColorRing6 |

Definition at line 60 of file HsNavCommon.h.

    00061 {
    00062   hsNavFocusColorInsideBottomRightRing  = 0,  // Deprecated (HsNav version 1 focus treatment)
    00063   hsNavFocusColorInsideTopLeftRing = 1,       // Deprecated (HsNav version 1 focus treatment)
    00064   hsNavFocusColorMiddleRing = 2,              // Deprecated (HsNav version 1 focus treatment)
    00065   hsNavFocusColorOutsideRing = 3,             // Deprecated (HsNav version 1 focus treatment)
    00066   hsNavFocusColorSecondaryHighlight = 4,
    00067   hsNavFocusColorRing1 = 5,                   // HsNav version 2 focus treatment.  Innermost ring.
    00068   hsNavFocusColorRing2 = 6,                   // HsNav version 2 focus treatment.
    00069   hsNavFocusColorRing3 = 7,                   // HsNav version 2 focus treatment.
    00070   hsNavFocusColorRing4 = 8,                   // HsNav version 2 focus treatment.
    00071   hsNavFocusColorRing5 = 9,                   // HsNav version 2 focus treatment.
    00072   hsNavFocusColorRing6 = 10                   // HsNav version 2 focus treatment.  Outermost ring.
    00073 };

enum HsNavFocusRingStyleEnumTag

Enumerator:

  hsNavFocusRingStyleObjectTypeDefault |
  hsNavFocusRingStyleSquare |
  hsNavFocusRingStyleRound |
  hsNavFocusRingStyleHorizontalBars |
  hsNavFocusRingStyleInvalid |

Definition at line 77 of file HsNavCommon.h.

    00078 {
    00079   hsNavFocusRingStyleObjectTypeDefault = 0,
    00080   hsNavFocusRingStyleSquare = 1,
    00081   hsNavFocusRingStyleRound = 2,
    00082   hsNavFocusRingStyleHorizontalBars = 3,
    00083   hsNavFocusRingStyleInvalid = 0xFFFF
    00084 };

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