Collapse all Symbian^3 Application Developer Library

MFscContactActionMenuModel Class Reference

class MFscContactActionMenuModel

Contact Action Menu Model interface.

Since: S60 3.1

Public Member Functions
TInt	AddItemL ( CFscContactActionMenuItem *)
void	AddPreQueriedCasItemsL ()
TInt	ItemCount ()
CFscContactActionMenuItem &	ItemL ( TInt )
CFscContactActionMenuItem *	NewMenuItemL (const TDesC &, const CGulIcon *, TInt , TBool , TUid )
void	RemoveAll ( TBool )
void	RemoveItemL ( TInt )
TInt	VisibleItemCount ()
CFscContactActionMenuItem &	VisibleItemL ( TInt )

Protected Member Functions
	~MFscContactActionMenuModel ()

Constructor & Destructor Documentation

~MFscContactActionMenuModel()

~MFscContactActionMenuModel

(

)

[protected, inline, virtual]

Destructor.

Member Functions Documentation

AddItemL(CFscContactActionMenuItem *)

TInt

AddItemL

(

CFscContactActionMenuItem *

aItem

)

[pure virtual]

Add a single item

Parameters

CFscContactActionMenuItem * aItem

New item. Ownership of the item is transferred.

AddPreQueriedCasItemsL()

void

AddPreQueriedCasItemsL

(

)

[pure virtual]

Add pre queried items to the list This method can be used when client application is using same instance of cas and it is know that cas's queryresults are ok for the menu. This is usefull when Cas items are used in options menu and action menu Previously set CAS items are removed before adding new items.

ItemCount()

TInt

ItemCount

(

)

[pure virtual]

Return number of items in the menu

ItemL(TInt)

CFscContactActionMenuItem &

ItemL

(

TInt

aIndex

)

[pure virtual]

Item getter Method leaves with KErrNotFound if given index is invalid

Parameters

TInt aIndex

Index of requested item

NewMenuItemL(const TDesC &, const CGulIcon *, TInt, TBool, TUid)

CFscContactActionMenuItem *	NewMenuItemL	(	const TDesC &	aMenuText,
			const CGulIcon *	aIcon,
			TInt	aPriority,
			TBool	aStatic,
			TUid	aUid
		)	[pure virtual]

Factory method for creating a new menu item. Item is not added to the menu. Ownership of new item is transferred and it is not added to the menu automatically

Parameters

const TDesC & aMenuText	Menu text
const CGulIcon * aIcon	Icon. Icon ownership is not transferred
TInt aPriority	Priority
TBool aStatic	Is static Static items are ment to be kept in the menu longer than non-static. Normal use case for static items are custom items set by Action Menu's client. These special items are always in the menu so client does not want to set them again after clearing other items from the menu. All CAS based items are non-static and therefore they can easily be removed from the menu without removing static items also.
TUid aUid	Item Uid

RemoveAll(TBool)

void

RemoveAll

(

TBool

aStaticAlso = EFalse

)

[pure virtual]

Remove all items from the menu

Parameters

TBool aStaticAlso = EFalse

If ETrue also static items will be removed

RemoveItemL(TInt)

void

RemoveItemL

(

TInt

aIndex

)

[pure virtual]

Remove a single item from the menu

Parameters

TInt aIndex

Index of the item

VisibleItemCount()

TInt

VisibleItemCount

(

)

[pure virtual]

Return number of visible items in the menu Visible items are not hidden or dimmed and they have an icon

VisibleItemL(TInt)

CFscContactActionMenuItem &

VisibleItemL

(

TInt

aIndex

)

[pure virtual]

Visible item getter. Visible items are not hidden or dimmed and they have an icon

Parameters

TInt aIndex

Index of requested item