CEikMenuPane Class Reference

#include <mw/eikmenup.h>

class CEikMenuPane : public CEikBorderedControl

Inherits from

CEikMenuPane
- CEikBorderedControl
  - CAknControl

Nested Classes and Structures

CEikMenuPane::CItemArray

Public Member Type Definitions
typedef	TBuf< 20 > THotKeyDisplayText

Public Member Functions
	CEikMenuPane(MEikMenuObserver *)
	~CEikMenuPane()
void	ActivateCurrentItemL()
void	AddCascadeMenuItemsToMenuL(TInt, TBool, TBool, CAknItemActionMenuData *, TInt)
IMPORT_C void	AddMenuItemL(const CEikMenuPaneItem::SData &)
IMPORT_C void	AddMenuItemL(const CEikMenuPaneItem::SData &, TInt)
IMPORT_C void	AddMenuItemsL(TInt, TInt, TBool)
void	AddMenuItemsToItemActionMenuL(CAknItemActionMenuData &)
TBool	CancelActiveMenuPane()
IMPORT_C CEikMenuPane *	CascadeMenuPane()
IMPORT_C void	Close()
IMPORT_C void	CloseCascadeMenu()
void	CloseCascadeMenu(TBool)
virtual IMPORT_C CCoeControl *	ComponentControl(TInt)
IMPORT_C void	ConstructL(CEikMenuPane , MEikMenuObserver )
IMPORT_C void	ConstructMenuSctRowFromDialogL(TDes &, TInt)
IMPORT_C void	ConstructMenuSctRowFromDialogL(TInt, TDes &, TInt)
IMPORT_C void	ConstructMenuSctRowL(TDes &)
IMPORT_C void	ConstructMenuSctRowL(TDes &, TInt)
virtual IMPORT_C TInt	CountComponentControls()
IMPORT_C void	DeleteBetweenMenuItems(TInt, TInt)
IMPORT_C void	DeleteMenuItem(TInt)
IMPORT_C void	EnableMarqueeL(const TBool)
void	FilterDimmedItems()
virtual IMPORT_C void	GetColorUseListL(CArrayFix< TCoeColorUse > &)
virtual IMPORT_C void	HandlePointerEventL(const TPointerEvent &)
virtual IMPORT_C void	HandleResourceChange(TInt)
void	HideMarkAndUnmark(TBool)
virtual IMPORT_C TCoeInputCapabilities	InputCapabilities()
IMPORT_C void	InsertMenuItemL(const CEikMenuPaneItem::SData &, TInt)
IMPORT_C TBool	IsCascadeMenuPane()
IMPORT_C CEikMenuPaneItem *	ItemAndPos(TInt, TInt &)
IMPORT_C CEikMenuPaneItem::SData &	ItemData(TInt)
IMPORT_C CEikMenuPaneItem::SData &	ItemDataByIndexL(TInt)
IMPORT_C TInt	MenuItemCommandId(TInt)
IMPORT_C TBool	MenuItemExists(TInt, TInt &)
IMPORT_C void	MoveHighlightTo(TInt)
IMPORT_C void	NavigateToNextItem()
CEikMenuPane *	NewItemCommandMenuL(MEikMenuObserver *)
IMPORT_C TInt	NumberOfItemsInPane()
virtual IMPORT_C TKeyResponse	OfferKeyEventL(const TKeyEvent &, TEventCode)
IMPORT_C TKeyResponse	OfferKeyEventL(const TKeyEvent &, TEventCode, TBool)
IMPORT_C void	Reset()
IMPORT_C TInt	SelectedItem()
IMPORT_C void	SetArrowHeadScrollBar(TBool)
void	SetDefaultHighlight()
void	SetEmbeddedCba(CEikCba *)
void	SetItemActionsStateL(TBool)
IMPORT_C void	SetItemArray(CItemArray *)
IMPORT_C void	SetItemArrayOwnedExternally(TBool)
IMPORT_C void	SetItemButtonState(TInt, TInt)
void	SetItemCommandsStateL(TBool)
IMPORT_C void	SetItemDimmed(TInt, TBool)
IMPORT_C void	SetItemSpecific(TInt, TBool)
IMPORT_C void	SetItemTextL(TInt, const TDesC &)
IMPORT_C void	SetItemTextL(TInt, TInt)
IMPORT_C void	SetLaunchingButton(CEikButtonBase *)
IMPORT_C void	SetScrollBarOnLeft(TBool)
IMPORT_C void	SetSelectedItem(TInt)
IMPORT_C void	StartDisplayingMenuPane(const CEikHotKeyTable , const TPoint &, const CEikMenuPaneTitle , TInt, TPopupTargetPosType)

Protected Member Functions
virtual IMPORT_C void	ConstructFromResourceL(TResourceReader &)
virtual IMPORT_C void	Draw(const TRect &)
virtual IMPORT_C void	FocusChanged(TDrawNow)
IMPORT_C TTypeUid::Ptr	MopSupplyObject(TTypeUid)
TInt	NumberOfItemsThatFitInView()

