API Guide Home
(Online version only)

HsAppLaunchCmd.h File Reference


Detailed Description

Public header file akin to Palm's AppLaunchCmd.h.

Version:
1.0
Date:
04/20/2000

Definition in file HsAppLaunchCmd.h.

Include dependency graph for HsAppLaunchCmd.h:

Go to the source code of this file.

Data Structures

Defines

Typedefs

Enumerations


Define Documentation

#define AddrHsLookupUserDataVersion   0

Version number of the addrAppNotificationHsLookup command and structures

Definition at line 282 of file HsAppLaunchCmd.h.

#define AddrHsLookupUserDataVersion2   1

Version number of the addrAppNotificationHsLookup command for the V2 structure

Definition at line 297 of file HsAppLaunchCmd.h.

#define addrLookupNoMinLength   1

Flag definitions for AddrCallerIDParamsType flags field If this flag is set, we match numbers that are shorter than the usual minimum required length. We match the *entire* string, not substrings.

Definition at line 172 of file HsAppLaunchCmd.h.

#define CallWithCommand ( type,
creator,
command,
commandParams   ) 

Value:

{ \
    UInt16              cardNo; \
    LocalID             dbID; \
    DmSearchStateType   searchState; \
    UInt32 result; \
    Err err; \
    DmGetNextDatabaseByTypeCreator(true, &searchState, type, \
        creator, true,  &cardNo, &dbID); \
    ErrNonFatalDisplayIf(!dbID, "Could not find db"); \
    if (dbID) \
      { \
        err = SysAppLaunch(cardNo, dbID, 0, command, (Ptr) commandParams, &result); \
        ErrNonFatalDisplayIf(err, "Could not launch db"); \
      } \
  }
internal

Definition at line 80 of file HsAppLaunchCmd.h.

#define cameraAppLaunchCmdStopPreview   (sysAppLaunchCmdCustomBase)

Stop any active Camera preview

Definition at line 694 of file HsAppLaunchCmd.h.

#define hsDialPrefs4DigitPrefixLength   11

Definition at line 542 of file HsAppLaunchCmd.h.

#define hsDialPrefs5DigitPrefixLength   11

Definition at line 541 of file HsAppLaunchCmd.h.

#define hsDialPrefs6DigitPrefixLength   11

Definition at line 540 of file HsAppLaunchCmd.h.

#define hsDialPrefsAutoAreaCodeLength   11

MAX Length of the dialing prefixes for 7,6,5 and 4 digit numbers respectively, including zero-terminator.

Definition at line 539 of file HsAppLaunchCmd.h.

#define hsDialPrefsMaxDialingPrefixLength   11

Definition at line 544 of file HsAppLaunchCmd.h.

#define LaunchWithCommand ( type,
creator,
command,
commandParams   ) 

Value:

{ \
    UInt16              cardNo; \
    LocalID             dbID; \
    DmSearchStateType   searchState; \
    Err                     err; \
    DmGetNextDatabaseByTypeCreator(true, &searchState, type, \
        creator, true,  &cardNo, &dbID); \
    ErrNonFatalDisplayIf(!dbID, "Could not find db"); \
    if (dbID) \
      { \
        err = SysUIAppSwitch(cardNo, dbID, command, (Ptr) commandParams); \
        ErrNonFatalDisplayIf(err, "Could not launch db"); \
      } \
  }
Author:
dia
History:8 12-oct-1999 dia - Created by Douglas Anderson 20-apr-2000 dia - New APIs for dialing.


Definition at line 54 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdActivation   (sysAppLaunchCmdCustomBase+10)

Launch the ## Application

Definition at line 398 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdBluetoothDial   (sysAppLaunchCmdCustomBase+22)

Definition at line 436 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdBluetoothDialVoiceMail   (sysAppLaunchCmdCustomBase+23)

Definition at line 439 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdCallerIDLookup   (sysAppLaunchCmdCustomBase+25)

