Menu

#include <bb/system/Menu>

To link against this class, add the following line to your .pro file: LIBS += -lbbsystem

A menu of invokable items.

Since:

BlackBerry 10.0.0

Public Functions Index

	Menu ()
	Menu (const Menu &other)
	~Menu ()
Menu &	operator= (const Menu &other)
QString	title () const
QString	subtitle () const
QUrl	titleIcon () const
QUrl	subtitleIcon () const
QList< MenuItem >	items () const
bool	isValid () const

Public Functions

Menu & operator= (
const Menu &other)

Copies the data from an existing Menu object to this object.

Parameters
other	The source Menu object to copy.

Return:

The Menu instance.

Since:

BlackBerry 10.0.0

QString title ()

Returns the localized title of the menu.

This can be used at the top of the menu to describe the items in the menu.

Return:

The localized title of the menu, or an empty string if the menu instance is not valid (see isValid()).

Since:

BlackBerry 10.0.0

QString subtitle ()

Returns the localized subtitle of the menu.

This is a secondary title that can be presented as subscript to the main title.

Return:

The localized subtitle of the menu, or an empty string if the menu instance is not valid (see isValid()).

Since:

BlackBerry 10.0.0

QUrl titleIcon ()

Returns a path to a localized icon file that can be displayed with the menu title.

Return:

A path to a localized icon file that can be displayed with the menu title, or a default (invalid) QUrl if the menu instance is not valid (see isValid()).

Since:

BlackBerry 10.0.0

QUrl subtitleIcon ()

Returns a path to a localized icon file that can be displayed with the menu subtitle.

Return:

A path to a localized icon file that can be displayed with the menu subtitle, or a default (invalid) QUrl if the menu instance is not valid (see isValid()).

Since:

BlackBerry 10.0.0

QList< MenuItem > items ()

Returns the list of menu items.

Return:

The list of menu items. If the menu instance is not valid (see isValid()), an empty list is returned.

Since:

BlackBerry 10.0.0

bool isValid ()

Indicates if this menu is valid.

This menu is valid if all of the following conditions are met:

A request to populate a menu was made using the bb::system::MenuManager::populateMenu() method.
The request completed, indicated by the arrival of the bb::system::MenuManager::finished() signal.
The request was successful, indicated by bb::system::MenuManager::error() returning a value of bb::system::MenuManagerError::None.

Return:

true if this menu is valid, false otherwise.

Since:

BlackBerry 10.0.0

Last modified: 2013-06-12