Inherited Attributes
	CCoeControl::iCoeEnv
	CCoeControl::iContext
	CCoeControl::iPosition
	CCoeControl::iSize
	CEikBorderedControl::iBorder

Inherited Enumerations
	CCoeControl:TZoomType

Inherited Functions
	CAknControl::CAknControl()
	CAknControl::~CAknControl()
	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()
	CCoeControl::AccumulatedZoom()const
	CCoeControl::ActivateGc()const
	CCoeControl::ActivateL()
	CCoeControl::BackedUpWindow()const
	CCoeControl::Background()const
	CCoeControl::CCoeControl()
	CCoeControl::CCoeControl(CCoeEnv *)
	CCoeControl::CCoeControl(const CCoeControl &)
	CCoeControl::CCoeControlArray
	CCoeControl::CapturesPointer()const
	CCoeControl::ClaimPointerGrab(TBool)
	CCoeControl::ClaimPointerGrab(TInt,TBool)
	CCoeControl::CloseWindow()
	CCoeControl::ComponentArrayExists()const
	CCoeControl::Components()
	CCoeControl::Components()const
	CCoeControl::ControlContext()const
	CCoeControl::ControlEnv()const
	CCoeControl::CopyControlContextFrom(const CCoeControl *)
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
	CCoeControl::CreateWindowL()
	CCoeControl::CreateWindowL(RWindowGroup *)
	CCoeControl::CreateWindowL(RWindowTreeNode &)
	CCoeControl::CreateWindowL(const CCoeControl *)
	CCoeControl::CustomGc()const
	CCoeControl::DeactivateGc()const
	CCoeControl::DrawBackground(const TRect &)const
	CCoeControl::DrawDeferred()const
	CCoeControl::DrawForeground(const TRect &)const
	CCoeControl::DrawNow()const
	CCoeControl::DrawNow(const TRect &)const
	CCoeControl::DrawableWindow()const
	CCoeControl::EnableDragEvents()
	CCoeControl::EnableReportControlStateChange(TBool)
	CCoeControl::EnableWindowTransparency()
	CCoeControl::FindBackground()const
	CCoeControl::FindFontProvider()const
	CCoeControl::GetColor(TInt,TRgb &)const
	CCoeControl::GetGc()const
	CCoeControl::GetHelpContext(TCoeHelpContext &)const
	CCoeControl::GrabbingComponent()const
	CCoeControl::GrabbingComponent(TInt)const
	CCoeControl::HandleComponentControlsResourceChange(TInt)
	CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray ,CCoeControl ,TInt)
	CCoeControl::HandlePointerBufferReadyL()
	CCoeControl::HandleRedrawEvent(const TRect &)const
	CCoeControl::HitTest()const
	CCoeControl::IgnoreEventsUntilNextPointerUp()
	CCoeControl::Index(const CCoeControl *)const
	CCoeControl::InitComponentArrayL()
	CCoeControl::IsActivated()const
	CCoeControl::IsBackedUp()const
	CCoeControl::IsBeingDestroyed()const
	CCoeControl::IsBlank()const
	CCoeControl::IsDimmed()const
	CCoeControl::IsFocused()const
	CCoeControl::IsNonFocusing()const
	CCoeControl::IsReadyToDraw()const
	CCoeControl::IsVisible()const
	CCoeControl::LayoutManager()const
	CCoeControl::MakeVisible(TBool)
	CCoeControl::MaximumWidth()const
	CCoeControl::MinimumSize()
	CCoeControl::NotifyFontChange(const CCoeFontProvider *)
	CCoeControl::Observer()const
	CCoeControl::OverrideColorL(TInt,TRgb)
	CCoeControl::OwnsWindow()const
	CCoeControl::Parent()
	CCoeControl::Parent()const
	CCoeControl::Position()const
	CCoeControl::PositionChanged()
	CCoeControl::PositionRelativeToScreen()const
	CCoeControl::PrepareForFocusGainL()
	CCoeControl::PrepareForFocusLossL()
	CCoeControl::ProcessPointerBufferReadyL()
	CCoeControl::ProcessPointerEventL(const TPointerEvent &)
	CCoeControl::Rect()const
	CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
	CCoeControl::RecursivelyMergedInputCapabilities()const
	CCoeControl::RefetchPixelMappingL()
	CCoeControl::RemoveFromParent()
	CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
	CCoeControl::RequestRelayout(const CCoeControl *)
	CCoeControl::ResetGc()const
	CCoeControl::ScreenFont(const TCoeFont &)const
	CCoeControl::SetAllowStrayPointers()
	CCoeControl::SetBackground(const MCoeControlBackground *)
	CCoeControl::SetBlank()
	CCoeControl::SetCanDrawOutsideRect()
	CCoeControl::SetComponentsToInheritVisibility(TBool)
	CCoeControl::SetContainerWindowL(RBackedUpWindow &)
	CCoeControl::SetContainerWindowL(RWindow &)
	CCoeControl::SetContainerWindowL(const CCoeControl &)
	CCoeControl::SetControlContext(MCoeControlContext *)
	CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
	CCoeControl::SetCustomGc(CWindowGc *)
	CCoeControl::SetDimmed(TBool)
	CCoeControl::SetExtent(const TPoint &,const TSize &)
	CCoeControl::SetExtentToWholeScreen()
	CCoeControl::SetFocus(TBool,TDrawNow)
	CCoeControl::SetFocusing(TBool)
	CCoeControl::SetFontProviderL(const CCoeFontProvider &)
	CCoeControl::SetGc(CWindowGc *)const
	CCoeControl::SetGloballyCapturing(TBool)
	CCoeControl::SetHitTest(const MCoeControlHitTest *)
	CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
	CCoeControl::SetMaximumWidth(TInt)
	CCoeControl::SetMopParent(MObjectProvider *)
	CCoeControl::SetNeighbor(CCoeControl *)
	CCoeControl::SetNonFocusing()
	CCoeControl::SetObserver(MCoeControlObserver *)
	CCoeControl::SetParent(CCoeControl *)
	CCoeControl::SetPointerCapture(TBool)
	CCoeControl::SetPosition(const TPoint &)
	CCoeControl::SetRect(const TRect &)
	CCoeControl::SetSize(const TSize &)
	CCoeControl::SetSizeWithoutNotification(const TSize &)
	CCoeControl::SetTextBaselineSpacing(TInt)
	CCoeControl::SetUniqueHandle(TInt)
	CCoeControl::SetZoomFactorL(TInt,TZoomType)
	CCoeControl::Size()const
	CCoeControl::SizeChanged()
	CCoeControl::SystemGc()const
	CCoeControl::TextBaselineOffset(const TSize &)const
	CCoeControl::TextDrawer(TInt)const
	CCoeControl::UniqueHandle()const
	CCoeControl::Window()const
	CCoeControl::WriteInternalStateNowL(RWriteStream &)const
	CCoeControl::ZoomWithType()const
	CCoeControl::operator=(const CCoeControl &)
	CCoeControl::~CCoeControl()
	CEikBorderedControl::Border()const
	CEikBorderedControl::CEikBorderedControl()
	CEikBorderedControl::CEikBorderedControl(const TGulBorder &)
	CEikBorderedControl::HasBorder()const
	CEikBorderedControl::SetAdjacent(TInt)
	CEikBorderedControl::SetBorder(TGulBorder::TBorderType)
	CEikBorderedControl::SetBorder(TInt)
	CEikBorderedControl::WriteInternalStateL(RWriteStream &)const

