API Guide Home (Online version only) |

# HsPhoneMiscTypes.h

Go to the documentation of this file.

    00001 /******************************************************************************
    00002  * Copyright (c) 2004 palmOne, Inc. or its subsidiaries.
    00003  * All rights reserved.
    00004  *****************************************************************************/
    00005 /** @ingroup Telephony
    00006  *
    00007  */
    00008
    00009
    00010 /**
    00011  *
    00012  * @file    HsPhoneMiscTypes.h
    00013  *
    00014  * @brief  Header File for Phone Library API ---- NETWORK CATEGORY
    00015  *
    00016  * NOTES:
    00017  *  All implementations of the Handspring Phone Library support a common API.
    00018  *  This API is broken up into various categories for easier management.  This file
    00019  *  defines the SMS category.  These API calls are used to interact with the wireless network.
    00020  */
    00021
    00022
    00023
    00024 #ifndef _HS_PHONE_MISC_TYPES_H__
    00025 #define _HS_PHONE_MISC_TYPES_H__
    00026 #include <PalmOS.h>
    00027 #include <PalmTypes.h>
    00028 #ifndef __CORE_COMPATIBILITY_H__
    00029 #include <PalmCompatibility.h>
    00030     /** workaround for differing header files in sdk-3.5 and sdk-internal */
    00031     #ifndef __CORE_COMPATIBILITY_H__
    00032     #define __CORE_COMPATIBILITY_H__
    00033     #endif
    00034 #endif
    00035
    00036
    00037 /**
    00038  *  Vibrate mode while ringing.
    00039  **/
    00040 typedef enum
    00041   {
    00042     phnVibrateOff,      /**<        */
    00043     phnVibrateOn        /**<        */
    00044   }
    00045 PhnVibrateType;
    00046
    00047 #define isValidPhnVibrateType(t) ((t >= phnVibrateOff) && (t <= phnVibrateOn))  /**<        */
    00048
    00049
    00050 /**
    00051  *  Phone Connection Type
    00052  **/
    00053 typedef enum {
    00054   voiceConnection   = 1,    /**<        */
    00055   csdConnection     = 2,    /**<        */
    00056   gprsConnection    = 3,    /**<        */
    00057   oneXConnection    = 4     /**<        */
    00058 } PhnConnectionEnum;
    00059
    00060 #define isValidPhnConnectionEnum(e) ((e >= voiceConnection) && (e <= oneXConnection))   /**<        */
    00061
    00062 /**
    00063  *
    00064  **/
    00065 typedef enum
    00066 {
    00067   phnHandsetMode,             /**< sets default mode to handset mode */
    00068   phnHeadsetMode,             /**< sets default mode to headdset mode */
    00069   phnSpeakerPhoneMode,        /**< sets default mode to speaker phone mode */
    00070   phnCarKitMode,              /**< set carkit mode */
    00071   phnHandsetLidCloseMode,     /**<        */
    00072   phnAutoMode,                /**< automatic mode where modem internaly decides the mode */
    00073   phnBluetoothHeadsetMode,    /**<        */
    00074   phnBluetoothHandsfreeMode,  /**<        */
    00075   phnInvalidEquipmentMode,    /**< Used to flag an invalid mode */
    00076   phnEquipmentModeLast        /**<        */
    00077
    00078 }PhnEquipmentMode;
    00079
    00080 #define isValidPhnEquipmentMode(m) (m <= phnEquipmentModeLast)  /**<        */
    00081
    00082
    00083 /**
    00084  *  Radio state
    00085  **/
    00086 typedef struct
    00087   {
    00088     UInt16 version;     /**<        */
    00089     UInt32 size;        /**<        */
    00090     UInt16 maxConnections;  /**<        */
    00091     Boolean alsSupported;   /**< GSM only feature. if False activeLineNumber should always be 1 */
    00092     Int16 activeLineNumber; /**<        */
    00093   }
    00094 PhnRadioStateType,* PhnRadioStatePtr;
    00095
    00096 #define kRadioStateVersion 1        /**<        */
    00097
    00098 /**
    00099  *  Line State
    00100  **/
    00101 typedef struct
    00102   {
    00103     UInt16 version;     /**<        */
    00104     UInt16 size;            /**<        */
    00105     Boolean activeLine;     /**<        */
    00106     Boolean divertIndicator;    /**<        */
    00107     Boolean voiceMailIndicator; /**<        */
    00108   }
    00109 PhnLineStateType, * PhnLineStatePtr;
    00110 #define kLineStateVersion 1     /**<        */
    00111
    00112
    00113 /**
    00114  *  Phone Library Attributes
    00115  **/
    00116 typedef enum
    00117   {
    00118     phnGsmAttrFirst = 0,            /**<        */
    00119     phnGsmNoFWVersionCompatibilityCheck,    /**<        */
    00120     phnGsmSimBookSimMaxEntries,         /**<        */
    00121     phnGsmSimBookSimUsedEntries,        /**<        */
    00122     phnGsmRadioAudioSet,            /**<        */
    00123         phnGsmFWControlLED,
    00124
    00125     phnGsmAttrLast
    00126   }_PhnLibAttrType;
    00127 typedef UInt8  PhnLibAttrType;
    00128 typedef UInt8* PhnLibAttrPtr;
    00129
    00130 typedef enum
    00131 {
    00132     phnOprtModeNone =-1,   /**< FOR INTERNAL USE OF CM ONLY! */
    00133     phnOprtModePwroff,    /**< phone is powering off */
    00134     phnOprtModeOffline,   /**< phone is offline Digital*/
    00135     phnOprtModeOfflineA, /**< phone is offline analog */
    00136     phnOprtModeOnline,    /**< phone is online */
    00137     phnOprtModeLPM,       /**< phone is in LPM - Low Power Mode */
    00138     phnOprtModeReset,     /**< phone is resetting - i.e. power-cycling */
    00139
    00140     phnOprtModeMax
    00141
    00142 } _PhnOprtModeType;
    00143
    00144 typedef UInt8 PhnOprtModeType;
    00145
    00146 /**
    00147 *  CDMA System info
    00148 **/
    00149 typedef struct
    00150 {
    00151  UInt16 sid;
    00152  UInt16 nid;
    00153  UInt8  bandClass;
    00154  UInt16 chNum;
    00155  UInt8  wsCode;
    00156 } PhnCdmaSystemInfoType, *PhnCdmaSystemInfoPtr;
    00157
    00158
    00159 #endif // _HS_PHONE_MISC_TYPES_H__

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