API Guide Home (Online version only) |

# PmUIUtilLibCommon.h File Reference

## Detailed Description

Public 68k common header file for system Library that exports UI utility API functions.

This file contains the constants and definitions for the system UI-Util library.

Definition in file PmUIUtilLibCommon.h.

Include dependency graph for PmUIUtilLibCommon.h:

Go to the source code of this file.

## Defines

- #define kPmUIUtilLibType sysFileTLibrary
- #define kPmUIUtilLibCreator pmFileCUIUtilLib
- #define kPmUIUtilLibName "PmUIUtilLib-PmUU"
- #define kPmUIUtilLibAPIMajorVersion 2
- #define kPmUIUtilLibAPIMinorVersion 0
- #define kPmUIUtilLibAPIVersion sysMakeLibAPIVersion(kPmUIUtilLibAPIMajorVersion, kPmUIUtilLibAPIMinorVersion)

Feature values

- #define kPmUIUtilLibFtrValAPIVersion 0

Function Traps

- #define kPmUIUtilLibTrapOpen sysLibTrapOpen
- #define kPmUIUtilLibTrapClose sysLibTrapClose
- #define kPmUIUtilLibTrapGetObjectUsable (sysLibTrapCustom)
- #define kPmUIUtilLibTrapPutObjectAfterTitle (sysLibTrapCustom+1)
- #define kPmUIUtilLibTrapFrmDoDialogWithCallback (sysLibTrapCustom+2)
- #define kPmUIUtilLibTrapFrmDoDialog (sysLibTrapCustom+3)
- #define kPmUIUtilLibTrapFrmDoTimedDialogEx (sysLibTrapCustom+4)
- #define kPmUIUtilLibTrapFrmSetHelpID (sysLibTrapCustom+5)
- #define kPmUIUtilLibTrapFrmSetLabel (sysLibTrapCustom+6)
- #define kPmUIUtilLibTrapFrmSetLabelFont (sysLibTrapCustom+7)
- #define kPmUIUtilLibTrapFrmGetDefaultButtonID (sysLibTrapCustom+8)
- #define kPmUIUtilLibTrapFrmGetEventHandler (sysLibTrapCustom+9)
- #define kPmUIUtilLibTrapCtlGetStyle (sysLibTrapCustom+10)
- #define kPmUIUtilLibTrapCtlGetFont (sysLibTrapCustom+11)
- #define kPmUIUtilLibTrapLstGetItemsText (sysLibTrapCustom+12)
- #define kPmUIUtilLibTrapLstGetTopItem (sysLibTrapCustom+13)
- #define kPmUIUtilLibTrapLstPopupListExt (sysLibTrapCustom+14)
- #define kPmUIUtilLibTrapSclUpdateScrollBar (sysLibTrapCustom+15)
- #define kPmUIUtilLibTrapSclScroll (sysLibTrapCustom+16)
- #define kPmUIUtilLibTrapSclScrollPage (sysLibTrapCustom+17)
- #define kPmUIUtilLibTrapSliHandleKeyDown (sysLibTrapCustom+18)
- #define kPmUIUtilLibTrapWinGetMaxDepth (sysLibTrapCustom+19)
- #define kPmUIUtilLibTrapAttnNagInfo (sysLibTrapCustom+20)
- #define kPmUIUtilLibTrapAttnEnable (sysLibTrapCustom+21)
- #define kPmUIUtilLibTrapAttnIndicatorAllow (sysLibTrapCustom+22)
- #define kPmUIUtilLibTrapAttnGetAttentionExt (sysLibTrapCustom+23)
- #define kPmUIUtilLibTrapAttnUpdateExt (sysLibTrapCustom+24)
- #define kPmUIUtilLibTrapAttrGet (sysLibTrapCustom+25)
- #define kPmUIUtilLibTrapAttrSet (sysLibTrapCustom+26)
- #define kPmUIUtilLibTrapLstSetTempSelection (sysLibTrapCustom+27)
- #define kPmUIUtilLibTrapLstGetTempSelection (sysLibTrapCustom+28)
- #define kPmUIUtilLibTrapNavGetFocusColor (sysLibTrapCustom+29)
- #define kPmUIUtilLibTrapNavSetFocusColor (sysLibTrapCustom+30)
- #define kPmUIUtilLibTrapAttnDiagIsVisible (sysLibTrapCustom+31)

## Typedefs

- typedef UInt16 PmUIUtilAttrEnum

## Enumerations

- enum PmUIUtilAttrEnumTag { pmUIUtilAttrAutoSnoozeAttns }

## Define Documentation