Detailed Description

Menu panes are opened by activating the menu title (CEikMenuPaneTitle / MENU_TITLE) which is displayed in the menu bar (CEikMenuBar / MENU_BAR). They can also be cascaded from a menu item (CEikMenuPaneItem / MENU_ITEM) or launched by a menu button (CEikMenuButton).

Menu panes may be defined using a MENU_PANE resource.

Member Type Definition Documentation Typedef THotKeyDisplayText typedef TBuf< 20 > THotKeyDisplayText The text to be displayed for a hotkey. Constructor & Destructor Documentation CEikMenuPane ( MEikMenuObserver * ) IMPORT_C CEikMenuPane ( MEikMenuObserver * aMenuObserver ) C++ default constructor. Constructs a menu pane object with the specified observer. Parameter Description aMenuObserver Menu observer. ~CEikMenuPane ( ) IMPORT_C ~CEikMenuPane ( ) Destructor. Member Function Documentation ActivateCurrentItemL ( ) void ActivateCurrentItemL ( ) Report that selection was done for the currently highlighted item. AddCascadeMenuItemsToMenuL ( TInt, TBool, TBool, CAknItemActionMenuData *, TInt ) void AddCascadeMenuItemsToMenuL ( TInt aCascadeId, TBool aItemSpecific, TBool aAddToItemActionMenu, CAknItemActionMenuData * aMenuData = NULL, TInt aItemIndex = 0 ) Adds cascade menu items to item action menu data. AddMenuItemL ( const CEikMenuPaneItem::SData & ) IMPORT_C void AddMenuItemL ( const CEikMenuPaneItem::SData & aMenuItem ) Adds a menu item dynamically by creating a new menu item, setting its data to aMenuItem and appending it to the pane's menu item array. Updates the menu's scroll bar to take account of the new item. Parameter Description aMenuItem The menu item to add. NOTICE that SData is a structure so all fields in it should be set to avoid any unexpected behaviour. AddMenuItemL ( const CEikMenuPaneItem::SData &, TInt ) IMPORT_C void AddMenuItemL ( const CEikMenuPaneItem::SData & aMenuItem, TInt aPreviousId ) Adds a menu item dynamically by creating a new menu item, setting its data to aMenuItem and inserting it into the pane's menu item array. Updates the menu's scroll bar to take account of the new item. Parameter Description aMenuItem The menu item to add. NOTICE that SData is a structure so all fields in it should be set to avoid any unexpected behaviour. aPreviousId The id of the item after which the new item should be added. AddMenuItemsL ( TInt, TInt, TBool ) IMPORT_C void AddMenuItemsL ( TInt aResourceId, TInt aPreviousId = 0, TBool aAddSeperator = EFalse ) Adds menu items dynamically by creating new menu items from resource and inserts them into the pane's menu item array. Parameter Description aResourceId The ID of the resource for the menu item. aPreviousId The ID of the previous menu item, after which this newly created item should be added. aAddSeperator Shouldn't be used as separator is not not supported anymore. AddMenuItemsToItemActionMenuL ( CAknItemActionMenuData & ) void AddMenuItemsToItemActionMenuL ( CAknItemActionMenuData & aMenuData ) Adds menu items to this menu and item action menu data. CancelActiveMenuPane ( ) TBool CancelActiveMenuPane ( ) Closes cascade menu if there is one and it is active. CascadeMenuPane ( ) IMPORT_C CEikMenuPane * CascadeMenuPane ( ) Gets the menu pane for the cascade menu. Returns: The menu pane for the cascade menu. Close ( ) IMPORT_C void Close ( ) Closes the menu pane. CloseCascadeMenu ( ) IMPORT_C void CloseCascadeMenu ( ) Closes and destroys any current cascade menu and takes focus back. Does nothing if no cascade menu exists. CloseCascadeMenu ( TBool ) void CloseCascadeMenu ( TBool aMainMenuClosing ) Closes and destroys any current cascade menu and takes focus back. Does nothing if no cascade menu exists. Parameter Description aMainMenuClosing ETrue if main menu is also to be closed. ComponentControl ( TInt ) IMPORT_C CCoeControl * ComponentControl ( TInt aIndex ) const [virtual] Reimplemented from CCoeControl::ComponentControl(TInt)const From CoeControl. Gets the specified component of a compound control. This function should? be implemented by all compound controls. Note: Within a compound control, each component control is identified by an index, where the index depends on the order the controls were added: the first is given an index of 0, the next an index of 1, and so on. Parameter Description aIndex The index of the control to get. Returns: The component control with an index of aIndex. ConstructFromResourceL ( TResourceReader & ) IMPORT_C void ConstructFromResourceL ( TResourceReader & aReader ) [protected, virtual] Reimplemented from CCoeControl::ConstructFromResourceL(TResourceReader &) From CCoeControl. Constructs the menu pane using the specified resource reader. Fills the menu item array with the list of menu items provided by the resource file. leave KErrNoMemory Memory allocation failure earlier construction. Parameter Description aReader The resource reader to use. ConstructL ( CEikMenuPane *, MEikMenuObserver * ) IMPORT_C void ConstructL ( CEikMenuPane * aOwner, MEikMenuObserver * aEditMenuObserver = NULL ) Handles 2nd base construction. Completes construction of a menu pane object. Parameter Description aOwner Menu pane owner ( for cascade menu ). aEditMenuObserver Observer for the edit menu. In default this is NULL. ConstructMenuSctRowFromDialogL ( TDes &, TInt ) IMPORT_C void ConstructMenuSctRowFromDialogL ( TDes & aSpecialChars, TInt aResourceId ) Creates and enables a special characters row to be used in the edit menu. The special character row is constructed from the given special character dialog. Since S60 3.2 Parameter Description aSpecialChars Buffer that holds the selected characters after user has selected them. aResourceId The special character dialog resource id that contains a special character table ConstructMenuSctRowFromDialogL ( TInt, TDes &, TInt ) IMPORT_C void ConstructMenuSctRowFromDialogL ( TInt aCharCase, TDes & aSpecialChars, TInt aResourceId ) Creates and enables a special characters row to be used in the edit menu. The special character row is constructed from the given special character dialog. Since S60 3.2 Parameter Description aCharCase the charcase used by menu sct aSpecialChars Buffer that holds the selected characters after user has selected them. aResourceId The special character dialog resource id that contains a special character table ConstructMenuSctRowL ( TDes & ) IMPORT_C void ConstructMenuSctRowL ( TDes & aSpecialChars ) Creates and enables a special characters row to be used in the edit menu. Since S60 3.1 Parameter Description aSpecialChars Buffer that holds the selected characters after user has selected them. ConstructMenuSctRowL ( TDes &, TInt ) IMPORT_C void ConstructMenuSctRowL ( TDes & aSpecialChars, TInt aResourceId ) Creates and enables a special characters row to be used in the edit menu. The special character row is constructed from the given special character table. Since S60 3.1 Parameter Description aSpecialChars Buffer that holds the selected characters after user has selected them. aResourceId The special character table resource id to define the characters in the row. CountComponentControls ( ) IMPORT_C TInt CountComponentControls ( ) const [virtual] Reimplemented from CCoeControl::CountComponentControls()const From CoeControl. Gets the number of controls contained in a compound control. This function should be implemented by all compound controls. Note: In SDK 6.1 this was changed from protected to public. Returns: The number of component controls contained by this control. DeleteBetweenMenuItems ( TInt, TInt ) IMPORT_C void DeleteBetweenMenuItems ( TInt aStartIndex, TInt aEndIndex ) Deletes the items between specified items. Parameter Description aStartIndex The index of the item after which items should be deleted. aEndIndex The index of the item up to which items should be deleted. DeleteMenuItem ( TInt ) IMPORT_C void DeleteMenuItem ( TInt aCommandId ) Deletes the specified item in the menu pane. Parameter Description aCommandId The ID for the item to be deleted. Draw ( const TRect & ) IMPORT_C void Draw ( const TRect & aRect ) const [protected, virtual] Reimplemented from CEikBorderedControl::Draw(const TRect &)const From CCoeControl Draw a control called by window server. All controls, except blank controls, should implement this function. The default implementation draws a blank control. This function is used for window server-initiated redrawing of controls, and for some application-initiated drawing. It should be implemented by each control, but is only called from within CCoeControl's member functions, and not from the derived class. For this reason it is a private member function of CCoeControl. The rectangle aRect indicates the region of the control that needs to be redrawn. The implementation of Draw() must always draw to every pixel within this rectangle. Parameter Description aRect The region of the control to be redrawn. Co-ordinates are relative to the control's origin (top left corner). Optional, not used currently. EnableMarqueeL ( const TBool ) IMPORT_C void EnableMarqueeL ( const TBool aEnable ) Enables or disables text scrolling functionality. It is disabled by default. Parameter Description aEnable ETrue to enable text scrolling functionality. FilterDimmedItems ( ) void FilterDimmedItems ( ) Deletes dimmed items from the menu item array. FocusChanged ( TDrawNow ) IMPORT_C void FocusChanged ( TDrawNow aDrawNow ) [protected, virtual] Reimplemented from CCoeControl::FocusChanged(TDrawNow) From CCoeControl. Takes any action required when the menu pane gains or loses focus, to change its appearance for example. Parameter Description aDrawNow If EDrawNow the menu pane is redrawn. If ENoDrawNow the menu pane is not redrawn. GetColorUseListL ( CArrayFix< TCoeColorUse > & ) IMPORT_C void GetColorUseListL ( CArrayFix< TCoeColorUse > & aColorUseList ) const [virtual] Reimplemented from CEikBorderedControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const From CcoeControl. Gets the list of logical colours employed in the drawing of the control, paired with an explanation of how they are used. Appends the list into aColorUseList. Since 005u Parameter Description aColorUseList The list of colours paired with explanations. HandlePointerEventL ( const TPointerEvent & ) IMPORT_C void HandlePointerEventL ( const TPointerEvent & aPointerEvent ) [virtual] Reimplemented from CEikBorderedControl::HandlePointerEventL(const TPointerEvent &) From CcoeControl. Handles a pointer event on the menu. Parameter Description aPointerEvent The pointer event to handle. HandleResourceChange ( TInt ) IMPORT_C void HandleResourceChange ( TInt aType ) [virtual] Reimplemented from CEikBorderedControl::HandleResourceChange(TInt) From CcoeControl. Handles a change to the menu's resources which are shared across the environment. For example, colours or fonts. Since 005u Parameter Description aType The type of resource that has changed. HideMarkAndUnmark ( TBool ) void HideMarkAndUnmark ( TBool aHide ) Updates flag which is used for hiding mark and unmark -commands from submenus. This is called with ETrue when collection has marked items. Parameter Description aHide ETrue to hide, EFalse to show InputCapabilities ( ) IMPORT_C TCoeInputCapabilities InputCapabilities ( ) const [virtual] Reimplemented from CCoeControl::InputCapabilities()const From CCoeControl. Gets the list box s input capabilities as set through the list box flags. Returns: List box input capabilities. InsertMenuItemL ( const CEikMenuPaneItem::SData &, TInt ) IMPORT_C void InsertMenuItemL ( const CEikMenuPaneItem::SData & aMenuItem, TInt aPosition ) Inserts the menu item to the specified position. Parameter Description aMenuItem The menu item to add. NOTICE SData is the structure and all fileds should be initialized. aPosition The position of newly created item in the array. IsCascadeMenuPane ( ) IMPORT_C TBool IsCascadeMenuPane ( ) const Checks whether the menu pane is a cascade menu or a main menu. Returns: ETrue if the menu pane is cascade menu and EFalse if the menu pane is the main menu. ItemAndPos ( TInt, TInt & ) IMPORT_C CEikMenuPaneItem * ItemAndPos ( TInt aCommandId, TInt & aPos ) Gets a pointer to the specified menu item. Also gets the position of the item within the menu pane. Panics if there are no menu items in the menu pane. Panics if the menu pane id does not identify any menu pane item in the array. panic EEikPanicNoSuchMenuItem Panics if there are no menu items in the menu pane or if the menu pane id does not identify any menu pane item in the array. Parameter Description aCommandId The ID of the menu item for which a pointer is returned. aPos On return, the position of the menu item with an ID of aCommandId. Returns: A pointer to the menu item. ItemData ( TInt ) IMPORT_C CEikMenuPaneItem::SData & ItemData ( TInt aCommandId ) Gets a reference to the data in the specified menu item. Parameter Description aCommandId The command ID of the menu item for which data is obtained. Returns: Reference to struct that contains command id. ItemDataByIndexL ( TInt ) IMPORT_C CEikMenuPaneItem::SData & ItemDataByIndexL ( TInt aItemIndex ) Gets a reference to the data in the specified menu item. Since S60 3.1 leave KErrArgument Wrong . Parameter Description aItemIndex The index of the item in the items array. Returns: The menu item's data. MenuItemCommandId ( TInt ) IMPORT_C TInt MenuItemCommandId ( TInt aIndex ) const Returns the command id of the specified menu item. The function panics if aIndex doesn't exist or is out of range. Since 3.1 Parameter Description aIndex The index of the menu item for which the command ID is returned. MenuItemExists ( TInt, TInt & ) IMPORT_C TBool MenuItemExists ( TInt aCommandId, TInt & aPosition ) Checks whether menu pane contains the menu item and returns position of it if the item is found. Parameter Description aCommandId The command ID of the item to be searched for. aPosition On return contains position of the item. Returns: ETrue if item was found. Otherwise EFalse. MopSupplyObject ( TTypeUid ) IMPORT_C TTypeUid::Ptr MopSupplyObject ( TTypeUid aId ) [protected] Reimplemented from CCoeControl::MopSupplyObject(TTypeUid) From CCoeControl. Retrieves an object of the same type as that encapsulated in aId. Other than in the case where NULL is returned, the object returned must be of the same object type - that is, the ETypeId member of the object pointed to by the pointer returned by this function must be equal to the iUid member of aId. Since SDK 7.0s Parameter Description aId An encapsulated object type ID. Returns: Encapsulates the pointer to the object provided. Note that the encapsulated pointer may be NULL. MoveHighlightTo ( TInt ) IMPORT_C void MoveHighlightTo ( TInt aNewSelectedItem ) Moves the menu pane highlight to a newly selected menu item identified by aNewSelectedItem. Scrolls the menu to show the new selected item if necessary and redraws only the newly selected item and the currently selected item if possible. Parameter Description aNewSelectedItem The newly selected menu item index. NavigateToNextItem ( ) IMPORT_C void NavigateToNextItem ( ) Moves highlight to the next item or to the first one if last item is selected. NewItemCommandMenuL ( MEikMenuObserver * ) CEikMenuPane * NewItemCommandMenuL ( MEikMenuObserver * aObserver ) [static] Symbian two-phased constructor for menu panes that are created for item specific menus. NumberOfItemsInPane ( ) IMPORT_C TInt NumberOfItemsInPane ( ) const Gets the number of menu items within the menu pane. Returns: Number of menu items within menu pane. NumberOfItemsThatFitInView ( ) TInt NumberOfItemsThatFitInView ( ) const [protected] Gets the maximum number of items which can be seen simultaneously. Returns: The maximum number of items which can be seen simultaneously. OfferKeyEventL ( const TKeyEvent &, TEventCode ) IMPORT_C TKeyResponse OfferKeyEventL ( const TKeyEvent & aKeyEvent, TEventCode aType ) [virtual] Reimplemented from CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode) From CcoeControl. Handles key events offered to the menu by the control environment and provides an appropriate implementation of CCoeControl::OfferKeyEventL(). Parameter Description aKeyEvent The key event. aType The type of key event: EEventKey, EEventKeyUp or EEventKeyDown. OfferKeyEventL ( const TKeyEvent &, TEventCode, TBool ) IMPORT_C TKeyResponse OfferKeyEventL ( const TKeyEvent & aKeyEvent, TEventCode aType, TBool aConsumeAllKeys ) From @ CCoeControl Handles key events offered to the menu by the control environment. Since Platform 004. Parameter Description aKeyEvent The key event. aType The type of key event: EEventKey, EEventKeyUp or EEventKeyDown. aConsumeAllKeys If ETrue this function returns EKeyWasConsumed regardless of whether it was used. If EFalse the key event is consumed if possible and either EKeyWasConsumed or EKeyWasNotConsumed is returned as appropriate. Reset ( ) IMPORT_C void Reset ( ) Destroys the menu pane's item array. SelectedItem ( ) IMPORT_C TInt SelectedItem ( ) const Gets the position of the selected menu item. Returns: The position of the selected menu item. SetArrowHeadScrollBar ( TBool ) IMPORT_C void SetArrowHeadScrollBar ( TBool aArrowHead ) Sets whether the menu pane uses an arrow head scroll bar. Parameter Description aArrowHead If ETrue the menu pane uses an arrow head scroll bar. SetDefaultHighlight ( ) void SetDefaultHighlight ( ) Enables the default highlight in menu SetEmbeddedCba ( CEikCba * ) void SetEmbeddedCba ( CEikCba * aCba ) Sets the embedded cba to options menu Since S60 v5.2 Parameter Description aCba Cba to embed to menu SetItemActionsStateL ( TBool ) void SetItemActionsStateL ( TBool aDimmed ) Sets item action commands state. SetItemArray ( CItemArray * ) IMPORT_C void SetItemArray ( CItemArray * aItemArray ) Sets the array containing the list of menu items for the current menu pane. Parameter Description aItemArray The menu item array for the menu pane. SetItemArrayOwnedExternally ( TBool ) IMPORT_C void SetItemArrayOwnedExternally ( TBool aOwnedExternally ) Set menu item array ownership. Parameter Description aOwnedExternally If ETrue the menu pane's menu item array is set as externally owned. If EFalse the menu pane's menu item array is set as not externally owned. SetItemButtonState ( TInt, TInt ) IMPORT_C void SetItemButtonState ( TInt aCommandId, TInt aButtonState ) Sets the item to be indicated or not. It should be used to change the state of radio buttons or check box items. It has real effect only starting from S60 v3.0. Parameter Description aCommandId The command (as defined in an .hrh file) associated with this menu item. This identifies the menu item for which the state is set or unset. aButtonState should be EEikMenuItemSymbolOn or EEikMenuItemSymbolIndeterminate SetItemCommandsStateL ( TBool ) void SetItemCommandsStateL ( TBool aDimmed ) Sets item specific commands state. SetItemDimmed ( TInt, TBool ) IMPORT_C void SetItemDimmed ( TInt aCommandId, TBool aDimmed ) Dims (greys out) or undims a menu item. Dimming indicates that user input is not accepted. Parameter Description aCommandId The command (as defined in an .hrh file) associated with this menu item. This identifies the menu item whose text is to be dimmed or un-dimmed. aDimmed ETrue to dim this menu item. EFalse to un-dim this menu item. SetItemSpecific ( TInt, TBool ) IMPORT_C void SetItemSpecific ( TInt aCommandId, TBool aItemSpecific ) Sets menu item as item specific command. Parameter Description aCommandId The command associated with this menu item. aItemSpecific ETrue to define the menu item item specific, EFalse otherwise. SetItemTextL ( TInt, const TDesC & ) IMPORT_C void SetItemTextL ( TInt aCommandId, const TDesC & aDes ) Sets the text in a menu item. Parameter Description aCommandId The command (as defined in an .hrh file) associated with this menu item. This identifies the menu item whose text is to be set. aDes New item text. SetItemTextL ( TInt, TInt ) IMPORT_C void SetItemTextL ( TInt aCommandId, TInt aRid ) Sets the text in a menu item from resource. Parameter Description aCommandId The command (as defined in an .hrh file) associated with this menu item. This identifies the menu item whose text is to be set. aRid The resource ID of the menu item text. SetLaunchingButton ( CEikButtonBase * ) IMPORT_C void SetLaunchingButton ( CEikButtonBase * aButton ) Sets the specified button to launch the menu pane. Doesn't have any effect in current implementation. Parameter Description aButton The button to set as launching the menu. SetScrollBarOnLeft ( TBool ) IMPORT_C void SetScrollBarOnLeft ( TBool aOnLeft ) Sets whether the scroll bar occupies the left side of the menu pane. Parameter Description aOnLeft If ETrue the scroll bar will occupy the left side of the menu pane. SetSelectedItem ( TInt ) IMPORT_C void SetSelectedItem ( TInt aSelectedItem ) Sets the selected menu item. Parameter Description aSelectedItem The index of the item to get selected StartDisplayingMenuPane ( const CEikHotKeyTable *, const TPoint &, const CEikMenuPaneTitle *, TInt, TPopupTargetPosType ) IMPORT_C void StartDisplayingMenuPane ( const CEikHotKeyTable * aHotKeyTable, const TPoint & aTargetPos, const CEikMenuPaneTitle * aMenuPaneTitle, TInt aMinWidth, TPopupTargetPosType aTargetType = EPopupTargetTopLeft ) Displays the menu pane with the corner identified by aTargetType in the position specified by aTargetPos. This function uses aMinTitleWidth to calculate the area required to display the menu pane, taking into account whether the menu is a cascading menu or popup menu. Parameter Description aHotKeyTable Optional hotkey table. aTargetPos Position of the corner of the menu pane identified by aTargetType. aMenuPaneTitle The menu pane's title. aMinWidth Minimum width of the menu's title. aTargetType The corner of the menu pane to which aTargetPos relates. The default is the top left corner. Possible: EPopupTargetTopLeft, EPopupTargetTopRight, , EPopupTargetBottomRight. © Nokia 2011.

