TrackpadHandler

Since: BlackBerry 10.3.1

#include <bb/cascades/TrackpadHandler>

A handler for capturing input from the trackpad.

This handler returns minimally filtered events. To avoid hardware-specific dependencies it's recommended that you use the high-level NavigationHandler instead.


Overview

QML properties

consumeTrackpadEvents: bb::cascades::ConsumeTrackpadEvent::Types
attachedObjects: QDeclarativeListProperty< QObject > [read-only]Inherited
objectName: QStringInherited
parent: QObject [read-only]Inherited
ui: bb::cascades::UIConfig [read-only]Inherited

QML signals

Properties Index

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

Public Functions Index

TrackpadHandler (bb::cascades::UIObject *parent=0)
virtual ~TrackpadHandler ()
bb::cascades::ConsumeTrackpadEvent::TypesconsumeTrackpadEvents ()
Q_SLOT voidresetConsumeTrackpadEvents ()
Q_SLOT voidsetConsumeTrackpadEvents (bb::cascades::ConsumeTrackpadEvent::Types consumeTrackpadEvents)
virtual boolevent (QEvent *event)Inherited
voidsetObjectName (const QString &name)Inherited
virtual Q_INVOKABLE QStringtoDebugString () const Inherited
Q_INVOKABLE bb::cascades::UIConfig *ui () const Inherited

Static Public Functions Index

Buildercreate ()

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

voidconsumeTrackpadEventsChanged (bb::cascades::ConsumeTrackpadEvent::Types newConsumeTrackpadEvents)
voidtrackpad (bb::cascades::TrackpadEvent *event)
voidcreationCompleted ()Inherited
voidobjectNameChanged (const QString &objectName)Inherited

Properties

bb::cascades::ConsumeTrackpadEvent::Types consumeTrackpadEvents

This property defines which trackpad events that are consumed by the application.

Since:

BlackBerry 10.3.1

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

TrackpadHandler (

Creates a TrackpadHandler.

Parameters
parent

The parent object. The default is 0. If not 0, the ownership of the constructed object will be transferred to the parent object.

Since:

BlackBerry 10.3.1

virtual~TrackpadHandler ()

Destructor.

Since:

BlackBerry 10.3.1

bb::cascades::ConsumeTrackpadEvent::Types consumeTrackpadEvents ()

Gets the consume trackpad event types.

The flag describes which trackpad events that will be consumed.

Return:

The consume trackpad event types for this handler.

Since:

BlackBerry 10.3.1

Q_SLOT void resetConsumeTrackpadEvents ()

Reset the consume trackpad event types for this handler.

Since:

BlackBerry 10.3.1

Q_SLOT void setConsumeTrackpadEvents (
  • bb::cascades::ConsumeTrackpadEvent::TypesconsumeTrackpadEvents)

Sets which type of trackpad events that are consumed.

Parameters
consumeTrackpadEvents

The type of trackpad events that are consumed.

Since:

BlackBerry 10.3.1

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

Static Public Functions

Builder create ()

Creates and returns a builder for constructing an TrackpadHandler.

Using the builder to create a handler for receiving trackpad events:
 Container::create()
     .addEventHandler(TrackpadHandler::create()
         .onTrackpad(this, SLOT(handleTrackpad(bb::cascades::TrackpadEvent*))));
Return:

A Builder for constructing an TrackpadHandler.

Since:

BlackBerry 10.3.1

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 consumeTrackpadEventsChanged (
  • bb::cascades::ConsumeTrackpadEvent::TypesnewConsumeTrackpadEvents)

Emitted when the consume trackpad event types changes.

Parameters
newConsumeTrackpadEvents

The consume trackpad event types.

Since:

BlackBerry 10.3.1

void trackpad (

Emitted when a trackpad event is received from the trackpad.

Parameters
event

The trackpad event.

Since:

BlackBerry 10.3.1

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