1.1 --- a/epoc32/include/mw/aiwcommon.hrh Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/mw/aiwcommon.hrh Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,417 @@
1.4 -aiwcommon.hrh
1.5 +/*
1.6 +* Copyright (c) 2003-2005 Nokia Corporation and/or its subsidiary(-ies).
1.7 +* All rights reserved.
1.8 +* This component and the accompanying materials are made available
1.9 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.10 +* which accompanies this distribution, and is available
1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.12 +*
1.13 +* Initial Contributors:
1.14 +* Nokia Corporation - initial contribution.
1.15 +*
1.16 +* Contributors:
1.17 +*
1.18 +* Description: Declares common constants to be used in both resources and
1.19 +* C++ code of consumers and providers.
1.20 +*
1.21 +*/
1.22 +
1.23 +
1.24 +
1.25 +
1.26 +
1.27 +#ifndef AIW_COMMON_HRH
1.28 +#define AIW_COMMON_HRH
1.29 +
1.30 +// DATA TYPES
1.31 +
1.32 +// CONSTANTS
1.33 +
1.34 +/**
1.35 +* Predefined service commands (UIDs).
1.36 +*/
1.37 +enum TAiwServiceCommands
1.38 + {
1.39 + /** Null value. */
1.40 + KAiwCmdNone = 0,
1.41 +
1.42 + /** Create new content. */
1.43 + KAiwCmdNew = 0x101F864C,
1.44 +
1.45 + /** Edit existing content. */
1.46 + KAiwCmdEdit = 0x101F864D,
1.47 +
1.48 + /** Select content. */
1.49 + KAiwCmdSelect = 0x101F864E,
1.50 +
1.51 + /** View content. */
1.52 + KAiwCmdView = 0x101F864F,
1.53 +
1.54 + /** Create call. */
1.55 + KAiwCmdCall = 0x101F86B0,
1.56 +
1.57 + /** Send content. */
1.58 + KAiwCmdSend = 0x101F86B3,
1.59 +
1.60 + /** Print content. */
1.61 + KAiwCmdPrint = 0x101F8666,
1.62 +
1.63 + /** Assign content. */
1.64 + KAiwCmdAssign = 0x101F8716,
1.65 +
1.66 + /** Share content. */
1.67 + KAiwCmdShare = 0x101F871E,
1.68 +
1.69 + /** Synchronize content. */
1.70 + KAiwCmdSynchronize = 0x101F8724,
1.71 +
1.72 + /** Synchronize selected. */
1.73 + KAiwCmdSynchronizeSelected = 0x1020720C,
1.74 +
1.75 + /** Search content. */
1.76 + KAiwCmdSearch = 0x101F87DF,
1.77 +
1.78 + /** Copy content. */
1.79 + KAiwCmdCopy = 0x101F87DE,
1.80 +
1.81 + /** Show print preview. */
1.82 + KAiwCmdPrintPreview = 0x101FD656,
1.83 +
1.84 + /** Push to talk. */
1.85 + KAiwCmdPoC = 0x101FD657,
1.86 +
1.87 + /** View content in online store. */
1.88 + KAiwCmdViewOnline = 0x102072EA,
1.89 +
1.90 + /** Upload content. */
1.91 + KAiwCmdUpload = 0x102072EB,
1.92 +
1.93 + /** Transfer a range of media files to a remote storage device. */
1.94 + KAiwCmdXpressTransfer = 0x10207430,
1.95 +
1.96 + /** UPnP copy content. */
1.97 + KAiwCmdUPnPCopy = 0x10207431,
1.98 +
1.99 + /** UPnP move content. */
1.100 + KAiwCmdUPnPMove = 0x10207432,
1.101 +
1.102 + /** UPnP play content. */
1.103 + KAiwCmdUPnPPlay = 0x10207433,
1.104 +
1.105 + /** UPnP open content. */
1.106 + KAiwCmdUPnPOpen = 0x10207434,
1.107 +
1.108 + /** UPnP enable external. */
1.109 + KAiwCmdUPnPEnableExternal = 0x10207435,
1.110 +
1.111 + /** Show help content. */
1.112 + KAiwCmdHelp = 0x10275075,
1.113 +
1.114 + /** Add or remove items from intent. (Should be used as a menu service command). */
1.115 + KAiwCmdIntent = 0x10275114,
1.116 +
1.117 + /** Add items to intent. (Should be used as a base service command). */
1.118 + KAiwCmdAddToIntent = 0x10275115,
1.119 +
1.120 + /** Remove items from intent. (Should be used as a base service command). */
1.121 + KAiwCmdRemoveFromIntent = 0x10275116,
1.122 +
1.123 + /** Client can request that map should be displayed on screen. */
1.124 + KAiwCmdMnShowMap = 0x10206904,
1.125 +
1.126 + /** Allows to start navigation to desired destination. */
1.127 + KAiwCmdMnNavigateTo = 0x10206905,
1.128 +
1.129 + /** Starts reverse geocoding request: finding address for given coordinate. */
1.130 + KAiwCmdMnAddrByCoord = 0x10206906,
1.131 +
1.132 + /** Starts geocoding request: finding coordinate by given address. */
1.133 + KAiwCmdMnCoordByAddr = 0x10206907,
1.134 +
1.135 + /** Allows client to request that user shall select a location from map. */
1.136 + KAiwCmdMnSelectFromMap = 0x10206908,
1.137 +
1.138 + /** Send via Bluetooth. */
1.139 + KAiwCmdSendViaBT = 0x10281894,
1.140 +
1.141 + /** Send via Irda. */
1.142 + KAiwCmdSendViaIR = 0x10281895,
1.143 +
1.144 + /** Enterprise telephony. */
1.145 + KAiwCmdEnterpriseTel = 0x20001FC6,
1.146 +
1.147 + /** Rotate image etc. */
1.148 + KAiwCmdRotate = 0x10281F96,
1.149 +
1.150 + /** Rotate device screen. */
1.151 + KAiwCmdRotateScreen = 0x10281F97,
1.152 +
1.153 + /** Set call image. */
1.154 + KAiwCmdCallImage = 0x1028245E,
1.155 +
1.156 + /** Give different objects to another device using Near Field Communications. */
1.157 + KAiwCmdNFCGive = 0x1028245F,
1.158 +
1.159 + /** Start listening secondary bearer (e.g. Bluetooth) setup events via Near Field Communication. */
1.160 + KAiwCmdNFCEasySetup = 0x2001FE32,
1.161 +
1.162 + /** SettingWizard Email view activation. */
1.163 + KAiwCmdSettingWizardEmailView = 0x10281C95,
1.164 +
1.165 + /** In-device search. */
1.166 + KAiwCmdContentSearch = 0x10282844,
1.167 +
1.168 + /** A special service command enabling consumer to attach for all relevant
1.169 + AIW services for a certain object. */
1.170 + KAiwCmdAnyCmdForObject = 0x102823F1,
1.171 +
1.172 + /** To support VoIP settings provisioning with plugins **/
1.173 + KAiwCmdEasyVoIPProvisioning = 0x10283099,
1.174 +
1.175 + /** Assign Screensaver*/
1.176 + KAiwCmdAssignScreenSaver = 0x1028309A,
1.177 +
1.178 + /*Location Trail*/
1.179 + KAiwCmdLocationTrail=0x10282845
1.180 +/*<branchInfo originator="gronoff" since="08-04-18" category="new_feature" error=”none”>
1.181 +<pf_5250_OFF_CYCLE_SW_INT>
1.182 +</branchInfo>*/
1.183 +// BRANCH 08-04-18 : gronoff
1.184 + ,
1.185 + /** Converged service plugin and UI extension plugin*/
1.186 + KAiwCmdCSCServicePlugins = 0x1020E56F,
1.187 + KAiwCmdCSCUiExtensionPlugins = 0x10282EF7
1.188 +// BRANCH_END 08-04-18 : gronoff
1.189 + };
1.190 +
1.191 +
1.192 +// Service command strings. These strings are used in service provider's
1.193 +// opaque data field to specify what service command(s) the provider implements.
1.194 +
1.195 +#define KAiwCmdNoneStr "00000000"
1.196 +#define KAiwCmdNewStr "101F864C"
1.197 +#define KAiwCmdEditStr "101F864D"
1.198 +#define KAiwCmdSelectStr "101F864E"
1.199 +#define KAiwCmdViewStr "101F864F"
1.200 +#define KAiwCmdPrintStr "101F8666"
1.201 +#define KAiwCmdCallStr "101F86B0"
1.202 +#define KAiwCmdSendStr "101F86B3"
1.203 +#define KAiwCmdAssignStr "101F8716"
1.204 +#define KAiwCmdShareStr "101F871E"
1.205 +#define KAiwCmdSynchronizeStr "101F8724"
1.206 +#define KAiwCmdSearchStr "101F87DF"
1.207 +#define KAiwCmdCopy "101F87DE"
1.208 +#define KAiwCmdPrintPreviewStr "101FD656"
1.209 +#define KAiwCmdPoCStr "101FD657"
1.210 +#define KAiwCmdSynchronizeSelectedStr "1020720C"
1.211 +#define KAiwCmdViewOnlineStr "102072EA"
1.212 +#define KAiwCmdUploadStr "102072EB"
1.213 +#define KAiwCmdXpressTransferStr "10207430"
1.214 +#define KAiwCmdUPnPCopyStr "10207431"
1.215 +#define KAiwCmdUPnPMoveStr "10207432"
1.216 +#define KAiwCmdUPnPPlayStr "10207433"
1.217 +#define KAiwCmdUPnPOpenStr "10207434"
1.218 +#define KAiwCmdUPnPEnableExternalStr "10207435"
1.219 +#define KAiwCmdHelpStr "10275075"
1.220 +#define KAiwCmdIntentStr "10275114"
1.221 +#define KAiwCmdAddToIntentStr "10275115"
1.222 +#define KAiwCmdRemoveFromIntentStr "10275116"
1.223 +#define KAiwCmdMnShowMapStr "10206904"
1.224 +#define KAiwCmdMnNavigateToStr "10206905"
1.225 +#define KAiwCmdMnAddrByCoordStr "10206906"
1.226 +#define KAiwCmdMnCoordByAddrStr "10206907"
1.227 +#define KAiwCmdMnSelectFromMapStr "10206908"
1.228 +#define KAiwCmdSendViaBTStr "10281894"
1.229 +#define KAiwCmdSendViaIRStr "10281895"
1.230 +#define KAiwCmdEnterpriseTelStr "20001FC6"
1.231 +#define KAiwCmdRotateStr "10281F96"
1.232 +#define KAiwCmdRotateScreenStr "10281F97"
1.233 +#define KAiwCmdCallImageStr "1028245E"
1.234 +#define KAiwCmdNFCGiveStr "1028245F"
1.235 +#define KAiwCmdNFCEasySetupStr "2001FE32"
1.236 +#define KAiwCmdSettingWizardEmailViewStr "10281C95"
1.237 +#define KAiwCmdContentSearchStr "10282844"
1.238 +#define KAiwCmdAnyCmdForObjectStr "102823F1"
1.239 +#define KAiwCmdEasyVoIPProvisioningStr "10283099"
1.240 +#define KAiwCmdAssignScreenSaverStr "1028309A"
1.241 +#define KAiwCmdLocationTrail "10282845"
1.242 +/*<branchInfo originator="gronoff" since="08-04-18" category="new_feature" error=”none”>
1.243 +<pf_5250_OFF_CYCLE_SW_INT>
1.244 +</branchInfo>*/
1.245 +// BRANCH 08-04-18 : gronoff
1.246 +#define KAiwCmdCSCServicePluginsStr "1020E56F"
1.247 +#define KAiwCmdCSCUiExtensionPluginsStr "10282EF7"
1.248 +// BRANCH_END 08-04-18 : gronoff
1.249 +
1.250 +/**
1.251 +* Service command options (bits) to alter command handling behaviour.
1.252 +*/
1.253 +enum TAiwServiceCmdOptions
1.254 + {
1.255 + /**
1.256 + * Consumer wants asynchronous command handling.
1.257 + * The default is synchronous command handling.
1.258 + * In asynchronous case consumer needs to pass a callback to provider.
1.259 + */
1.260 + KAiwOptASyncronous = 0x0001,
1.261 +
1.262 + /**
1.263 + * Consumer wants provider to make a callback to check coming output
1.264 + * parameters prior returning from service command handling.
1.265 + * Consumer needs to pass a callback to provider.
1.266 + */
1.267 + KAiwOptOutParamCheck = 0x0002,
1.268 +
1.269 + /**
1.270 + * Consumer tells provider that it is prepared to handle
1.271 + * callback events for possibly incomplete/wrong parameter list.
1.272 + */
1.273 + KAiwOptInParamCheck = 0x0004,
1.274 +
1.275 + /**
1.276 + * Consumer wants to cancel an asynchronous AIW service.
1.277 + * When a consumer wants to cancel the asynchronous service that a provider
1.278 + * is executing, it should call ExecuteMenuCmdL() or ExecuteServiceCmdL()
1.279 + * with the same parameters as when requesting the service, but set this
1.280 + * cancel bit on. The cancel operation itself is synchronous, i.e. the
1.281 + * provider must call the consumer's callback with KAiwEventCanceled before
1.282 + * the Execute*CmdL() returns.
1.283 + */
1.284 + KAiwOptCancel = 0x0008
1.285 + };
1.286 +
1.287 +
1.288 +/**
1.289 +* Service classes (UID). Technically these are same as service interface UIDs.
1.290 +*/
1.291 +enum TAiwServiceClass
1.292 + {
1.293 + /**
1.294 + * None.
1.295 + */
1.296 + KAiwClassNone = 0x0,
1.297 +
1.298 + /**
1.299 + * Base service (no UI expected).
1.300 + * Every other class must implement this always!
1.301 + */
1.302 + KAiwClassBase = 0x101F8650,
1.303 +
1.304 + /**
1.305 + * Filter service class.
1.306 + */
1.307 + KAiwClassFilter = 0x101F8651,
1.308 +
1.309 + /**
1.310 + * Menu service class (offers menu based services).
1.311 + */
1.312 + KAiwClassMenu = 0x101F8652,
1.313 +
1.314 + /**
1.315 + * Stub service class.
1.316 + */
1.317 + KAiwClassStub = 0x101F8653,
1.318 +
1.319 + /**
1.320 + * View service class (offers view based services).
1.321 + */
1.322 + KAiwClassView = 0x101F8654,
1.323 +
1.324 + /**
1.325 + * This class is for R&D purposes.
1.326 + */
1.327 + KAiwClassDebug = 0x101F866B
1.328 + };
1.329 +
1.330 +
1.331 +/**
1.332 +* Event codes. To be used with HandleNotifyL method.
1.333 +*/
1.334 +enum
1.335 + {
1.336 + /**
1.337 + * Asynchronous service informs consumer to prepare itself for
1.338 + * action.
1.339 + */
1.340 + KAiwEventStarted = 1,
1.341 +
1.342 + /**
1.343 + * Asynchronous service request completed.
1.344 + */
1.345 + KAiwEventCompleted = 2,
1.346 +
1.347 + /**
1.348 + * Asynchronous service request canceled.
1.349 + */
1.350 + KAiwEventCanceled = 3,
1.351 +
1.352 + /**
1.353 + * Error during asynchronous service request.
1.354 + */
1.355 + KAiwEventError = 4,
1.356 +
1.357 + /**
1.358 + * Relates to KAiwOptOutParamCheck.
1.359 + */
1.360 + KAiwEventOutParamCheck = 5,
1.361 +
1.362 + /**
1.363 + * Relates to KAiwOptInParamCheck.
1.364 + */
1.365 + KAiwEventInParamCheck = 6,
1.366 +
1.367 + /**
1.368 + * Provider informs consumer that service is no longer available or
1.369 + * has stopped.
1.370 + */
1.371 + KAiwEventStopped = 7,
1.372 +
1.373 + /**
1.374 + * Provider asks consumer whether Exit can be done (needed at least in
1.375 + * embedded use cases where server application offers Exit possibility
1.376 + * to end user, but consumer can not allow Exit due to fact that for
1.377 + * example network connections owned by consumer are open and they need
1.378 + * to be kept alive).
1.379 + */
1.380 + KAiwEventQueryExit = 8
1.381 + };
1.382 +
1.383 +// ============================================================================
1.384 +// Menu item flags for AIW consumers.
1.385 +// ============================================================================
1.386 +/**
1.387 + * Always keep the provider menu items in a submenu.
1.388 + */
1.389 +#define AIW_CASCADE_ID 0x01010001
1.390 +
1.391 +/**
1.392 + * Menu item is placed intelligently either to the main level or a submenu.
1.393 + */
1.394 +#define AIW_INTELLIGENT_CASCADE_ID 0x01010010
1.395 +
1.396 +/**
1.397 + * Consumer defines the menu title.
1.398 + */
1.399 +#define AIW_LOCK_SUBMENU_TITLE 0x00000020
1.400 +
1.401 +// ============================================================================
1.402 +// Criteria item flags for AIW consumers.
1.403 +// ============================================================================
1.404 +/**
1.405 + * Criteria item loadOptions bit, only providers in ROM are accepted.
1.406 + */
1.407 +#define AIW_OPTIONS_ROM_ONLY 0x01
1.408 +
1.409 +// ============================================================================
1.410 +// Menu item flags for AIW providers.
1.411 +// ============================================================================
1.412 +/**
1.413 + * For providers only: Provider suggests the submenu title.
1.414 + */
1.415 +#define AIW_SUBMENU_TITLE 0x0ff11012
1.416 +
1.417 +#endif // AIW_COMMON_HRH
1.418 +
1.419 +// End of file
1.420 +
1.421 +