CAknGlobalNote Class Reference

#include <mw/AknGlobalNote.h>

class CAknGlobalNote : public CAknNotifyBase

Inherits from

CAknGlobalNote
- CAknNotifyBase

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 &)

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()

Detailed Description

This class handles the global notes.

Since: S60 0.9

Constructor & Destructor Documentation

~CAknGlobalNote ( )

IMPORT_C

~CAknGlobalNote

(

)

Destructor.

Member Function Documentation

CancelNoteL ( TInt )

IMPORT_C void

CancelNoteL

(

TInt

aNoteId

)

Cancels the global note.

Parameter	Description
aNoteId	Note ID.

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.

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]

NewL ( )

IMPORT_C CAknGlobalNote *

NewL

(

)

[static]

Two-phased constructor.

Returns: Pointer to new global note object.

NewLC ( )

IMPORT_C CAknGlobalNote *

NewLC

(

)

[static]

Two-phased constructor.

Returns: Pointer to new global note object.

SetAnimation ( TInt )

IMPORT_C void

SetAnimation

(

TInt

aResourceId

)

Sets the animation.

Parameter	Description
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.

Parameter	Description
aId	Graphic ID
aMaskId	Graphic mask ID.

SetPriority ( TInt )

IMPORT_C void

SetPriority

(

TInt

aPriority

)

Sets the priority.

Parameter	Description
aPriority	An integer specifying the new priority.

SetSoftkeys ( TInt )

IMPORT_C void

SetSoftkeys

(

TInt

aId

)

Sets the softkey ID. (Not used)

Parameter	Description
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

Parameter	Description
aEnabled	Enable or disable all text processing.

SetTone ( TInt )

IMPORT_C void

SetTone

(

TInt

aTone

)

Sets the tone.

Parameter	Description
aTone	New tone.

ShowNoteL ( TAknGlobalNoteType, const TDesC & )

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

Displays the global note.

Parameter	Description
aType	Note type.
aNoteText	Note text.

Returns: Note ID.

ShowNoteL ( TRequestStatus &, TAknGlobalNoteType, const TDesC & )

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

Displays the global note.

Parameter	Description
aStatus	Reference to request status.
aType	Note type.
aNoteText	Note text.

Returns: Note ID.