AbstractActionItem

#include <bb/cascades/AbstractActionItem>

The base class for all action item subclasses.

All subclasses can be added to a Page, which means that they will be displayed on the action bar.

See:

Page, ActionItem

Since:

BlackBerry 10.0.0

Inheritance

bb::cascades::BaseObject
	bb::cascades::UIObject
		bb::cascades::AbstractActionItem
			bb::cascades::ActionItem
			bb::cascades::DeleteActionItem
			bb::cascades::HelpActionItem
			bb::cascades::InvokeActionItem
			bb::cascades::MultiSelectActionItem
			bb::cascades::SettingsActionItem
			bb::cascades::Tab

QML properties

title	: QString
image	: bb::cascades::Image
imageSource	: QUrl
enabled	: bool
accessibility	: bb::cascades::AbstractAccessibilityObject [read-only]
shortcuts	: QDeclarativeListProperty< bb::cascades::AbstractShortcut > [read-only]
attachedObjects	: QDeclarativeListProperty< QObject > [read-only]
objectName	: QString
parent	: QObject [read-only]

QML signals

onTitleChanged	: {}
onTriggered	: {}
onEnabledChanged	: {}
onImageChanged	: {}
onImageSourceChanged	: {}
onCreationCompleted	: {}
onObjectNameChanged	: {}

Properties Index

QString	title
QVariant	image
QUrl	imageSource
bool	enabled
bb::cascades::AbstractAccessibilityObject	accessibility [read-only]
QDeclarativeListProperty< bb::cascades::AbstractShortcut >	shortcuts [read-only]
QDeclarativeListProperty< QObject >	attachedObjects [read-only]
QString	objectName
QObject	parent [read-only]

Public Functions Index

virtual	~AbstractActionItem ()
Q_INVOKABLE void	addShortcut (bb::cascades::AbstractShortcut *shortcut)
Q_INVOKABLE bool	removeShortcut (bb::cascades::AbstractShortcut *shortcut)
Q_INVOKABLE void	removeAllShortcuts ()
Q_INVOKABLE int	shortcutCount () const
Q_INVOKABLE bb::cascades::AbstractShortcut *	shortcutAt (int index) const
Q_INVOKABLE void	enableAllShortcuts ()
Q_INVOKABLE void	disableAllShortcuts ()
Q_SLOT void	setTitle (const QString &title)
Q_SLOT void	resetTitle ()
const QString	title () const
bool	isEnabled () const
Q_SLOT void	setEnabled (bool enabled)
Q_SLOT void	resetEnabled ()
bb::cascades::Image	image () const
Q_SLOT void	setImage (const bb::cascades::Image &image)
Q_SLOT void	resetImage ()
QUrl	imageSource () const
Q_SLOT void	setImageSource (const QUrl &source)
Q_SLOT void	resetImageSource ()
bb::cascades::AbstractAccessibilityObject *	accessibility () const
virtual bool	event (QEvent *event)
void	setObjectName (const QString &name)
virtual Q_INVOKABLE QString	toDebugString () const

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	titleChanged (const QString &title)
void	triggered ()
void	enabledChanged (bool enabled)
void	imageChanged (const bb::cascades::Image &image)
void	imageSourceChanged (const QUrl &imageSource)
void	creationCompleted ()
void	objectNameChanged (const QString &objectName)

Properties

QString title

A string that will be displayed with the action.

The default value is QString::Null, indicating that no text is set.

Since:

BlackBerry 10.0.0

QVariant image

The image set on the action.

The default value is an empty image, indicating no image is set.

Since:

BlackBerry 10.0.0

QUrl imageSource

The image set on the action.

If no image is set, an invalid QUrl will be returned. When changing the image source the imageSourceChanged() signal will be emitted.

Since:

BlackBerry 10.0.0

bool enabled

Indicates whether the action is enabled.

When an action is disabled, it will be dimmed and it will not be possible for the user to press on it and it will not emit the triggered signal.

Since:

BlackBerry 10.0.0

bb::cascades::AbstractAccessibilityObject accessibility[read-only]

Defines this UIObject's accessibility object used by assistive technologies for people with disabilities or special needs, e.g.

visual impairment.

See:

Control::accessibility

Since:

BlackBerry 10.2.0

