aiwcommon.hrh File Reference

API published in: S60 3rd Ed FP 2


Defines
#define	KAiwCmdNoneStr "00000000"
#define	KAiwCmdHelpStr "10275075"
#define	KAiwCmdMnShowMapStr "10206904"
#define	KAiwCmdMnNavigateToStr "10206905"
#define	KAiwCmdMnAddrByCoordStr "10206906"
#define	KAiwCmdMnCoordByAddrStr "10206907"
#define	KAiwCmdMnSelectFromMapStr "10206908"
#define	AIW_CASCADE_ID 0x01010001
	Always keep the provider menu items in a submenu.
#define	AIW_INTELLIGENT_CASCADE_ID 0x01010010
	Menu item is placed intelligently either to the main level or a submenu.
#define	AIW_LOCK_SUBMENU_TITLE 0x00000020
	Consumer defines the menu title.
#define	AIW_OPTIONS_ROM_ONLY 0x01
	Criteria item loadOptions bit, only providers in ROM are accepted.
Enumerations
enum	TAiwServiceCommands { KAiwCmdNone = 0, KAiwCmdHelp = 0x10275075, KAiwCmdMnShowMap = 0x10206904, KAiwCmdMnNavigateTo = 0x10206905, KAiwCmdMnAddrByCoord = 0x10206906, KAiwCmdMnCoordByAddr = 0x10206907, KAiwCmdMnSelectFromMap = 0x10206908 }
	Predefined service commands (UIDs). More...
enum	TAiwServiceCmdOptions { KAiwOptASyncronous = 0x0001, KAiwOptOutParamCheck = 0x0002, KAiwOptInParamCheck = 0x0004, KAiwOptCancel = 0x0008 }
	Service command options (bits) to alter command handling behaviour. More...
enum	TAiwServiceClass { KAiwClassNone = 0x0, KAiwClassBase = 0x101F8650, KAiwClassMenu = 0x101F8652 }
	Service classes (UID). More...
enum	{ KAiwEventStarted = 1, KAiwEventCompleted = 2, KAiwEventCanceled = 3, KAiwEventError = 4, KAiwEventOutParamCheck = 5, KAiwEventInParamCheck = 6, KAiwEventStopped = 7, KAiwEventQueryExit = 8 }
	Event codes. More...

Define Documentation

#define AIW_CASCADE_ID 0x01010001

Always keep the provider menu items in a submenu.

#define AIW_INTELLIGENT_CASCADE_ID 0x01010010

Menu item is placed intelligently either to the main level or a submenu.

#define AIW_LOCK_SUBMENU_TITLE 0x00000020

Consumer defines the menu title.

#define AIW_OPTIONS_ROM_ONLY 0x01

Criteria item loadOptions bit, only providers in ROM are accepted.

#define KAiwCmdHelpStr "10275075"

#define KAiwCmdMnAddrByCoordStr "10206906"

#define KAiwCmdMnCoordByAddrStr "10206907"

#define KAiwCmdMnNavigateToStr "10206905"

#define KAiwCmdMnSelectFromMapStr "10206908"

#define KAiwCmdMnShowMapStr "10206904"

#define KAiwCmdNoneStr "00000000"

anonymous enum

Event codes.

To be used with HandleNotifyL method.

Enumerator:

KAiwEventStarted	Asynchronous service informs consumer to prepare itself for action.
KAiwEventCompleted	Asynchronous service request completed.
KAiwEventCanceled	Asynchronous service request canceled.
KAiwEventError	Error during asynchronous service request.
KAiwEventOutParamCheck	Relates to KAiwOptOutParamCheck.
KAiwEventInParamCheck	Relates to KAiwOptInParamCheck.
KAiwEventStopped	Provider informs consumer that service is no longer available or has stopped.
KAiwEventQueryExit	Provider asks consumer whether Exit can be done (needed at least in embedded use cases where server application offers Exit possibility to end user, but consumer can not allow Exit due to fact that for example network connections owned by consumer are open and they need to be kept alive).

enum TAiwServiceClass

Service classes (UID).

Technically these are same as service interface UIDs.

Enumerator:

KAiwClassNone	None.
KAiwClassBase	Base service (no UI expected). Every other class must implement this always!
KAiwClassMenu	Menu service class (offers menu based services).

enum TAiwServiceCmdOptions

Service command options (bits) to alter command handling behaviour.

Enumerator:

KAiwOptASyncronous	Consumer wants asynchronous command handling. The default is synchronous command handling. In asynchronous case consumer needs to pass a callback to provider.
KAiwOptOutParamCheck	Consumer wants provider to make a callback to check coming output parameters prior returning from service command handling. Consumer needs to pass a callback to provider.
KAiwOptInParamCheck	Consumer tells provider that it is prepared to handle callback events for possibly incomplete/wrong parameter list.
KAiwOptCancel	Consumer wants to cancel an asynchronous AIW service. When a consumer wants to cancel the asynchronous service that a provider is executing, it should call ExecuteMenuCmdL() or ExecuteServiceCmdL() with the same parameters as when requesting the service, but set this cancel bit on. The cancel operation itself is synchronous, i.e. the provider must call the consumer's callback with KAiwEventCanceled before the Execute*CmdL() returns.

enum TAiwServiceCommands

Predefined service commands (UIDs).

Enumerator:

KAiwCmdNone	Null value.
KAiwCmdHelp	Show help content.
KAiwCmdMnShowMap	Client can request that map should be displayed on screen.
KAiwCmdMnNavigateTo	Allows to start navigation to desired destination.
KAiwCmdMnAddrByCoord	Starts reverse geocoding request: finding address for given coordinate.
KAiwCmdMnCoordByAddr	Starts geocoding request: finding coordinate by given address.
KAiwCmdMnSelectFromMap	Allows client to request that user shall select a location from map.