AbstractPane

#include <bb/cascades/AbstractPane>

An abstract class that provides functionality for inherited page and pane classes.

Only classes deriving from the AbstractPane class can be set as the root component of an application. This means that every application will have at least one object that derives from AbstractPane.

AbstractPane has an attribute called paneProperties, which contains properties used for visual representation within its parent (for example, a title or icon). The type of pane properties of the child must match up with parent. For example, if you add a Page to a NavigationPane, the Page must use NavigationPaneProperties.

AbstractPane has another attribute called peekedAt. When true, a user is currently "peeking" at the AbstractPane from another pane. Depending on the type of AbstractPane, peeking behaves differently. In a NavigationPane, the user can swipe from left to right to peek at the previous pane in the stack, or drag the Back button to peek at root pane. On a Sheet, the user can swipe from left to right to peek at the content directly beneath it.

Here's an example that shows "peeking" from a sheet to the page behind it.

See:

Page, TabbedPane, NavigationPane

Since:

BlackBerry 10.0.0

Inheritance

bb::cascades::BaseObject
bb::cascades::UIObject
bb::cascades::AbstractPane
bb::cascades::NavigationPane
bb::cascades::Page
bb::cascades::TabbedPane

QML properties

paneProperties: bb::cascades::PaneProperties
peekedAt: bool [read-only]
shortcuts: QDeclarativeListProperty< bb::cascades::AbstractShortcut > [read-only]
keyListeners: QDeclarativeListProperty< bb::cascades::KeyListener > [read-only]
attachedObjects: QDeclarativeListProperty< QObject > [read-only]Inherited
objectName: QStringInherited
parent: QObject [read-only]Inherited

Properties Index

bb::cascades::PanePropertiespaneProperties
boolpeekedAt [read-only]
QDeclarativeListProperty< bb::cascades::AbstractShortcut >shortcuts [read-only]
QDeclarativeListProperty< bb::cascades::KeyListener >keyListeners [read-only]
QDeclarativeListProperty< QObject >attachedObjects [read-only]Inherited
QStringobjectNameInherited
QObjectparent [read-only]Inherited

Public Functions Index

virtual ~AbstractPane ()
Q_INVOKABLE voidaddShortcut (bb::cascades::AbstractShortcut *shortcut)
Q_INVOKABLE boolremoveShortcut (bb::cascades::AbstractShortcut *shortcut)
Q_INVOKABLE voidremoveAllShortcuts ()
Q_INVOKABLE intshortcutCount () const
Q_INVOKABLE bb::cascades::AbstractShortcut *shortcutAt (int index) const
Q_INVOKABLE voidenableAllShortcuts ()
Q_INVOKABLE voiddisableAllShortcuts ()
Q_INVOKABLE voidaddKeyListener (bb::cascades::KeyListener *keyListener)
Q_INVOKABLE boolremoveKeyListener (bb::cascades::KeyListener *keyListener)
Q_INVOKABLE voidremoveAllKeyListeners ()
Q_INVOKABLE intkeyListenerCount () const
Q_INVOKABLE bb::cascades::KeyListener *keyListenerAt (int index) const
bb::cascades::PaneProperties *paneProperties () const
Q_SLOT voidsetPaneProperties (bb::cascades::PaneProperties *paneProperties)
Q_SLOT voidresetPaneProperties ()
boolisPeekedAt () const
virtual boolevent (QEvent *event)Inherited
voidsetObjectName (const QString &name)Inherited
virtual Q_INVOKABLE QStringtoDebugString () 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

voidpanePropertiesChanged (bb::cascades::PaneProperties *paneProperties)
voidpeekedAtChanged (bool peekedAt)
voidpeekStarted ()
voidpeekEnded ()
voidcreationCompleted ()Inherited
voidobjectNameChanged (const QString &objectName)Inherited

Properties

bb::cascades::PaneProperties paneProperties

The pane properties for this AbstractPane.

The paneProperties property specifies data that the parent AbstractPane may use. The type of pane properties of the child must match up with parent. For example, if you add a Page to a NavigationPane, you must use NavigationPaneProperties.

By default, the paneProperties of an AbstractPane is 0.

Since:

BlackBerry 10.0.0

bool peekedAt[read-only]

Indicates whether this AbstractPane is being "peeked" at.

If true, the pane is currently being revealed by peeking from a Sheet or a Page within a NavigationPane. By default, the value is false, indicating that the pane is not currently being peeked at.

If a NavigationPane is being peeked at, both the NavigationPane and its currently visible page will return true for the peekedAt property.

As a convenience, there are two signals available called peekStarted and peekEnded, which are emitted when a peek on the AbstractPane starts or ends.

The peekedAtChanged() signal is emitted when peekedAt changes.

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:

AbstractShortcut

Since:

BlackBerry 10.1.0

QDeclarativeListProperty< bb::cascades::KeyListener > keyListeners[read-only]

A list of key listeners attached to this abstract pane.

The order in which key listeners are added does not change their behavior.

See:

KeyListener

Since:

BlackBerry 10.1.0

QDeclarativeListProperty< QObject > attachedObjectsInherited[read-only]

A hierarchical list of the UIObject's attached objects.

This QDeclarativeListProperty can contain any QObject. When a QObject is added to property, the UIObject takes ownership of the attached object.

This feature is typically used from QML to specify business logic object or any other shared objects for the subnodes of this UIObject. In C++ the same functionality can be achived by setting a parent of a QObject to be attached to the QObject which is going to own it.

QML usage example (MyObject is a custom class registered for QML using the qmlRegisterType() function):

