DeleteActionItem

Since: BlackBerry 10.0.0

#include <bb/cascades/DeleteActionItem>

The DeleteActionItem is used to specify that an action is a "destructive" action.

Actions of this type will always be placed in the overflow menu in a fixed position. According to general guidelines all destructive action such as 'delete' should use this action type to ensure a consistent UI experience.

If an image isn't specified on the DeleteAction a default delete icon will be displayed. and if a title isn't specified, a default string "Delete" will be shown.

See also:

Page

Overview

Inheritance

bb::cascades::BaseObject
	bb::cascades::UIObject
		bb::cascades::AbstractActionItem
			bb::cascades::DeleteActionItem

QML properties

Only has inherited QML properties

accessibility	: bb::cascades::AbstractA11yObject [read-only]
attachedObjects	: QDeclarativeListProperty< QObject > [read-only]
backgroundColor	: bb::cascades::Color \| bb::cascades::ColorPaint
builtInShortcutsEnabled	: bool
enabled	: bool
image	: bb::cascades::Image
imageSource	: QUrl
objectName	: QString
parent	: QObject [read-only]
shortcuts	: QDeclarativeListProperty< bb::cascades::AbstractShortcut > [read-only]
title	: QString
ui	: bb::cascades::UIConfig [read-only]

QML signals

Only has inherited QML signals

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

Properties Index

Only has inherited properties

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

Public Functions Index

	DeleteActionItem ()
virtual	~DeleteActionItem ()
bb::cascades::AbstractA11yObject *	accessibility () const
Q_INVOKABLE void	addShortcut (bb::cascades::AbstractShortcut *shortcut)
QVariant	backgroundColor () const
Q_INVOKABLE bool	builtInShortcutsEnabled () const
Q_INVOKABLE void	disableAllShortcuts ()
Q_INVOKABLE void	enableAllShortcuts ()
virtual bool	event (QEvent *event)
bb::cascades::Image	image () const
QUrl	imageSource () const
bool	isEnabled () const
Q_INVOKABLE void	removeAllShortcuts ()
Q_INVOKABLE bool	removeShortcut (bb::cascades::AbstractShortcut *shortcut)
Q_SLOT void	resetBackgroundColor ()
Q_INVOKABLE void	resetBuiltInShortcutsEnabled ()
Q_SLOT void	resetEnabled ()
Q_SLOT void	resetImage ()
Q_SLOT void	resetImageSource ()
Q_SLOT void	resetTitle ()
Q_SLOT void	setBackgroundColor (const ColorPaint &backgroundColor)
Q_INVOKABLE void	setBuiltInShortcutEnabled (bb::cascades::SystemShortcuts::Type type, bool enabled)
Q_SLOT void	setBuiltInShortcutsEnabled (bool enabled)
Q_SLOT void	setEnabled (bool enabled)
Q_SLOT void	setImage (const bb::cascades::Image &image)
Q_SLOT void	setImageSource (const QUrl &source)
void	setObjectName (const QString &name)
Q_SLOT void	setTitle (const QString &title)
Q_INVOKABLE bb::cascades::AbstractShortcut *	shortcutAt (int index) const
Q_INVOKABLE int	shortcutCount () const
const QString	title () const
virtual Q_INVOKABLE QString	toDebugString () const
Q_INVOKABLE bb::cascades::UIConfig *	ui () 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

Only has inherited signals

void	backgroundColorChanged (const ColorPaint &backgroundColor)
void	builtInShortcutsEnabledChanged (bool builtInShortcutsEnabled)
void	creationCompleted ()
void	enabledChanged (bool enabled)
void	imageChanged (const bb::cascades::Image &image)
void	imageSourceChanged (const QUrl &imageSource)
void	objectNameChanged (const QString &objectName)
void	titleChanged (const QString &title)
void	triggered ()

Properties

(Only has inherited properties)

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

Defines this action's accessibility object.

See also:

Control::accessibility

Since:

BlackBerry 10.2.0

QDeclarativeListProperty< QObject > attachedObjects[read-only]

A hierarchical list of the UIObject's attached objects.

Since:

BlackBerry 10.0.0

QVariant backgroundColor

A background color to display on an action item.

Right now it's only a signature action that utilizes it but may well be used by other action items.

The default value is the system primary color as a QVariant.

Since:

BlackBerry 10.3.0

bool builtInShortcutsEnabled

Enables or disables all ActionItem's built-in shortcuts.

This property is used when all ActionItem's built-in shortcuts should be enabled or disabled. built-in shortcuts are ActionItem's built-in shortcuts like 'backspace' shortcut in DeleteActionItem

Since:

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

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

QString objectName

This property is overridden from QObject.

See also:

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

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

AbstractShortcut

Since:

BlackBerry 10.1.0

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

bb::cascades::UIConfig ui[read-only]

An object that gives access to unit conversion routines.

