NavigationHandler

Since: BlackBerry 10.3.1

#include <bb/cascades/NavigationHandler>

A handler for reacting to navigation events from the trackpad.

This handler captures high-level navigation events that are filtered and scaled for the dpi of the device (unlike TrackpadHandler which captures minimally filtered events).

You can attach a handler to any node in your app by using VisualNode::addEventHandler().

Overview

Inheritance

bb::cascades::BaseObject
	bb::cascades::UIObject
		bb::cascades::AbstractEventHandler
			bb::cascades::NavigationHandler

QML properties

consumeNavigationEvents	: bb::cascades::ConsumeNavigationEvent::Types
attachedObjects	: QDeclarativeListProperty< QObject > [read-only]
objectName	: QString
parent	: QObject [read-only]
ui	: bb::cascades::UIConfig [read-only]

QML signals

onConsumeNavigationEventsChanged	: {}
onNavigation	: {}
onCreationCompleted	: {}
onObjectNameChanged	: {}

Properties Index

bb::cascades::ConsumeNavigationEvent::Types	consumeNavigationEvents
QDeclarativeListProperty< QObject >	attachedObjects [read-only]
QString	objectName
QObject	parent [read-only]
bb::cascades::UIConfig	ui [read-only]

Public Functions Index

	NavigationHandler (bb::cascades::UIObject *parent=0)
virtual	~NavigationHandler ()
bb::cascades::ConsumeNavigationEvent::Types	consumeNavigationEvents ()
Q_SLOT void	resetConsumeNavigationEvents ()
Q_SLOT void	setConsumeNavigationEvents (bb::cascades::ConsumeNavigationEvent::Types consumeNavigationEvents)
virtual bool	event (QEvent *event)
void	setObjectName (const QString &name)
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

void	consumeNavigationEventsChanged (bb::cascades::ConsumeNavigationEvent::Types newConsumeNavigationEvents)
void	navigation (bb::cascades::NavigationEvent *event)
void	creationCompleted ()
void	objectNameChanged (const QString &objectName)

Properties

bb::cascades::ConsumeNavigationEvent::Types consumeNavigationEvents

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

Since:

BlackBerry 10.3.1

QDeclarativeListProperty< QObject > attachedObjects[read-only]

A hierarchical list of the UIObject's attached objects.

Since:

BlackBerry 10.0.0

QString objectName

This property is overridden from QObject.

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

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

NavigationHandler (
bb::cascades::UIObject *parent)

Creates a NavigationHandler.

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

Since:

BlackBerry 10.3.1

virtual~NavigationHandler ()

Destructor.

Since:

BlackBerry 10.3.1

bb::cascades::ConsumeNavigationEvent::Types consumeNavigationEvents ()

Gets the consume navigation event types.

The flag describes which navigation events that will be consumed.

Return:

The consume navigation event types for this handler.

Since:

BlackBerry 10.3.1

Q_SLOT void resetConsumeNavigationEvents ()

Reset the consume navigation event types for this handler.

Since:

BlackBerry 10.3.1

Q_SLOT void setConsumeNavigationEvents (
bb::cascades::ConsumeNavigationEvent::TypesconsumeNavigationEvents)

Sets which type of navigation events that are consumed.

Parameters
consumeNavigationEvents	The type of navigation events that are consumed.

Since:

BlackBerry 10.3.1

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

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

Using the builder to create a handler for receiving navigation events:

 Container::create()
     .addEventHandler(NavigationHandler::create()
         .onNavigation(this, SLOT(handleTouch(bb::cascades::NavigationEvent*))));

Return:

A Builder for constructing an NavigationHandler.

Since:

BlackBerry 10.3.1

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 consumeNavigationEventsChanged (
bb::cascades::ConsumeNavigationEvent::TypesnewConsumeNavigationEvents)

Emitted when the consume navigation event types changes.

Parameters
newConsumeNavigationEvents	The consume navigation event types.

Since:

BlackBerry 10.3.1

void navigation (
bb::cascades::NavigationEvent *event)

Emitted when a trackpad event is received from the trackpad.

Parameters
event	The trackpad event.

Since:

BlackBerry 10.3.1

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.

void objectNameChanged (
const QString &objectName)

This signal is emitted when the objectName property is changed.

NavigationHandler

Overview

Inheritance

QML properties

QML signals

Properties Index

Public Functions Index

Static Public Functions Index

Protected Functions Index

Signals Index

Properties

bb::cascades::ConsumeNavigationEvent::Types consumeNavigationEvents

QDeclarativeListProperty< QObject > attachedObjects[read-only]

QString objectName

QObject parent[read-only]

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

Public Functions

NavigationHandler (bb::cascades::UIObject *parent)

virtual~NavigationHandler ()

bb::cascades::ConsumeNavigationEvent::Types consumeNavigationEvents ()

Q_SLOT void resetConsumeNavigationEvents ()

Q_SLOT void setConsumeNavigationEvents (bb::cascades::ConsumeNavigationEvent::TypesconsumeNavigationEvents)

virtual bool event (QEvent *event)

void setObjectName (const QString &name)

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 consumeNavigationEventsChanged (bb::cascades::ConsumeNavigationEvent::TypesnewConsumeNavigationEvents)

void navigation (bb::cascades::NavigationEvent *event)

void creationCompleted ()

void objectNameChanged (const QString &objectName)

1. Download the tools

2. Try the sample apps

3. Educate yourself

4. Start developing

NavigationHandler (
bb::cascades::UIObject *parent)

Q_SLOT void setConsumeNavigationEvents (
bb::cascades::ConsumeNavigationEvent::TypesconsumeNavigationEvents)

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 consumeNavigationEventsChanged (
bb::cascades::ConsumeNavigationEvent::TypesnewConsumeNavigationEvents)

void navigation (
bb::cascades::NavigationEvent *event)

void objectNameChanged (
const QString &objectName)