Collapse all Symbian^3 Product Developer Library

CAknSoftNotificationParameters Class Reference

class CAknSoftNotificationParameters : public CBase

Utility implementation for CAknSoftNotificationParameters

AknNotifyPlugin.lib

Since: S60 1.2

Inherits from

CAknSoftNotificationParameters
- CBase

Public Member Functions
	~CAknSoftNotificationParameters()
IMPORT_C CAknSoftNotificationParameters *	NewL()
IMPORT_C CAknSoftNotificationParameters *	NewL(const TDesC &, TInt, TInt, TInt, CAknNoteDialog::TTone)
IMPORT_C CAknSoftNotificationParameters *	NewL(const TDesC &, TInt, TInt, TInt, CAknNoteDialog::TTone, TVwsViewId, TUid, TInt, const TDesC8 &)
void	SetGroupedTexts(TInt)
void	SetPluralViewId(const TVwsViewId &)

Protected Member Functions
	CAknSoftNotificationParameters()

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

Protected Attributes
TInt	iAcceptSoftKey
TUid	iCustomMessageId
TInt	iGroupedTextResourceId
TInt	iNoteResourceId
TVwsViewId	iPluralViewId
TInt	iPriority
HBufC *	iResourceFile
TInt	iSoftkeys
CAknNoteDialog::TTone	iTone
HBufC8 *	iViewActivationMsg
TVwsViewId	iViewId

Constructor & Destructor Documentation

CAknSoftNotificationParameters()

CAknSoftNotificationParameters

(

)

[protected, inline]

~CAknSoftNotificationParameters()

IMPORT_C

~CAknSoftNotificationParameters

(

)

Destructor.

Member Functions Documentation

NewL()

IMPORT_C CAknSoftNotificationParameters *

NewL

(

)

[static]

Static constructor for creating custom soft notification parameters. Initializes the member variables with null values.

NewL(const TDesC &, TInt, TInt, TInt, CAknNoteDialog::TTone)

IMPORT_C CAknSoftNotificationParameters *	NewL	(	const TDesC &	aResourceFile,
			TInt	aNoteResourceId,
			TInt	aPriority,
			TInt	aSoftkeys,
			CAknNoteDialog::TTone	aTone
		)	[static]

Static constructor for creating custom soft notification parameters.

Parameters

const TDesC & aResourceFile	Full resource file name (containing drive and path).
TInt aNoteResourceId	Resource ID in given resource file. Must be a resource of type AVKON_NOTE.
TInt aPriority	Priority for soft notification.
TInt aSoftkeys	Resource ID for softkeys. Must be from avkon.rsg.
CAknNoteDialog::TTone aTone	Tone for soft notification.

NewL(const TDesC &, TInt, TInt, TInt, CAknNoteDialog::TTone, TVwsViewId, TUid, TInt, const TDesC8 &)

IMPORT_C CAknSoftNotificationParameters *	NewL	(	const TDesC &	aResourceFile,
			TInt	aNoteResourceId,
			TInt	aPriority,
			TInt	aSoftkeys,
			CAknNoteDialog::TTone	aTone,
			TVwsViewId	aViewId,
			TUid	aCustomMessageId,
			TInt	aAcceptKeyId,
			const TDesC8 &	aViewActivationMsg
		)	[static]

Static constructor for creating custom soft notification parameters.

Parameters

const TDesC & aResourceFile	Full resource file name (containing drive and path).
TInt aNoteResourceId	Resource ID in given resource file. Must be a resource of type AVKON_NOTE.
TInt aPriority	Priority for soft notification.
TInt aSoftkeys	Resource ID for softkeys. Must be from avkon.rsg.
CAknNoteDialog::TTone aTone	Tone for soft notification.
TVwsViewId aViewId	View ID of the view where to switch in case user chooses accept softkey in the soft notification.
TUid aCustomMessageId	Custom Uid sent to the view in the view activation process.
TInt aAcceptKeyId	ID of a softkey used for accepting the query. Exiting type softkeys (e.g. "cancel", "exit", "back", "done", etc.) should not be used.
const TDesC8 & aViewActivationMsg	Custom message sent to the view in the view activation process.

SetGroupedTexts(TInt)

void

SetGroupedTexts

(

TInt

aGroupedTextsID

)

[inline]

Sets the texts to be used when the soft notification is displayed in grouped form. Calling this method with non-null parameter also indicates that the soft notification supports grouped form.

Parameters

TInt aGroupedTextsID

Resource identifier pointing to AVKON_GROUPED_NOTE_TEXTS resource. The resource can have singular and plural labels. See avkon.rh for details.

SetPluralViewId(const TVwsViewId &)

void

SetPluralViewId

(

const TVwsViewId &

aViewId

)

[inline]

Legacy support. Sets the plural view ID.

Parameters

const TVwsViewId & aViewId

Plural view ID.

Member Data Documentation

TInt iAcceptSoftKey

TInt

iAcceptSoftKey

[protected]

TUid iCustomMessageId

TUid

iCustomMessageId

[protected]

TInt iGroupedTextResourceId

TInt

iGroupedTextResourceId

[protected]

TInt iNoteResourceId

TInt

iNoteResourceId

[protected]

TVwsViewId iPluralViewId

TVwsViewId

iPluralViewId

[protected]

TInt iPriority

TInt

iPriority

[protected]

HBufC * iResourceFile

HBufC *

iResourceFile

[protected]

TInt iSoftkeys

TInt

iSoftkeys

[protected]

CAknNoteDialog::TTone iTone

CAknNoteDialog::TTone

iTone

[protected]

HBufC8 * iViewActivationMsg

HBufC8 *

iViewActivationMsg

[protected]

TVwsViewId iViewId

TVwsViewId

iViewId

[protected]