Definition at line 442 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdDial   (sysAppLaunchCmdCustomBase)

Launch the phone application and dial the passed number

Definition at line 371 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdDialSTKSETUPCALL   (sysAppLaunchCmdCustomBase+13)

Launch the phone application and dial the passed number for SATK SETUP CALL

Definition at line 407 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdDialVoiceMail   (sysAppLaunchCmdCustomBase+4)

Launch the phone application and dial a number

Definition at line 383 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdDisplayDialPrefs   (sysAppLaunchCmdCustomBase+17)

Display Dial Prefs

Definition at line 421 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdGetALSLineNumber   (sysAppLaunchCmdCustomBase+21)

Launch the phone application and display the Options menu

Definition at line 433 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdGetDialPrefFlag   (sysAppLaunchCmdCustomBase+18)

Query for the carrier flag to determine if Dial Prefs menu option should be displyed

Definition at line 424 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdGetUSDialingRules   (sysAppLaunchCmdCustomBase+19)

Query for the carrier flag to determine if Dial Prefs menu option should be displyed

Definition at line 427 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdNetworkSearch   (sysAppLaunchCmdCustomBase+14)

Launch the phone application to display the UI to ask the user if they would like to search again.

Definition at line 412 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdPowerOn   (sysAppLaunchCmdCustomBase+3)

Launch the phone application and prompt to power on the phone

Definition at line 380 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdRedial   (sysAppLaunchCmdCustomBase+1)

Launch the phone application and dial the last number dialed.

Definition at line 374 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdRegisterAllViews   (sysAppLaunchCmdCustomBase+27)

Definition at line 445 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdSendDTMFTone   (sysAppLaunchCmdCustomBase+15)

Launch the phone application and send DTMF tone to the network

Definition at line 415 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdSetWallpaper   (sysAppLaunchCmdCustomBase+11)

Set the Wallpaper

Definition at line 401 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdStartNetInitUSSD   (sysAppLaunchCmdCustomBase+12)

Start the Network-initiated USSD

Definition at line 404 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdViewCalls   (sysAppLaunchCmdCustomBase+2)

Launch the phone application and display the active calls view.

Definition at line 377 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdViewHistory   (sysAppLaunchCmdCustomBase+5)

Launch the phone application and display the call history view.

Definition at line 386 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdViewKeypad   (sysAppLaunchCmdCustomBase+7)

Launch the phone application and display the keypad view.

Definition at line 392 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdViewMissedCalls   (sysAppLaunchCmdCustomBase+16)

Launch the phone application and display missed calls in the call history view.

Definition at line 418 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdViewPhoneHome   (sysAppLaunchCmdCustomBase+8)

Launch the phone application and display the Phone Home view

Definition at line 395 of file HsAppLaunchCmd.h.

#define phoneAppLaunchCmdViewSpeed   (sysAppLaunchCmdCustomBase+6)

Launch the phone application and display the speed dial view.

Definition at line 389 of file HsAppLaunchCmd.h.

#define phoneAppLaunchOptionsMenu   (sysAppLaunchCmdCustomBase+20)

Launch the phone application and display the Options menu

Definition at line 430 of file HsAppLaunchCmd.h.

#define pmNotifyHighPriorityAudioTask   'pmAT'

Notification to request stop/pause audio preview/playback. In the event of high priority UI action like an incoming phone call, if the responsible application does not take action the sender of this notification may take appropriate action in order to handle the high priority task

Definition at line 706 of file HsAppLaunchCmd.h.

#define pmNotifyHighPriorityUITask   'pmUT'

Notification to request stop/pause video preview/playback. In the event of high priority UI action like an incoming phone call, if the responsible application does not take action the sender of this notification may take appropriate action in order to handle the high priority task

Definition at line 700 of file HsAppLaunchCmd.h.

#define pmPhoneAppNotifyHomeAppEvent   'pEvt'

