CAknGlobalNote Class Reference

class CAknGlobalNote : public CAknNotifyBase

This class handles the global notes.

S60 0.9

Inherits from

Public Member Functions
~CAknGlobalNote()
IMPORT_C voidCancelNoteL(TInt)
IMPORT_C voidDoGlobaNoteBufferL(TInt16, TInt16, TInt, TInt16, TInt16, TInt, TInt16, TBool, TBool, const TDesC &, CBufFlat *)
voidDoGlobalNoteBufferL(TInt16, TInt16, TInt, TInt16, TInt16, TInt, TInt16, TBool, TBool, const TDesC &, CBufFlat *, TInt32)
IMPORT_C CAknGlobalNote *NewL()
IMPORT_C CAknGlobalNote *NewLC()
IMPORT_C voidSetAnimation(TInt)
IMPORT_C voidSetGraphic(TInt, TInt)
IMPORT_C voidSetPriority(TInt)
IMPORT_C voidSetSoftkeys(TInt)
IMPORT_C voidSetTextProcessing(TBool)
IMPORT_C voidSetTone(TInt)
IMPORT_C TIntShowNoteL(TAknGlobalNoteType, const TDesC &)
IMPORT_C TIntShowNoteL(TRequestStatus &, TAknGlobalNoteType, const TDesC &)
Private Member Functions
CAknGlobalNote()
IMPORT_C voidCAknNotifyBase_Reserved()
voidConstructL()
voidPrepareBufferL(TAknGlobalNoteType, const TDesC &, TInt)
Inherited Functions
CAknNotifyBase::CAknNotifyBase(TUid)
CAknNotifyBase::SecondaryDisplayData()
CAknNotifyBase::SetSecondaryDisplayData(CAknSDData *)
CAknNotifyBase::StartOrUpdateAndGetResponseL(TRequestStatus &,const TDesC8 &,TDes8 &)
CAknNotifyBase::StartOrUpdateL(const TDesC8 &,TDes8 &)
CAknNotifyBase::~CAknNotifyBase()
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
TInt iAnimation
CBufFlat *iBuffer
TPtrC8 iBufferPtr
CBufFlat *iCancelBuffer
TPtrC8 iCancelBufferPtr
TInt iGraphic
TInt iGraphicMask
TInt iPriority
TPckgBuf< SAknGlobalNoteReturnParams >iRetPckg
TInt iSoftkeys
TBool iTextProcessing
TInt iTone

Constructor & Destructor Documentation

CAknGlobalNote()

CAknGlobalNote()[private]

~CAknGlobalNote()

IMPORT_C~CAknGlobalNote()

Destructor.

Member Functions Documentation

CAknNotifyBase_Reserved()

IMPORT_C voidCAknNotifyBase_Reserved()[private]

CancelNoteL(TInt)

IMPORT_C voidCancelNoteL(TIntaNoteId)

Cancels the global note.

Parameters

TInt aNoteIdNote ID.

ConstructL()

voidConstructL()[private]

2nd phase constructor. Connects to the notifier server.

DoGlobaNoteBufferL(TInt16, TInt16, TInt, TInt16, TInt16, TInt, TInt16, TBool, TBool, const TDesC &, CBufFlat *)

IMPORT_C voidDoGlobaNoteBufferL(TInt16aType,
TInt16aPriority,
TIntaSoftkeys,
TInt16aGraphic,
TInt16aGraphicMask,
TIntaAnimation,
TInt16aTone,
TBoolaAdapterUsed,
TBoolaTextProcessingEnabled,
const TDesC &aNoteText,
CBufFlat *aBuffer
)[static]

Internal, please do not use.

Parameters

TInt16 aType
TInt16 aPriority
TInt aSoftkeys
TInt16 aGraphic
TInt16 aGraphicMask
TInt aAnimation
TInt16 aTone
TBool aAdapterUsed
TBool aTextProcessingEnabled
const TDesC & aNoteText
CBufFlat * aBuffer

DoGlobalNoteBufferL(TInt16, TInt16, TInt, TInt16, TInt16, TInt, TInt16, TBool, TBool, const TDesC &, CBufFlat *, TInt32)

voidDoGlobalNoteBufferL(TInt16aType,
TInt16aPriority,
TIntaSoftkeys,
TInt16aGraphic,
TInt16aGraphicMask,
TIntaAnimation,
TInt16aTone,
TBoolaAdapterUsed,
TBoolaTextProcessingEnabled,
const TDesC &aNoteText,
CBufFlat *aBuffer,
TInt32aPreallocatedGlobalNoteId
)[static]

