MenuDefinition

#include <bb/cascades/MenuDefinition>

A menu that contains important application-wide actions.

A Menu is positioned at the top of the screen and can be accessed by swiping downwards from the top of the screen. It is typically used to display seldom-used actions such as Help or Settings that are global (that is, apply from anywhere in the application).

Example of C++ usage:

Menu *menu = Menu::create()
    .addAction(ActionItem::create().title("Menu Item 1"))
    .addAction(ActionItem::create().title("Menu Item 2"))
    .help(HelpActionItem::create());
Application::instance()->setMenu(menu);

Example of QML usage:

Page {
  Menu.definition: MenuDefinition {
    settingsAction: SettingsActionItem {
      onTriggered : {}
    }
    actions: [
      ActionItem {}
    ]
  }
}

Since:

BlackBerry 10.0.0

Inheritance

bb::cascades::BaseObject
	bb::cascades::UIObject
		bb::cascades::MenuDefinition

QML properties

actions	: QDeclarativeListProperty< bb::cascades::ActionItem > [read-only]
helpAction	: bb::cascades::HelpActionItem
settingsAction	: bb::cascades::SettingsActionItem
attachedObjects	: QDeclarativeListProperty< QObject > [read-only]
objectName	: QString
parent	: QObject [read-only]

QML signals

onEnabledChanged	: {}
onActionAdded	: {}
onActionRemoved	: {}
onHelpActionChanged	: {}
onSettingsActionChanged	: {}
onCreationCompleted	: {}
onObjectNameChanged	: {}

Properties Index

QDeclarativeListProperty< bb::cascades::ActionItem >	actions [read-only]
bb::cascades::HelpActionItem	helpAction
bb::cascades::SettingsActionItem	settingsAction
QDeclarativeListProperty< QObject >	attachedObjects [read-only]
QString	objectName
QObject	parent [read-only]

Public Functions Index

	Menu (QObject *parent=0)
virtual	~Menu ()
Q_INVOKABLE void	addAction (bb::cascades::ActionItem *actionItem)
Q_INVOKABLE bool	removeAction (bb::cascades::ActionItem *actionItem)
Q_INVOKABLE int	actionCount () const
Q_INVOKABLE bb::cascades::ActionItem *	actionAt (int index) const
bb::cascades::HelpActionItem *	helpAction () const
Q_SLOT void	setHelpAction (bb::cascades::HelpActionItem *helpAction)
Q_SLOT void	resetHelpAction ()
bb::cascades::SettingsActionItem *	settingsAction () const
Q_SLOT void	setSettingsAction (bb::cascades::SettingsActionItem *settingsAction)
Q_SLOT void	resetSettingsAction ()
virtual bool	event (QEvent *event)
void	setObjectName (const QString &name)
virtual Q_INVOKABLE QString	toDebugString () const

Static Public Functions Index

Builder

create ()

Protected Functions Index

Only has inherited protected functions

	BaseObject (QObject *parent=0)
virtual void	connectNotify (const char *signal)
virtual void	disconnectNotify (const char *signal)

Signals Index

void	enabledChanged (bool enabled)
void	actionAdded (bb::cascades::ActionItem *action)
void	actionRemoved (bb::cascades::ActionItem *action)
void	helpActionChanged (bb::cascades::HelpActionItem *helpAction)
void	settingsActionChanged (bb::cascades::SettingsActionItem *settingsAction)
void	creationCompleted ()
void	objectNameChanged (const QString &objectName)

Properties

QDeclarativeListProperty< bb::cascades::ActionItem > actions[read-only]

Specifies the actions that will be shown on the application menu.

A maximum of five actions can be shown at the same time, including the helpAction and settingAction actions. If these actions are set, only three additional actions can be displayed.

Since:

BlackBerry 10.0.0

bb::cascades::HelpActionItem helpAction

Specifies the Help action item.

The Help action is placed in a specific location, and if an image isn't specified on the action, a default icon is shown.

Since:

BlackBerry 10.0.0

bb::cascades::SettingsActionItem settingsAction

Specifies the Settings action item.

The Settings action is placed in a specific location, and if an image isn't specified on the action, a default icon is shown.

Since:

BlackBerry 10.0.0

QDeclarativeListProperty< QObject > attachedObjects[read-only]

A hierarchical list of the UIObject's attached objects.

This QDeclarativeListProperty can contain any QObject. When a QObject is added to property, the UIObject takes ownership of the attached object.

This feature is typically used from QML to specify business logic object or any other shared objects for the subnodes of this UIObject. In C++ the same functionality can be achived by setting a parent of a QObject to be attached to the QObject which is going to own it.

QML usage example (MyObject is a custom class registered for QML using the qmlRegisterType() function):

Container {
    Label { text: "Title: " + myObject.title } 
    Label { text: "Subject: " + myObject.subject }
    attachedObjects: [
        MyObject { id: myObject
            title: "Hello World"
            subject: "Nice Day"
        }
    ]
}

Since:

BlackBerry 10.0.0

QString objectName

This property is overridden from QObject.

As the objectName property is overridden from the QObject class, this signal will not be emitted if setObjectName() function is called directly on QObject.

