CAknGlobalNote Class Reference

API published in: S60 1st Ed

Link against: aknnotify.lib eiksrv.lib

Capability Information

Required Capabilities

None

#include <aknglobalnote.h>

Inherits CAknNotifyBase.

Detailed Description

This class handles the global notes.


Public Member Functions
IMPORT_C	~CAknGlobalNote ()
	Destructor.
IMPORT_C void	SetTextProcessing (TBool aEnabled)
	Enable or disable all text processing done by the dialog.
IMPORT_C TInt	ShowNoteL (TAknGlobalNoteType aType, const TDesC &aNoteText)
	Displays the global note.
IMPORT_C TInt	ShowNoteL (TRequestStatus &aStatus, TAknGlobalNoteType aType, const TDesC &aNoteText)
	Displays the global note.
IMPORT_C void	CancelNoteL (TInt aNoteId)
	Cancels the global note.
IMPORT_C void	SetPriority (TInt aPriority)
	Sets the priority.
IMPORT_C void	SetSoftkeys (TInt aId)
	Sets the softkey ID.
IMPORT_C void	SetGraphic (TInt aId, TInt aMaskId=-1)
	Sets the graphic ID and the graphic mask ID.
IMPORT_C void	SetAnimation (TInt aResourceId)
	Sets the animation.
IMPORT_C void	SetTone (TInt aTone)
	Sets the tone.
Static Public Member Functions
static IMPORT_C CAknGlobalNote *	NewL ()
	Two-phased constructor.
static IMPORT_C CAknGlobalNote *	NewLC ()
	Two-phased constructor.
static 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)

Constructor & Destructor Documentation

IMPORT_C CAknGlobalNote::~CAknGlobalNote

(

)

Destructor.

Member Function Documentation

IMPORT_C void CAknGlobalNote::CancelNoteL

Cancels the global note.

Parameters:

aNoteId

Note ID.

static IMPORT_C void CAknGlobalNote::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]`

static IMPORT_C CAknGlobalNote* CAknGlobalNote::NewL ( ) [static]

Two-phased constructor.

Returns:: Pointer to new global note object.

static IMPORT_C CAknGlobalNote* CAknGlobalNote::NewLC ( ) [static]

Two-phased constructor.

Returns:: Pointer to new global note object.

IMPORT_C void CAknGlobalNote::SetAnimation

Sets the animation.

Parameters:

aResourceId

Resource ID of the animation.

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

Sets the graphic ID and the graphic mask ID.

Parameters:

	aId	Graphic ID
	aMaskId	Graphic mask ID.

IMPORT_C void CAknGlobalNote::SetPriority

Sets the priority.

Parameters:

aPriority

An integer specifying the new priority.

IMPORT_C void CAknGlobalNote::SetSoftkeys

Sets the softkey ID.

(Not used)

Parameters:

aId

softkey ID

IMPORT_C void CAknGlobalNote::SetTextProcessing

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.

Parameters:

aEnabled

Enable or disable all text processing.

IMPORT_C void CAknGlobalNote::SetTone

Sets the tone.

Parameters:

aTone

New tone.