aknglobalnote.h

00001 /*
00002 * ============================================================================
00003 *  Name        : AknGlobalNote.h
00004 *  Part of     : UI Framework Core / AVKON Notifiers Client
00005 *  Description :
00006 *  Version     : %version: %
00007 *
00008 *  Copyright © 2002-2007 Nokia.  All rights reserved.
00009 *  This material, including documentation and any related computer
00010 *  programs, is protected by copyright controlled by Nokia.  All
00011 *  rights are reserved.  Copying, including reproducing, storing,
00012 *  adapting or translating, any or all of this material requires the
00013 *  prior written consent of Nokia.  This material also contains
00014 *  confidential information which may not be disclosed to others
00015 *  without the prior written consent of Nokia.
00016 * ============================================================================
00017 */
00018 #ifndef __AKNGLOBALNOTENOTIFY_H__
00019 #define __AKNGLOBALNOTENOTIFY_H__
00020 
00021 // INCLUDES
00022 #include <AknNotify.h>
00023 #include <aknnotifystd.h>
00024 
00025 // CLASS DECLARATION
00026 
00032 NONSHARABLE_CLASS(CAknGlobalNote) : public CAknNotifyBase
00033     {
00034 public: 
00039     IMPORT_C static CAknGlobalNote* NewL();
00040     
00045     IMPORT_C static CAknGlobalNote* NewLC();
00046     
00050     IMPORT_C ~CAknGlobalNote();
00051 
00066     IMPORT_C void SetTextProcessing(TBool aEnabled);
00067 
00074     IMPORT_C TInt ShowNoteL(TAknGlobalNoteType aType, const TDesC& aNoteText);
00075     
00083     IMPORT_C TInt ShowNoteL(
00084         TRequestStatus& aStatus, 
00085         TAknGlobalNoteType aType,
00086         const TDesC& aNoteText);
00087     
00092     IMPORT_C void CancelNoteL(TInt aNoteId);
00093     
00098     IMPORT_C void SetPriority(TInt aPriority);
00099     
00104     IMPORT_C void SetSoftkeys(TInt aId);
00105     
00111     IMPORT_C void SetGraphic(TInt aId, TInt aMaskId=-1);
00112     
00117     IMPORT_C void SetAnimation(TInt aResourceId);
00118     
00123     IMPORT_C void SetTone(TInt aTone);  // must be specified in avkon.hrh
00124     
00125     // internal, please do not use
00126     IMPORT_C static void DoGlobaNoteBufferL(
00127         TInt16 aType,
00128         TInt16 aPriority,
00129         TInt aSoftkeys,
00130         TInt16 aGraphic,
00131         TInt16 aGraphicMask,
00132         TInt aAnimation,
00133         TInt16 aTone,
00134         TBool aAdapterUsed,
00135         TBool aTextProcessingEnabled,
00136         const TDesC& aNoteText,
00137         CBufFlat* aBuffer
00138         );
00139 
00140 private:
00141     CAknGlobalNote();
00142     void ConstructL();    
00143     
00144     void PrepareBufferL(
00145         TAknGlobalNoteType aType,
00146         const TDesC& aNoteText);
00147 
00148 private:
00149     IMPORT_C void CAknNotifyBase_Reserved();
00150     
00151 private:
00152     TInt iPriority;
00153     TInt iSoftkeys;
00154     TInt iGraphic;
00155     TInt iGraphicMask;
00156     TInt iAnimation;
00157     TInt iTone;
00158     TBool iTextProcessing;
00159     CBufFlat *iBuffer;
00160     TPtrC8 iBufferPtr;
00161     // Not really used, but needed to prevent buffer handling errors.
00162     TPckgBuf<SAknGlobalNoteReturnParams> iRetPckg;
00163     };
00164 
00165 // __AKNGLOBALNOTENOTIFY_H__
00166 #endif