QDeclarativeListProperty< bb::cascades::AbstractShortcut > shortcuts[read-only]

A list of shortcuts that can be triggered via user actions.

The order in which they are added will determine which shortcut will be triggered in case of an overlap. Predefined shortcuts take precedence over shortcuts defined via QString in case of a collision.

See:

AbstractShortcut

Since:

BlackBerry 10.1.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

virtual~AbstractActionItem ()

Destructor.

Q_INVOKABLE void addShortcut (
bb::cascades::AbstractShortcut *shortcut)

Adds a shortcut to the AbstractActionItem.

AbstractActionItem will always take ownership, as shortcuts should never be shared. If the shortcut already belongs to the AbstractActionItem or the shortcut is 0, nothing will happen. The order in which shortcuts are added will determine which shortcut will be triggered in case of an overlap.

Parameters
shortcut	The AbstractShortcut to add to the AbstractActionItem.

Since:

BlackBerry 10.1.0

Q_INVOKABLE bool removeShortcut (
bb::cascades::AbstractShortcut *shortcut)

Removes a shortcut from the AbstractActionItem.

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

Parameters
shortcut	The AbstractShortcut to remove.

Return:

true if the shortcut was owned by the AbstractActionItem, false otherwise.

Since:

BlackBerry 10.1.0

Q_INVOKABLE void removeAllShortcuts ()

Removes all of a AbstractActionItem's shortcuts and frees up their memory.

Since:

BlackBerry 10.1.0

Q_INVOKABLE int shortcutCount ()

Returns the number of shortcuts.

Return:

The number of shortcuts.

Since:

BlackBerry 10.1.0

Q_INVOKABLE bb::cascades::AbstractShortcut * shortcutAt (
intindex)

Returns a shortcut at the specified index.

Ownership of the shortcut remains with the AbstractActionItem.

Parameters
index	The index of the shortcut.

Return:

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

Since:

BlackBerry 10.1.0

Q_INVOKABLE void enableAllShortcuts ()

Enables all shortcuts attached to the AbstractActionItem.

Since:

BlackBerry 10.1.0

Q_INVOKABLE void disableAllShortcuts ()

Disables all shortcuts attached to the AbstractActionItem.

Shortcuts that are attached afterward will use the default enabled state.

Since:

BlackBerry 10.1.0

Q_SLOT void setTitle (
const QString &title)

Sets the title on the action.

After the operation is completed, and the title changed, the titleChanged() signal is emitted.

Parameters
title	The title of the action.

Since:

BlackBerry 10.0.0

Q_SLOT void resetTitle ()

Resets the title on the action to QString::Null.

After the operation is completed, and the title is changed, the titleChanged() signal is emitted.

Since:

BlackBerry 10.0.0

const QString title ()

Gets the title of the action.

Return:

The title of the action.

Since:

BlackBerry 10.0.0

bool isEnabled ()

Returns the enabled state of the action.

Return:

true if the control is enabled, false otherwise.

Since:

BlackBerry 10.0.0

Q_SLOT void setEnabled (
boolenabled)

Sets the enabled state of the action.

After the operation is completed and the enabled state is changed, the enabledChanged() signal is emitted.

Parameters
enabled	If true the action is enabled and if false the action is disabled.

Since:

BlackBerry 10.0.0

Q_SLOT void resetEnabled ()

Resets the enabled state of the action to true.

After the operation is completed and the enabled state is changed, the enabledChanged() signal is emitted.

Since:

BlackBerry 10.0.0

bb::cascades::Image image ()

Returns the image to display on the action item.

Return:

The image for the item or an empty image.

Since:

BlackBerry 10.0.0

Q_SLOT void setImage (
const bb::cascades::Image &image)

Sets the image to display on the action item.

After the operation is completed and the image is changed, the imageChanged() signal is emitted.

Parameters
image	The image to display.

Since:

BlackBerry 10.0.0

Q_SLOT void resetImage ()

Resets the image, meaning no image is set for the action.

After the operation is completed and the image is changed, the imageChanged() signal is emitted.

Since:

BlackBerry 10.0.0

QUrl imageSource ()

Returns the image source.

Return:

The source of the displayed image.

Since:

BlackBerry 10.0.0

Q_SLOT void setImageSource (
const QUrl &source)

Sets the Image for the action.

