Collapse all Symbian^3 Product Developer Library

CAknGlobalNote Class Reference

class CAknGlobalNote : public CAknNotifyBase

This class handles the global notes.

Since: S60 0.9

Inherits from

CAknGlobalNote
- CAknNotifyBase
  - CBase

Public Member Functions
	~CAknGlobalNote()
IMPORT_C void	CancelNoteL(TInt)
IMPORT_C void	DoGlobaNoteBufferL(TInt16, TInt16, TInt, TInt16, TInt16, TInt, TInt16, TBool, TBool, const TDesC &, CBufFlat *)
void	DoGlobalNoteBufferL(TInt16, TInt16, TInt, TInt16, TInt16, TInt, TInt16, TBool, TBool, const TDesC &, CBufFlat *, TInt32)
IMPORT_C CAknGlobalNote *	NewL()
IMPORT_C CAknGlobalNote *	NewLC()
IMPORT_C void	SetAnimation(TInt)
IMPORT_C void	SetGraphic(TInt, TInt)
IMPORT_C void	SetPriority(TInt)
IMPORT_C void	SetSoftkeys(TInt)
IMPORT_C void	SetTextProcessing(TBool)
IMPORT_C void	SetTone(TInt)
IMPORT_C TInt	ShowNoteL(TAknGlobalNoteType, const TDesC &)
IMPORT_C TInt	ShowNoteL(TRequestStatus &, TAknGlobalNoteType, const TDesC &)

Private Member Functions
	CAknGlobalNote()
IMPORT_C void	CAknNotifyBase_Reserved()
void	ConstructL()
void	PrepareBufferL(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 void

CAknNotifyBase_Reserved

(

)

[private]

CancelNoteL(TInt)

IMPORT_C void

CancelNoteL

(

TInt

aNoteId

)

Cancels the global note.

Parameters

TInt aNoteId

Note ID.

ConstructL()

void

ConstructL

(

)

[private]

2nd phase constructor. Connects to the notifier server.

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

IMPORT_C void	DoGlobaNoteBufferL	(	TInt16	aType,
			TInt16	aPriority,
			TInt	aSoftkeys,
			TInt16	aGraphic,
			TInt16	aGraphicMask,
			TInt	aAnimation,
			TInt16	aTone,
			TBool	aAdapterUsed,
			TBool	aTextProcessingEnabled,
			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)

void	DoGlobalNoteBufferL	(	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
		)	[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.

NewLC()

IMPORT_C CAknGlobalNote *

NewLC

(

)

[static]

Two-phased constructor.

PrepareBufferL(TAknGlobalNoteType, const TDesC &, TInt)

void	PrepareBufferL	(	TAknGlobalNoteType	aType,
			const TDesC &	aNoteText,
			TInt	aPreallocatedGlobalNoteId = 0
		)	[private]

Parameters

TAknGlobalNoteType aType
const TDesC & aNoteText
TInt aPreallocatedGlobalNoteId = 0

SetAnimation(TInt)

IMPORT_C void

SetAnimation

(

TInt

aResourceId

)

Sets the animation.

Parameters

TInt aResourceId

Resource ID of the animation.

SetGraphic(TInt, TInt)

IMPORT_C void	SetGraphic	(	TInt	aId,
			TInt	aMaskId = -1
		)

Sets the graphic ID and the graphic mask ID.

Parameters

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

SetPriority(TInt)

IMPORT_C void

SetPriority

(

TInt

aPriority

)

Sets the priority.

Parameters

TInt aPriority

An integer specifying the new priority.

SetSoftkeys(TInt)

IMPORT_C void

SetSoftkeys

(

TInt

aId

)

Sets the softkey ID. (Not used)

Parameters

TInt aId

softkey ID

SetTextProcessing(TBool)

IMPORT_C void

SetTextProcessing

(

TBool

aEnabled

)

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.

Since: S60 2.0

Parameters

TBool aEnabled

Enable or disable all text processing.

SetTone(TInt)

IMPORT_C void

SetTone

(

TInt

aTone

)

Sets the tone.

Parameters

TInt aTone

New tone.

ShowNoteL(TAknGlobalNoteType, const TDesC &)

IMPORT_C TInt	ShowNoteL	(	TAknGlobalNoteType	aType,
			const TDesC &	aNoteText
		)

Displays the global note.

Parameters

TAknGlobalNoteType aType	Note type.
const TDesC & aNoteText	Note text.

ShowNoteL(TRequestStatus &, TAknGlobalNoteType, const TDesC &)

IMPORT_C TInt	ShowNoteL	(	TRequestStatus &	aStatus,
			TAknGlobalNoteType	aType,
			const TDesC &	aNoteText
		)

Displays the global note.

Parameters

TRequestStatus & aStatus	Reference to request status.
TAknGlobalNoteType aType	Note type.
const TDesC & aNoteText	Note 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]