S60 3rd Edition API Reference: aknglobalnote.h Source File

00001 /*
00002 * ============================================================================
00003 *  Name     : AknGlobalNote.h
00004 *  Part of  : Avkon
00005 *
00006 *  Description:
00007 *     
00008 *  Version:
00009 *
00010 *  Copyright � 2002 Nokia Corporation.
00011 *  This material, including documentation and any related 
00012 *  computer programs, is protected by copyright controlled by 
00013 *  Nokia Corporation. All rights are reserved. Copying, 
00014 *  including reproducing, storing,  adapting or translating, any 
00015 *  or all of this material requires the prior written consent of 
00016 *  Nokia Corporation. This material also contains confidential 
00017 *  information which may not be disclosed to others without the 
00018 *  prior written consent of Nokia Corporation.
00019 * ============================================================================
00020 */
00021 #ifndef __AKNGLOBALNOTENOTIFY_H__
00022 #define __AKNGLOBALNOTENOTIFY_H__
00023 
00024 // INCLUDES
00025 
00026 #include <AknNotify.h>
00027 #include <aknnotifystd.h>
00028 
00029 // CLASS DECLARATION
00030 
00036 NONSHARABLE_CLASS(CAknGlobalNote) : public CAknNotifyBase
00037   {
00038 public: 
00039         
00044         IMPORT_C static CAknGlobalNote* NewL();
00045         
00050         IMPORT_C static CAknGlobalNote* NewLC();
00051         
00055         IMPORT_C ~CAknGlobalNote();
00056 
00071         IMPORT_C void SetTextProcessing(TBool aEnabled);
00072 
00079         IMPORT_C TInt ShowNoteL(TAknGlobalNoteType aType,const TDesC& aNoteText);
00080         
00088         IMPORT_C TInt ShowNoteL(TRequestStatus& aStatus, 
00089                                 TAknGlobalNoteType aType,
00090                                 const TDesC& aNoteText);
00091         
00096         IMPORT_C void CancelNoteL(TInt aNoteId);
00097         
00102         IMPORT_C void SetPriority(TInt aPriority);
00103         
00108         IMPORT_C void SetSoftkeys(TInt aId);
00109         
00115         IMPORT_C void SetGraphic(TInt aId, TInt aMaskId=-1);
00116         
00121         IMPORT_C void SetAnimation(TInt aResourceId);
00122         
00127         IMPORT_C void SetTone(TInt aTone);      // must be specified in avkon.hrh
00128 
00129     
00130     // internal, please do not use
00131     IMPORT_C static void DoGlobaNoteBufferL(
00132         TInt16 aType,
00133         TInt16 aPriority,
00134         TInt aSoftkeys,
00135         TInt16 aGraphic,
00136         TInt16 aGraphicMask,
00137         TInt aAnimation,
00138         TInt16 aTone,
00139         TBool aAdapterUsed,
00140         TBool aTextProcessingEnabled,
00141         const TDesC& aNoteText,
00142         CBufFlat* aBuffer
00143         );
00144 
00145 
00146 private:
00147         CAknGlobalNote();
00148         void ConstructL();    
00149         void PrepareBufferL(TAknGlobalNoteType aType,
00150                             const TDesC& aNoteText);
00151 
00152 private:
00153         IMPORT_C void CAknNotifyBase_Reserved();
00154 private:
00155         TInt iPriority;
00156         TInt iSoftkeys;
00157         TInt iGraphic;
00158         TInt iGraphicMask;
00159         TInt iAnimation;
00160         TInt iTone;
00161     TBool iTextProcessing;
00162         CBufFlat *iBuffer;
00163         TPtrC8 iBufferPtr;
00164     // not really used, but needed to prevent buffer handling errors
00165         TPckgBuf<SAknGlobalNoteReturnParams> iRetPckg;
00166   };
00167 
00168 
00169 #endif