The default value of this property is QString::null.

See:

QObject::objectName().

Since:

BlackBerry 10.0.0

QObject parent[read-only]

A read-only property that represents this object's parent.

The parent of an object is specified using QObject::setParent(QObject*). The purpose of the property is to expose the object's parent to QML.

This property is read-only to prevent modifications from QML, where typically the parent is declaratively set. In C++ code, the parent can be explicitly set using QObject::setParent(QObject*), or implicitly set by adding it to a visual container.

The default value of this property is 0.

Since:

BlackBerry 10.0.0

Public Functions

Q_INVOKABLE void addAction (
bb::cascades::ActionItem *actionItem)

Adds an action to this Menu.

This Menu will always take ownership of the specified action, because actions should not be shared. If the specified action already belongs to this Menu, or is 0, then nothing will happen. The actionAdded() signal is emitted, when the operation is successful. The order in which actions are added determines how they appear on the Menu. Actions are added to the Menu from left to right.

Parameters
actionItem	The action to add to the Menu.

Since:

BlackBerry 10.0.0

Q_INVOKABLE bool removeAction (
bb::cascades::ActionItem *actionItem)

Removes an action from this Menu.

Once the action is removed, the Menu no longer references it, but it is still owned by the Menu. It is up to the application to either delete the removed action, transfer its ownership (by setting its parent) to another object, or leave it as a child of the Menu, in which case it will be deleted with the Menu.

If the operation was successful, the actionRemoved() signal is emitted.

Parameters
actionItem	The action to remove.

Return:

true if the action was owned by this Menu, false otherwise.

Since:

BlackBerry 10.0.0

Q_INVOKABLE int actionCount ()

Returns the number of actions in this Menu.

Return:

The number of actions.

Since:

BlackBerry 10.0.0

Q_INVOKABLE bb::cascades::ActionItem * actionAt (
intindex)

Returns the action at the specified index in this Menu.

Ownership of the action remains with this Menu.

Parameters
index	The index of the action.

Return:

The requested action if the index was valid, 0 otherwise.

Since:

BlackBerry 10.0.0

bb::cascades::HelpActionItem * helpAction ()

Gets the Help action for this Menu.

The Menu keeps the ownership of the Help action.

Return:

The Help action, or 0 if no Help action is specified.

Since:

BlackBerry 10.0.0

Q_SLOT void setHelpAction (
bb::cascades::HelpActionItem *helpAction)

Sets the Help action for this Menu.

The Menu takes the ownership of the Help action. When this function completes, the helpActionChanged() signal is emitted.

Parameters
helpAction	The Help action.

Since:

BlackBerry 10.0.0

Q_SLOT void resetHelpAction ()

Resets the Help action for this Menu.

This function removes the Help action for this Menu. When this function completes, the helpActionChanged() signal is emitted.

Since:

BlackBerry 10.0.0

bb::cascades::SettingsActionItem * settingsAction ()

Gets the Settings action for this Menu.

The Menu keeps the ownership of the Settings action.

Return:

The Settings action, or 0 if no Settings action has been specified.

Since:

BlackBerry 10.0.0

Q_SLOT void setSettingsAction (
bb::cascades::SettingsActionItem *settingsAction)

Sets the Settings action for this Menu.

The Menu takes the ownership of the Settings action. When this function completes, the settingsActionChanged() signal is emitted.

Parameters
settingsAction	The Settings action.

Since:

BlackBerry 10.0.0

Q_SLOT void resetSettingsAction ()

Resets the Settings action for this Menu.

This function removes the Settings action for this Menu. When this function completes, the settingsActionChanged() signal is emitted.

Since:

BlackBerry 10.0.0

virtual bool event (
QEvent *event)

Overloaded to implement the event mechanism in Cascades.

Warning:

If this function is overridden, it must be called by the derived class for events to work properly in Cascades.

Parameters
event	The received event.

Return:

True if the received event was recognized and processed, false otherwise.

Since:

BlackBerry 10.0.0

void setObjectName (
const QString &name)

Sets the objectName property.

Parameters
name	The new name for the object.

Since:

BlackBerry 10.0.0

virtual Q_INVOKABLE QString toDebugString ()

Returns a debug string representing this object.

Return:

A debug string for the object.

Since:

BlackBerry 10.0.0

Static Public Functions

Builder create ()

Creates and returns a builder for constructing a Menu.

Using the builder to create a Menu:

Menu* menu = Menu::create();

Return:

A builder used for constructing a Menu.

Since:

BlackBerry 10.0.0

Protected Functions

(Only has inherited protected functions)

BaseObject (
QObject *parent)

Constructs an instance of BaseObject's subclass.

Parameters
parent	An optional parent, defaults to 0.

Since:

BlackBerry 10.0.0

virtual void connectNotify (
const char *signal)

Overloaded to implement the event mechanism in Cascades.

If this function is overridden, it must be called by the derived class for events to work properly in Cascades.

Parameters
signal	The connected signal.

Since:

BlackBerry 10.0.0

virtual void disconnectNotify (
const char *signal)

Overloaded to implement the event mechanism in Cascades.

