CAknItemActionMenu Class Reference

class CAknItemActionMenu : public CBase

Item action menu.

Classes implementing MAknCollection interface can launch item specific action menu using this class. Item specific commands are fetched from the current menu bar and handled like any other options menu commands.

Collections that wish to use item action menu should register themselves using static call RegisterCollectionL. This call returns pointer to item action menu instance (ownership does not transfer to caller). Pointer to item action menu can be used to launch the menu. When there is no need for item action menu usage in collection anymore, collection should be removed with method RemoveCollection.

Simplified example:

 // Initialization (NOTE: ownership does not transfer!) 
 iItemActionMenu = CAknItemActionMenu::RegisterCollectionL( *this );
 
 // Show menu
 if ( iItemActionMenu->InitMenuL() )
     {
     iItemActionMenu->ShowMenuL( position );
     }
 
 // Remove collection
 iItemActionMenu->RemoveCollection( *this );

eikcoctl S60 v5.2

Inherits from

CAknItemActionMenu
- CBase

Public Member Functions
	~CAknItemActionMenu()
void	AddCollectionStateL(MAknCollection &)
IMPORT_C void	CollectionChanged(MAknCollection &)
TInt	CollectionCount()
TBool	CollectionHighlightVisible()
TBool	CollectionSoftkeyVisible(TBool)
IMPORT_C TBool	InitMenuL()
CAknItemActionMenuData &	MenuData()
CAknItemActionMenu *	NewL(MAknCollection &, MObjectProvider *)
CAknItemActionMenu *	NewLC(MAknCollection &, MObjectProvider *)
MObjectProvider *	Owner()
IMPORT_C CAknItemActionMenu *	RegisterCollectionL(MAknCollection &)
void	RegisterCollectionObserverL(MAknCollectionObserver &)
IMPORT_C void	RemoveCollection(MAknCollection &)
void	RemoveCollectionObserver(MAknCollectionObserver &)
void	SetMenuBar(MEikMenuObserver , CEikMenuBar )
IMPORT_C void	ShowMenuL(const TPoint &, TUint)

Private Member Functions
	CAknItemActionMenu(MObjectProvider *)
void	ConstructL(MAknCollection &)
TInt	LaunchSubMenuQueryL(const TDesC &)
void	NotifyChangeToActiveObserver(TBool)
void	ProcessCommandL(TInt)
void	SetEmphasis(CCoeControl *, TBool)
void	UnregisterMenu()

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

Private Attributes
CEikMenuBar *	iMenuBar
MEikMenuObserver *	iMenuBarObserver
CAknItemActionMenuData *	iMenuData
CEikMenuPane *	iMenuPane
RPointerArray< MAknCollectionObserver >	iObservers
MObjectProvider *	iOwner
CAknStylusPopUpMenu *	iPopupMenu
TBool	iProcessingCommand
RPointerArray< MAknCollection >	iStates

Constructor & Destructor Documentation

CAknItemActionMenu(MObjectProvider *)

CAknItemActionMenu

(

MObjectProvider *

aOwner

)

[private]

C++ constructor.

Parameters

MObjectProvider * aOwner

Menu's owner.

~CAknItemActionMenu()

~CAknItemActionMenu

(

)

[virtual]

Destructor.

Member Functions Documentation

AddCollectionStateL(MAknCollection &)

void

AddCollectionStateL

(

MAknCollection &

aCollection

)

Adds collection to this item action menu.

Parameters

MAknCollection & aCollection

New collection.

CollectionChanged(MAknCollection &)

IMPORT_C void

CollectionChanged

(

MAknCollection &

aCollection

)

Notifies that collection has been changed.

Parameters

MAknCollection & aCollection

Changed collection.

CollectionCount()

TInt

CollectionCount

(

)

const

Provides item action menu collection count.

CollectionHighlightVisible()

TBool

CollectionHighlightVisible

(

)

const

Provides collection highlight state.

CollectionSoftkeyVisible(TBool)

TBool

CollectionSoftkeyVisible

(

TBool

aVisibleCollection = ETrue

)

const

Provides collection softkey state.

Parameters

TBool aVisibleCollection = ETrue

ConstructL(MAknCollection &)

void

ConstructL

(

MAknCollection &

aCollection

)

[private]

Symbian second-phase constructor.

Parameters

MAknCollection & aCollection

Collection.

InitMenuL()

IMPORT_C TBool

InitMenuL

(

)

Initializes this item action menu. Menu should be initialized before it can be shown with ShowMenuL.

ETrue if item action menu has content. EFalse otherwise.

LaunchSubMenuQueryL(const TDesC &)

TInt

LaunchSubMenuQueryL

(

const TDesC &

aHeading

)

[private]

Fills query dialog with menu data and launches it.

Selected menu data index.

Parameters

const TDesC & aHeading

Dialog heading.

MenuData()

CAknItemActionMenuData &

MenuData

(

)

Provides reference to this item action menu data.

Reference to item action menu data.

NewL(MAknCollection &, MObjectProvider *)

CAknItemActionMenu *	NewL	(	MAknCollection &	aCollection,
			MObjectProvider *	aOwner
		)	[static]

Two-phased constructor.

Parameters

MAknCollection & aCollection
MObjectProvider * aOwner

NewLC(MAknCollection &, MObjectProvider *)

CAknItemActionMenu *	NewLC	(	MAknCollection &	aCollection,
			MObjectProvider *	aOwner
		)	[static]

Two-phased constructor.

Parameters

MAknCollection & aCollection
MObjectProvider * aOwner

NotifyChangeToActiveObserver(TBool)

void

NotifyChangeToActiveObserver

(

TBool

aCollectionVisible = ETrue

)