QML use:

        // Size using design units
        Container {
            preferredWidth: ui.du(12)
            preferredHeight: ui.du(5)
        }

        // Size using design units, snap to whole pixels
        Container {
            preferredWidth: ui.sdu(13.5)
            preferredHeight: ui.sdu(7.5)
        }

        // Size using absolute pixel values
        Container {
            preferredWidth: ui.px(150)
            preferredHeight: ui.px(50)
        }

C++ use:

Container *container1 = Container::create().background(Color::Red);
UIConfig *ui = container1->ui();
container1->setPreferredWidth(ui->du(12));
container1->setPreferredHeight(ui->du(5));

Container *container2 = Container::create().background(Color::Green);
container2->setPreferredWidth(ui->sdu(13.5));
container2->setPreferredHeight(ui->sdu(7.5));

Container *container3 = Container::create().background(Color::Blue);
container3->setPreferredWidth(ui->px(150));
container3->setPreferredHeight(ui->sdu(50));

Since:

Blackberry 10.3.0

Public Functions

DeleteActionItem ()

Constructs an DeleteActionItem.

Since:

BlackBerry 10.0.0

virtual~DeleteActionItem ()

Destructor.

Since:

BlackBerry 10.0.0

bb::cascades::AbstractA11yObject * accessibility ()

Returns the accessibility object.

Return:

The accessibility object.

Since:

BlackBerry 10.2.0

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

QVariant backgroundColor ()

Returns the backgroundColor used on this action item.

The returned QVariant contain values of type Color or ColorPaint.

Use QVariant::canConvert<Type T>() to find the type, and then use QVariant::value<Type T>() to get the value.

Return:

The background Color or ColorPaint used on the action item.

Since:

BlackBerry 10.3.0

Q_INVOKABLE bool builtInShortcutsEnabled ()

Returns a builtInShortcutsEnabled property value.

Return:

true if builtInShortcutsEnabled property is set to true and false otherwise.

Since:

BlackBerry 10.2.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_INVOKABLE void enableAllShortcuts ()

Enables all shortcuts attached to the AbstractActionItem.

Since:

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

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

QUrl imageSource ()

Returns the image source.

Return:

The source of the displayed image.

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_INVOKABLE void removeAllShortcuts ()

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

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_SLOT void resetBackgroundColor ()

Resets the background color for this action item to the system primary color.

Since:

BlackBerry 10.3.0

Q_INVOKABLE void resetBuiltInShortcutsEnabled ()

Resets a builtInShortcutsEnabled property to default value.

Default value is true.

Since:

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

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

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

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

Q_SLOT void setBackgroundColor (
const ColorPaint &backgroundColor)

Sets the background color used on this action item.

Parameters
backgroundColor	The background Color or ColorPaint used on the action item.

Since:

BlackBerry 10.3.0

Q_INVOKABLE void setBuiltInShortcutEnabled (
bb::cascades::SystemShortcuts::Typetype,
boolenabled )

Sets the enabled state of the built-in shortcut attached to the AbstractActionItem at a system level.

Built-in SystemShortcuts that are attached afterward will use the same enabled state.

Note:

Selected built-in shortcut can be enabled or disbaled only if AbstractActionItem::builtInShortcutsEnabled property is set to true.

Parameters
type	The system shortcut type
enabled	If true the shortcut is enabled, and if false the shortcut is disabled.

Since:

BlackBerry 10.2.0

Q_SLOT void setBuiltInShortcutsEnabled (
boolenabled)

Sets the enabled state of all built-in shortcut attached to the AbstractActionItem at a system level.

Built-in shortcuts that are attached afterward will use the specified enabled state.

Parameters
enabled	If true all shortcuts are enabled, and if false all shortcut are disabled.

Since:

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

void setObjectName (
const QString &name)

Sets the objectName property.

Parameters
name	The new name for the object.

Since:

BlackBerry 10.0.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_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 int shortcutCount ()

Returns the number of shortcuts.

Return:

The number of shortcuts.

Since:

BlackBerry 10.1.0

const QString title ()

Gets the title of the action.

Return:

The title of the action.

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

Q_INVOKABLE bb::cascades::UIConfig * ui ()

Returns the UIConfig for this ui object.

The UIConfig can be used to perform unit conversions from design units (du) and snapped design units (sdu) to pixels.

Ownership remains with Cascades.

C++ use:

Container *container1 = Container::create().background(Color::Red);
UIConfig *ui = container1->ui();
container1->setPreferredWidth(ui->du(12));
container1->setPreferredHeight(ui->du(5));

Container *container2 = Container::create().background(Color::Green);
container2->setPreferredWidth(ui->sdu(13.5));
container2->setPreferredHeight(ui->sdu(7.5));

Container *container3 = Container::create().background(Color::Blue);
container3->setPreferredWidth(ui->px(150));
container3->setPreferredHeight(ui->sdu(50));

