CEikMenuBar Class Reference

IMPORT_C CEikMenuBar::~CEikMenuBar

Public Since 3rd Ed FP1.

Enumerator:

EMenuOptions�	Options menu launched from the Options softkey. This is the default value. Public since 3rd Ed FP1
EMenuContext�	Context sensitive menu that is launched from selection key when the application supports it. Public since 3rd Ed FP1
EMenuEdit�	Edit menu containing editing specific items. Public since 3rd Ed FP1
EMenuOptionsNoTaskSwapper�	Options menu launched from the Options softkey. Task swapper item is not shown. Public since 3rd Ed FP1

Constructor & Destructor Documentation

IMPORT_C CEikMenuBar::CEikMenuBar

�	Destructor.

�	C++ default constructor.

Member Function Documentation

IMPORT_C void CEikMenuBar::ChangeMenuBarL	(�	TInt�	aHotKeyResourceId = `0`,
		TInt�	aMenuTitleResourceId = `0`,
		TInt�	aDisplayNow = `ETrue`
	)�

IMPORT_C void CEikMenuBar::ConstructFromResourceL

Not implemented.

Parameters:

	aHotKeyResourceId�	Not used.
	aMenuTitleResourceId�	Not used.
	aDisplayNow�	Not used.

Second phase constructor for a menu bar which builds the menu bar from the given resource file.

Parameters:

aReader�

The resource reader.

IMPORT_C void CEikMenuBar::ConstructL	(�	MEikMenuObserver *�	aMenuObserver,
		TInt�	aHotKeyResourceId = `0`,
		TInt�	aMenuTitleResourceId = `0`
	)�

IMPORT_C void CEikMenuBar::Draw

Second phase constructor for a menu bar.

Parameters:

	aMenuObserver�	The menu's observer.
	aHotKeyResourceId�	The ID of the resource, of type HOTKEY from which the hotkey table is created. This is optional. By default it's nil.
	aMenuTitleResourceId�	The ID of the resource, of type `MENU_BAR` from which the menu title array is created. This is optional. By default it's nil.

CEikMenuBar::DECLARE_TYPE_ID (� 0x101F4106� �)� [inline]

�	Specifies the menu item within the menu pane. Index of a title in the menu bar. Index of an item in a menu pane.

From CCoeControl.

Not implemented.

Parameters:

Not�

used.

Reimplemented from CEikBorderedControl.

IMPORT_C void CEikMenuBar::DrawItem

Not implemented.

Parameters:

aItem�

virtual IMPORT_C void CEikMenuBar::FindCommandIdInResourceL	(�	TInt�	aCommandId,
		TInt &�	aPaneindex,
		TInt &�	aItemindex
	)�	`[virtual]`

Searches for the menu item that corresponds to the specified command.

Parameters:

	aCommandId�	The ID to search for.
	aPaneindex�	Menu pane index.
	aItemindex�	Menu item index.

virtual IMPORT_C void CEikMenuBar::GetColorUseListL (� CArrayFix< TCoeColorUse > &� aColorUseList �)� const [virtual]

IMPORT_C void CEikMenuBar::HandlePointerEventL

From CCoeControl.

Gets the list of logical colours used to draw the control.

The list includes an explanation of how each colour is used. By default, this function has an empty implementation.

Parameters:

aColorUseList�

The colour list.

Reimplemented from CEikBorderedControl.

const TPointerEvent &�

aPointerEvent

From CCoeControl.

Handles pointer events. This function gets called whenever a pointer event occurs in the control, i.e. when the pointer is within the control's extent, or when the control has grabbed the pointer. The control should implement this function to handle pointer events.

Note: events of type EButton1Down are processed before HandlePointerEventL() is called, in order to transfer keyboard focus to the control in which the EButton1Down event occurred.

If overriding HandlePointerEventL(), the implementation must include a base call to CCoeControl's HandlePointerEventL().

Parameters:

aPointerEvent�

The pointer event.

Reimplemented from CEikBorderedControl.

virtual IMPORT_C void CEikMenuBar::HandleResourceChange (� TInt� aType �)� [virtual]

IMPORT_C TBool CEikMenuBar::IsDisplayed

From CCoeControl.

Handles a change to the control's resources.

The types of resources handled are those which are shared across the environment, e.g. colours or fonts.

Parameters:

aType� A message UID value. The most common is KEikMessageColorSchemeChange which controls get when the colour scheme is changed. Other examples include: KEikMessageFadeAllWindows, KEikMessageUnfadeWindows, KEikMessageZoomChange, KEikMessageVirtualCursorStateChange, KEikMessageCapsLock, KEikMessagePrepareForSave.

Reimplemented from CEikBorderedControl.