void	AddCascadeMenuItemsToMenuL	(	TInt	aCascadeId,
			TBool	aItemSpecific,
			TBool	aAddToItemActionMenu,
			CAknItemActionMenuData *	aMenuData = NULL,
			TInt	aItemIndex = 0
		)

IMPORT_C void	AddMenuItemL	(	const CEikMenuPaneItem::SData &	aMenuItem,
			TInt	aPreviousId
		)

Parameter	Description
aMenuItem	The menu item to add. NOTICE that SData is a structure so all fields in it should be set to avoid any unexpected behaviour.
aPreviousId	The id of the item after which the new item should be added.

IMPORT_C void	AddMenuItemsL	(	TInt	aResourceId,
			TInt	aPreviousId = 0,
			TBool	aAddSeperator = EFalse
		)

Parameter	Description
aResourceId	The ID of the resource for the menu item.
aPreviousId	The ID of the previous menu item, after which this newly created item should be added.
aAddSeperator	Shouldn't be used as separator is not not supported anymore.

IMPORT_C void	ConstructL	(	CEikMenuPane *	aOwner,
			MEikMenuObserver *	aEditMenuObserver = NULL
		)

Parameter	Description
aOwner	Menu pane owner ( for cascade menu ).
aEditMenuObserver	Observer for the edit menu. In default this is NULL.