Container {
    Label { text: "Title: " + myObject.title } 
    Label { text: "Subject: " + myObject.subject }
    attachedObjects: [
        MyObject { id: myObject
            title: "Hello World"
            subject: "Nice Day"
        }
    ]
}

Since:

BlackBerry 10.0.0

QString objectNameInherited

This property is overridden from QObject.

As the objectName property is overridden from the QObject class, this signal will not be emitted if setObjectName() function is called directly on QObject.

The default value of this property is QString::null.

See:

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

Public Functions

virtual~AbstractPane ()

Destructor.

Q_INVOKABLE void addShortcut (

Adds a shortcut to the AbstractPane.

AbstractPane will always take ownership as shortcuts should never be shared. If the shortcut already belongs to the AbstractPane 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 AbstractPane.
Since:

BlackBerry 10.1.0

Q_INVOKABLE bool removeShortcut (

Removes a shortcut from the AbstractPane.

Once the shortcut is removed, the AbstractPane no longer references it, but it is still owned by the AbstractPane. 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 AbstractPane (in which case it will be deleted with the AbstractPane).

Parameters
shortcut

The AbstractShortcut to remove.

Return:

true if the shortcut was owned by the AbstractPane, false otherwise.

Since:

BlackBerry 10.1.0

Q_INVOKABLE void removeAllShortcuts ()

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

Since:

BlackBerry 10.1.0

Q_INVOKABLE int shortcutCount ()

Returns the number of shortcuts.

Return:

The number of shortcuts.

Since:

BlackBerry 10.1.0

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

Returns a shortcut at the specified index.

Ownership of the shortcut remains with the AbstractPane.

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 void enableAllShortcuts ()

Enables all shortcuts attached to the AbstractPane.

Since:

BlackBerry 10.1.0

Q_INVOKABLE void disableAllShortcuts ()

Disables all shortcuts attached to the AbstractPane.

Shortcuts that are attached afterward will use the default enabled state.

Since:

BlackBerry 10.1.0

Q_INVOKABLE void addKeyListener (

Adds a key listener to the AbstractPane.

AbstractPane will always take ownership as key listener should never be shared. If the key listener already belongs to the AbstractPane or the key listener is 0, nothing will happen.

Parameters
keyListener

The KeyListener to add to the AbstractPane.
Since:

BlackBerry 10.1.0

Q_INVOKABLE bool removeKeyListener (

Removes a key listener from the AbstractPane.

Once the key listener is removed, the AbstractPane no longer references it, but it is still owned by the AbstractPane. It is up to the application to either delete the removed key listener, transfer its ownership (by setting its parent) to another object, or leave it as a child of the AbstractPane (in which case it will be deleted with the AbstractPane).

Parameters
keyListener

The KeyListener to remove.

Return:

true if the key listener was owned by the AbstractPane, false otherwise.

Since:

BlackBerry 10.1.0

Q_INVOKABLE void removeAllKeyListeners ()

Removes all of AbstractPane's key listeners and frees up their memory.

Since:

BlackBerry 10.1.0

Q_INVOKABLE int keyListenerCount ()

Returns the number of key listeners.

Return:

The number of key listeners.

Since:

BlackBerry 10.1.0

Q_INVOKABLE bb::cascades::KeyListener * keyListenerAt (
  • intindex)

Returns a key listener at the specified index.

Ownership of the key listener remains with the AbstractPane.

Parameters
index

The index of the key listener.

Return:

The requested key listener if the index was valid, 0 otherwise.

Since:

BlackBerry 10.1.0

bb::cascades::PaneProperties * paneProperties ()

Returns the PaneProperties object for the pane.

Ownership of the PaneProperties object remains unchanged.

Return:

The PaneProperties for the pane.

Since:

BlackBerry 10.0.0

Q_SLOT void setPaneProperties (

Sets the paneProperties property for the pane.

The pane takes ownership of the PaneProperties object if no other pane owns it already. If the PaneProperties object already has an owner, the properties are applied to the pane, but ownership of the PaneProperties object remains unchanged. If the pane already owns a PaneProperties object, the existing settings are replaced by the specified PaneProperties object and the pane retains ownership of both.

Parameters
paneProperties

The new PaneProperties for the pane.
Since:

BlackBerry 10.0.0

Q_SLOT void resetPaneProperties ()

Resets the paneProperties property for the pane to 0.

Since:

BlackBerry 10.0.0

bool isPeekedAt ()

Indicates if this AbstractPane is being peeked at.

Return:

true if being peeked at, false otherwise.

Since:

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

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

Emitted when the paneProperties of the pane changes.

Parameters
paneProperties

The new PaneProperties for the AbstractPane.
Since:

BlackBerry 10.0.0

void peekedAtChanged (
  • boolpeekedAt)

Emitted when the peekedAt property of this AbstractPane changes.

Parameters
peekedAt

If true the AbstractPane is being peeked at, otherwise false.
Since:

BlackBerry 10.0.0

void peekStarted ()

Emitted when a peek on this AbstractPane starts.

Since:

BlackBerry 10.0.0

void peekEnded ()

Emitted when a peek on this AbstractPane ends.

Since:

BlackBerry 10.0.0

void creationCompleted ()Inherited

This signal is emitted only when this object is instantiated as a result of loading a QML document and creating the root node, or when an object is being constructed using its builder class.

This signal is emitted only 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 is emitted to indicate 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:

QmlDocument

Since:

BlackBerry 10.0.0

void objectNameChanged (Inherited

This signal is emitted when the objectName property is changed.

See:

QObject, BaseObject::objectName.

Since:

BlackBerry 10.0.0