RearrangeHandler

Since: BlackBerry 10.3.0

#include <bb/cascades/RearrangeHandler>

The object type of the rearrange handler used to manage rearrange sessions.

An application should never construct a handler itself. Instead use the already attached handler of the ListView by accessing the ListView::rearrangeHandler property.

For more information about rearranging lists, see the [Rearranging lists documentation](https://developer.blackberry.com/native/documentation/cascades/ui/lists/list_view_selection.html#rearranginglists103).


Overview

Inheritance

bb::cascades::BaseObject
bb::cascades::UIObject
bb::cascades::RearrangeHandler

QML properties

active: bool
attachedObjects: QDeclarativeListProperty< QObject > [read-only]Inherited
objectName: QStringInherited
parent: QObject [read-only]Inherited
ui: bb::cascades::UIConfig [read-only]Inherited

Properties Index

boolactive
QDeclarativeListProperty< QObject >attachedObjects [read-only]Inherited
QStringobjectNameInherited
QObjectparent [read-only]Inherited
bb::cascades::UIConfigui [read-only]Inherited

Public Functions Index

Q_SLOT boolactive ()
Q_SLOT voidsetActive (bool active)
virtual boolevent (QEvent *event)Inherited
voidsetObjectName (const QString &name)Inherited
virtual Q_INVOKABLE QStringtoDebugString () const Inherited
Q_INVOKABLE bb::cascades::UIConfig *ui () const Inherited

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

voidactiveChanged (bool active)
voidmoveAborted (bb::cascades::RearrangeMoveEndEvent *event)
voidmoveEnded (bb::cascades::RearrangeMoveEndEvent *event)
voidmoveStarted (bb::cascades::RearrangeMoveStartEvent *event)
voidmoveUpdated (bb::cascades::RearrangeMoveUpdateEvent *event)
voidcreationCompleted ()Inherited
voidobjectNameChanged (const QString &objectName)Inherited

Properties

bool active

Activates or deactivates rearrange mode on the hosting ListView.

Since:

BlackBerry 10.3.0

QDeclarativeListProperty< QObject > attachedObjectsInherited[read-only]

A hierarchical list of the UIObject's attached objects.

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

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

Q_SLOT bool active ()

Returns the current value of the property RearrangeHandler::active.

Return:

The active state of the handler.

Since:

BlackBerry 10.3.0

Q_SLOT void setActive (
  • boolactive)

Sets the value for the property RearrangeHandler::active.

Parameters
active

The new value for the property.

Since:

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

void setObjectName (Inherited

Sets the objectName property.

Parameters
name

The new name for the object.

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

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 activeChanged (
  • boolactive)

Emitted when the active state of the handler changes.

Parameters
active

The new active state of the handler.

Since:

BlackBerry 10.3.0

void moveAborted (

Emitted when the currently active move session is aborted.

This occurs when the framework forcefully terminates the session, thereby interrupting any current user interaction. Note that the item will remain where it was last moved to, that is, the position it had after the most recent moveUpdated() signal that wasn't denied.

Parameters
event

An event object containing details and support for handling the signal. The event object must not be stored for later use, because it is destroyed after emitting the signal.

Since:

BlackBerry 10.3.0

void moveEnded (

Emitted when the currently active rearrange session is ended normally.

Parameters
event

An event object containing details and support for handling the signal. The event object must not be stored for later use, because it is destroyed after emitting the signal.

Since:

BlackBerry 10.3.0

void moveStarted (

Emitted when a move session is started.

Parameters
event

An event object containing details and support for handling the signal. The event object must not be stored for later use, because it is destroyed after emitting the signal.

Since:

BlackBerry 10.3.0

void moveUpdated (

Emitted when the item being rearranged is hovering over a possible target destination.

The application can either choose to respond to this signal by performing the move within the data model. In such case, the empty space in the list layout will move to the new drop target. The user still retains control over the item visual. If an application chooses to ignore the request, the list layout will remain unchanged. The user still retains control over the drag visual.

**IMPORTANT**: Signalling the move operation to the list must be done by emitting the DataModel::itemMoved() signal. Notifying the list through pairs of DataModel::itemRemoved() DataModel::itemAdded() will cause the move session to be aborted since the list will receive a remove signal for the item being rearranged.

Parameters
event

An event object containing details and support for handling the signal. The event object must not be stored for later use, because it is destroyed after emitting the signal.

Since:

BlackBerry 10.3.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 objectNameChanged (Inherited

This signal is emitted when the objectName property is changed.

Since:

BlackBerry 10.0.0

Last modified: 2015-03-26



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

comments powered by Disqus