Home · All Classes · Main Classes · Deprecated
Public Slots | Signals | Public Member Functions | Properties

MNavigationBar Class Reference

MNavigationBar implements a navigation bar with viewmenu. More...

Inherits MSceneWindow.

List of all members.

Public Slots

void notifyUser ()
void dockToolBar (MToolBar *toolbar)
void undockToolBar ()
void setViewMenuDescription (const QString &text)
void setViewMenuIconID (const QString &id)
void setProgressIndicatorVisible (bool visible)
void setArrowIconVisible (bool visible)
void setEscapeButtonMode (MNavigationBarModel::EscapeButtonModeEnum newMode)
void setEscapeButtonEnabled (bool enabled)
void setEscapeButtonVisible (bool visible)

Signals

void viewmenuTriggered ()
void backButtonClicked ()
void closeButtonClicked ()

Public Member Functions

 MNavigationBar ()
 MNavigationBar (QGraphicsItem *parent)
virtual ~MNavigationBar ()
QString viewMenuIconID () const
bool isProgressIndicatorVisible () const
bool isArrowIconVisible () const
MNavigationBarModel::EscapeButtonModeEnum escapeButtonMode () const
bool escapeButtonEnabled () const
bool escapeButtonVisible () const

Properties

MNavigationBarModel::EscapeButtonModeEnum escapeButtonMode

Detailed Description

MNavigationBar implements a navigation bar with viewmenu.

MNavigationBar doesn't have that many parameters which are read from theme. The theming is done changing the items which lay inside the navigation bar.


Constructor & Destructor Documentation

MNavigationBar::MNavigationBar (  ) 

Default constructor. Creates a navigation bar.

MNavigationBar::MNavigationBar ( QGraphicsItem parent  ) 
MNavigationBar::~MNavigationBar (  )  [virtual]

Destroys the navigation bar.


Member Function Documentation

void MNavigationBar::backButtonClicked (  )  [signal]

Signal emitted when the escape button in back mode is clicked.

See also:
MNavigationBar::escapeButtonMode
void MNavigationBar::closeButtonClicked (  )  [signal]

Signal emitted when the escape button in close mode is clicked.

See also:
MNavigationBar::escapeButtonMode
void MNavigationBar::dockToolBar ( MToolBar toolbar  )  [slot]

Dock a toolbar.

Parameters:
toolbar The toolbar to dock.
bool MNavigationBar::escapeButtonEnabled (  )  const

Returns true if escape button is enabled.

MNavigationBarModel::EscapeButtonModeEnum MNavigationBar::escapeButtonMode (  )  const

Returns the current mode of the escape button.

See also:
MNavigationBarModel::EscapeButtonModeEnum
bool MNavigationBar::escapeButtonVisible (  )  const

Returns true if escape button is visible.

bool MNavigationBar::isArrowIconVisible (  )  const

Returns true if the arrow icon is visible.

bool MNavigationBar::isProgressIndicatorVisible (  )  const

Returns if the progress indicator is visible.

Deprecated:
do not use
void MNavigationBar::notifyUser (  )  [slot]

Trigger notification of the user via the navigation bar.

This slot asks the NavigationBarView to notify the user, e.g. by flashing the Home button.

void MNavigationBar::setArrowIconVisible ( bool  visible  )  [slot]

Sets the visible of progress indicator.

void MNavigationBar::setEscapeButtonEnabled ( bool  enabled  )  [slot]

Enables or disables escape button.

void MNavigationBar::setEscapeButtonMode ( MNavigationBarModel::EscapeButtonModeEnum  newMode  )  [slot]

Sets the mode of the escape button.

See also:
MNavigationBarModel::EscapeButtonModeEnum
void MNavigationBar::setEscapeButtonVisible ( bool  visible  )  [slot]

Sets the visibility of escape button.

void MNavigationBar::setProgressIndicatorVisible ( bool  visible  )  [slot]

Sets the visible of progress indicator.

Deprecated:
do not use
Parameters:
bool visible
void MNavigationBar::setViewMenuDescription ( const QString text  )  [slot]
void MNavigationBar::setViewMenuIconID ( const QString id  )  [slot]

Sets the new icon of the application menu button.

Parameters:
the id of the icon that should be shown.
void MNavigationBar::undockToolBar (  )  [slot]

Undock a toolbar.

QString MNavigationBar::viewMenuIconID (  )  const

Returns the iconID of the icon of the application menu button.

void MNavigationBar::viewmenuTriggered (  )  [signal]

viewmenuButton was clicked


Property Documentation

MNavigationBar::escapeButtonMode [read, write]

This property holds the mode of the escape button.

Set it with setEscapeButtonMode() and get its current value with escapeButtonMode().

See also:
MNavigationBarModel::EscapeButtonModeEnum, escapeButtonClicked().

Copyright © 2010 Nokia Corporation
MeeGo Touch