Class CQikMenuPopout

class CQikMenuPopout : public CBase;

Description

Class for displaying menu popouts. Uses CEikMenuPane .

Derivation

• CBase - Base class for all classes to be instantiated on the heap
• CQikMenuPopout - Class for displaying menu popouts

Members

Defined in CQikMenuPopout:
AddCommandL(), DisplayL(), MenuPane(), NewL(), ResetL(), SetCommandListL(), SetRootPaneId(), ~CQikMenuPopout()

Inherited from CBase:
Delete(), Extension_(), operator new()

See also:

• CEikMenuPane

static IMPORT_C CQikMenuPopout *NewL(CEikonEnv &aEikonEnv, MQikCommandHandler &aCommandHandler);

Description

Creates the menu popout

Parameters

Return value

IMPORT_C ~CQikMenuPopout();

Description

Destructor Clears and deallocates resources used by the menu popout. If the commands are added through SetCommandListL() they are deleted, if the commands are added through AddCommandL() are not deleted.

IMPORT_C void ResetL();

Description

Clears and initializes the menu popout. Will not leave. Name retained for BC reasons

IMPORT_C void AddCommandL(const CQikCommand &aCommand);

Description

Adds a command to the menu popout. Does not take ownership of the commands added through this method.

Parameters

IMPORT_C void SetCommandListL(TInt aResourceId);

Description

Initializes the menu popout with a command list and creates the menu pane. Takes ownership of the commands created from resource. Calling this method will remove all other commands added.

Parameters

IMPORT_C void DisplayL(TPoint &aPopoutPos, TPopupTargetPosType aTargetType, TBool aFullClientWidth=EFalse);

Description

Displays the popout menu.

Parameters

IMPORT_C CEikMenuPane *MenuPane();

Description

Returns the CEikMenuPane used by the menu popout so it can be directly manipulated. Note: calling ResetL() will invalidate this pointer!

Return value

See also:

• CEikMenuPane

IMPORT_C void SetRootPaneId(TInt aId);

Description

Use this method to set namedgroup-id of the root menupane. This only needs to be done if you for some reason don't use 0 as id for the first menupane. In normal circumstances this method isn't used. If not zero, the namedgroup-id needs to be set before before calling AddCommandL .

Parameters