CEikHotKeyTable* CEikMenuBar::HotKeyTable (� �)� const [inline]

�	Gets a pointer to the menu’s hot key table.

IMPORT_C CEikMenuPane* CEikMenuBar::MenuPane

�	Allows the client to determine if the menubar instance is displayed. Returns: `Etrue` if displayed and `EFalse` if not.

�	Gets a menu pane resource. Returns: The pointer to `CEikMenuPane` object containing a menu pane resource.

IMPORT_C void CEikMenuBar::MoveHighlightToL	(�	TInt�	aNewSelectedTitle,
		TInt�	aNewSelectedItem = `0`
	)�

Not implemented.

Parameters:

	aNewSelectedTitle�	Not used
	aNewSelectedItem�	Not used.

IMPORT_C TKeyResponse CEikMenuBar::OfferKeyEventL	(�	const TKeyEvent &�	aKeyEvent,
		TEventCode�	aType
	)�

IMPORT_C void CEikMenuBar::ReduceRect

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`.

Returns:: Indicates whether or not the key event was used by this control.

If the menu bar is visible, removes the menu bar height from the top of aRect and returns the new rectangle in a new value of aRect.

Parameters:

[in,out]� aRect� A rectangle that on return is reduced in height by the height of the menu bar.

IMPORT_C void CEikMenuBar::RemoveEditMenuObserver

Sets the menu observer interface to NULL.

Parameters:

aEditMenuObserver� Menu observer interface that will be set to NULL.

IMPORT_C TInt CEikMenuBar::SelectedItem

IMPORT_C TInt CEikMenuBar::SelectedTitle

�	Gets the index of the menu item selected by the cursor. Returns: The index of the selected menu item.

IMPORT_C void CEikMenuBar::SetContextMenuTitleResourceId

�	Gets the index of the menu pane selected by the cursor. Returns: The index of the selected menu pane.

TInt�

aMenuTitleResourceId

IMPORT_C void CEikMenuBar::SetEditMenuObserver

Public since 3rd Ed FP1.

Parameters:

aMenuTitleResourceId�

Sets menu observer interface.

Parameters:

aEditMenuObserver�

Menu observer interface.

IMPORT_C CEikHotKeyTable* CEikMenuBar::SetHotKeyTable

Not implemented!

Parameters:

aHotKeyTable�

IMPORT_C SCursor CEikMenuBar::SetMenuCursor

Returns:: NULL.

Sets the cursor to the specifed menu pane and menu item.

Parameters:

aCursor�

The menu pane and menu item to which the cursor is set.

Returns:: A SCursor structure holding the menu item within the menu pane.

IMPORT_C void CEikMenuBar::SetMenuTitleArray

Not implemented.

Parameters:

aTitleArray�

IMPORT_C void CEikMenuBar::SetMenuTitleResourceId

TInt�

aMenuTitleResourceId

The ID of the resource to use.

Sets the menu’s resource ID.

Parameters:

aMenuTitleResourceId�

IMPORT_C void CEikMenuBar::SetMenuType

Sets type of the menu.

Menu can be for example Options menu launched from Options softkey or context sensitive menu launched from the selection key. By default the launched menu is options menu. Public since 3rd Ed FP1

Parameters:

aMenuType�

One of values of CEikMenuBar::TMenuType enumeration.

IMPORT_C void CEikMenuBar::SetTitleArrayOwnedExternally

Not implemented.

Parameters:

aOwnedExternally�

IMPORT_C void CEikMenuBar::StopDisplayingMenuBar

IMPORT_C CTitleArray* CEikMenuBar::TitleArray

�	Stops displaying the menu bar. This function causes the menu bar to disappear from the screen until it is invoked again by the user. In most circumstances this is done by the `Uikon` framework, so an application program will not normally need to use this function.

IMPORT_C void CEikMenuBar::TryDisplayContextMenuBarL

�	Gets array of information about the menu bar titles. Returns: Pointer to `CTitleArray` object containing array of information about menu bar titles.

IMPORT_C void CEikMenuBar::TryDisplayMenuBarL

�	Public Since 3rd Ed FP1.

IMPORT_C void CEikMenuBar::TryDisplayMenuBarWithoutFepMenusL

�	Displays the menu bar. If the menu is not already displayed, this function displays the menu bar and allows the user to make a selection. In most circumstances this is done by the `Uikon` framework, so an application program will not normally need to use this function.

friend class CEikMenuBarExtension [friend]

�	If the menu is not already displayed, this function displays the menu bar without fep menu and allows the user to make a selection. In most circumstances this is done by the `Uikon` framework, so an application program will not normally need to use this function.

Friends And Related Function Documentation

friend class CEikMenuPaneTitle [friend]