CEikMenuBar Class Reference
class CEikMenuBar : public CEikBorderedControl |
Menu bars are constructed from MENU_BAR resources and issue application commands which should be handled by overriding CEikAppUi::HandleCommandL().
Nested Classes and Structures
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::CapturesPointer()const |
| CCoeControl::ClaimPointerGrab(TBool) |
| CCoeControl::ClaimPointerGrab(TInt,TBool) |
| CCoeControl::CloseWindow() |
| CCoeControl::ComponentArrayExists()const |
| CCoeControl::ComponentControl(TInt)const |
| CCoeControl::Components() |
| CCoeControl::Components()const |
| CCoeControl::ControlContext()const |
| CCoeControl::ControlEnv()const |
| CCoeControl::CopyControlContextFrom(const CCoeControl *) |
| CCoeControl::CountComponentControls()const |
| 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::FocusChanged(TDrawNow) |
| 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 |
Constructor & Destructor Documentation
Member Functions Documentation
AddFEPMenuL()
void | AddFEPMenuL | ( | ) | [private] |
AddMenuIfNotPresentL(TInt)
void | AddMenuIfNotPresentL | ( | TInt | aResourceId | ) | [private] |
ChangeMenuBarL(TInt, TInt, TInt)
IMPORT_C void | ChangeMenuBarL | ( | TInt | aHotKeyResourceId = 0, |
| TInt | aMenuTitleResourceId = 0, |
| TInt | aDisplayNow = ETrue |
| ) | |
Parameters
TInt aHotKeyResourceId = 0 | Not used. |
TInt aMenuTitleResourceId = 0 | Not used. |
TInt aDisplayNow = ETrue | Not used. |
CloseState()
void | CloseState | ( | ) | [private] |
ConstructFromResourceL(TResourceReader &)
Second phase constructor for a menu bar which builds the menu bar from the given resource file.
Constructs the menu bar using the resource reader aReader.
ConstructL(MEikMenuObserver *, TInt, TInt)
Second phase constructor for a menu bar.
Parameters
MEikMenuObserver * aMenuObserver | The menu's observer. |
TInt aHotKeyResourceId = 0 | The ID of the resource, of type HOTKEY from which the hotkey table is created. This is optional. By default it's nil. |
TInt aMenuTitleResourceId = 0 | 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. |
CreateTitleArrayL()
void | CreateTitleArrayL | ( | ) | [private] |
Creates a new menu bar title array if one does not already exist. Resets and destroys the elements of an existing array..
Draw(const TRect &)
IMPORT_C void | Draw | ( | const TRect & | aRect | ) | const [virtual] |
DrawItem(TInt)
IMPORT_C void | DrawItem | ( | TInt | aItem | ) | const |
ExtensionInterface(TUid)
IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
FindCommandIdInResourceL(TInt, TInt &, TInt &)
IMPORT_C void | FindCommandIdInResourceL | ( | TInt | aCommandId, |
| TInt & | aPaneindex, |
| TInt & | aItemindex |
| ) | [virtual] |
Searches for the menu item that corresponds to the specified command.
Parameters
TInt aCommandId | The ID to search for. |
TInt & aPaneindex | Menu pane index. |
TInt & aItemindex | Menu item index. |
GetColorUseListL(CArrayFix< TCoeColorUse > &)
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.
- Since
- 5.1 SDK.
Gets the list of logical colors employed in the drawing of the control, paired with an explanation of how they are used. Appends the list to aColorUseList.
HandlePointerEventL(const TPointerEvent &)
IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
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
const TPointerEvent & aPointerEvent | The pointer event. |
HandleResourceChange(TInt)
IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
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.
- Since
- 5.1 SDK.
Handles a change to the control's resources of type aType which are shared across the environment, e.g. colors or fonts.
Parameters
TInt 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. |
HideMenuPane()
void | HideMenuPane | ( | ) | [private] |
HotKeyTable()
Gets a pointer to the menu s hot key table.
IsDisplayed()
IMPORT_C TBool | IsDisplayed | ( | ) | |
Allows the client to determine if the menubar instance is displayed.
Allows the client to determine if the menubar instance is displayed ("UP")
ItemActionMenu()
CAknItemActionMenu * | ItemActionMenu | ( | ) | const |
Provides pointer to item action menu.
ItemSpecificCommandsEnabled()
IMPORT_C TBool | ItemSpecificCommandsEnabled | ( | ) | const |
Returns ETrue when item specific commands are enabled in menu bar (main pane collection has a highlight) and EFalse when they are disabled (main pane collection does not have a highlight).
MenuHasItems()
TBool
| MenuHasItems | ( | ) | const [private, inline] |
MenuHasPane()
TBool
| MenuHasPane | ( | ) | const [private, inline] |
MenuPane()
Gets a menu pane resource.
MopSupplyObject(TTypeUid)
MoveHighlightToL(TInt, TInt)
IMPORT_C void | MoveHighlightToL | ( | TInt | aNewSelectedTitle, |
| TInt | aNewSelectedItem = 0 |
| ) | |
Parameters
TInt aNewSelectedTitle | Not used |
TInt aNewSelectedItem = 0 | Not used. |
OfferKeyEventL(const TKeyEvent &, TEventCode)
Parameters
const TKeyEvent & aKeyEvent | The key event. |
TEventCode aType | The type of key event: EEventKey, EEventKeyUp or EEventKeyDown. |
PopulateItemActionMenuL(CAknItemActionMenu &)
CEikMenuPane * | PopulateItemActionMenuL | ( | CAknItemActionMenu & | aItemActionMenu | ) | |
Populates item action menu.
Parameters
CAknItemActionMenu & aItemActionMenu | |
ProcessCommandL(TInt)
void | ProcessCommandL | ( | TInt | aCommandId | ) | [private] |
ReduceRect(TRect &)
IMPORT_C void | ReduceRect | ( | TRect & | aRect | ) | const |
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
TRect & aRect | A rectangle that on return is reduced in height by the height of the menu bar. |
RemoveEditMenuObserver(MEikMenuObserver *)
Sets the menu observer interface to NULL.
Parameters
MEikMenuObserver * aEditMenuObserver | Menu observer interface that will be set to NULL. |
Reserved_1()
IMPORT_C void | Reserved_1 | ( | ) | [private] |
Reserved_2()
IMPORT_C void | Reserved_2 | ( | ) | [private, virtual] |
ResetTitleArray()
void | ResetTitleArray | ( | ) | [private] |
Resets the menu bar's title array and destroys its elements.
SaveCurrentMenuPositionL()
void | SaveCurrentMenuPositionL | ( | ) | [private] |
SelectedItem()
IMPORT_C TInt | SelectedItem | ( | ) | |
Gets the index of the menu item selected by the cursor.
SelectedTitle()
IMPORT_C TInt | SelectedTitle | ( | ) | |
Gets the index of the menu pane selected by the cursor.
SetContextMenuTitleResourceId(TInt)
IMPORT_C void | SetContextMenuTitleResourceId | ( | TInt | aMenuTitleResourceId | ) | |
Parameters
TInt aMenuTitleResourceId | |
SetCursorPositionFromArray()
void | SetCursorPositionFromArray | ( | ) | [private] |
SetEditMenuObserver(MEikMenuObserver *)
Sets menu observer interface.
SetHotKeyTable(CEikHotKeyTable *)
SetItemActionMenu(CAknItemActionMenu *)
void | SetItemActionMenu | ( | CAknItemActionMenu * | aItemActionMenu | ) | |
Sets item action menu instance to menu bar.
Parameters
CAknItemActionMenu * aItemActionMenu | |
SetMenuCursor(const SCursor &)
Sets the cursor to the specifed menu pane and menu item.
Parameters
const SCursor & aCursor | The menu pane and menu item to which the cursor is set. |
SetMenuHasItems()
void | SetMenuHasItems | ( | ) | [private, inline] |
SetMenuHasPane()
void | SetMenuHasPane | ( | ) | [private, inline] |
SetMenuPaneFlag(TInt)
void | SetMenuPaneFlag | ( | TInt | aFlag | ) | [private] |
Sets the flags on the menu pane owned by the menu bar to aFlags.
SetMenuTitleArray(CTitleArray *)
IMPORT_C void | SetMenuTitleArray | ( | CTitleArray * | aTitleArray | ) | |
SetMenuTitleResourceId(TInt)
IMPORT_C void | SetMenuTitleResourceId | ( | TInt | aMenuTitleResourceId | ) | |
Sets the menu s resource ID.
Parameters
TInt aMenuTitleResourceId | The ID of the resource to use. |
SetMenuType(TMenuType)
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.
- Since
- S60 3.1
Parameters
TMenuType aMenuType | One of values of CEikMenuBar::TMenuType enumeration. |
SetTitleArrayOwnedExternally(TBool)
IMPORT_C void | SetTitleArrayOwnedExternally | ( | TBool | aOwnedExternally | ) | |
Not implemented.
Sets the menu bar title array to be owned externally if aOwnedExternally is ETrue.
since ER5U
Parameters
TBool aOwnedExternally | Not used. |
StartDisplayingMenuBarL()
void | StartDisplayingMenuBarL | ( | ) | [private] |
StopDisplayingMenuBar()
IMPORT_C void | StopDisplayingMenuBar | ( | ) | |
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.
TitleArray()
Gets array of information about the menu bar titles.
TitleArrayOwnedExternally()
TBool
| TitleArrayOwnedExternally | ( | ) | const [private, inline] |
TryDisplayContextMenuBarL()
IMPORT_C void | TryDisplayContextMenuBarL | ( | ) | |
TryDisplayMenuBarL()
IMPORT_C void | TryDisplayMenuBarL | ( | ) | |
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.
TryDisplayMenuBarWithoutFepMenusL()
IMPORT_C void | TryDisplayMenuBarWithoutFepMenusL | ( | ) | |
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.
UpdateTitleTextBaseline()
void | UpdateTitleTextBaseline | ( | ) | [private] |
Member Enumerations Documentation
Enum TEikMenuFlags
Enumerators
ETitleArrayOwnedExternally = 0x01 | |
EMenuHasItems = 0x02 | |
EMenuHasPane = 0x04 | |
EBackgroundFaded = 0x08 | |
ESoundsInstalled = 0x10 | |
Enum TMenuType
Enumerators
EMenuOptions = 0 |
Options menu launched from the Options softkey. This is the default value.
|
EMenuContext = 1 |
Context sensitive menu that is launched from selection key when the application supports it.
|
EMenuEdit = 2 |
Edit menu containing editing specific items.
|
EMenuOptionsNoTaskSwapper = 3 |
Options menu launched from the Options softkey. Task swapper item is not shown.
|
Member Data Documentation
MEikMenuObserver * iActiveEditMenuObserver
MEikMenuObserver * iEditMenuObserver
CEikMenuBarExtension * iExt
CEikMenuBarExtension * | iExt | [private] |
CEikHotKeyTable * iHotKeyTable
CEikButtonGroupContainer * iMenuCba
CEikButtonGroupContainer * | iMenuCba | [private] |
TInt
iMenuHotKeyResourceId
TInt
| iMenuHotKeyResourceId | [private] |
MEikMenuObserver * iMenuObserver
TInt
iMenuPaneResourceId
TInt
| iMenuPaneResourceId | [private] |
TInt
iMenuTitleLeftSpace
TInt
| iMenuTitleLeftSpace | [private] |
TInt
iMenuTitleResourceId
TInt
| iMenuTitleResourceId | [private] |
CArrayFixFlat< SPosition > * iPastMenuPosArray
TBool
iPreventFepMenu
TBool
| iPreventFepMenu | [private] |
TInt
iSelectedTitle
TInt
| iSelectedTitle | [private] |
CTitleArray * iTitleArray
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.