Parameters

TInt16 aType
TInt16 aPriority
TInt aSoftkeys
TInt16 aGraphic
TInt16 aGraphicMask
TInt aAnimation
TInt16 aTone
TBool aAdapterUsed
TBool aTextProcessingEnabled
const TDesC & aNoteText
CBufFlat * aBuffer
TInt32 aPreallocatedGlobalNoteId

NewL()

IMPORT_C CAknGlobalNote *NewL()[static]

Two-phased constructor. Pointer to new global note object.

NewLC()

IMPORT_C CAknGlobalNote *NewLC()[static]

Two-phased constructor. Pointer to new global note object.

PrepareBufferL(TAknGlobalNoteType, const TDesC &, TInt)

voidPrepareBufferL(TAknGlobalNoteTypeaType,
const TDesC &aNoteText,
TIntaPreallocatedGlobalNoteId = 0
)[private]

Parameters

TAknGlobalNoteType aType
const TDesC & aNoteText
TInt aPreallocatedGlobalNoteId = 0

SetAnimation(TInt)

IMPORT_C voidSetAnimation(TIntaResourceId)

Sets the animation.

Parameters

TInt aResourceIdResource ID of the animation.

SetGraphic(TInt, TInt)

IMPORT_C voidSetGraphic(TIntaId,
TIntaMaskId = -1
)

Sets the graphic ID and the graphic mask ID.

Parameters

TInt aIdGraphic ID
TInt aMaskId = -1Graphic mask ID.

SetPriority(TInt)

IMPORT_C voidSetPriority(TIntaPriority)

Sets the priority.

Parameters

TInt aPriorityAn integer specifying the new priority.

SetSoftkeys(TInt)

IMPORT_C voidSetSoftkeys(TIntaId)

Sets the softkey ID. (Not used)

Parameters

TInt aIdsoftkey ID

SetTextProcessing(TBool)

IMPORT_C voidSetTextProcessing(TBoolaEnabled)

Enable or disable all text processing done by the dialog. This includes text wrapping, text truncation and reordering of bidirectional text.

By default, it is enabled.

If text processing is disabled, lines are broken only at explicit line end characters and they are not truncated, but drawn as long as they fit. Also, the dialog does not handle reordering of bidirectional text.

S60 2.0

Parameters

TBool aEnabledEnable or disable all text processing.

SetTone(TInt)

IMPORT_C voidSetTone(TIntaTone)

Sets the tone.

Parameters

TInt aToneNew tone.

ShowNoteL(TAknGlobalNoteType, const TDesC &)

IMPORT_C TIntShowNoteL(TAknGlobalNoteTypeaType,
const TDesC &aNoteText
)

Displays the global note. Note ID.

Parameters

TAknGlobalNoteType aTypeNote type.
const TDesC & aNoteTextNote text.

ShowNoteL(TRequestStatus &, TAknGlobalNoteType, const TDesC &)

IMPORT_C TIntShowNoteL(TRequestStatus &aStatus,
TAknGlobalNoteTypeaType,
const TDesC &aNoteText
)

Displays the global note. Note ID.

Parameters

TRequestStatus & aStatusReference to request status.
TAknGlobalNoteType aTypeNote type.
const TDesC & aNoteTextNote text.

Member Data Documentation

TInt iAnimation

TInt iAnimation[private]

CBufFlat * iBuffer

CBufFlat *iBuffer[private]

TPtrC8 iBufferPtr

TPtrC8 iBufferPtr[private]

CBufFlat * iCancelBuffer

CBufFlat *iCancelBuffer[private]

TPtrC8 iCancelBufferPtr

TPtrC8 iCancelBufferPtr[private]

TInt iGraphic

TInt iGraphic[private]

TInt iGraphicMask

TInt iGraphicMask[private]

TInt iPriority

TInt iPriority[private]

TPckgBuf< SAknGlobalNoteReturnParams > iRetPckg

TPckgBuf< SAknGlobalNoteReturnParams >iRetPckg[private]

TInt iSoftkeys

TInt iSoftkeys[private]

TBool iTextProcessing

TBool iTextProcessing[private]

TInt iTone

TInt iTone[private]
© Nokia 2010.