If this function is overridden, it must be called by the derived class for events to work properly in Cascades.

Parameters
signal	The disconnected signal.

Since:

BlackBerry 10.0.0

Signals

void enabledChanged (
boolenabled)

Emitted when the enabled property has changed.

Parameters
enabled	If true the Menu is enabled, if false the Menu is not enabled.

Since:

BlackBerry 10.0.0

void actionAdded (
bb::cascades::ActionItem *action)

Emitted when an action has been added to the Menu.

Parameters
action	The action that has been added.

Since:

BlackBerry 10.0.0

void actionRemoved (
bb::cascades::ActionItem *action)

Emitted when an action has been removed from the Menu.

Parameters
action	The action that has been removed.

Since:

BlackBerry 10.0.0

void helpActionChanged (
bb::cascades::HelpActionItem *helpAction)

Emitted when the Help action has changed.

Parameters
helpAction	The new Help action.

Since:

BlackBerry 10.0.0

void settingsActionChanged (
bb::cascades::SettingsActionItem *settingsAction)

Emitted when the Settings action has changed.

Parameters
settingsAction	The new Settings action.

Since:

BlackBerry 10.0.0

void creationCompleted ()

This signal is emitted only when this object is instantiated as a result of loading a QML document and creating the root node, or when an object is being constructed using its builder class.

This signal is emitted only when this object is instantiated as a result of loading a QML document and creating the root node (only after the root component that caused this instantiation has completed construction), or when the object is being constructed from its builder class. This signal is emitted to indicate that the construction and initialization of the object has been completed, the properties are initialized, and any QML binding values have been assigned to the object.

This signal is not emitted when the object is constructed from C++ using the constructor. If the object is constructed using its builder class, the signal is emitted when the the builder class returns the fully constructed object.

This signal can be used when there is an activity that needs to be performed, such as a property state integrity verification after the object is instantiated from a QML document or a builder, but before control is returned to the application.

See:

QmlDocument

Since:

BlackBerry 10.0.0

void objectNameChanged (
const QString &objectName)

This signal is emitted when the objectName property is changed.

See:

QObject, BaseObject::objectName.

Since:

BlackBerry 10.0.0

Inheritance

QML properties

QML signals

Properties Index

Public Functions Index

Static Public Functions Index

Protected Functions Index

Signals Index

Properties

QDeclarativeListProperty< bb::cascades::ActionItem > actions[read-only]

bb::cascades::HelpActionItem helpAction

bb::cascades::SettingsActionItem settingsAction

QDeclarativeListProperty< QObject > attachedObjects[read-only]

QString objectName

QObject parent[read-only]

Public Functions

Menu (QObject *parent)

virtual~Menu ()

Q_INVOKABLE void addAction (bb::cascades::ActionItem *actionItem)

Q_INVOKABLE bool removeAction (bb::cascades::ActionItem *actionItem)

Q_INVOKABLE int actionCount ()

Q_INVOKABLE bb::cascades::ActionItem * actionAt (intindex)

bb::cascades::HelpActionItem * helpAction ()

Q_SLOT void setHelpAction (bb::cascades::HelpActionItem *helpAction)

Q_SLOT void resetHelpAction ()

bb::cascades::SettingsActionItem * settingsAction ()

Q_SLOT void setSettingsAction (bb::cascades::SettingsActionItem *settingsAction)

Q_SLOT void resetSettingsAction ()

virtual bool event (QEvent *event)

void setObjectName (const QString &name)

virtual Q_INVOKABLE QString toDebugString ()

Static Public Functions

Builder create ()

Protected Functions

BaseObject (QObject *parent)

virtual void connectNotify (const char *signal)

virtual void disconnectNotify (const char *signal)

Signals

void enabledChanged (boolenabled)

void actionAdded (bb::cascades::ActionItem *action)

void actionRemoved (bb::cascades::ActionItem *action)

void helpActionChanged (bb::cascades::HelpActionItem *helpAction)

void settingsActionChanged (bb::cascades::SettingsActionItem *settingsAction)

void creationCompleted ()

void objectNameChanged (const QString &objectName)

Menu (
QObject *parent)

Q_INVOKABLE void addAction (
bb::cascades::ActionItem *actionItem)

Q_INVOKABLE bool removeAction (
bb::cascades::ActionItem *actionItem)

Q_INVOKABLE bb::cascades::ActionItem * actionAt (
intindex)

Q_SLOT void setHelpAction (
bb::cascades::HelpActionItem *helpAction)

Q_SLOT void setSettingsAction (
bb::cascades::SettingsActionItem *settingsAction)

virtual bool event (
QEvent *event)

void setObjectName (
const QString &name)

BaseObject (
QObject *parent)

virtual void connectNotify (
const char *signal)

virtual void disconnectNotify (
const char *signal)

void enabledChanged (
boolenabled)

void actionAdded (
bb::cascades::ActionItem *action)

void actionRemoved (
bb::cascades::ActionItem *action)

void helpActionChanged (
bb::cascades::HelpActionItem *helpAction)

void settingsActionChanged (
bb::cascades::SettingsActionItem *settingsAction)

void objectNameChanged (
const QString &objectName)