API Guide Home (Online version only) |

# PalmStatusBar.h

Go to the documentation of this file.

    00001 /******************************************************************************
    00002  * Copyright (c) 2005 palmOne, Inc. or its subsidiaries.
    00003  * All rights reserved.
    00004  *****************************************************************************/
    00005 /**
    00006  * @ingroup StatusBar
    00007  *
    00008  */
    00009
    00010 /**
    00011  * file     PalmStatusBar.h
    00012  * @version 1.0
    00013  * @date    03/03/2003
    00014  *
    00015  * @brief  Public API for the Status Bar Library
    00016  *
    00017  *
    00018  * <hr>
    00019  */
    00020
    00021
    00022 #ifndef __STATUSBARMGRLIB_H__
    00023 #define __STATUSBARMGRLIB_H__
    00024
    00025 #include <PalmTypes.h>
    00026 #include <LibTraps.h>
    00027
    00028 /**
    00029  * @name Library type and creator
    00030  *
    00031  */
    00032 /*@{*/
    00033 #define statLibName     "StatusBarMgrLib"   /**         */
    00034 #define statLibCreator      'sBar'          /**         */
    00035 #define statLibType     sysFileTLibrary     /**         */
    00036 #define statFtrNumVersion   (0)         /**         */
    00037 /*@}*/
    00038
    00039 /**
    00040  * @name Status Bar Errors
    00041  *
    00042  */
    00043 /*@{*/
    00044 #define statErrorClass      (appErrorClass  | 0x0900)   /**         */
    00045 #define statErrNoStatusBar  (statErrorClass | 1)        /**         */
    00046 #define statErrInvalidSelector  (statErrorClass | 2)        /**         */
    00047 #define statErrInputWindowOpen  (statErrorClass | 3)        /**         */
    00048 #define statErrBadParam     (statErrorClass | 101)      /**         */
    00049 #define statErrInvalidState (statErrorClass | 102)      /**         */
    00050 /*@}*/
    00051
    00052 /**
    00053  * Status Bar Attributes
    00054  **/
    00055 typedef enum StatAttrTypeTag
    00056 {
    00057     statAttrExists     = 0,         /**< device supports the status bar */
    00058     statAttrBarVisible,             /**< status bar is visible */
    00059     statAttrDimension               /**< bounds of status bar window */
    00060 } StatAttrType;
    00061
    00062 /**
    00063  * @name Library Traps
    00064  *
    00065  */
    00066 /*@{*/
    00067 #define kStatusBarMgrLibTrapOpen    sysLibTrapOpen      /**         */
    00068 #define kStatusBarMgrLibTrapClose   sysLibTrapClose     /**         */
    00069 #define kStatusBarMgrLibGetAttribute    (sysLibTrapCustom)  /**         */
    00070 #define kStatusBarMgrLibHide        (sysLibTrapCustom + 1)  /**         */
    00071 #define kStatusBarMgrLibShow        (sysLibTrapCustom + 2)  /**         */
    00072 /*@}*/
    00073
    00074 /**
    00075  * Prototypes
    00076  **/
    00077 #ifdef __cplusplus
    00078 extern "C" {
    00079 #endif
    00080
    00081 /**
    00082  * @brief
    00083  *
    00084  * @param refnum:   IN:
    00085  * @retval Err error code.
    00086  **/
    00087 Err StatLibOpen(UInt16 refnum)
    00088                 SYS_TRAP(kStatusBarMgrLibTrapOpen);
    00089
    00090 /**
    00091  * @brief
    00092  *
    00093  * @param refnum:   IN:
    00094  * @retval Err error code.
    00095  **/
    00096 Err StatLibClose(UInt16 refnum)
    00097                 SYS_TRAP(kStatusBarMgrLibTrapClose);
    00098
    00099 /**
    00100  * @brief
    00101  *
    00102  * @param refnum:   IN:
    00103  * @param selector: IN:
    00104  * @param *dataP:   IN:
    00105  * @retval Err error code.
    00106  **/
    00107 Err StatGetAttribute(UInt16 refnum, StatAttrType selector, UInt32 *dataP)
    00108                 SYS_TRAP(kStatusBarMgrLibGetAttribute);
    00109
    00110 /**
    00111  * @brief
    00112  *
    00113  * @param refnum:   IN:
    00114  * @retval Err error code.
    00115  **/
    00116 Err StatHide(UInt16 refnum)
    00117                 SYS_TRAP(kStatusBarMgrLibHide);
    00118
    00119 /**
    00120  * @brief
    00121  *
    00122  * @param refnum:   IN:
    00123  * @retval Err error code.
    00124  **/
    00125 Err StatShow(UInt16 refnum)
    00126                 SYS_TRAP(kStatusBarMgrLibShow);
    00127
    00128 #ifdef __cplusplus
    00129 }
    00130 #endif
    00131
    00132 #endif  //__STATUSBARMGRLIB_H__

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