CEikMenuPane Class Reference

Public Types

Public Member Functions

Protected Member Functions

Friends

Data Structures

The text to be displayed for a hotkey.

Destructor.

C++ default constructor.

Constructs a menu pane object with the specified observer.

Parameters:

aMenuObserver

Menu observer.

Report that selection was done for the currently highlighted item.

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.

Parameters:

	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.

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.

Parameters:

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.

Adds menu items dynamically by creating new menu items from resource and inserts them into the pane's menu item array.

Parameters:

	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.

Closes cascade menu if there is one and it is active.

Gets the menu pane for the cascade menu.

Returns:

The menu pane for the cascade menu.

Not implemented.

Parameters:

aWidth

Not used.

Closes the menu pane.

Closes and destroys any current cascade menu and takes focus back.

Does nothing if no cascade menu exists.

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.

Parameters:

[in,out]

aIndex

The index of the control to get.

Returns:

The component control with an index of aIndex.

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.

Parameters:

aReader

The resource reader to use.

Leave:

KErrNoMemory Memory allocation failure earlier construction.

Handles 2nd base construction.

Completes construction of a menu pane object.

Parameters:

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

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.

Parameters:

	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

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.

Parameters:

	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

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.

Parameters:

	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.

Creates and enables a special characters row to be used in the edit menu.

Parameters:

aSpecialChars

Buffer that holds the selected characters after user has selected them.

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.

Deletes the items between specified items.

Parameters:

	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.

Deletes the specified item in the menu pane.

Parameters:

aCommandId

The ID for the item to be deleted.

Disables sliding effect By default is enabled if there is enough memory.

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.

Parameters:

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.

Reimplemented from CEikBorderedControl.

Enables or disables text scrolling functionality.

It is disabled by default.

Parameters:

aEnable

ETrue to enable text scrolling functionality.

Deletes dimmed items from the menu item array.

From CCoeControl.

Takes any action required when the menu pane gains or loses focus, to change its appearance for example.

Parameters:

aDrawNow

If EDrawNow the menu pane is redrawn. If ENoDrawNow the menu pane is not redrawn.

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.

Parameters:

aColorUseList

The list of colours paired with explanations.

Reimplemented from CEikBorderedControl.

From CcoeControl.

Handles a pointer event on the menu.

Parameters:

aPointerEvent

The pointer event to handle.

Reimplemented from CEikBorderedControl.

From CcoeControl.

Handles a change to the menu's resources which are shared across the environment. For example, colours or fonts.

Parameters:

aType

The type of resource that has changed.

Reimplemented from CEikBorderedControl.

From CCoeControl.

Gets the list box’s input capabilities as set through the list box flags.

Returns:

List box input capabilities.

Inserts the menu item to the specified position.

Parameters:

	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.

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.

Checks if the position of the menu was set from outside.

Returns:

ETrue in case when position of the menu was set from outside.

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.

Parameters:

	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.

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.

Gets a reference to the data in the specified menu item.

Parameters:

aCommandId

The command ID of the menu item for which data is obtained.

Returns:

Reference to struct that contains command id.

Gets a reference to the data in the specified menu item.

Parameters:

aItemIndex

The index of the item in the items array.

Returns:

The menu item's data.

Leave:

KErrArgument Wrong .

Returns the command id of the specified menu item.

The function panics if aIndex doesn't exist or is out of range.

Parameters:

aIndex

The index of the menu item for which the command ID is returned.

Checks whether menu pane contains the menu item and returns position of it if the item is found.

Parameters:

[in]	aCommandId	The command ID of the item to be searched for.
[out]	aPosition	On return contains position of the item.

Returns:

ETrue if item was found. Otherwise EFalse.

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.

Parameters:

aId

An encapsulated object type ID.

Returns:

Encapsulates the pointer to the object provided. Note that the encapsulated pointer may be NULL.

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.

Parameters:

aNewSelectedItem

The newly selected menu item index.

Moves highlight to the next item or to the first one if last item is selected.

Gets the number of menu items within the menu pane.

Returns:

Number of menu items within menu pane.

Gets the maximum number of items which can be seen simultaneously.

Returns:

The maximum number of items which can be seen simultaneously.

From @ CCoeControl.

Handles key events offered to the menu by the control environment.

Parameters:

	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.

From CcoeControl.

Handles key events offered to the menu by the control environment and provides an appropriate implementation of CCoeControl::OfferKeyEventL().

Parameters:

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

Destroys the menu pane's item array.

Gets the position of the selected menu item.

Returns:

The position of the selected menu item.

Sets whether the menu pane uses an arrow head scroll bar.

Parameters:

aArrowHead

If ETrue the menu pane uses an arrow head scroll bar.

Sets the array containing the list of menu items for the current menu pane.

Parameters:

aItemArray

The menu item array for the menu pane.

Set menu item array ownership.

Parameters:

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.

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.

Parameters:

	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

Dims (greys out) or undims a menu item.

Dimming indicates that user input is not accepted.

Parameters:

	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.

Sets the text in a menu item from resource.

Parameters:

	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.

Sets the text in a menu item.

Parameters:

	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.

Sets the specified button to launch the menu pane.

Doesn't have any effect in current implementation.

Parameters:

aButton

The button to set as launching the menu.

The position of the menu will be changed according to the one which is specified by arguments in StartDisplayingMenuPane() By default those arguments are not used.

Parameters:

aForced

Etrue if arguments are used.

Sets whether the scroll bar occupies the left side of the menu pane.

Parameters:

aOnLeft

If ETrue the scroll bar will occupy the left side of the menu pane.

Sets the selected menu item.

Parameters:

aSelectedItem

The index of the item to get selected

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.

Parameters:

	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.