An invalid QUrl indicates no image. This function emits an imageSourceChanged() signal if the currently set image source changes.

Parameters
source	The image URL.

Since:

BlackBerry 10.0.0

Q_SLOT void resetImageSource ()

Resets the Image on the action to its default, meaning that no image is set.

This function emits an imageSourceChanged() signal if the currently set image source changes.

Since:

BlackBerry 10.0.0

bb::cascades::AbstractAccessibilityObject * accessibility ()

Returns the accessibility object.

Return:

The accessibility object.

Since:

BlackBerry 10.2.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

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 titleChanged (
const QString &title)

Emitted when the title has changed.

Parameters
title	The new title.

Since:

BlackBerry 10.0.0

void triggered ()

Emitted when the ActionItem is triggered by user.

Since:

BlackBerry 10.0.0

void enabledChanged (
boolenabled)

Emitted when the enabled property on the action changes.

Parameters
enabled	If true the action is enabled, if false the action is disabled.

Since:

BlackBerry 10.0.0

void imageChanged (
const bb::cascades::Image &image,
)

Emitted when the image for the action changes.

Parameters
image	The new image or an empty image if changed to no image.

Since:

BlackBerry 10.0.0

void imageSourceChanged (
const QUrl &imageSource)

Emitted when the image source changes.

Parameters
imageSource	The new image source or an invalid QUrl if no source is set.

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

Protected Functions Index

Signals Index

Properties

QString title

QVariant image

QUrl imageSource

bool enabled

bb::cascades::AbstractAccessibilityObject accessibility[read-only]

QDeclarativeListProperty< bb::cascades::AbstractShortcut > shortcuts[read-only]

QDeclarativeListProperty< QObject > attachedObjects[read-only]

QString objectName

QObject parent[read-only]

Public Functions

virtual~AbstractActionItem ()

Q_INVOKABLE void addShortcut (bb::cascades::AbstractShortcut *shortcut)

Q_INVOKABLE bool removeShortcut (bb::cascades::AbstractShortcut *shortcut)

Q_INVOKABLE void removeAllShortcuts ()

Q_INVOKABLE int shortcutCount ()

Q_INVOKABLE bb::cascades::AbstractShortcut * shortcutAt (intindex)

Q_INVOKABLE void enableAllShortcuts ()

Q_INVOKABLE void disableAllShortcuts ()

Q_SLOT void setTitle (const QString &title)

Q_SLOT void resetTitle ()

const QString title ()

bool isEnabled ()

Q_SLOT void setEnabled (boolenabled)

Q_SLOT void resetEnabled ()

bb::cascades::Image image ()

Q_SLOT void setImage (const bb::cascades::Image &image)

Q_SLOT void resetImage ()

QUrl imageSource ()

Q_SLOT void setImageSource (const QUrl &source)

Q_SLOT void resetImageSource ()

bb::cascades::AbstractAccessibilityObject * accessibility ()

virtual bool event (QEvent *event)

void setObjectName (const QString &name)

virtual Q_INVOKABLE QString toDebugString ()

Protected Functions

BaseObject (QObject *parent)

virtual void connectNotify (const char *signal)

virtual void disconnectNotify (const char *signal)

Signals

void titleChanged (const QString &title)

void triggered ()

void enabledChanged (boolenabled)

void imageChanged (const bb::cascades::Image &image, )

void imageSourceChanged (const QUrl &imageSource)

void creationCompleted ()

void objectNameChanged (const QString &objectName)

Q_INVOKABLE void addShortcut (
bb::cascades::AbstractShortcut *shortcut)

Q_INVOKABLE bool removeShortcut (
bb::cascades::AbstractShortcut *shortcut)

Q_INVOKABLE bb::cascades::AbstractShortcut * shortcutAt (
intindex)

Q_SLOT void setTitle (
const QString &title)

Q_SLOT void setEnabled (
boolenabled)

Q_SLOT void setImage (
const bb::cascades::Image &image)

Q_SLOT void setImageSource (
const QUrl &source)

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 titleChanged (
const QString &title)

void enabledChanged (
boolenabled)

void imageChanged (
const bb::cascades::Image &image,
)

void imageSourceChanged (
const QUrl &imageSource)

void objectNameChanged (
const QString &objectName)