Menu

Since: BlackBerry 10.0.0

#include <bb/system/Menu>

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

A menu of invokable items.


Overview

Public Functions Index

Menu ()
Menu (const Menu &other)
~Menu ()
boolisValid () const
QList< MenuItem >items () const
Menu &operator= (const Menu &other)
QStringsubtitle () const
QUrlsubtitleIcon () const
QStringtitle () const
QUrltitleIcon () const

Public Functions

Menu ()

Creates a new Menu object.

Since:

BlackBerry 10.0.0

Menu (

Creates a copy of an existing Menu object.

Parameters
other

The source Menu object to copy.

Since:

BlackBerry 10.0.0

~Menu ()

Destructor.

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:
Return:

true if this menu is valid, false otherwise.

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

Menu & operator= (

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

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

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

Last modified: 2014-09-30



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus