InvokeActionItem

Since: BlackBerry 10.0.0

#include <bb/cascades/InvokeActionItem>

Represents actions for invoking application-level components.

The InvokeActionItem class represents an invocation service that can be added to a context menu like an ActionItem. It will expand to a number of visual action items in the context menu (though these generated items won't be accessible in code). Each of these action items will represent a possible invocation action and will display a list of possible invocation targets when pressed. When selecting an invocation target from the list InvokeActionItem will perform the invocation using the chosen action and target.

In addition to providing a simple-to-use invocation service, this class provides the option of adding data at a very late stage to be used when invoking the target. If this data is actively set, then it overrides data previously set from query. The data is an array that can carry multiple items defined by the caller to be communicated to the target.

This class uses the Invocation framework (bb::system::MenuManager, bb::system::InvokeManager and related classes) for its operations. It is to be seen as the default way of connecting invocations to Control objects, providing a system default UI and execution flow for the task through a simple interface. If more advanced invocation options are needed or the usual UI flow does not fit the task at hand, it's recommended to bypass this class and access the Invoke framework directly and build the execution flow from scratch.

For more information about invocations and the Invoke framework, bb::system::MenuManager, bb::system::InvokeManager, bb::system::InvokeAction, and bb::system::InvokeTarget might be good places to start.

Note:

Make sure the created InvokeActionItem objects are not deleted before a Context Menu/Target List dialog is completed. The finished() signal can be used to trigger a call to QObject::deleteLater().

The InvokeActionItem class uses InvokeQuery to represent an immutable query object containing properties used to ask the Invoke framework for supporting actions and targets.
These are the rules controlling how InvokeActionItem will interpret an InvokeQuery: If there is only one invoke target possible for an invoke action generated from an InvokeActionItem, the ActionItem representing the invoke action will immediately launch the invocation target when pressed, without showing a list of targets to choose from.

The caller has an option to control the invocation process using the property handler. If (and only if) the handler is set, the caller is notified when this InvokeActionItem is ready to invoke the user-selected target. By default, the handler is not set. Typical need for this option could for example be to ask the user for necessary input by showing a dialog, show a spinner if a file needs to be updated before invocation or simply for some reason choose to cancel the whole operation.

The InvokeActionItem delegates the communication with the caller to the InvokeHandler object (the handler) provided by the caller. The handler (delegate) reports back to this InvokeActionItem (delegator) the corresponding answer from the caller; confirmed or cancelled. If confirmed, then this InvokeActionItem will continue invocation. If cancelled is intercepted, then invocation is aborted and a finished signal will be sent from InvokeActionItem.

The title, image and imageSource properties inherited from AbstractActionItem have no real purpose in InvokeActionItem since the InvokeActionItem itself will never be shown. If used anyway, all the items displayed as a result from the query will have the same title/image. Don't use these properties on InvokeActionItem.

Here's how to create an InvokeActionItem, using the builder pattern:

 InvokeActionItem* pInvokeActionItem(InvokeActionItem::create(
   InvokeQuery::create()
     .parent(this)
     .mimeType("text/txt"))
   .onFinished(this, SLOT(onFinished(bb::cascades::InvokeState::Type))));

And here's how to create an InvokeActionItem for a Button using QML:

 InvokeActionItem {
     query {
         mimeType: "text/txt"
         uri: "file:///path/to/my/textfile.txt"
     }
 }


Overview

QML properties

data: QVariant
handler: bb::cascades::InvokeHandler
metadata: QVariantMap
query: bb::cascades::InvokeQuery [read-only]
state: bb::cascades::InvokeState::Type [read-only]
accessibility: bb::cascades::AbstractA11yObject [read-only]Inherited
attachedObjects: QDeclarativeListProperty< QObject > [read-only]Inherited
backgroundColor: bb::cascades::Color | bb::cascades::ColorPaintInherited
shortcuts: QDeclarativeListProperty [read-only]Inherited
builtInShortcutsEnabled: boolInherited
defaultAction: boolInherited
enabled: boolInherited
image: bb::cascades::ImageInherited
imageSource: QUrlInherited
objectName: QStringInherited
parent: QObject [read-only]Inherited
title: QStringInherited
ui: bb::cascades::UIConfig [read-only]Inherited

Public Functions Index

InvokeActionItem (QObject *pParent=0)
InvokeActionItem (const bb::cascades::InvokeQuery *query, QObject *pParent=0)
virtual ~InvokeActionItem ()
QByteArraydata () const
bb::cascades::InvokeHandler *handler () const
QByteArrayinvocationData () const
QVariantMapmetadata () const
bb::cascades::InvokeQuery *query () const
Q_SLOT voidresetData ()
Q_SLOT voidresetHandler ()
Q_SLOT voidresetInvocationData ()
Q_SLOT voidresetMetadata ()
Q_SLOT voidsetData (const QByteArray &data)
Q_SLOT voidsetHandler (bb::cascades::InvokeHandler *pHandler)
Q_SLOT voidsetInvocationData (const QByteArray &invocationData)
Q_SLOT voidsetMetadata (const QVariantMap &metadata)
bb::cascades::InvokeState::Typestate () const
bb::cascades::AbstractA11yObject *accessibility () const Inherited
Q_INVOKABLE voidaddShortcut (bb::cascades::AbstractShortcut *shortcut)Inherited
QVariantbackgroundColor () const Inherited
Q_INVOKABLE boolbuiltInShortcutsEnabled () const Inherited
Q_INVOKABLE voiddisableAllShortcuts ()Inherited
Q_INVOKABLE voidenableAllShortcuts ()Inherited
virtual boolevent (QEvent *event)Inherited
bb::cascades::Imageimage () const Inherited
QUrlimageSource () const Inherited
boolisDefaultAction () const Inherited
boolisEnabled () const Inherited
Q_INVOKABLE voidremoveAllShortcuts ()Inherited
Q_INVOKABLE boolremoveShortcut (bb::cascades::AbstractShortcut *shortcut)Inherited
Q_SLOT voidresetBackgroundColor ()Inherited
Q_INVOKABLE voidresetBuiltInShortcutsEnabled ()Inherited
Q_SLOT voidresetDefaultAction ()Inherited
Q_SLOT voidresetEnabled ()Inherited
Q_SLOT voidresetImage ()Inherited
Q_SLOT voidresetImageSource ()Inherited
Q_SLOT voidresetTitle ()Inherited
Q_SLOT voidsetBackgroundColor (const ColorPaint &backgroundColor)Inherited
Q_INVOKABLE voidsetBuiltInShortcutEnabled (bb::cascades::SystemShortcuts::Type type, bool enabled)Inherited
Q_SLOT voidsetBuiltInShortcutsEnabled (bool enabled)Inherited
Q_SLOT voidsetDefaultAction (bool defaultAction)Inherited
Q_SLOT voidsetEnabled (bool enabled)Inherited
Q_SLOT voidsetImage (const bb::cascades::Image &image)Inherited
Q_SLOT voidsetImageSource (const QUrl &source)Inherited
voidsetObjectName (const QString &name)Inherited
Q_SLOT voidsetTitle (const QString &title)Inherited
Q_INVOKABLE bb::cascades::AbstractShortcut *shortcutAt (int index) const Inherited
Q_INVOKABLE intshortcutCount () const Inherited
const QStringtitle () const Inherited
virtual Q_INVOKABLE QStringtoDebugString () const Inherited
Q_INVOKABLE bb::cascades::UIConfig *ui () const Inherited

Static Public Functions Index

Buildercreate (bb::cascades::InvokeQuery *pQuery)

Protected Functions Index

Only has inherited protected functions

BaseObject (QObject *parent=0)Inherited
virtual voidconnectNotify (const char *signal)Inherited
virtual voiddisconnectNotify (const char *signal)Inherited

Signals Index

voiddataChanged (const QByteArray &data)
voidfinished (bb::cascades::InvokeState::Type newState)
voidhandlerChanged (const bb::cascades::InvokeHandler *handler)
voidhandlerChanged (bb::cascades::InvokeHandler *handler)
voidmetadataChanged (const QVariantMap &metadata)
voidstateChanged (bb::cascades::InvokeState::Type newState)
voidbackgroundColorChanged (const ColorPaint &backgroundColor)Inherited
voidbuiltInShortcutsEnabledChanged (bool builtInShortcutsEnabled)Inherited
voidcreationCompleted ()Inherited
voiddefaultActionChanged (bool defaultAction)Inherited
voidenabledChanged (bool enabled)Inherited
voidimageChanged (const bb::cascades::Image &image)Inherited
voidimageSourceChanged (const QUrl &imageSource)Inherited
voidobjectNameChanged (const QString &objectName)Inherited
voidtitleChanged (const QString &title)Inherited
voidtriggered ()Inherited

Properties

QVariant data

The data used when invoking an action/target overriding the data set from query.

Since:

BlackBerry 10.0.0

bb::cascades::InvokeHandler handler

The handler used by this InvokeActionItem to communicate with the caller when ready to invoke the selected target.

This InvokeActionItem will wait to invoke the user-selected target when ready and delegate the communication with the caller to its InvokeHandler if such is set. The handler will report back to this InvokeActionItem to make decisions. If the handler reports that the invocation has been confirmed, this InvokeActionItem will continue invocation. If the handler reports that the invocation has been cancelled, this InvokeActionItem will abort invocation. If no handler is set or the set handler is reset, this feature is disabled and this InvokeActionItem will invoke the target directly without interruption. By default the handler is not set.

Note:

When an InvokeHandler is called a target has been selected and a re-query to MenuService is not possible.

Since:

BlackBerry 10.0.0

QVariantMap metadata

The metadata used when invoking an action/target overriding the metadata set from query.

The caller can set metadata to be invoked at a late stage prior to invoke the target. If this metadata is set, then it overrides the metadata previously set from query.

Since:

BlackBerry 10.0.0

bb::cascades::InvokeQuery query[read-only]

The query used by the InvokeActionItem.

Once this InvokeActionItem has been created, this property becomes read-only and attempts to change it will be ignored.

Since:

BlackBerry 10.0.0

bb::cascades::InvokeState::Type state[read-only]

The different state an InvokeActionItem can be in or end up in.

When InvokeActionItem is finished the finished() signal is emitted with the final state.

Since:

BlackBerry 10.0.0

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

Defines this action's accessibility object.

Since:

BlackBerry 10.2.0

QDeclarativeListProperty< QObject > attachedObjectsInherited[read-only]

A hierarchical list of the UIObject's attached objects.

Since:

BlackBerry 10.0.0

QVariant backgroundColorInherited

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

QDeclarativeListProperty shortcutsInherited[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.

Since:

BlackBerry 10.1.0

bool builtInShortcutsEnabledInherited

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 defaultActionInherited

Specifies if this action item is the default action.

The default action will get focus when opening a menu where the action item is presented. Note that the action will not get focus if the menu is already open. Specifying signature action placement for an action will change this property to true. If there is more than one default action when opening a menu the menu will give one of these actions focus.

Since:

BlackBerry 10.3.1

bool enabledInherited

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 imageInherited

The image set on the action.

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

Since:

BlackBerry 10.0.0

QUrl imageSourceInherited

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 objectNameInherited

This property is overridden from QObject.

See also:

QObject::objectName().

Since:

BlackBerry 10.0.0

QObject parentInherited[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

QString titleInherited

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

InvokeActionItem (

Creates a new InvokeActionItem with a 0 query.

Parameters
pParent

The parent of this object.

Since:

BlackBerry 10.0.0

InvokeActionItem (

Creates a new InvokeActionItem with provided query and optional parent.

Parameters
query

The query to use in the new InvokeActionItem.

pParent

The parent of this object.

Since:

BlackBerry 10.0.0

virtual~InvokeActionItem ()

Destructor.

Since:

BlackBerry 10.0.0

QByteArray data ()

Gets the invocation data to be invoked with target.

The caller can inspect previously set invocation data. If this data is set, then it overrides the data previously set from query when invoking the action/target.

Return:

The data used for invoking the action.

Since:

BlackBerry 10.0.0

bb::cascades::InvokeHandler * handler ()

Gets the invoke handler for this InvokeActionItem.

Return:

The invoke handler object.

Since:

BlackBerry 10.0.0

QByteArray invocationData ()

Deprecated

Use data() instead.

Since:

BlackBerry 10.0.0

QVariantMap metadata ()

Gets the metadata to be sent when invoking the target.

The caller can inspect previously set invocation metadata. If this metadata is set, then it overrides the metadata previously set from query when invoking the action/target.

Return:

The metadata used for invoking the action.

Since:

BlackBerry 10.0.0

bb::cascades::InvokeQuery * query ()

Gets the immutable query used to ask for actions and targets previously set by this interface.

The caller takes ownership of the returned pointer.

Return:

The query of this InvokeActionItem.

Since:

BlackBerry 10.0.0

Q_SLOT void resetData ()

Resets the data for this InvokeActionItem.

The caller can reset invocation data and this way reuse the data first set from the query when invoking the action/target.

Since:

BlackBerry 10.0.0

Q_SLOT void resetHandler ()

Resets the invoke handler for this InvokeActionItem.

Resetting a previously set handler means that this InvokeActionItem will invoke the target directly without waiting for confirmation from the caller.

Since:

BlackBerry 10.0.0

Q_SLOT void resetInvocationData ()

Deprecated

Use resetData() instead.

Since:

BlackBerry 10.0.0

Q_SLOT void resetMetadata ()

Resets the metadata for this InvokeActionItem.

Note:

To ensure that metadata is not lost in an invocation request, you must set metadata in the InvokeQuery class.

Since:

BlackBerry 10.0.0

Q_SLOT void setData (

Sets the data to be sent when invoking the target.

The caller can set data to be invoked at a late stage prior to invoke the target. If this data is set, then it overrides the data previously set from query.

Parameters
data

is data used when invoking the action/target.

Since:

BlackBerry 10.0.0

Q_SLOT void setHandler (

Sets the invoke handler for this InvokeActionItem.

If a handler is set by this interface and this InvokeActionItem is ready to invoke a user-selected target, it will wait for confirmation from the caller. However, this InvokeActionItem will delegate the communication with the caller to its InvokeHandler set by this interface.

This InvokeActionItem takes ownership of the handler object unless it already has a parent.

When a new handler is set by this interface, the former is replaced.

Parameters
pHandler

The invoke handler object.

Since:

BlackBerry 10.0.0

Q_SLOT void setInvocationData (

Deprecated

Use setData() instead.

Since:

BlackBerry 10.0.0

Q_SLOT void setMetadata (

Sets the metadata to be sent when invoking the target.

Parameters
metadata

The metadata used when invoking the action/target.

Since:

BlackBerry 10.0.0

bb::cascades::InvokeState::Type state ()

Gets the current state of the InvokeActionItem.

Return:

The current state of the InvokeActionItem.

Since:

BlackBerry 10.0.0

bb::cascades::AbstractA11yObject * accessibility ()Inherited

Returns the accessibility object.

Return:

The accessibility object.

Since:

BlackBerry 10.2.0

Q_INVOKABLE void addShortcut (Inherited

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 ()Inherited

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 ()Inherited

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 ()Inherited

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 ()Inherited

Enables all shortcuts attached to the AbstractActionItem.

Since:

BlackBerry 10.1.0

virtual bool event (Inherited

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 ()Inherited

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 ()Inherited

Returns the image source.

Return:

The source of the displayed image.

Since:

BlackBerry 10.0.0

bool isDefaultAction ()Inherited

Returns true if the action item is the default action.

Return:

true if the action item is the default action, false otherwise.

Since:

BlackBerry 10.3.1

bool isEnabled ()Inherited

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 ()Inherited

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

Since:

BlackBerry 10.1.0

Q_INVOKABLE bool removeShortcut (Inherited

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 ()Inherited

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

Since:

BlackBerry 10.3.0

Q_INVOKABLE void resetBuiltInShortcutsEnabled ()Inherited

Resets a builtInShortcutsEnabled property to default value.

Default value is true.

Since:

BlackBerry 10.2.0

Q_SLOT void resetDefaultAction ()Inherited

Resets the action item to not being the default action.

Since:

BlackBerry 10.3.1

Q_SLOT void resetEnabled ()Inherited

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 ()Inherited

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 ()Inherited

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 ()Inherited

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

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

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

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 setDefaultAction (
  • booldefaultAction)
Inherited

Specifies if this action item is the default action.

The default action will get focus when opening a menu where the action item is presented. Note that the action will not get focus if the menu is already open. Specifying signature action placement for an action will change this property to true. If there is more than one default action when opening a menu the menu will give one of these actions focus.

Parameters
defaultAction

If true the action item is the default action and if false the action item is not the default action.

Since:

BlackBerry 10.3.1

Q_SLOT void setEnabled (
  • boolenabled)
Inherited

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

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

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

Sets the objectName property.

Parameters
name

The new name for the object.

Since:

BlackBerry 10.0.0

Q_SLOT void setTitle (Inherited

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

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 ()Inherited

Returns the number of shortcuts.

Return:

The number of shortcuts.

Since:

BlackBerry 10.1.0

const QString title ()Inherited

Gets the title of the action.

Return:

The title of the action.

Since:

BlackBerry 10.0.0

virtual Q_INVOKABLE QString toDebugString ()Inherited

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 ()Inherited

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

Usage:
 InvokeActionItem* pInvokeActionItem(InvokeActionItem::create(
   InvokeQuery::create()
     .parent(this)
     .mimeType("text/txt")));
Parameters
pQuery

The non-0 query to use in the invocation.

Return:

A builder used for constructing an InvokeActionItem.

Since:

BlackBerry 10.0.0

Protected Functions

(Only has inherited protected functions)

BaseObject (Inherited

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

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

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

Emitted when data has been changed.

Parameters
data

The new data set late by application.

Since:

BlackBerry 10.0.0

void finished (

Emitted when InvokeActionItem processing has finished.

Note:

Due to a work around for a Qt Core issue with accessing enums from QML the argument of this signal doesn't follow naming convention for signals in which the signal arguments are typically named to match the associated property's name. Use the object's property to access current property value instead of the signal argument to avoid runtime errors (i.e. use state instead of newState).

Parameters
newState

The final state of InvokeActionItem.

Since:

BlackBerry 10.0.0

void handlerChanged (

Since:

BlackBerry 10.0.0

void handlerChanged (

Emitted when the invoke handler is changed.

Parameters
handler

The new invocation handler.

Since:

BlackBerry 10.1.0

void metadataChanged (

Emitted when the metadata has changed.

Parameters
metadata

The new metadata.

Since:

BlackBerry 10.0.0

void stateChanged (

Emitted when the state has changed.

Note:

Due to a work around for a Qt Core issue with accessing enums from QML the argument of this signal doesn't follow naming convention for signals in which the signal arguments are typically named to match the associated property's name. Use the object's property to access current property value instead of the signal argument to avoid runtime errors (i.e. use state instead of newState).

Parameters
newState

The new state.

See also:

finished()

Since:

BlackBerry 10.0.0

void backgroundColorChanged (Inherited

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

Emitted when the builtInShortcutsEnabled property changes.

Parameters
builtInShortcutsEnabled

The new value.

Since:

BlackBerry 10.2.0

void creationCompleted ()Inherited

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 defaultActionChanged (
  • booldefaultAction)
Inherited

Emitted when the defaultAction property on the action item changes.

Parameters
defaultAction

If true the action item is the default action, if false the action item is not the default action.

Since:

BlackBerry 10.3.1

void enabledChanged (
  • boolenabled)
Inherited

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

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

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

This signal is emitted when the objectName property is changed.

Since:

BlackBerry 10.0.0

void titleChanged (Inherited

Emitted when the title has changed.

Parameters
title

The new title.

Since:

BlackBerry 10.0.0

void triggered ()Inherited

Emitted when the ActionItem is triggered by user.

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