This notification is broadcast by the Phone application

Definition at line 602 of file HsAppLaunchCmd.h.

#define pmPhoneAppNotifySetWallpaper   'pWlp'

The parameter for pmPhoneAppNotifyHomeAppEvent notification is of type PhnEventPtr(as defined in HsPhoneEvent.h

Definition at line 606 of file HsAppLaunchCmd.h.

#define soundPrefsLaunchCmdCalendar   (sysAppLaunchCmdCustomBase+4)

Launch Sound Prefs in Calendar Prefs view

Definition at line 628 of file HsAppLaunchCmd.h.

#define soundPrefsLaunchCmdEmail   (sysAppLaunchCmdCustomBase+3)

Launch Sound Prefs in Email Prefs view

Definition at line 625 of file HsAppLaunchCmd.h.

#define soundPrefsLaunchCmdGeneral   (sysAppLaunchCmdCustomBase+6)

Launch Sound Prefs in the General Prefs view

Definition at line 634 of file HsAppLaunchCmd.h.

#define soundPrefsLaunchCmdIM   (sysAppLaunchCmdCustomBase+2)

Launch Sound Prefs in IM Prefs view

Definition at line 622 of file HsAppLaunchCmd.h.

#define soundPrefsLaunchCmdMMS   (sysAppLaunchCmdCustomBase+5)

Launch Sound Prefs in the MMS Prefs view

Definition at line 631 of file HsAppLaunchCmd.h.

#define soundPrefsLaunchCmdPhone   (sysAppLaunchCmdCustomBase)

Launch sounds Prefs in Phone Prefs view

Definition at line 616 of file HsAppLaunchCmd.h.

#define soundPrefsLaunchCmdSMS   (sysAppLaunchCmdCustomBase+1)

Launch Sound Prefs in SMS Prefs view

Definition at line 619 of file HsAppLaunchCmd.h.

#define sysAppLaunchWebBrowserAutoCrawl   (sysAppLaunchCmdCustomBase + 3)

Launch the browser in autocrawl mode

Definition at line 665 of file HsAppLaunchCmd.h.

#define sysAppLaunchWebBrowserGetHomePage   (sysAppLaunchCmdCustomBase + 1)

Retrieve the browser's home page

Definition at line 659 of file HsAppLaunchCmd.h.

#define sysAppLaunchWebBrowserLaunchBookmarkDialog   (sysAppLaunchCmdCustomBase)

Launch the browser in the bookmark dialog

Definition at line 656 of file HsAppLaunchCmd.h.

#define sysAppLaunchWebBrowserMinimalMode   (sysAppLaunchCmdCustomBase + 5)

Launch the browser in minimal mode

Definition at line 671 of file HsAppLaunchCmd.h.

#define sysAppLaunchWebBrowserSetHomePage   (sysAppLaunchCmdCustomBase + 2)

Set the browser's home page

Definition at line 662 of file HsAppLaunchCmd.h.

#define sysAppLaunchWebBrowserTutorialMode   (sysAppLaunchCmdCustomBase + 4)

Launch the browser in tips/tutorial mode

Definition at line 668 of file HsAppLaunchCmd.h.

#define sysAppLaunchWebBrowserURLWithSvcID   (sysAppLaunchCmdCustomBase + 6)

Definition at line 680 of file HsAppLaunchCmd.h.


Typedef Documentation

Parameter block is the same as OS 3.1's block for sysAppLaunchCmdLookup

Definition at line 148 of file HsAppLaunchCmd.h.

typedef AddrLookupParamsType AddrHsLookupParamsType

Parameter block is the same as OS 3.1's block for sysAppLaunchCmdLookup

Definition at line 145 of file HsAppLaunchCmd.h.

AddrListLookupTypeEnum -> UInt16

Definition at line 208 of file HsAppLaunchCmd.h.


Enumeration Type Documentation

anonymous enum

Various address book lookup methods.

Enumerator:
addrListLookupTypeLastName  phone lookup will be by last name...
addrListLookupTypeFirstName  phone lookup will be by first name...
addrListLookupTypeCompany  phone lookup will be by company (currently unused)...
addrListLookupTypeIntelligent  phone lookup will be intelligent (either name or some other matching) (currently unused)...

Definition at line 200 of file HsAppLaunchCmd.h.

00201   {
00202     addrListLookupTypeLastName,           /**< phone lookup will be by last name... */
00203     addrListLookupTypeFirstName,          /**< phone lookup will be by first name... */
00204     addrListLookupTypeCompany,            /**< phone lookup will be by company (currently unused)... */
00205     addrListLookupTypeIntelligent         /**< phone lookup will be intelligent (either name or
00206                                                some other matching) (currently unused)...  */
00207   };

anonymous enum

Data structure that goes with phoneAppLaunchCmdGetUSDialingRules launch cmd

Enumerator:
hsDialPrefsAddAreaCodeUnknown  we don't know yet, so prompt when appropriate
hsDialPrefsAddAreaCodeNo  no auto-area code
hsDialPrefsAddAreaCodeYes  add area code automatically before dialing
hsDialPrefsAdd4DigitPrefixUnknown 
hsDialPrefsAdd4DigitPrefixNo 
hsDialPrefsAdd4DigitPrefixYes 
hsDialPrefsAdd5DigitPrefixUnknown 
hsDialPrefsAdd5DigitPrefixNo 
hsDialPrefsAdd5DigitPrefixYes 
hsDialPrefsAdd6DigitPrefixUnknown 
hsDialPrefsAdd6DigitPrefixNo 
hsDialPrefsAdd6DigitPrefixYes 

Definition at line 518 of file HsAppLaunchCmd.h.

00519   {
00520     hsDialPrefsAddAreaCodeUnknown = 0,    /**< we don't know yet, so prompt when appropriate */
00521     hsDialPrefsAddAreaCodeNo,             /**< no auto-area code */
00522     hsDialPrefsAddAreaCodeYes,            /**< add area code automatically before dialing */
00523 
00524     hsDialPrefsAdd4DigitPrefixUnknown, //For 6 digit dialing
00525     hsDialPrefsAdd4DigitPrefixNo,
00526     hsDialPrefsAdd4DigitPrefixYes,
00527     
00528     hsDialPrefsAdd5DigitPrefixUnknown,
00529     hsDialPrefsAdd5DigitPrefixNo,
00530     hsDialPrefsAdd5DigitPrefixYes,
00531     
00532     hsDialPrefsAdd6DigitPrefixUnknown,
00533     hsDialPrefsAdd6DigitPrefixNo,
00534     hsDialPrefsAdd6DigitPrefixYes
00535   };

Launch codes start at customBase + 0x2300 so that hopefully there won't be any conflict with any launch codes that PalmSource or others add to the address book. IMPORTANT: See also AddrCustomNotificationCodes .

Enumerator:
addrAppLaunchCmdHsLookup  Launch Contacts for lookup
addrAppLaunchCmdCallerID  Launch Contacts for callerID lookup

Definition at line 110 of file HsAppLaunchCmd.h.

00111   {
00112     addrAppLaunchCmdHsLookup= sysAppLaunchCmdCustomBase + 0x2300,   /**< Launch Contacts for lookup */
00113     addrAppLaunchCmdCallerID                                        /**< Launch Contacts for callerID lookup */
00114   } 

Switch to using notifications rather than launch codes to avoid potential conflicts if PalmSource modifies the address book app.

Enumerator:
addrAppNotificationHsLookup 
addrAppNotificationCmdCallerID 
addrAppNotificationPhonebookApp 
addrAppNotificationListLookupTypeGet 
addrAppNotificationCreateNewRecord 
addrAppNotificationDialPrefs 
addrAppNotificationBeamBusinessCard 
addrAppNotificationPhotoCallerID 

Definition at line 119 of file HsAppLaunchCmd.h.

00120   {
00121         // NOTE: 
00122         // Shouldn't be using these values!  Notification types are
00123         // supposed to be 4-character creator IDs that are registered in Palm's
00124         // Creator database!  Guess it's a little late now, since these codes are
00125         // out in the field.
00126         addrAppNotificationHsLookup = sysAppLaunchCmdCustomBase + 0x2300,
00127         addrAppNotificationCmdCallerID,
00128         addrAppNotificationPhonebookApp,
00129 
00130         // DON'T ADD ANY MORE based on 2300:  See above NOTE
00131 
00132         addrAppNotificationListLookupTypeGet = 'HsLL',      // Registered 2001-09-12 w/ Creator DB
00133         addrAppNotificationCreateNewRecord = 'HsNR',        // Registered 2002-07-30 w/ Creator DB
00134         addrAppNotificationDialPrefs = 'HsDP',              // Registered 2003-01-29 w/ Creator DB
00135         addrAppNotificationBeamBusinessCard = 'HsBB',       // Registered 2003-02-14 w/ Creator DB
00136         addrAppNotificationPhotoCallerID = 'HsPC'
00137   }

Expansion to the Palm OS AddressLookupFields.

Enumerator:
addrLookupVoicePhones  All phone fields except fax and email.
addrLookupAnyPhones  All phone fields (including email)
addrLookupSMSPhones  Mobile, other and email fields
addrLookupSMSPhonesNoEmail  Mobile and other fields

Definition at line 156 of file HsAppLaunchCmd.h.

00156              {
00157     addrLookupVoicePhones=0x70,     /**< All phone fields except fax and email. */
00158     addrLookupAnyPhones ,           /**< All phone fields (including email) */
00159     addrLookupSMSPhones ,           /**< Mobile, other and email fields */
00160     addrLookupSMSPhonesNoEmail      /**< Mobile and other fields */
00161 } AddressHsLookupFields;

Phone application dial methods.

Enumerator:
PhoneAppDialMethodNormal  Normal PhnLibDial()
PhoneAppDialMethodSATSetupCall  Use SIM Toolkit and respond affirmative to the SIM's request to set up a call.
PhoneAppDialMethodSATSetupCallModeNotBusy 
PhoneAppDialMethodSATSetupCallWithRedialModeNotBusy 
PhoneAppDialMethodSATSetupCallHoldOtherCalls 
PhoneAppDialMethodSATSetupCallWithRedialHoldOtherCalls 
PhoneAppDialMethodSATSetupCallDisconnectOtherCalls 
PhoneAppDialMethodSATSetupCallWithRedialDisconnectOtherCalls 

Definition at line 452 of file HsAppLaunchCmd.h.

00453   {
00454     PhoneAppDialMethodNormal = 0,     /**< Normal PhnLibDial() */
00455     PhoneAppDialMethodSATSetupCall,   /**< Use SIM Toolkit and respond 
00456                                             affirmative to the SIM's request 
00457                                             to set up a call. */ 
00458         // The below codes are added to allow passing of the call setup 
00459         // options
00460         PhoneAppDialMethodSATSetupCallModeNotBusy, 
00461         PhoneAppDialMethodSATSetupCallWithRedialModeNotBusy, 
00462         PhoneAppDialMethodSATSetupCallHoldOtherCalls, 
00463         PhoneAppDialMethodSATSetupCallWithRedialHoldOtherCalls, 
00464         PhoneAppDialMethodSATSetupCallDisconnectOtherCalls, 
00465         PhoneAppDialMethodSATSetupCallWithRedialDisconnectOtherCalls,
00466   }

Different sound pref dialog views.

Enumerator:
soundPrefsViewTones 
soundPrefsViewVolume 

Definition at line 637 of file HsAppLaunchCmd.h.


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