williamr@2: /*
williamr@2: * Copyright (c) 2003-2005 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@4: * under the terms of "Eclipse Public License v1.0"
williamr@2: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description: Declares common constants to be used in both resources and
williamr@2: * C++ code of consumers and providers.
williamr@2: *
williamr@2: */
williamr@2:
williamr@2:
williamr@2:
williamr@2:
williamr@2:
williamr@2: #ifndef AIW_COMMON_HRH
williamr@2: #define AIW_COMMON_HRH
williamr@2:
williamr@2: // DATA TYPES
williamr@2:
williamr@2: // CONSTANTS
williamr@2:
williamr@2: /**
williamr@2: * Predefined service commands (UIDs).
williamr@2: */
williamr@2: enum TAiwServiceCommands
williamr@2: {
williamr@2: /** Null value. */
williamr@2: KAiwCmdNone = 0,
williamr@2:
williamr@2: /** Create new content. */
williamr@2: KAiwCmdNew = 0x101F864C,
williamr@2:
williamr@2: /** Edit existing content. */
williamr@2: KAiwCmdEdit = 0x101F864D,
williamr@2:
williamr@2: /** Select content. */
williamr@2: KAiwCmdSelect = 0x101F864E,
williamr@2:
williamr@2: /** View content. */
williamr@2: KAiwCmdView = 0x101F864F,
williamr@2:
williamr@2: /** Create call. */
williamr@2: KAiwCmdCall = 0x101F86B0,
williamr@2:
williamr@2: /** Send content. */
williamr@2: KAiwCmdSend = 0x101F86B3,
williamr@2:
williamr@2: /** Print content. */
williamr@2: KAiwCmdPrint = 0x101F8666,
williamr@2:
williamr@2: /** Assign content. */
williamr@2: KAiwCmdAssign = 0x101F8716,
williamr@2:
williamr@2: /** Share content. */
williamr@2: KAiwCmdShare = 0x101F871E,
williamr@2:
williamr@2: /** Synchronize content. */
williamr@2: KAiwCmdSynchronize = 0x101F8724,
williamr@2:
williamr@2: /** Synchronize selected. */
williamr@2: KAiwCmdSynchronizeSelected = 0x1020720C,
williamr@2:
williamr@2: /** Search content. */
williamr@2: KAiwCmdSearch = 0x101F87DF,
williamr@2:
williamr@2: /** Copy content. */
williamr@2: KAiwCmdCopy = 0x101F87DE,
williamr@2:
williamr@2: /** Show print preview. */
williamr@2: KAiwCmdPrintPreview = 0x101FD656,
williamr@2:
williamr@2: /** Push to talk. */
williamr@2: KAiwCmdPoC = 0x101FD657,
williamr@2:
williamr@2: /** View content in online store. */
williamr@2: KAiwCmdViewOnline = 0x102072EA,
williamr@2:
williamr@2: /** Upload content. */
williamr@2: KAiwCmdUpload = 0x102072EB,
williamr@2:
williamr@2: /** Transfer a range of media files to a remote storage device. */
williamr@2: KAiwCmdXpressTransfer = 0x10207430,
williamr@2:
williamr@2: /** UPnP copy content. */
williamr@2: KAiwCmdUPnPCopy = 0x10207431,
williamr@2:
williamr@2: /** UPnP move content. */
williamr@2: KAiwCmdUPnPMove = 0x10207432,
williamr@2:
williamr@2: /** UPnP play content. */
williamr@2: KAiwCmdUPnPPlay = 0x10207433,
williamr@2:
williamr@2: /** UPnP open content. */
williamr@2: KAiwCmdUPnPOpen = 0x10207434,
williamr@2:
williamr@2: /** UPnP enable external. */
williamr@2: KAiwCmdUPnPEnableExternal = 0x10207435,
williamr@2:
williamr@2: /** Show help content. */
williamr@2: KAiwCmdHelp = 0x10275075,
williamr@2:
williamr@2: /** Add or remove items from intent. (Should be used as a menu service command). */
williamr@2: KAiwCmdIntent = 0x10275114,
williamr@2:
williamr@2: /** Add items to intent. (Should be used as a base service command). */
williamr@2: KAiwCmdAddToIntent = 0x10275115,
williamr@2:
williamr@2: /** Remove items from intent. (Should be used as a base service command). */
williamr@2: KAiwCmdRemoveFromIntent = 0x10275116,
williamr@2:
williamr@2: /** Client can request that map should be displayed on screen. */
williamr@2: KAiwCmdMnShowMap = 0x10206904,
williamr@2:
williamr@2: /** Allows to start navigation to desired destination. */
williamr@2: KAiwCmdMnNavigateTo = 0x10206905,
williamr@2:
williamr@2: /** Starts reverse geocoding request: finding address for given coordinate. */
williamr@2: KAiwCmdMnAddrByCoord = 0x10206906,
williamr@2:
williamr@2: /** Starts geocoding request: finding coordinate by given address. */
williamr@2: KAiwCmdMnCoordByAddr = 0x10206907,
williamr@2:
williamr@2: /** Allows client to request that user shall select a location from map. */
williamr@2: KAiwCmdMnSelectFromMap = 0x10206908,
williamr@2:
williamr@2: /** Send via Bluetooth. */
williamr@2: KAiwCmdSendViaBT = 0x10281894,
williamr@2:
williamr@2: /** Send via Irda. */
williamr@2: KAiwCmdSendViaIR = 0x10281895,
williamr@2:
williamr@2: /** Enterprise telephony. */
williamr@2: KAiwCmdEnterpriseTel = 0x20001FC6,
williamr@2:
williamr@2: /** Rotate image etc. */
williamr@2: KAiwCmdRotate = 0x10281F96,
williamr@2:
williamr@2: /** Rotate device screen. */
williamr@2: KAiwCmdRotateScreen = 0x10281F97,
williamr@2:
williamr@2: /** Set call image. */
williamr@2: KAiwCmdCallImage = 0x1028245E,
williamr@2:
williamr@2: /** Give different objects to another device using Near Field Communications. */
williamr@2: KAiwCmdNFCGive = 0x1028245F,
williamr@2:
williamr@2: /** Start listening secondary bearer (e.g. Bluetooth) setup events via Near Field Communication. */
williamr@2: KAiwCmdNFCEasySetup = 0x2001FE32,
williamr@2:
williamr@2: /** SettingWizard Email view activation. */
williamr@2: KAiwCmdSettingWizardEmailView = 0x10281C95,
williamr@2:
williamr@2: /** In-device search. */
williamr@2: KAiwCmdContentSearch = 0x10282844,
williamr@2:
williamr@2: /** A special service command enabling consumer to attach for all relevant
williamr@2: AIW services for a certain object. */
williamr@2: KAiwCmdAnyCmdForObject = 0x102823F1,
williamr@2:
williamr@2: /** To support VoIP settings provisioning with plugins **/
williamr@2: KAiwCmdEasyVoIPProvisioning = 0x10283099,
williamr@2:
williamr@2: /** Assign Screensaver*/
williamr@2: KAiwCmdAssignScreenSaver = 0x1028309A,
williamr@2:
williamr@2: /*Location Trail*/
williamr@2: KAiwCmdLocationTrail=0x10282845
williamr@2: /*
williamr@2:
williamr@2: */
williamr@2: // BRANCH 08-04-18 : gronoff
williamr@2: ,
williamr@2: /** Converged service plugin and UI extension plugin*/
williamr@2: KAiwCmdCSCServicePlugins = 0x1020E56F,
williamr@4: KAiwCmdCSCUiExtensionPlugins = 0x10282EF7,
williamr@4: KAiwCmdSaveToCalendar = 0x2002A507
williamr@2: // BRANCH_END 08-04-18 : gronoff
williamr@2: };
williamr@2:
williamr@2:
williamr@2: // Service command strings. These strings are used in service provider's
williamr@2: // opaque data field to specify what service command(s) the provider implements.
williamr@2:
williamr@2: #define KAiwCmdNoneStr "00000000"
williamr@2: #define KAiwCmdNewStr "101F864C"
williamr@2: #define KAiwCmdEditStr "101F864D"
williamr@2: #define KAiwCmdSelectStr "101F864E"
williamr@2: #define KAiwCmdViewStr "101F864F"
williamr@2: #define KAiwCmdPrintStr "101F8666"
williamr@2: #define KAiwCmdCallStr "101F86B0"
williamr@2: #define KAiwCmdSendStr "101F86B3"
williamr@2: #define KAiwCmdAssignStr "101F8716"
williamr@2: #define KAiwCmdShareStr "101F871E"
williamr@2: #define KAiwCmdSynchronizeStr "101F8724"
williamr@2: #define KAiwCmdSearchStr "101F87DF"
williamr@2: #define KAiwCmdCopy "101F87DE"
williamr@2: #define KAiwCmdPrintPreviewStr "101FD656"
williamr@2: #define KAiwCmdPoCStr "101FD657"
williamr@2: #define KAiwCmdSynchronizeSelectedStr "1020720C"
williamr@2: #define KAiwCmdViewOnlineStr "102072EA"
williamr@2: #define KAiwCmdUploadStr "102072EB"
williamr@2: #define KAiwCmdXpressTransferStr "10207430"
williamr@2: #define KAiwCmdUPnPCopyStr "10207431"
williamr@2: #define KAiwCmdUPnPMoveStr "10207432"
williamr@2: #define KAiwCmdUPnPPlayStr "10207433"
williamr@2: #define KAiwCmdUPnPOpenStr "10207434"
williamr@2: #define KAiwCmdUPnPEnableExternalStr "10207435"
williamr@2: #define KAiwCmdHelpStr "10275075"
williamr@2: #define KAiwCmdIntentStr "10275114"
williamr@2: #define KAiwCmdAddToIntentStr "10275115"
williamr@2: #define KAiwCmdRemoveFromIntentStr "10275116"
williamr@2: #define KAiwCmdMnShowMapStr "10206904"
williamr@2: #define KAiwCmdMnNavigateToStr "10206905"
williamr@2: #define KAiwCmdMnAddrByCoordStr "10206906"
williamr@2: #define KAiwCmdMnCoordByAddrStr "10206907"
williamr@2: #define KAiwCmdMnSelectFromMapStr "10206908"
williamr@2: #define KAiwCmdSendViaBTStr "10281894"
williamr@2: #define KAiwCmdSendViaIRStr "10281895"
williamr@2: #define KAiwCmdEnterpriseTelStr "20001FC6"
williamr@2: #define KAiwCmdRotateStr "10281F96"
williamr@2: #define KAiwCmdRotateScreenStr "10281F97"
williamr@2: #define KAiwCmdCallImageStr "1028245E"
williamr@2: #define KAiwCmdNFCGiveStr "1028245F"
williamr@2: #define KAiwCmdNFCEasySetupStr "2001FE32"
williamr@2: #define KAiwCmdSettingWizardEmailViewStr "10281C95"
williamr@2: #define KAiwCmdContentSearchStr "10282844"
williamr@2: #define KAiwCmdAnyCmdForObjectStr "102823F1"
williamr@2: #define KAiwCmdEasyVoIPProvisioningStr "10283099"
williamr@2: #define KAiwCmdAssignScreenSaverStr "1028309A"
williamr@2: #define KAiwCmdLocationTrail "10282845"
williamr@2: /*
williamr@2:
williamr@2: */
williamr@2: // BRANCH 08-04-18 : gronoff
williamr@2: #define KAiwCmdCSCServicePluginsStr "1020E56F"
williamr@4: #define KAiwCmdCSCUiExtensionPluginsStr "10282EF7"
williamr@4: #define KAiwCmdSaveToCalendarStr "2002A507"
williamr@2: // BRANCH_END 08-04-18 : gronoff
williamr@2:
williamr@2: /**
williamr@2: * Service command options (bits) to alter command handling behaviour.
williamr@2: */
williamr@2: enum TAiwServiceCmdOptions
williamr@2: {
williamr@2: /**
williamr@2: * Consumer wants asynchronous command handling.
williamr@2: * The default is synchronous command handling.
williamr@2: * In asynchronous case consumer needs to pass a callback to provider.
williamr@2: */
williamr@2: KAiwOptASyncronous = 0x0001,
williamr@2:
williamr@2: /**
williamr@2: * Consumer wants provider to make a callback to check coming output
williamr@2: * parameters prior returning from service command handling.
williamr@2: * Consumer needs to pass a callback to provider.
williamr@2: */
williamr@2: KAiwOptOutParamCheck = 0x0002,
williamr@2:
williamr@2: /**
williamr@2: * Consumer tells provider that it is prepared to handle
williamr@2: * callback events for possibly incomplete/wrong parameter list.
williamr@2: */
williamr@2: KAiwOptInParamCheck = 0x0004,
williamr@2:
williamr@2: /**
williamr@2: * Consumer wants to cancel an asynchronous AIW service.
williamr@2: * When a consumer wants to cancel the asynchronous service that a provider
williamr@2: * is executing, it should call ExecuteMenuCmdL() or ExecuteServiceCmdL()
williamr@2: * with the same parameters as when requesting the service, but set this
williamr@2: * cancel bit on. The cancel operation itself is synchronous, i.e. the
williamr@2: * provider must call the consumer's callback with KAiwEventCanceled before
williamr@2: * the Execute*CmdL() returns.
williamr@2: */
williamr@2: KAiwOptCancel = 0x0008
williamr@2: };
williamr@2:
williamr@2:
williamr@2: /**
williamr@2: * Service classes (UID). Technically these are same as service interface UIDs.
williamr@2: */
williamr@2: enum TAiwServiceClass
williamr@2: {
williamr@2: /**
williamr@2: * None.
williamr@2: */
williamr@2: KAiwClassNone = 0x0,
williamr@2:
williamr@2: /**
williamr@2: * Base service (no UI expected).
williamr@2: * Every other class must implement this always!
williamr@2: */
williamr@2: KAiwClassBase = 0x101F8650,
williamr@2:
williamr@2: /**
williamr@2: * Filter service class.
williamr@2: */
williamr@2: KAiwClassFilter = 0x101F8651,
williamr@2:
williamr@2: /**
williamr@2: * Menu service class (offers menu based services).
williamr@2: */
williamr@2: KAiwClassMenu = 0x101F8652,
williamr@2:
williamr@2: /**
williamr@2: * Stub service class.
williamr@2: */
williamr@2: KAiwClassStub = 0x101F8653,
williamr@2:
williamr@2: /**
williamr@2: * View service class (offers view based services).
williamr@2: */
williamr@2: KAiwClassView = 0x101F8654,
williamr@2:
williamr@2: /**
williamr@2: * This class is for R&D purposes.
williamr@2: */
williamr@2: KAiwClassDebug = 0x101F866B
williamr@2: };
williamr@2:
williamr@2:
williamr@2: /**
williamr@2: * Event codes. To be used with HandleNotifyL method.
williamr@2: */
williamr@2: enum
williamr@2: {
williamr@2: /**
williamr@2: * Asynchronous service informs consumer to prepare itself for
williamr@2: * action.
williamr@2: */
williamr@2: KAiwEventStarted = 1,
williamr@2:
williamr@2: /**
williamr@2: * Asynchronous service request completed.
williamr@2: */
williamr@2: KAiwEventCompleted = 2,
williamr@2:
williamr@2: /**
williamr@2: * Asynchronous service request canceled.
williamr@2: */
williamr@2: KAiwEventCanceled = 3,
williamr@2:
williamr@2: /**
williamr@2: * Error during asynchronous service request.
williamr@2: */
williamr@2: KAiwEventError = 4,
williamr@2:
williamr@2: /**
williamr@2: * Relates to KAiwOptOutParamCheck.
williamr@2: */
williamr@2: KAiwEventOutParamCheck = 5,
williamr@2:
williamr@2: /**
williamr@2: * Relates to KAiwOptInParamCheck.
williamr@2: */
williamr@2: KAiwEventInParamCheck = 6,
williamr@2:
williamr@2: /**
williamr@2: * Provider informs consumer that service is no longer available or
williamr@2: * has stopped.
williamr@2: */
williamr@2: KAiwEventStopped = 7,
williamr@2:
williamr@2: /**
williamr@2: * Provider asks consumer whether Exit can be done (needed at least in
williamr@2: * embedded use cases where server application offers Exit possibility
williamr@2: * to end user, but consumer can not allow Exit due to fact that for
williamr@2: * example network connections owned by consumer are open and they need
williamr@2: * to be kept alive).
williamr@2: */
williamr@2: KAiwEventQueryExit = 8
williamr@2: };
williamr@2:
williamr@2: // ============================================================================
williamr@2: // Menu item flags for AIW consumers.
williamr@2: // ============================================================================
williamr@2: /**
williamr@2: * Always keep the provider menu items in a submenu.
williamr@2: */
williamr@2: #define AIW_CASCADE_ID 0x01010001
williamr@2:
williamr@2: /**
williamr@2: * Menu item is placed intelligently either to the main level or a submenu.
williamr@2: */
williamr@2: #define AIW_INTELLIGENT_CASCADE_ID 0x01010010
williamr@2:
williamr@2: /**
williamr@2: * Consumer defines the menu title.
williamr@2: */
williamr@2: #define AIW_LOCK_SUBMENU_TITLE 0x00000020
williamr@2:
williamr@2: // ============================================================================
williamr@2: // Criteria item flags for AIW consumers.
williamr@2: // ============================================================================
williamr@2: /**
williamr@2: * Criteria item loadOptions bit, only providers in ROM are accepted.
williamr@2: */
williamr@2: #define AIW_OPTIONS_ROM_ONLY 0x01
williamr@2:
williamr@2: // ============================================================================
williamr@2: // Menu item flags for AIW providers.
williamr@2: // ============================================================================
williamr@2: /**
williamr@2: * For providers only: Provider suggests the submenu title.
williamr@2: */
williamr@2: #define AIW_SUBMENU_TITLE 0x0ff11012
williamr@2:
williamr@2: #endif // AIW_COMMON_HRH
williamr@2:
williamr@2: // End of file
williamr@2:
williamr@2: