API Guide Home (Online version only) |

# PmSysGadgetLibCommon.h File Reference

## Detailed Description

Public 68k header file for system Library that exports system gadget related APIs.

This file contains the common definitions and structures for the gadget-related APIs.

Definition in file PmSysGadgetLibCommon.h.

Go to the source code of this file.

## Data Structures

- struct PmSysGadgetBbutMappingType
    This is the structure of a single big button mapping... More...
- struct PmSysGadgetBbutResourceType
    This is the structure of a big button resource... More...
- struct PmSysGadgetPttNotificationType
    This is the structure used by the PTT notification event. More...

## Defines

- #define kPmSysGadgetLibType sysFileTLibrary
- #define kPmSysGadgetLibCreator pmFileCSysGadgetLib
- #define kPmSysGadgetLibName "PmSysGadgetLib-PmSg"
- #define kPmSysGadgetBbutGadgetMiscSelectSelector 7014
- #define kPmSysGadgetBbutGadgetMiscSelectData ((void*)0xBADC0DE1)
- #define kPmSysGadgetBbutRscType 'bBut'
- #define kPttNotificationEvent 'pPTT'
- #define kPttNotificationStatusOffset (0xF00)

- #define kPmSysGadgetFtrIDStatusGadgetRev 1
- #define kPmSysGadgetFtrValStatusGadgetRev1 0x0001

Function Traps

- #define kPmSysGadgetLibTrapOpen sysLibTrapOpen
- #define kPmSysGadgetLibTrapClose sysLibTrapClose
- #define kPmSysGadgetLibTrapStatusGadgetTypeSet (sysLibTrapCustom)
- #define kPmSysGadgetLibTrapStatusGadgetsUpdate (sysLibTrapCustom+1)
- #define kPmSysGadgetLibTrapBbutInstallFromResource (sysLibTrapCustom+2)
- #define kPmSysGadgetLibTrapBbutInstallNewButton (sysLibTrapCustom+3)
- #define kPmSysGadgetLibTrapBbutSetLabel (sysLibTrapCustom+4)
- #define kPmSysGadgetLibTrapBbutSetBitmap (sysLibTrapCustom+5)
- #define kPmSysGadgetLibTrapBbutHitBigButton (sysLibTrapCustom+6)

## Enumerations

- enum PmSysGadgetStatusGadgetTypeEnum {
  pmSysGadgetStatusGadgetNone = 0,
  pmSysGadgetStatusGadgetBattery = 1,
  pmSysGadgetStatusGadgetSignal = 2,
  pmSysGadgetStatusGadgetBt = 3,
  pmSysGadgetStatusGadgetEvdo = 4,
  pmSysGadgetStatusGadgetLine = 5,
  pmSysGadgetStatusGadgetRoaming = 6,
  pmSysGadgetStatusGadgetCallFwd = 7,
  pmSysGadgetStatusGadgetVm = 8,
  pmSysGadgetStatusGadgetOperator = 9,
  pmSysGadgetStatusGadgetPhoneCall = 10,
  pmSysGadgetStatusGadgetTty = 11,
  pmSysGadgetStatusGadgetPtt = 12
  }
- enum PmSysGadgetBtStatusTypeEnum {
  kIndicatorBtOff = 0x0700,
  kIndicatorBtOn,
  kIndicatorBtConnectHeadset,
  kIndicatorBtConnectOther,
  kIndicatorBtDUN,
  kIndicatorBtConnectAudio,
  kIndicatorBtConnectStereo
  }

## Define Documentation

#define kPmSysGadgetBbutGadgetMiscSelectData ((void*)0xBADC0DE1)

Magic # to make conflicts even less likely for detecting big button presses.

Definition at line 53 of file PmSysGadgetLibCommon.h.

#define kPmSysGadgetBbutGadgetMiscSelectSelector 7014

This selector gets sent with a frmGadgetMiscEvent to let you know that the gadget has been selected. The numbers are picked semi-randomly so that generic code (like PmUIUtilFrmDoDialogWithCallback()) can tell that this is actually a button press without doing the wrong thing for other people's gadget events.

Note that in most code, you shouldn't need to worry about checking the data, since you know exactly what gadgets are on your form and what kind of events they send. Randomish number so people can easily detect big button presses

Definition at line 51 of file PmSysGadgetLibCommon.h.

#define kPmSysGadgetBbutRscType 'bBut'

This is the type of big button resources. The ID should match the ID of the form... Registered: yes

Definition at line 61 of file PmSysGadgetLibCommon.h.

#define kPmSysGadgetFtrIDStatusGadgetRev 1

Feature that says that status gadget API exists and what revision it is

Definition at line 67 of file PmSysGadgetLibCommon.h.

#define kPmSysGadgetFtrValStatusGadgetRev1 0x0001

Feature that says that status gadget API exists and what revision it is

Definition at line 68 of file PmSysGadgetLibCommon.h.

#define kPmSysGadgetLibCreator pmFileCSysGadgetLib

Library creator ID

Definition at line 38 of file PmSysGadgetLibCommon.h.

#define kPmSysGadgetLibName "PmSysGadgetLib-PmSg"

Library name

Definition at line 39 of file PmSysGadgetLibCommon.h.

#define kPmSysGadgetLibTrapBbutHitBigButton (sysLibTrapCustom+6)

Definition at line 169 of file PmSysGadgetLibCommon.h.

#define kPmSysGadgetLibTrapBbutInstallFromResource (sysLibTrapCustom+2)

Definition at line 165 of file PmSysGadgetLibCommon.h.

#define kPmSysGadgetLibTrapBbutInstallNewButton (sysLibTrapCustom+3)

