AknGlobalNote.h

00001 /*
00002 * ============================================================================
00003 *  Name        : AknGlobalNote.h
00004 *  Part of     : UI Framework Core / AVKON Notifiers Client
00005 *  Description :
00006 *  Version     : %version: tr1s60#12.1.1.1.2.1.1 %
00007 *
00008 *  Copyright © 2002-2008 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>
00025 // CLASS DECLARATION
00032 NONSHARABLE_CLASS(CAknGlobalNote) : public CAknNotifyBase
00033     {
00034 public: 
00039     IMPORT_C static CAknGlobalNote* NewL();
00045     IMPORT_C static CAknGlobalNote* NewLC();
00050     IMPORT_C ~CAknGlobalNote();
00066     IMPORT_C void SetTextProcessing(TBool aEnabled);
00074     IMPORT_C TInt ShowNoteL(TAknGlobalNoteType aType, const TDesC& aNoteText);
00083     IMPORT_C TInt ShowNoteL(
00084         TRequestStatus& aStatus, 
TAknGlobalNoteType aType,
00086         const TDesC& aNoteText);
00092     IMPORT_C void CancelNoteL(TInt aNoteId);
00098     IMPORT_C void SetPriority(TInt aPriority);
00104     IMPORT_C void SetSoftkeys(TInt aId);
00111     IMPORT_C void SetGraphic(TInt aId, TInt aMaskId=-1);
00117     IMPORT_C void SetAnimation(TInt aResourceId);
00123     IMPORT_C void SetTone(TInt aTone);  // must be specified in avkon.hrh
00129     IMPORT_C static void DoGlobaNoteBufferL(
00130         TInt16 aType,
00131         TInt16 aPriority,
00132         TInt aSoftkeys,
00133         TInt16 aGraphic,
00134         TInt16 aGraphicMask,
00135         TInt aAnimation,
00136         TInt16 aTone,
00137         TBool aAdapterUsed,
00138         TBool aTextProcessingEnabled,
00139         const TDesC& aNoteText,
00140         CBufFlat* aBuffer
00141         );
00146     static void DoGlobalNoteBufferL(
00147         TInt16 aType,
00148         TInt16 aPriority,
00149         TInt aSoftkeys,
00150         TInt16 aGraphic,
00151         TInt16 aGraphicMask,
00152         TInt aAnimation,
00153         TInt16 aTone,
00154         TBool aAdapterUsed,
00155         TBool aTextProcessingEnabled,
00156         const TDesC& aNoteText,
00157         CBufFlat* aBuffer,
00158         TInt32 aPreallocatedGlobalNoteId
00159         );        
00161 private:
CAknGlobalNote();
00163     void ConstructL();    
00165     void PrepareBufferL(
TAknGlobalNoteType aType,
00167         const TDesC& aNoteText,
00168         TInt aPreallocatedGlobalNoteId = 0);
00170 private:
00171     IMPORT_C void CAknNotifyBase_Reserved();
00173 private:
00174     TInt iPriority;
00175     TInt iSoftkeys;
00176     TInt iGraphic;
00177     TInt iGraphicMask;
00178     TInt iAnimation;
00179     TInt iTone;
00180     TBool iTextProcessing;
00182     CBufFlat *iBuffer;
00183     TPtrC8 iBufferPtr;
00185     CBufFlat *iCancelBuffer;
00186     TPtrC8 iCancelBufferPtr;
00188     // Not really used, but needed to prevent buffer handling errors.
00189     TPckgBuf<SAknGlobalNoteReturnParams> iRetPckg;
00190     };
00192 #endif // __AKNGLOBALNOTENOTIFY_H__