IMPORT_C void	ConstructMenuSctRowFromDialogL	(	TDes &	aSpecialChars,
			TInt	aResourceId
		)

Parameter	Description
aSpecialChars	Buffer that holds the selected characters after user has selected them.
aResourceId	The special character dialog resource id that contains a special character table

Parameter	Description
aCharCase	the charcase used by menu sct
aSpecialChars	Buffer that holds the selected characters after user has selected them.
aResourceId	The special character dialog resource id that contains a special character table

IMPORT_C void	ConstructMenuSctRowL	(	TDes &	aSpecialChars,
			TInt	aResourceId
		)

IMPORT_C void	DeleteBetweenMenuItems	(	TInt	aStartIndex,
			TInt	aEndIndex
		)

Parameter	Description
aStartIndex	The index of the item after which items should be deleted.
aEndIndex	The index of the item up to which items should be deleted.

IMPORT_C void	InsertMenuItemL	(	const CEikMenuPaneItem::SData &	aMenuItem,
			TInt	aPosition
		)

Parameter	Description
aMenuItem	The menu item to add. NOTICE SData is the structure and all fileds should be initialized.
aPosition	The position of newly created item in the array.

IMPORT_C CEikMenuPaneItem *	ItemAndPos	(	TInt	aCommandId,
			TInt &	aPos
		)