Definition at line 166 of file PmSysGadgetLibCommon.h.

#define kPmSysGadgetLibTrapBbutSetBitmap (sysLibTrapCustom+5)

Definition at line 168 of file PmSysGadgetLibCommon.h.

#define kPmSysGadgetLibTrapBbutSetLabel (sysLibTrapCustom+4)

Definition at line 167 of file PmSysGadgetLibCommon.h.

#define kPmSysGadgetLibTrapClose sysLibTrapClose

Definition at line 162 of file PmSysGadgetLibCommon.h.

#define kPmSysGadgetLibTrapOpen sysLibTrapOpen

Definition at line 161 of file PmSysGadgetLibCommon.h.

#define kPmSysGadgetLibTrapStatusGadgetsUpdate (sysLibTrapCustom+1)

Definition at line 164 of file PmSysGadgetLibCommon.h.

#define kPmSysGadgetLibTrapStatusGadgetTypeSet (sysLibTrapCustom)

Definition at line 163 of file PmSysGadgetLibCommon.h.

#define kPmSysGadgetLibType sysFileTLibrary

Library type

Definition at line 37 of file PmSysGadgetLibCommon.h.

#define kPttNotificationEvent 'pPTT'

Constants added for PTT Notification

Definition at line 74 of file PmSysGadgetLibCommon.h.

#define kPttNotificationStatusOffset (0xF00)

Definition at line 75 of file PmSysGadgetLibCommon.h.

## Enumeration Type Documentation

enum PmSysGadgetBtStatusTypeEnum

Bluetooth radio status

Enumerator:

  kIndicatorBtOff | Bt Radio turned off
  kIndicatorBtOn | Bt radio turned on
  kIndicatorBtConnectHeadset | Connected to Headset
  kIndicatorBtConnectOther | Connected to other Bt devices
  kIndicatorBtDUN | Connected to DUN
  kIndicatorBtConnectAudio | Connected audio
  kIndicatorBtConnectStereo | Connected stereo

Definition at line 101 of file PmSysGadgetLibCommon.h.

    00102   {
    00103     kIndicatorBtOff       = 0x0700, /**< Bt Radio turned off */
    00104     kIndicatorBtOn,                 /**< Bt radio turned on */
    00105     kIndicatorBtConnectHeadset,     /**< Connected to Headset */
    00106     kIndicatorBtConnectOther,       /**< Connected to other Bt devices */
    00107     kIndicatorBtDUN,                /**< Connected to DUN */
    00108     kIndicatorBtConnectAudio,       /**< Connected audio **/
    00109     kIndicatorBtConnectStereo       /**< Connected stereo **/
    00110   } PmSysGadgetBtStatusTypeEnum;

enum PmSysGadgetStatusGadgetTypeEnum

Equates for supporting system handled status gadgets

Enumerator:

  pmSysGadgetStatusGadgetNone | No type specified for status gadget
  pmSysGadgetStatusGadgetBattery | Status gadget is a battery meter
  pmSysGadgetStatusGadgetSignal | Status gadget is a signal strength indicator
  pmSysGadgetStatusGadgetBt | Status gadget is a Bluetooth status indicator
  pmSysGadgetStatusGadgetEvdo | Status gadget is an EVDO status indicator
  pmSysGadgetStatusGadgetLine | Status gadget is an Active line status indicator
  pmSysGadgetStatusGadgetRoaming | Status gadget is a Roaming status indicator
  pmSysGadgetStatusGadgetCallFwd | Status gadget is a Call Forwarding status indicator
  pmSysGadgetStatusGadgetVm | Status gadget is a Voicemail status indicator
  pmSysGadgetStatusGadgetOperator | Status gadget is an Operator status indicator
  pmSysGadgetStatusGadgetPhoneCall | Status gadget is an Operator status indicator
  pmSysGadgetStatusGadgetTty | Status gadget is a TTY status indicator
  pmSysGadgetStatusGadgetPtt | Status gadget is a PTT status indicator, RJS added 22May06

Definition at line 83 of file PmSysGadgetLibCommon.h.

    00084   {
    00085     pmSysGadgetStatusGadgetNone = 0,       /**< No type specified for status gadget */
    00086     pmSysGadgetStatusGadgetBattery = 1,    /**< Status gadget is a battery meter */
    00087     pmSysGadgetStatusGadgetSignal = 2,     /**< Status gadget is a signal strength indicator */
    00088     pmSysGadgetStatusGadgetBt = 3,         /**< Status gadget is a Bluetooth status indicator */
    00089     pmSysGadgetStatusGadgetEvdo = 4,       /**< Status gadget is an EVDO status indicator */
    00090     pmSysGadgetStatusGadgetLine = 5,       /**< Status gadget is an Active line status indicator */
    00091     pmSysGadgetStatusGadgetRoaming = 6,    /**< Status gadget is a Roaming status indicator */
    00092     pmSysGadgetStatusGadgetCallFwd = 7,    /**< Status gadget is a Call Forwarding status indicator */
    00093     pmSysGadgetStatusGadgetVm = 8,         /**< Status gadget is a Voicemail status indicator */
    00094     pmSysGadgetStatusGadgetOperator = 9,   /**< Status gadget is an Operator status indicator */
    00095     pmSysGadgetStatusGadgetPhoneCall = 10, /**< Status gadget is an Operator status indicator */
    00096     pmSysGadgetStatusGadgetTty = 11,       /**< Status gadget is a TTY status indicator */
    00097     pmSysGadgetStatusGadgetPtt = 12        /**< Status gadget is a PTT status indicator, RJS added 22May06 */
    00098   } PmSysGadgetStatusGadgetTypeEnum;

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