Return:

The UIConfig for this ui object.

Since:

BlackBerry 10.3.0

Static Public Functions

Builder create ()

Creates and returns a builder for constructing an DeleteActionItem.

Using the builder to create an DeleteActionItem:

DeleteActionItem* actionItem = DeleteActionItem::create();

Return:

A builder used for constructing a DeleteActionItem.

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

(Only has inherited signals)

void backgroundColorChanged (
const ColorPaint &backgroundColor)

Emitted when the background color for this action changes.

Parameters
backgroundColor	The new background color for this action

Since:

BlackBerry 10.3.0

void builtInShortcutsEnabledChanged (
boolbuiltInShortcutsEnabled)

Emitted when the builtInShortcutsEnabled property changes.

Parameters
builtInShortcutsEnabled	The new value.

Since:

BlackBerry 10.2.0

void creationCompleted ()

Emitted 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 indicates 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 also:

QmlDocument

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 objectNameChanged (
const QString &objectName)

This signal is emitted when the objectName property is changed.

See also:

QObject, BaseObject::objectName.

Since:

BlackBerry 10.0.0

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

DeleteActionItem

Overview

Inheritance

QML properties

QML signals

Properties Index

Public Functions Index

Static Public Functions Index

Protected Functions Index

Signals Index

Properties

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

QDeclarativeListProperty< QObject > attachedObjects[read-only]

QVariant backgroundColor

bool builtInShortcutsEnabled

bool enabled

QVariant image

QUrl imageSource

QString objectName

QObject parent[read-only]

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

QString title

bb::cascades::UIConfig ui[read-only]

Public Functions

DeleteActionItem ()

virtual~DeleteActionItem ()

bb::cascades::AbstractA11yObject * accessibility ()

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

QVariant backgroundColor ()

Q_INVOKABLE bool builtInShortcutsEnabled ()

Q_INVOKABLE void disableAllShortcuts ()

Q_INVOKABLE void enableAllShortcuts ()

virtual bool event (QEvent *event)

bb::cascades::Image image ()

QUrl imageSource ()

bool isEnabled ()

Q_INVOKABLE void removeAllShortcuts ()

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

Q_SLOT void resetBackgroundColor ()

Q_INVOKABLE void resetBuiltInShortcutsEnabled ()

Q_SLOT void resetEnabled ()

Q_SLOT void resetImage ()

Q_SLOT void resetImageSource ()

Q_SLOT void resetTitle ()

Q_SLOT void setBackgroundColor (const ColorPaint &backgroundColor)

Q_INVOKABLE void setBuiltInShortcutEnabled (bb::cascades::SystemShortcuts::Typetype, boolenabled )

Q_SLOT void setBuiltInShortcutsEnabled (boolenabled)

Q_SLOT void setEnabled (boolenabled)

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

Q_SLOT void setImageSource (const QUrl &source)

void setObjectName (const QString &name)

Q_SLOT void setTitle (const QString &title)

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

Q_INVOKABLE int shortcutCount ()

const QString title ()

virtual Q_INVOKABLE QString toDebugString ()

Q_INVOKABLE bb::cascades::UIConfig * ui ()

Static Public Functions

Builder create ()

Protected Functions

BaseObject (QObject *parent)

virtual void connectNotify (const char *signal)

virtual void disconnectNotify (const char *signal)

Signals

void backgroundColorChanged (const ColorPaint &backgroundColor)

void builtInShortcutsEnabledChanged (boolbuiltInShortcutsEnabled)

void creationCompleted ()

void enabledChanged (boolenabled)

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

void imageSourceChanged (const QUrl &imageSource)

void objectNameChanged (const QString &objectName)

void titleChanged (const QString &title)

void triggered ()

1. Choose your focus

2. Download the tools

3. Try the sample apps

4. Educate yourself

5. Start developing

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

virtual bool event (
QEvent *event)

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

Q_SLOT void setBackgroundColor (
const ColorPaint &backgroundColor)

Q_INVOKABLE void setBuiltInShortcutEnabled (
bb::cascades::SystemShortcuts::Typetype,
boolenabled )

Q_SLOT void setBuiltInShortcutsEnabled (
boolenabled)

Q_SLOT void setEnabled (
boolenabled)

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

Q_SLOT void setImageSource (
const QUrl &source)

void setObjectName (
const QString &name)

Q_SLOT void setTitle (
const QString &title)

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

BaseObject (
QObject *parent)

virtual void connectNotify (
const char *signal)

virtual void disconnectNotify (
const char *signal)

void backgroundColorChanged (
const ColorPaint &backgroundColor)

void builtInShortcutsEnabledChanged (
boolbuiltInShortcutsEnabled)

void enabledChanged (
boolenabled)

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

void imageSourceChanged (
const QUrl &imageSource)

void objectNameChanged (
const QString &objectName)

void titleChanged (
const QString &title)