Header Files » Incs » 68k » libraries » pmuiutillib
PmUIUtilLib.h

00001 /******************************************************************************
00002  * Copyright (c) 2004 palmOne, Inc. or its subsidiaries.
00003  * All rights reserved.
00004  *****************************************************************************/
00005 /**
00006  * @ingroup PmUIUtilLib
00007  */
00008 
00009 /**
00010  * @file  PmUIUtilLib.h
00011  * @brief This is the public header for PmUIUtil library.
00012  *
00013  * This library contains general utility functions that supplement
00014  * OS functionality.  That is, it contains functions that
00015  * are general enough to be useful to many applications but
00016  * weren't included in the OS utility functions for whatever
00017  * reason.
00018  *
00019  */
00020 
00021 #ifndef __PM_UI_UTIL_LIB_H__
00022 #define __PM_UI_UTIL_LIB_H__
00023 
00024 #ifdef __cplusplus
00025 extern "C" {
00026 #endif
00027 
00028 #include <HsNavCommon.h>
00029 #include <PmUIUtilLibCommon.h>
00030 
00031 #if 0
00032 #pragma mark --------   Basic Lib API  ----------------
00033 #endif
00034 
00035 /**
00036  * @brief Standard library open routine
00037  *
00038  * @param   refNum: IN: Library reference number
00039  * @retval  Err     Error code
00040  */
00041 Err
00042 PmUIUtilLibOpen (UInt16 refNum)
00043             SYS_TRAP (kPmUIUtilLibTrapOpen);
00044 
00045 /**
00046  * @brief Standard library close routine
00047  *
00048  * @param   refNum: IN: Library reference number
00049  * @retval  Err     Error code
00050  */
00051 Err
00052 PmUIUtilLibClose (UInt16 refNum)
00053             SYS_TRAP (kPmUIUtilLibTrapClose);
00054 
00055 
00056 
00057 #if 0
00058 #pragma mark -------- List API --------
00059 #endif
00060 
00061 void
00062 PmUIUtilLstSetTempSelection (UInt16 refNum, const FormType* formP, UInt16 listID, Int16 itemNum)
00063             SYS_TRAP (kPmUIUtilLibTrapLstSetTempSelection);
00064 
00065 Int16
00066 PmUIUtilLstGetTempSelection (UInt16 refNum, const FormType* formP, UInt16 listID)
00067             SYS_TRAP (kPmUIUtilLibTrapLstGetTempSelection);
00068 
00069 
00070 #if 0
00071 #pragma mark -------- Attr API --------
00072 #endif
00073 
00074 Err
00075 PmUIUtilAttrGet (UInt16 refNum, UInt16 /*PmUIUtilAttrEnum*/ attr, UInt32 flags, UInt32* valueP)
00076             SYS_TRAP (kPmUIUtilLibTrapAttrGet);
00077 
00078 Err
00079 PmUIUtilAttrSet (UInt16 refNum, UInt16 /*PmUIUtilAttrEnum*/ attr, UInt32 flags, UInt32 value)
00080             SYS_TRAP (kPmUIUtilLibTrapAttrSet);
00081 
00082 
00083 #if 0
00084 #pragma mark -------- PalmOne-Specific Nav API --------
00085 #endif
00086 
00087 void
00088 PmUIUtilNavGetFocusColor (UInt16 refNum, HsNavFocusColorEnum color, RGBColorType* rgbColorP)
00089             SYS_TRAP (kPmUIUtilLibTrapNavGetFocusColor);
00090 
00091 void
00092 PmUIUtilNavSetFocusColor (UInt16 refNum, HsNavFocusColorEnum color, RGBColorType* rgbColorP,
00093                           RGBColorType* oldRgbColorP)
00094             SYS_TRAP (kPmUIUtilLibTrapNavSetFocusColor);
00095 
00096 #ifdef __cplusplus
00097 }
00098 #endif
00099 
00100 #endif // __PM_UI_UTIL_LIB_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