Parameter	Description
aCommandId	The ID of the menu item for which a pointer is returned.
aPos	On return, the position of the menu item with an ID of aCommandId.

IMPORT_C TBool	MenuItemExists	(	TInt	aCommandId,
			TInt &	aPosition
		)

Parameter	Description
aCommandId	The command ID of the item to be searched for.
aPosition	On return contains position of the item.

IMPORT_C TKeyResponse	OfferKeyEventL	(	const TKeyEvent &	aKeyEvent,
			TEventCode	aType
		)	[virtual]

Parameter	Description
aKeyEvent	The key event.
aType	The type of key event: EEventKey, EEventKeyUp or EEventKeyDown.

IMPORT_C void	SetItemButtonState	(	TInt	aCommandId,
			TInt	aButtonState
		)

Parameter	Description
aCommandId	The command (as defined in an .hrh file) associated with this menu item. This identifies the menu item for which the state is set or unset.
aButtonState	should be EEikMenuItemSymbolOn or EEikMenuItemSymbolIndeterminate

Parameter	Description
aCommandId	The command (as defined in an .hrh file) associated with this menu item. This identifies the menu item whose text is to be dimmed or un-dimmed.
aDimmed	ETrue to dim this menu item. EFalse to un-dim this menu item.

IMPORT_C void	SetItemSpecific	(	TInt	aCommandId,
			TBool	aItemSpecific
		)

Parameter	Description
aCommandId	The command associated with this menu item.
aItemSpecific	ETrue to define the menu item item specific, EFalse otherwise.

Parameter	Description
aCommandId	The command (as defined in an .hrh file) associated with this menu item. This identifies the menu item whose text is to be set.
aDes	New item text.

Parameter	Description
aCommandId	The command (as defined in an .hrh file) associated with this menu item. This identifies the menu item whose text is to be set.
aRid	The resource ID of the menu item text.

IMPORT_C void	StartDisplayingMenuPane	(	const CEikHotKeyTable *	aHotKeyTable,
			const TPoint &	aTargetPos,
			const CEikMenuPaneTitle *	aMenuPaneTitle,
			TInt	aMinWidth,
			TPopupTargetPosType	aTargetType = EPopupTargetTopLeft
		)

Parameter	Description
aHotKeyTable	Optional hotkey table.
aTargetPos	Position of the corner of the menu pane identified by aTargetType.
aMenuPaneTitle	The menu pane's title.
aMinWidth	Minimum width of the menu's title.
aTargetType	The corner of the menu pane to which aTargetPos relates. The default is the top left corner. Possible: EPopupTargetTopLeft, EPopupTargetTopRight, , EPopupTargetBottomRight.