(Online version only)
|
API Guide Home (Online version only) |
|
00001 /******************************************************************************* 00002 * Copyright (c) 2004-2005 palmOne, Inc. or its subsidiaries. 00003 * All rights reserved. 00004 ******************************************************************************/ 00005 /** 00006 * @defgroup PmUIUtilLib UI Utility Library 00007 * @brief This library provides support for the misc. UI-related functionalities. 00008 * 00009 * Applications can use this library API to retrieve the different layers of colors of 00010 * the focus ring and use the colors to manually draw custom-shaped focus rings. Please 00011 * also refer to the HsNav.h header file for more of the library constants and definitions. 00012 * 00013 * @{ 00014 * @} 00015 */ 00016 /** 00017 * @ingroup PmUIUtilLib 00018 */ 00019 00020 /** 00021 * @file PmUIUtilLibCommon.h 00022 * @brief Public 68k common header file for system Library that exports UI utility API functions. 00023 * 00024 * This file contains the constants and definitions for the system UI-Util library. 00025 * <hr> 00026 */ 00027 00028 #ifndef __PM_UI_UTIL_LIB_COMMON_H__ 00029 #define __PM_UI_UTIL_LIB_COMMON_H__ 00030 00031 #include <palmOneSystemCommon.h> // for sysMakeLibAPIVersion 00032 00033 00034 /******************************************************************** 00035 * Constants and Enums 00036 ********************************************************************/ 00037 00038 #define kPmUIUtilLibType sysFileTLibrary /**< Library type */ 00039 #define kPmUIUtilLibCreator pmFileCUIUtilLib /**< Library creator ID */ 00040 #define kPmUIUtilLibName "PmUIUtilLib-PmUU" /**< Library name */ 00041 #define kPmUIUtilLibAPIMajorVersion 2 /**< Major version incremented when API 00042 changes */ 00043 #define kPmUIUtilLibAPIMinorVersion 0 /**< Minor version incremented with 00044 each release of library that 00045 doesn't change the API */ 00046 #define kPmUIUtilLibAPIVersion sysMakeLibAPIVersion(kPmUIUtilLibAPIMajorVersion, kPmUIUtilLibAPIMinorVersion) 00047 00048 00049 /** 00050 * @name Feature values 00051 */ 00052 /*@{*/ 00053 #define kPmUIUtilLibFtrValAPIVersion 0 /**< Feature value used to get/set 00054 library version 00055 (kPmUIUtilLibAPIVersion). Note 00056 that the first release of the 00057 library did not set this feature. 00058 Therefore, if the library does 00059 exist but the feature does not, 00060 you can assume the major version 00061 of the library is 1. Note also 00062 that the feature is not set 00063 until library is loaded so you 00064 must load PmUIUtil before getting 00065 the feature */ 00066 /*@}*/ 00067 00068 enum PmUIUtilAttrEnumTag 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 }; 00081 00082 /** @see PmUIUtilAttrEnumTag */ 00083 typedef UInt16 PmUIUtilAttrEnum; 00084 00085 00086 /******************************************************************** 00087 * Traps 00088 ********************************************************************/ 00089 00090 /** 00091 * @name Function Traps 00092 */ 00093 /*@{*/ 00094 #define kPmUIUtilLibTrapOpen sysLibTrapOpen 00095 #define kPmUIUtilLibTrapClose sysLibTrapClose 00096 #define kPmUIUtilLibTrapGetObjectUsable (sysLibTrapCustom) 00097 #define kPmUIUtilLibTrapPutObjectAfterTitle (sysLibTrapCustom+1) 00098 #define kPmUIUtilLibTrapFrmDoDialogWithCallback (sysLibTrapCustom+2) 00099 #define kPmUIUtilLibTrapFrmDoDialog (sysLibTrapCustom+3) 00100 #define kPmUIUtilLibTrapFrmDoTimedDialogEx (sysLibTrapCustom+4) 00101 #define kPmUIUtilLibTrapFrmSetHelpID (sysLibTrapCustom+5) 00102 #define kPmUIUtilLibTrapFrmSetLabel (sysLibTrapCustom+6) 00103 #define kPmUIUtilLibTrapFrmSetLabelFont (sysLibTrapCustom+7) 00104 #define kPmUIUtilLibTrapFrmGetDefaultButtonID (sysLibTrapCustom+8) 00105 #define kPmUIUtilLibTrapFrmGetEventHandler (sysLibTrapCustom+9) 00106 #define kPmUIUtilLibTrapCtlGetStyle (sysLibTrapCustom+10) 00107 #define kPmUIUtilLibTrapCtlGetFont (sysLibTrapCustom+11) 00108 #define kPmUIUtilLibTrapLstGetItemsText (sysLibTrapCustom+12) 00109 #define kPmUIUtilLibTrapLstGetTopItem (sysLibTrapCustom+13) 00110 #define kPmUIUtilLibTrapLstPopupListExt (sysLibTrapCustom+14) 00111 #define kPmUIUtilLibTrapSclUpdateScrollBar (sysLibTrapCustom+15) 00112 #define kPmUIUtilLibTrapSclScroll (sysLibTrapCustom+16) 00113 #define kPmUIUtilLibTrapSclScrollPage (sysLibTrapCustom+17) 00114 #define kPmUIUtilLibTrapSliHandleKeyDown (sysLibTrapCustom+18) 00115 #define kPmUIUtilLibTrapWinGetMaxDepth (sysLibTrapCustom+19) 00116 #define kPmUIUtilLibTrapAttnNagInfo (sysLibTrapCustom+20) 00117 #define kPmUIUtilLibTrapAttnEnable (sysLibTrapCustom+21) 00118 #define kPmUIUtilLibTrapAttnIndicatorAllow (sysLibTrapCustom+22) 00119 #define kPmUIUtilLibTrapAttnGetAttentionExt (sysLibTrapCustom+23) 00120 #define kPmUIUtilLibTrapAttnUpdateExt (sysLibTrapCustom+24) 00121 #define kPmUIUtilLibTrapAttrGet (sysLibTrapCustom+25) 00122 #define kPmUIUtilLibTrapAttrSet (sysLibTrapCustom+26) 00123 #define kPmUIUtilLibTrapLstSetTempSelection (sysLibTrapCustom+27) 00124 #define kPmUIUtilLibTrapLstGetTempSelection (sysLibTrapCustom+28) 00125 #define kPmUIUtilLibTrapNavGetFocusColor (sysLibTrapCustom+29) 00126 #define kPmUIUtilLibTrapNavSetFocusColor (sysLibTrapCustom+30) 00127 #define kPmUIUtilLibTrapAttnDiagIsVisible (sysLibTrapCustom+31) 00128 /* 00129 * End of traps in API version 1 00130 */ 00131 00132 /*@}*/ 00133 00134 #endif // __PM_UI_UTIL_LIB_COMMON_H__
| Top | Palm Developer Network © 2004-2008, Palm, Inc. All rights reserved. Generated on Fri Jun 13 10:06:55 2008 for Palm API Guide |