1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/AknNotifyStd.h Wed Mar 31 12:33:34 2010 +0100
1.3 @@ -0,0 +1,427 @@
1.4 +/*
1.5 +* Copyright (c) 2002-2008 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description: Structures and constant declarations for the AVKON Notifiers.
1.18 +*
1.19 +*/
1.20 +
1.21 +#ifndef AKNNOTIFYSTD_H
1.22 +#define AKNNOTIFYSTD_H
1.23 +
1.24 +#include <e32std.h>
1.25 +#include <e32base.h>
1.26 +#include <eiknotapi.h>
1.27 +
1.28 +/**
1.29 + * @deprecated
1.30 + */
1.31 +const TUid KAknPopupNotifierUid={0x100059DC};
1.32 +
1.33 +/**
1.34 + * UID for identifying AVKON signal notifier.
1.35 + * @internal
1.36 + */
1.37 +const TUid KAknSignalNotifierUid={0x100059AB};
1.38 +
1.39 +/**
1.40 + * UID for identifying AVKON battery notifier.
1.41 + * @internal
1.42 + */
1.43 +const TUid KAknBatteryNotifierUid={0x100059AC};
1.44 +
1.45 +/**
1.46 + * UID for identifying AVKON indicator notifier.
1.47 + * @internal
1.48 + */
1.49 +const TUid KAknSmallIndicatorUid={0x100059AD};
1.50 +
1.51 +/**
1.52 + * @deprecated
1.53 + */
1.54 +const TUid KAknAsyncDemoNotifierUid={0x100059AE};
1.55 +
1.56 +/**
1.57 + * @deprecated
1.58 + */
1.59 +const TUid KAknTestNoteUid={0x100059AF};
1.60 +
1.61 +/**
1.62 + * UID for identifying AVKON key lock notifier.
1.63 + * @internal
1.64 + */
1.65 +const TUid KAknKeyLockNotifierUid={0x100059B0};
1.66 +
1.67 +/**
1.68 + * UID for identifying AVKON global note notifier.
1.69 + * @internal
1.70 + */
1.71 +const TUid KAknGlobalNoteUid={0x100059B1};
1.72 +
1.73 +/**
1.74 + * UID for identifying AVKON soft notification notifier.
1.75 + * @internal
1.76 + */
1.77 +const TUid KAknSoftNotificationUid={0x100059B2};
1.78 +
1.79 +/**
1.80 + * UID for identifying AVKON incall bubble notifier.
1.81 + * @internal
1.82 + */
1.83 +const TUid KAknIncallBubbleUid={0x100059B3};
1.84 +
1.85 +/**
1.86 + * UID for identifying AVKON list query notifier.
1.87 + * @internal
1.88 + */
1.89 +const TUid KAknGlobalListQueryUid={0x100059B4};
1.90 +
1.91 +/**
1.92 + * UID for identifying AVKON list msg query notifier.
1.93 + * @internal
1.94 + */
1.95 +const TUid KAknGlobalListMsgQueryUid={0x20011102};
1.96 +
1.97 +/**
1.98 + * UID for identifying AVKON message query notifier.
1.99 + * @internal
1.100 + */
1.101 +const TUid KAknGlobalMsgQueryUid={0x100059CB};
1.102 +
1.103 +/**
1.104 + * UID for identifying AVKON confirmation query notifier.
1.105 + * @internal
1.106 + */
1.107 +const TUid KAknGlobalConfirmationQueryUid={0x100059DB};
1.108 +
1.109 +/**
1.110 + * UID for identifying AVKON progress dialog notifier.
1.111 + * @internal
1.112 + */
1.113 +const TUid KAknGlobalProgressDialogUid={0x10005A04};
1.114 +
1.115 +/**
1.116 + * @deprecated
1.117 + */
1.118 +const TUid KAknMemoryCardDialogUid={0x101F467A};
1.119 +
1.120 +/**
1.121 + * @deprecated
1.122 + */
1.123 +const TUid KAknNotifierControllerUid={0x1020721C};
1.124 +
1.125 +
1.126 +/**
1.127 + * AVKON notifier channel UID for notes.
1.128 + * @internal
1.129 + */
1.130 +const TUid EAknNotifierChannelNote = {1};
1.131 +/**
1.132 + * AVKON notifier channel UID for lists.
1.133 + * @internal
1.134 + */
1.135 +const TUid EAknNotifierChannelList = {2};
1.136 +/**
1.137 + * AVKON notifier channel UID for message queries.
1.138 + * @internal
1.139 + */
1.140 +const TUid EAknNotifierChannelMsgQuery = {3};
1.141 +/**
1.142 + * AVKON notifier channel UID for confirmation queries.
1.143 + * @internal
1.144 + */
1.145 +const TUid EAknNotifierChannelConfirmationQuery = {4};
1.146 +/**
1.147 + * AVKON notifier channel UID for progress dialogs.
1.148 + * @internal
1.149 + */
1.150 +const TUid EAknNotifierChannelProgressDialog = {5};
1.151 +/**
1.152 + * AVKON notifier channel UID for list message queries.
1.153 + * @internal
1.154 + */
1.155 +const TUid EAknNotifierChannelListMsgQuery = {6};
1.156 +
1.157 +/**
1.158 + * Signal state notifier parameter structure.
1.159 + * @internal
1.160 + */
1.161 +struct SAknSignalNotifyParams
1.162 + {
1.163 + TInt iGprsState;
1.164 + TInt iValue;
1.165 + };
1.166 +
1.167 +/**
1.168 + * Battery state notifier parameter structure.
1.169 + * @internal
1.170 + */
1.171 +struct SAknBatteryNotifyParams
1.172 + {
1.173 + enum { ERecharge, EStopRecharge, ENoRecharge, ESetValue, ESetState } iType;
1.174 + TInt iValue;
1.175 + TInt iBatteryState;
1.176 + };
1.177 +
1.178 +/**
1.179 + * Small indicator notifier parameter structure.
1.180 + * @internal
1.181 + */
1.182 +struct SAknSmallIndicatorParams
1.183 + {
1.184 + TUid iSmallIndicatorUid;
1.185 + TInt iValue;
1.186 + };
1.187 +
1.188 +/**
1.189 + * Incall status bubble notifier parameter structure.
1.190 + * @internal
1.191 + */
1.192 +struct SAknIncallBubbleParams
1.193 + {
1.194 + TInt iIncallBubbleFlags;
1.195 + };
1.196 +
1.197 +/**
1.198 + * Key lock notifier reasons.
1.199 + * @internal
1.200 + */
1.201 +enum TKeyLockNotifierReason
1.202 + {
1.203 + ELockEnabled,
1.204 + ELockDisabled,
1.205 + EAllowNotifications,
1.206 + EStopNotifications,
1.207 + EInquire,
1.208 + EOfferKeylock,
1.209 + ECancelAllNotifications,
1.210 + EEnableAutoLockEmulation,
1.211 + EDisableWithoutNote,
1.212 + EEnableWithoutNote,
1.213 + // add normal keylock operations before this
1.214 + ECommandFSWToHideApplication=99
1.215 + };
1.216 +
1.217 +/**
1.218 + * Soft note notifier parameter structure.
1.219 + * @internal
1.220 + */
1.221 +struct SAknSoftNoteNotifierParams
1.222 + {
1.223 + TInt iNoteResource;
1.224 + TInt iNoteCbaResource;
1.225 + TInt iResponse;
1.226 + };
1.227 +
1.228 +/**
1.229 + * Key lock notifier parameter structure.
1.230 + * @internal
1.231 + */
1.232 +struct SAknKeyLockNotifierParams
1.233 + {
1.234 + TKeyLockNotifierReason iReason;
1.235 + TBool iEnabled;
1.236 + };
1.237 +
1.238 +/**
1.239 + * Global note types.
1.240 + */
1.241 +enum TAknGlobalNoteType
1.242 + {
1.243 + EAknGlobalInformationNote = 1,
1.244 + EAknGlobalWarningNote,
1.245 + EAknGlobalConfirmationNote,
1.246 + EAknGlobalErrorNote,
1.247 + EAknGlobalChargingNote,
1.248 + EAknGlobalWaitNote,
1.249 + EAknGlobalPermanentNote,
1.250 + EAknGlobalNotChargingNote,
1.251 + EAknGlobalBatteryFullNote,
1.252 + EAknGlobalBatteryLowNote,
1.253 + EAknGlobalRechargeBatteryNote,
1.254 + EAknCancelGlobalNote,
1.255 + EAknGlobalTextNote,
1.256 + EAknGlobalBatteryFullUnplugNote = 105,
1.257 + EAknGlobalUnplugChargerNote
1.258 + };
1.259 +
1.260 +/**
1.261 + * Global note parameters.
1.262 + * @internal
1.263 + */
1.264 +struct SAknGlobalNoteParams
1.265 + {
1.266 + TAknGlobalNoteType iType;
1.267 + TPtrC iText;
1.268 + TInt iPriority;
1.269 + TInt iSoftkeys;
1.270 + TInt iGraphic;
1.271 + TInt iGraphicMask;
1.272 + TInt iAnimation;
1.273 + };
1.274 +
1.275 +/**
1.276 + * Global note return parameter structure.
1.277 + * @internal
1.278 + */
1.279 +struct SAknGlobalNoteReturnParams
1.280 + {
1.281 + TInt iNoteId;
1.282 + };
1.283 +
1.284 +/**
1.285 + * Global query commands.
1.286 + * @internal
1.287 + */
1.288 +enum TAknGlobalQueryCmd
1.289 + {
1.290 + EAknShowGlobalQuery=1,
1.291 + EAknCancelGlobalQuery,
1.292 + EAknUpdateGlobalQuery,
1.293 + // list query cmds,
1.294 + EAknMoveDownGlobalListQuery,
1.295 + EAknMoveUpGlobalListQuery,
1.296 + EAknSelectGlobalListQuery,
1.297 + // Progess dialog cmds
1.298 + EAknFinishGlobalProgressDialog
1.299 + };
1.300 +
1.301 +/**
1.302 + * Global list query parameter structure.
1.303 + * @internal
1.304 + */
1.305 +struct SAknGlobalListQueryParams
1.306 + {
1.307 + TAknGlobalQueryCmd iCmd;
1.308 + TInt iIndex;
1.309 + };
1.310 +
1.311 +/**
1.312 + * Global message query parameter structure.
1.313 + * @internal
1.314 + */
1.315 +struct SAknGlobalMsgQueryParams
1.316 + {
1.317 + TAknGlobalQueryCmd iCmd;
1.318 + TInt iSoftkeys;
1.319 + };
1.320 +
1.321 +/**
1.322 + * Global progress note parameter structure.
1.323 + * @internal
1.324 + */
1.325 +struct SAknGlobalProgressDialogParams
1.326 + {
1.327 + TAknGlobalQueryCmd iCmd;
1.328 + TInt iValue;
1.329 + TInt iFinalValue;
1.330 + };
1.331 +
1.332 +/**
1.333 + * Soft notification types.
1.334 + * @internal
1.335 + */
1.336 +enum TAknSoftNotificationType
1.337 + {
1.338 + ENoSoftNotification = -1,
1.339 + ENetworkInformationNotification=0,
1.340 + ESelectNetworkNotification,
1.341 + EUnstructuredSSDataNotification,
1.342 + EVoiceMailNotification,
1.343 + ESeparateVoiceMailOnLine1Notification,
1.344 + ESeparateVoiceMailOnLine2Notification,
1.345 + ECellBroadcastNotification,
1.346 +
1.347 + EDeliveryReportNotification,
1.348 + EClass0SmsNotification,
1.349 +
1.350 + EMissedCallsNotification,
1.351 + ENewMessagesNotification,
1.352 + ENewMailNotification,
1.353 +
1.354 + EShowActiveNotifications,
1.355 +
1.356 + EShowGroupedNotification,
1.357 + ECustomSoftNotification,
1.358 + EChatMessageNotification,
1.359 + EMaxSoftNotification,
1.360 + ESetIdleState = 100
1.361 + };
1.362 +
1.363 +/**
1.364 + * Soft notification parameters.
1.365 + * @internal
1.366 + */
1.367 +struct SAknSoftNotificationParams
1.368 + {
1.369 + /** The type of the soft notification, @see @c TAknSoftNotificationType
1.370 + */
1.371 + TAknSoftNotificationType iType;
1.372 +
1.373 + /**
1.374 + * @c iIsCancel is used to decide whether to spawn a new
1.375 + * (or add the number on an existing) soft notification or
1.376 + * to cancel a type of soft notification. Please note that
1.377 + * calling a cancel on a certain type of soft notification
1.378 + * cancels all soft notifications of that type.
1.379 + */
1.380 + TBool iIsCancel;
1.381 +
1.382 + /**
1.383 + * This parameter is intended only to be used when setting
1.384 + * the number of new messages. Stay clear otherwise!
1.385 + */
1.386 + TInt iCount;
1.387 + };
1.388 +
1.389 +
1.390 +/**
1.391 + * @deprecated
1.392 + */
1.393 +enum TAknSignalStates
1.394 + {
1.395 + EAknSignalGprsStateOff = 0,
1.396 + EAknSignalGprsStateOn = 1,
1.397 + EAknSignalGprsStateNotChanged = -1,
1.398 + EAknSignalStateNotChanged = -2,
1.399 + // Constants below are used for syncronizing signalpane and navipane background types.
1.400 + EAknSignalGprsIndicatorBgTypeNotDefined = -3,
1.401 + EAknSignalGprsIndicatorBgTypeWipe = -4,
1.402 + EAknSignalGprsIndicatorBgTypeSolid = -5
1.403 + };
1.404 +
1.405 +/**
1.406 + * @deprecated
1.407 + */
1.408 +const TInt KAknSignalNumberOfGprsStates = 6;
1.409 +
1.410 +/**
1.411 + * @deprecated
1.412 + */
1.413 +struct SAknMemoryCardUIParams
1.414 + {
1.415 + TBool iStore;
1.416 + };
1.417 +
1.418 +/**
1.419 + * @deprecated
1.420 + */
1.421 +class MAknUINotifierBase: public MEikSrvNotifierBase2
1.422 + {
1.423 +public:
1.424 + /**
1.425 + * @deprecated
1.426 + */
1.427 + TInt NotifierCapabilites(){return EScreenDeviceChangeSupported;}
1.428 + };
1.429 +
1.430 +#endif // AKNNOTIFYSTD_H