[private]

Notifies collection change to active observer.

Parameters

TBool aCollectionVisible = ETrue

ETrue if collection that changed is visible.

Owner()

MObjectProvider *

Owner

(

)

const

Returns pointer to item action menu's owner.

Menu's owner

ProcessCommandL(TInt)

void

ProcessCommandL

(

TInt

aCommandId

)

[private]

Processes user commands.

Parameters

TInt aCommandId

ID of the command to respond to.

RegisterCollectionL(MAknCollection &)

IMPORT_C CAknItemActionMenu *

RegisterCollectionL

(

MAknCollection &

aCollection

)

[static]

Adds collection to the item action menu of this view / dialog / appUi.

Pointer to the item action menu instance. Ownership does not transfer to caller.

Parameters

MAknCollection & aCollection

Collection implementing MAknCollection interface.

RegisterCollectionObserverL(MAknCollectionObserver &)

void

RegisterCollectionObserverL

(

MAknCollectionObserver &

aObserver

)

Registers collection observer.

Parameters

MAknCollectionObserver & aObserver

RemoveCollection(MAknCollection &)

IMPORT_C void

RemoveCollection

(

MAknCollection &

aCollection

)

Removes collection of this item action menu.

Parameters

MAknCollection & aCollection

Collection to be removed.

RemoveCollectionObserver(MAknCollectionObserver &)

void

RemoveCollectionObserver

(

MAknCollectionObserver &

aObserver

)

Removes collection observer.

Parameters

MAknCollectionObserver & aObserver

SetEmphasis(CCoeControl *, TBool)

void	SetEmphasis	(	CCoeControl *	aMenuControl,
			TBool	aEmphasis
		)	[private]

Called by the framework to handle the emphasising or de-emphasising of a menu window.

Parameters

CCoeControl * aMenuControl	The menu control.
TBool aEmphasis	ETrue to emphasize the menu, EFalse otherwise.

SetMenuBar(MEikMenuObserver , CEikMenuBar )

void	SetMenuBar	(	MEikMenuObserver *	aMenuObserver,
			CEikMenuBar *	aMenuBar
		)

Sets menu bar to item action menu.

Parameters

MEikMenuObserver * aMenuObserver
CEikMenuBar * aMenuBar

ShowMenuL(const TPoint &, TUint)

IMPORT_C void	ShowMenuL	(	const TPoint &	aPosition,
			TUint	aFlags = 0
		)

Shows this item action menu.

Parameters

const TPoint & aPosition	Menu position relative to screen.
TUint aFlags = 0	Flags - not used.

UnregisterMenu()

void

UnregisterMenu

(

)

[private]

Unregisters item action menu

Member Data Documentation

CEikMenuBar * iMenuBar

CEikMenuBar *

iMenuBar

[private]

Menu bar. Not own.

MEikMenuObserver * iMenuBarObserver

MEikMenuObserver *

iMenuBarObserver

[private]

Menu bar observer. Not own.

CAknItemActionMenuData * iMenuData

CAknItemActionMenuData *

iMenuData

[private]

Menu data. Own.

CEikMenuPane * iMenuPane

CEikMenuPane *

iMenuPane

[private]

Menu pane. Own.

RPointerArray< MAknCollectionObserver > iObservers

RPointerArray< MAknCollectionObserver >

iObservers

[private]

Collection observers.

MObjectProvider * iOwner

MObjectProvider *

iOwner

[private]

Pointer to menu's owner. Not own

CAknStylusPopUpMenu * iPopupMenu

CAknStylusPopUpMenu *

iPopupMenu

[private]

Menu control. Own.

TBool iProcessingCommand

TBool

iProcessingCommand

[private]

Boolean ensuring that item action menu is not unregistered during command processing.

RPointerArray< MAknCollection > iStates

RPointerArray< MAknCollection >

iStates

[private]

Collections.

CAknItemActionMenu Class Reference

Inherits from

Constructor & Destructor Documentation

CAknItemActionMenu(MObjectProvider *)

Parameters

~CAknItemActionMenu()

Member Functions Documentation

AddCollectionStateL(MAknCollection &)

Parameters

CollectionChanged(MAknCollection &)

Parameters

CollectionCount()

CollectionHighlightVisible()

CollectionSoftkeyVisible(TBool)

Parameters

ConstructL(MAknCollection &)

Parameters

InitMenuL()

LaunchSubMenuQueryL(const TDesC &)

Parameters

MenuData()

NewL(MAknCollection &, MObjectProvider *)

Parameters

NewLC(MAknCollection &, MObjectProvider *)

Parameters

NotifyChangeToActiveObserver(TBool)

Parameters

Owner()

ProcessCommandL(TInt)

Parameters

RegisterCollectionL(MAknCollection &)

Parameters

RegisterCollectionObserverL(MAknCollectionObserver &)

Parameters

RemoveCollection(MAknCollection &)

Parameters

RemoveCollectionObserver(MAknCollectionObserver &)

Parameters

SetEmphasis(CCoeControl *, TBool)

Parameters

SetMenuBar(MEikMenuObserver *, CEikMenuBar *)

Parameters

ShowMenuL(const TPoint &, TUint)

Parameters

UnregisterMenu()

Member Data Documentation

CEikMenuBar * iMenuBar

MEikMenuObserver * iMenuBarObserver

CAknItemActionMenuData * iMenuData

CEikMenuPane * iMenuPane

RPointerArray< MAknCollectionObserver > iObservers

MObjectProvider * iOwner

CAknStylusPopUpMenu * iPopupMenu

TBool iProcessingCommand

RPointerArray< MAknCollection > iStates

SetMenuBar(MEikMenuObserver , CEikMenuBar )