#define kPmUIUtilLibAPIMajorVersion 2

Major version incremented when API changes

Definition at line 41 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibAPIMinorVersion 0

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

Definition at line 43 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibAPIVersion sysMakeLibAPIVersion(kPmUIUtilLibAPIMajorVersion, kPmUIUtilLibAPIMinorVersion)

Definition at line 46 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibCreator pmFileCUIUtilLib

Library creator ID

Definition at line 39 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibFtrValAPIVersion 0

Feature value used to get/set library version (kPmUIUtilLibAPIVersion). 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 PmUIUtil before getting the feature

Definition at line 53 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibName "PmUIUtilLib-PmUU"

Library name

Definition at line 40 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapAttnDiagIsVisible (sysLibTrapCustom+31)

Definition at line 127 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapAttnEnable (sysLibTrapCustom+21)

Definition at line 117 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapAttnGetAttentionExt (sysLibTrapCustom+23)

Definition at line 119 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapAttnIndicatorAllow (sysLibTrapCustom+22)

Definition at line 118 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapAttnNagInfo (sysLibTrapCustom+20)

Definition at line 116 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapAttnUpdateExt (sysLibTrapCustom+24)

Definition at line 120 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapAttrGet (sysLibTrapCustom+25)

Definition at line 121 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapAttrSet (sysLibTrapCustom+26)

Definition at line 122 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapClose sysLibTrapClose

Definition at line 95 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapCtlGetFont (sysLibTrapCustom+11)

Definition at line 107 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapCtlGetStyle (sysLibTrapCustom+10)

Definition at line 106 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapFrmDoDialog (sysLibTrapCustom+3)

Definition at line 99 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapFrmDoDialogWithCallback (sysLibTrapCustom+2)

Definition at line 98 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapFrmDoTimedDialogEx (sysLibTrapCustom+4)

Definition at line 100 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapFrmGetDefaultButtonID (sysLibTrapCustom+8)

Definition at line 104 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapFrmGetEventHandler (sysLibTrapCustom+9)

Definition at line 105 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapFrmSetHelpID (sysLibTrapCustom+5)

Definition at line 101 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapFrmSetLabel (sysLibTrapCustom+6)

Definition at line 102 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapFrmSetLabelFont (sysLibTrapCustom+7)

Definition at line 103 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapGetObjectUsable (sysLibTrapCustom)

Definition at line 96 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapLstGetItemsText (sysLibTrapCustom+12)

Definition at line 108 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapLstGetTempSelection (sysLibTrapCustom+28)

Definition at line 124 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapLstGetTopItem (sysLibTrapCustom+13)

Definition at line 109 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapLstPopupListExt (sysLibTrapCustom+14)

Definition at line 110 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapLstSetTempSelection (sysLibTrapCustom+27)

Definition at line 123 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapNavGetFocusColor (sysLibTrapCustom+29)

Definition at line 125 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapNavSetFocusColor (sysLibTrapCustom+30)

Definition at line 126 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapOpen sysLibTrapOpen

Definition at line 94 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapPutObjectAfterTitle (sysLibTrapCustom+1)

Definition at line 97 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapSclScroll (sysLibTrapCustom+16)

Definition at line 112 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapSclScrollPage (sysLibTrapCustom+17)

Definition at line 113 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapSclUpdateScrollBar (sysLibTrapCustom+15)

Definition at line 111 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapSliHandleKeyDown (sysLibTrapCustom+18)

Definition at line 114 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibTrapWinGetMaxDepth (sysLibTrapCustom+19)

Definition at line 115 of file PmUIUtilLibCommon.h.

#define kPmUIUtilLibType sysFileTLibrary

Library type

Definition at line 38 of file PmUIUtilLibCommon.h.

## Typedef Documentation

typedef UInt16 PmUIUtilAttrEnum

See also:
  PmUIUtilAttrEnumTag

Definition at line 83 of file PmUIUtilLibCommon.h.

## Enumeration Type Documentation

enum PmUIUtilAttrEnumTag

Enumerator:

  pmUIUtilAttrAutoSnoozeAttns | whether we want to auto snooze the current instance of the attn dialog

Definition at line 68 of file PmUIUtilLibCommon.h.

    00069 {
    00070   pmUIUtilAttrAutoSnoozeAttns       /**< whether we want to auto snooze the current instance of the attn dialog */
    00071
    00072   /*
    00073    * End of enums in API version 1
    00074    */
    00075
    00076   /*
    00077    * Attributes greater than 0x9000 are defined for internal use
    00078    * in Prv/PmPrvKeyLibCommon.h
    00079    */
    00080 };

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