Page

#include <bb/cascades/Page>

Defines an individual screen within an application.

On a Page it's possible to specify a root control and a set of actions. The actions are displayed on the Action bar placed at the bottom of the screen. If no actions are specified, the Action bar will not be displayed, and the screen content assumes the full height of the screen. As soon as one or more actions are added, the Action bar will appear. To specify that an action should appear on the Action bar, rather than in the Action menu, the attached property ActionBar.placement can be used. Please note that the actionbar placement property will only be considered at initialization ie. it can only be specified once.

Here's an example of how to create a simple Page with an action placed on the Action bar.

Page {
    actions: [
        ActionItem {
            title: "Refresh"
            onTriggered: app.initiateRequest()
            ActionBar.placement: ActionBarPlacement.OnBar
        }
    ]
    content: Container {
        layout: DockLayout {}
       
        ActivityIndicator {
            verticalAlignment: VerticalAlignment.Fill
            horizontalAlignment: HorizontalAlignment.Fill    
        }
    }
}

See:

ActionItem

Since:

BlackBerry 10.0.0

Inheritance

bb::cascades::BaseObject
	bb::cascades::UIObject
		bb::cascades::AbstractPane
			bb::cascades::Page

QML properties

titleBar	: bb::cascades::TitleBar
actions	: QDeclarativeListProperty< bb::cascades::AbstractActionItem > [read-only]
content	: bb::cascades::Control
resizeBehavior	: bb::cascades::PageResizeBehavior::Type
actionBarVisibility	: bb::cascades::ChromeVisibility::Type
actionMenuVisualState	: bb::cascades::ActionMenuVisualState::Type [read-only]
inputRoute	: bb::cascades::InputRouteProperties [read-only]
actionBarAutoHideBehavior	: bb::cascades::ActionBarAutoHideBehavior::Type
accessibility	: bb::cascades::AbstractAccessibilityObject [read-only]
attachedObjects	: QDeclarativeListProperty< QObject > [read-only]
keyListeners	: QDeclarativeListProperty< bb::cascades::KeyListener > [read-only]
objectName	: QString
paneProperties	: bb::cascades::PaneProperties
parent	: QObject [read-only]
peekedAt	: bool [read-only]
shortcuts	: QDeclarativeListProperty< bb::cascades::AbstractShortcut > [read-only]

QML signals

onActionBarAutoHideBehaviorChanged	: {}
onActionBarVisibilityChanged	: {}
onResizeBehaviorChanged	: {}
onTitleBarChanged	: {}
onContentChanged	: {}
onActionAdded	: {}
onActionRemoved	: {}
onActionMenuVisualStateChanged	: {}
onCreationCompleted	: {}
onObjectNameChanged	: {}
onPanePropertiesChanged	: {}
onPeekedAtChanged	: {}
onPeekEnded	: {}
onPeekStarted	: {}

Properties Index

bb::cascades::TitleBar	titleBar
QDeclarativeListProperty< bb::cascades::AbstractActionItem >	actions [read-only]
bb::cascades::Control	content
bb::cascades::PageResizeBehavior::Type	resizeBehavior
bb::cascades::ChromeVisibility::Type	actionBarVisibility
bb::cascades::ActionMenuVisualState::Type	actionMenuVisualState [read-only]
bb::cascades::InputRouteProperties	inputRoute [read-only]
bb::cascades::ActionBarAutoHideBehavior::Type	actionBarAutoHideBehavior
bb::cascades::AbstractAccessibilityObject	accessibility [read-only]
QDeclarativeListProperty< QObject >	attachedObjects [read-only]
QDeclarativeListProperty< bb::cascades::KeyListener >	keyListeners [read-only]
QString	objectName
bb::cascades::PaneProperties	paneProperties
QObject	parent [read-only]
bool	peekedAt [read-only]
QDeclarativeListProperty< bb::cascades::AbstractShortcut >	shortcuts [read-only]

Public Functions Index

bb::cascades::TitleBar *	titleBar () const
Q_SLOT void	setTitleBar (bb::cascades::TitleBar *titleBar)
Q_SLOT void	resetTitleBar ()
	Page (QObject *parent=0)
virtual	~Page ()
Q_INVOKABLE void	addAction (bb::cascades::AbstractActionItem *actionItem, bb::cascades::ActionBarPlacement::Type placement=bb::cascades::ActionBarPlacement::Default)
Q_INVOKABLE bool	removeAction (bb::cascades::AbstractActionItem *actionItem)
Q_INVOKABLE void	removeAllActions ()
Q_INVOKABLE int	actionCount () const
Q_INVOKABLE bb::cascades::AbstractActionItem *	actionAt (int index) const
void	setContent (bb::cascades::Control *content)
bb::cascades::Control *	content () const
bb::cascades::PageResizeBehavior::Type	resizeBehavior () const
Q_SLOT void	setResizeBehavior (bb::cascades::PageResizeBehavior::Type resizeBehavior)
Q_SLOT void	resetResizeBehavior ()
void	setActionBarVisibility (const bb::cascades::ChromeVisibility::Type visibility)
bb::cascades::ChromeVisibility::Type	actionBarVisibility () const
Q_SLOT void	resetActionBarVisibility ()
bb::cascades::ActionMenuVisualState::Type	actionMenuVisualState () const
bb::cascades::InputRouteProperties *	inputRoute () const
bb::cascades::ActionBarAutoHideBehavior::Type	actionBarAutoHideBehavior () const
Q_SLOT void	setActionBarAutoHideBehavior (bb::cascades::ActionBarAutoHideBehavior::Type actionBarAutoHideBehavior)
Q_SLOT void	resetActionBarAutoHideBehavior ()
bb::cascades::AbstractAccessibilityObject *	accessibility () const
Q_INVOKABLE void	addKeyListener (bb::cascades::KeyListener *keyListener)
Q_INVOKABLE void	addShortcut (bb::cascades::AbstractShortcut *shortcut)
Q_INVOKABLE void	disableAllShortcuts ()
Q_INVOKABLE void	enableAllShortcuts ()
virtual bool	event (QEvent *event)
bool	isPeekedAt () const
Q_INVOKABLE bb::cascades::KeyListener *	keyListenerAt (int index) const
Q_INVOKABLE int	keyListenerCount () const
bb::cascades::PaneProperties *	paneProperties () const
Q_INVOKABLE void	removeAllKeyListeners ()
Q_INVOKABLE void	removeAllShortcuts ()
Q_INVOKABLE bool	removeKeyListener (bb::cascades::KeyListener *keyListener)
Q_INVOKABLE bool	removeShortcut (bb::cascades::AbstractShortcut *shortcut)
Q_SLOT void	resetPaneProperties ()
void	setObjectName (const QString &name)
Q_SLOT void	setPaneProperties (bb::cascades::PaneProperties *paneProperties)
Q_INVOKABLE bb::cascades::AbstractShortcut *	shortcutAt (int index) const
Q_INVOKABLE int	shortcutCount () const
virtual Q_INVOKABLE QString	toDebugString () 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	actionBarAutoHideBehaviorChanged (bb::cascades::ActionBarAutoHideBehavior::Type newActionBarAutoHideBehavior)
void	actionBarVisibilityChanged (bb::cascades::ChromeVisibility::Type newVisibility)
void	resizeBehaviorChanged (bb::cascades::PageResizeBehavior::Type newResizeBehavior)
void	titleBarChanged (bb::cascades::TitleBar *titleBar)
void	contentChanged (bb::cascades::Control *content)
void	actionAdded (bb::cascades::AbstractActionItem *action)
void	actionRemoved (bb::cascades::AbstractActionItem *action)
void	actionMenuVisualStateChanged (bb::cascades::ActionMenuVisualState::Type newActionMenuVisualState)
void	creationCompleted ()
void	objectNameChanged (const QString &objectName)
void	panePropertiesChanged (bb::cascades::PaneProperties *paneProperties)
void	peekedAtChanged (bool peekedAt)
void	peekEnded ()
void	peekStarted ()

Properties

bb::cascades::TitleBar titleBar

The title bar properties for this Page.

By default, the titleBar of a Page is 0.

Since:

BlackBerry 10.0.0

QDeclarativeListProperty< bb::cascades::AbstractActionItem > actions[read-only]

A list of actions that will be displayed on the Action bar or in the Action menu.

The order in which they are added will determine how they appear on the Action bar and in the Action menu.

Since this list consists of AbstractActionItem, you should cast the value to either an ActionItem or an InvokeActionItem before you use them.

Only one DeleteActionItem and MultiSelectActionItem can be displayed at one time. If more than one is added, only the first one is used and the rest are ignored. They are placed at a fixed position on the Action bar or in the Action menu along with the other actions. The MultiSelectActionItem is used to start a multiple selection session.

See:

ActionItem

InvokeActionItem

Since:

BlackBerry 10.0.0

bb::cascades::Control content

The root control for the Page (the contents of the screen).

This is the default property of the Page control, so it does not need to be explicitly declared in QML. A control added inside the Page will automatically be assigned to the content property.

Page {
    Container {
        Button {}
        Button {}
    }
}

The code snippet above is equal to the following code snippet:

Page {
    content: Container {
        Button {}
        Button {}
    }
}

Since:

BlackBerry 10.0.0

bb::cascades::PageResizeBehavior::Type resizeBehavior

The different ways that a Page can be resized when the available screen space is affected by external components (for example, when the keyboard appears).

The default resize behavior is PageResizeBehavior::Resize, but PageResizeBehavior::None can also be used.

Since:

BlackBerry 10.0.0

bb::cascades::ChromeVisibility::Type actionBarVisibility

Specifies the Action bar visibility.

This property specifies the visibility mode of the associated Action bar. By default, the Action bar is fully visible (if there are actions) and the Page content is compressed to show the Action bar at the bottom of the screen. Using this property, you can set the Action bar to either be overlaid (on top of the Page) or fully hidden.

Page {
    actionBarVisibility: ChromeVisibility.Overlay
}

Since:

BlackBerry 10.0.0

bb::cascades::ActionMenuVisualState::Type actionMenuVisualState[read-only]

The current visual state of the action menu.

Since:

BlackBerry 10.0.0

bb::cascades::InputRouteProperties inputRoute[read-only]

Defines this page's role in the propagation of input events.

QML usage:

Page {
    inputRoute.primaryKeyTarget: true

    shortcuts: [
        Shortcut {
            key: "a"
            onTriggered: {
                myLabel.text = "Shortcut triggered!"
            }
        }
    ]

    content: Label {
        id: myLabel;
    }
}

C++ usage:

Page *pPage = new Page();
pPage->inputRoute()->setPrimaryKeyTarget(true);

C++ usage (with builder):

Page *pPage = Page::create()
    .primaryKeyTarget(true)
    .content(Label::create()
            .text("My Page is the primary key target!"));

Since:

BlackBerry 10.1.0

bb::cascades::ActionBarAutoHideBehavior::Type actionBarAutoHideBehavior

Sets the auto-hide behavior of the Action Bar.

The Page uses the concept of "main scrollable" to decide which scrollable control to listen to for auto-hide behavior of the Action Bar. If a Page finds a main scrollable, either by the user explicitly specifying one, or automatically by inspecting the ui-tree, it will consider hiding the Action Bar when appropriate. Hiding the Action Bar is a best practice for devices with small screens and on OLED (organic light-emitting diode) screens to prevent burn in.

See:

ListView::scrollRole

ScrollView::scrollRole

Since:

BlackBerry 10.1.0

bb::cascades::AbstractAccessibilityObject accessibility[read-only]

Defines this UIObject's accessibility object used by assistive technologies for people with disabilities or special needs, e.g.

visual impairment.

See:

Control::accessibility

Since:

BlackBerry 10.2.0

QDeclarativeListProperty< QObject > attachedObjects[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

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

QString objectName

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

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

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

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

Public Functions

bb::cascades::TitleBar * titleBar ()

Returns the TitleBar object for the page.

Return:

The TitleBar for the page.

Since:

BlackBerry 10.0.0

Q_SLOT void setTitleBar (
bb::cascades::TitleBar *titleBar)

Sets the TitleBar property for the Page.

The Page takes ownership of the TitleBar object. If the TitleBar object is already set on another Page, it is removed from the original Page. Ownership of the TitleBar object stays with the original Page.

Parameters
titleBar	The new TitleBar for the page or 0 to remove title bar from the page.

Since:

BlackBerry 10.0.0

Q_SLOT void resetTitleBar ()

Resets the titleBar property for the Page to 0.

Since:

BlackBerry 10.0.0

Page (
QObject *parent)

Constructs a Page.

Since:

BlackBerry 10.0.0

virtual~Page ()

Destructor.

Since:

BlackBerry 10.0.0

Q_INVOKABLE void addAction (
bb::cascades::AbstractActionItem *actionItem,
bb::cascades::ActionBarPlacement::Typeplacement )

Adds an action to the Page.

A Page will always take ownership of the action, as actions should typically not be shared. If the action already belongs to the Page or the actionItem is 0, nothing will happen. If the operation was successful, the actionAdded() signal will be emitted. The order in which actions are added will decide how they appear on the Action bar and in the Action menu.

Valid action items are ActionItem or InvokeActionItem, and all other items will be ignored.

Parameters
actionItem	The ActionItem or InvokeActionItem to add to the Page.
placement	Specifies where the action should be placed.

Since:

BlackBerry 10.0.0

Q_INVOKABLE bool removeAction (
bb::cascades::AbstractActionItem *actionItem)

Removes an action from the Page.

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

If operation was successful, the actionRemoved() signal will be emitted.

Parameters
actionItem	The ActionItem or InvokeActionItem to remove.

Return:

true if the action was owned by the Page, false otherwise.

Since:

BlackBerry 10.0.0

Q_INVOKABLE void removeAllActions ()

Removes all actions on a Page and frees their memory.

The actionRemoved(bb::cascades::AbstractActionItem*) signal is emitted with 0 as its parameter.

Since:

BlackBerry 10.0.0

Q_INVOKABLE int actionCount ()

Returns the number of actions.

Return:

The number of actions.

Since:

BlackBerry 10.0.0

Q_INVOKABLE bb::cascades::AbstractActionItem * actionAt (
intindex)

Returns an action at the specified index.

Ownership of the action remains with the Page.

Since this method returns an AbstractActionItem, you should cast the value to either an ActionItem or an InvokeActionItem before you use it. For example:

AbstractActionItem *item = myPage->actionAt(0);
ActionItem *castedItem = qobject_cast<ActionItem *>(item);

Parameters
index	The index of the action.

Return:

The requested action if the index was valid, 0 otherwise.

Since:

BlackBerry 10.0.0

void setContent (
bb::cascades::Control *content)

Set the content of the Page.

Ownership will always be transferred to the Page. If Page already has a content, the old content will still be owned by Page and destroyed when Page is destroyed. If operation was successful, the contentChanged() signal will be emitted.

Parameters
content	The content. Can be 0 to remove content (old content will still be owned by Page).

Since:

BlackBerry 10.0.0

bb::cascades::Control * content ()

Get the active content.

Ownership will not be transferred.

Return:

The content.

Since:

BlackBerry 10.0.0

bb::cascades::PageResizeBehavior::Type resizeBehavior ()

Returns the resize behavior for the Page.

Return:

The resize behavior.

Since:

BlackBerry 10.0.0

Q_SLOT void setResizeBehavior (
bb::cascades::PageResizeBehavior::TyperesizeBehavior)

Sets the resize behavior for the Page.

After the resize behavior is set, the resizeBehaviorChanged() signal is emitted.

Parameters
resizeBehavior	The new resize behavior.

Since:

BlackBerry 10.0.0

Q_SLOT void resetResizeBehavior ()

Resets the resize behavior for the Page to its default.

The default resize behavior is PageResizeBehavior::Resize.

After the resize behavior is set, the resizeBehaviorChanged() signal is emitted.

Since:

BlackBerry 10.0.0

void setActionBarVisibility (
const bb::cascades::ChromeVisibility::Typevisibility)

Sets the Action bar visibility mode.

This property specifies the visibility mode of the associated Action bar. By default, the Action bar is fully visible (if there are actions) and the content on the Page is compressed to display the Action bar at the bottom of the screen. Using this property, you can set the Action bar to either be overlaid (on top of the page) or fully hidden.

The signal actionBarVisibilityChanged() is emitted if the visibility mode is changed.

Parameters
visibility	The Action bar visibility mode.

Since:

BlackBerry 10.0.0

bb::cascades::ChromeVisibility::Type actionBarVisibility ()

Gets the Action bar visibility mode.

Return:

The Action bar visibility mode.

Since:

BlackBerry 10.0.0

Q_SLOT void resetActionBarVisibility ()

Resets the Action bar visibility mode to its default value.

The default value is ChromeVisibility::Default.

The signal actionBarVisibilityChanged() is emitted if the Action bar visibility mode is changed.

Since:

BlackBerry 10.0.0

bb::cascades::ActionMenuVisualState::Type actionMenuVisualState ()

Returns the current visual state of the action menu.

Return:

The current visual state of the action menu.

Since:

BlackBerry 10.0.0

bb::cascades::InputRouteProperties * inputRoute ()

Returns the input route properties object.

Return:

The input route properties object.

Since:

BlackBerry 10.1.0

bb::cascades::ActionBarAutoHideBehavior::Type actionBarAutoHideBehavior ()

Returns the actionBarAutoHideBehavior.

Return:

The current actionBarAutoHideBehavior.

Since:

BlackBerry 10.1.0

Q_SLOT void setActionBarAutoHideBehavior (
bb::cascades::ActionBarAutoHideBehavior::TypeactionBarAutoHideBehavior)

Sets the actionBarAutoHideBehavior.

The signal actionBarAutoHideBehaviorChanged() is emitted if the value is changed.

Parameters
actionBarAutoHideBehavior	The new actionBarAutoHideBehavior.

Since:

BlackBerry 10.1.0

Q_SLOT void resetActionBarAutoHideBehavior ()

Resets actionBarAutoHideBehavior to its default value.

The default value is Default. The signal actionBarAutoHideBehaviorChanged() is emitted if the value is changed.

Since:

BlackBerry 10.1.0

bb::cascades::AbstractAccessibilityObject * accessibility ()

Returns the accessibility object.

Return:

The accessibility object.

Since:

BlackBerry 10.2.0

Q_INVOKABLE void addKeyListener (
bb::cascades::KeyListener *keyListener)

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 void addShortcut (
bb::cascades::AbstractShortcut *shortcut)

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

Enables all shortcuts attached to the AbstractPane.

Since:

BlackBerry 10.1.0

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

bool isPeekedAt ()

Indicates if this AbstractPane is being peeked at.

Return:

true if being peeked at, false otherwise.

Since:

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

Q_INVOKABLE int keyListenerCount ()

Returns the number of key listeners.

Return:

The number of key listeners.

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_INVOKABLE void removeAllKeyListeners ()

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

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 bool removeKeyListener (
bb::cascades::KeyListener *keyListener)

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 bool removeShortcut (
bb::cascades::AbstractShortcut *shortcut)

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_SLOT void resetPaneProperties ()

Resets the paneProperties property for the pane to 0.

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

Q_SLOT void setPaneProperties (
bb::cascades::PaneProperties *paneProperties)

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_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 int shortcutCount ()

Returns the number of shortcuts.

Return:

The number of shortcuts.

Since:

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

Static Public Functions

Builder create ()

Creates and returns a builder for constructing a Page.

Using the builder to create a Page:

Page* page = Page::create();

Return:

A builder used for constructing a Page.

Since:

BlackBerry 10.0.0

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 actionBarAutoHideBehaviorChanged (
bb::cascades::ActionBarAutoHideBehavior::TypenewActionBarAutoHideBehavior)

Emitted when actionBarAutoHideBehavior changed.

Parameters
newActionBarAutoHideBehavior	The new value of actionBarAutoBehavior.

Since:

BlackBerry 10.1.0

void actionBarVisibilityChanged (
bb::cascades::ChromeVisibility::TypenewVisibility)

Emitted when Action bar visibility changes.

Parameters
newVisibility	The new visibility.

Since:

BlackBerry 10.0.0

void resizeBehaviorChanged (
bb::cascades::PageResizeBehavior::TypenewResizeBehavior)

Emitted when the resizeBehavior property changes.

Note:

Due to a work around for a Qt Core issue with accessing enums from QML, the argument of this signal doesn't follow the usual naming convention for signals. Typically, signal arguments are named to match the associated property's name. In this case, you must use the object's property to access the current property value instead of the signal argument to avoid runtime errors (i.e. use resizeBehavior instead of newResizeBehavior).

Parameters
newResizeBehavior	The new resize behavior.

Since:

BlackBerry 10.0.0

void titleBarChanged (
bb::cascades::TitleBar *titleBar)

Emitted when the titleBar of the page changes.

Parameters
titleBar	The new TitleBar for the Page.

Since:

BlackBerry 10.0.0

void contentChanged (
bb::cascades::Control *content)

Emitted when the content has changed.

Parameters
content	The new content.

Since:

BlackBerry 10.0.0

void actionAdded (
bb::cascades::AbstractActionItem *action)

Emitted when an action has been added to the Page.

Parameters
action	The action that has been added.

Since:

BlackBerry 10.0.0

void actionRemoved (
bb::cascades::AbstractActionItem *action)

Emitted when a action has been removed from the Page.

Parameters
action	The action that has been removed. 0 if emitted by removeAllActions().

Since:

BlackBerry 10.0.0

void actionMenuVisualStateChanged (
bb::cascades::ActionMenuVisualState::TypenewActionMenuVisualState)

Emitted when actionMenuVisualState property changed.

Note:

Parameters
newActionMenuVisualState	The new value of the actionMenuVisualState property.

Since:

BlackBerry 10.0.0

void creationCompleted ()

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 (
const QString &objectName)

This signal is emitted when the objectName property is changed.

See:

QObject, BaseObject::objectName.

Since:

BlackBerry 10.0.0

void panePropertiesChanged (
bb::cascades::PaneProperties *paneProperties)

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

Emitted when a peek on this AbstractPane ends.

Since:

BlackBerry 10.0.0

void peekStarted ()

Emitted when a peek on this AbstractPane starts.

Since:

BlackBerry 10.0.0

Page

Inheritance

QML properties

QML signals

Properties Index

Public Functions Index

Static Public Functions Index

Protected Functions Index

Signals Index

Properties

bb::cascades::TitleBar titleBar

QDeclarativeListProperty< bb::cascades::AbstractActionItem > actions[read-only]

bb::cascades::Control content

bb::cascades::PageResizeBehavior::Type resizeBehavior

bb::cascades::ChromeVisibility::Type actionBarVisibility

bb::cascades::ActionMenuVisualState::Type actionMenuVisualState[read-only]

bb::cascades::InputRouteProperties inputRoute[read-only]

bb::cascades::ActionBarAutoHideBehavior::Type actionBarAutoHideBehavior

bb::cascades::AbstractAccessibilityObject accessibility[read-only]

QDeclarativeListProperty< QObject > attachedObjects[read-only]

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

QString objectName

bb::cascades::PaneProperties paneProperties

QObject parent[read-only]

bool peekedAt[read-only]

QDeclarativeListProperty< bb::cascades::AbstractShortcut > shortcuts[read-only]

Public Functions

bb::cascades::TitleBar * titleBar ()

Q_SLOT void setTitleBar (bb::cascades::TitleBar *titleBar)

Q_SLOT void resetTitleBar ()

Page (QObject *parent)

virtual~Page ()

Q_INVOKABLE void addAction (bb::cascades::AbstractActionItem *actionItem, bb::cascades::ActionBarPlacement::Typeplacement )

Q_INVOKABLE bool removeAction (bb::cascades::AbstractActionItem *actionItem)

Q_INVOKABLE void removeAllActions ()

Q_INVOKABLE int actionCount ()

Q_INVOKABLE bb::cascades::AbstractActionItem * actionAt (intindex)

void setContent (bb::cascades::Control *content)

bb::cascades::Control * content ()

bb::cascades::PageResizeBehavior::Type resizeBehavior ()

Q_SLOT void setResizeBehavior (bb::cascades::PageResizeBehavior::TyperesizeBehavior)

Q_SLOT void resetResizeBehavior ()

void setActionBarVisibility (const bb::cascades::ChromeVisibility::Typevisibility)

bb::cascades::ChromeVisibility::Type actionBarVisibility ()

Q_SLOT void resetActionBarVisibility ()

bb::cascades::ActionMenuVisualState::Type actionMenuVisualState ()

bb::cascades::InputRouteProperties * inputRoute ()

bb::cascades::ActionBarAutoHideBehavior::Type actionBarAutoHideBehavior ()

Q_SLOT void setActionBarAutoHideBehavior (bb::cascades::ActionBarAutoHideBehavior::TypeactionBarAutoHideBehavior)

Q_SLOT void resetActionBarAutoHideBehavior ()

bb::cascades::AbstractAccessibilityObject * accessibility ()

Q_INVOKABLE void addKeyListener (bb::cascades::KeyListener *keyListener)

Q_INVOKABLE void addShortcut (bb::cascades::AbstractShortcut *shortcut)

Q_INVOKABLE void disableAllShortcuts ()

Q_INVOKABLE void enableAllShortcuts ()

virtual bool event (QEvent *event)

bool isPeekedAt ()

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

Q_INVOKABLE int keyListenerCount ()

bb::cascades::PaneProperties * paneProperties ()

Q_INVOKABLE void removeAllKeyListeners ()

Q_INVOKABLE void removeAllShortcuts ()

Q_INVOKABLE bool removeKeyListener (bb::cascades::KeyListener *keyListener)

Q_INVOKABLE bool removeShortcut (bb::cascades::AbstractShortcut *shortcut)

Q_SLOT void resetPaneProperties ()

void setObjectName (const QString &name)

Q_SLOT void setPaneProperties (bb::cascades::PaneProperties *paneProperties)

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

Q_INVOKABLE int shortcutCount ()

virtual Q_INVOKABLE QString toDebugString ()

Static Public Functions

Builder create ()

Protected Functions

BaseObject (QObject *parent)

virtual void connectNotify (const char *signal)

virtual void disconnectNotify (const char *signal)

Signals

void actionBarAutoHideBehaviorChanged (bb::cascades::ActionBarAutoHideBehavior::TypenewActionBarAutoHideBehavior)

void actionBarVisibilityChanged (bb::cascades::ChromeVisibility::TypenewVisibility)

void resizeBehaviorChanged (bb::cascades::PageResizeBehavior::TypenewResizeBehavior)

Q_SLOT void setTitleBar (
bb::cascades::TitleBar *titleBar)

Page (
QObject *parent)

Q_INVOKABLE void addAction (
bb::cascades::AbstractActionItem *actionItem,
bb::cascades::ActionBarPlacement::Typeplacement )

Q_INVOKABLE bool removeAction (
bb::cascades::AbstractActionItem *actionItem)

Q_INVOKABLE bb::cascades::AbstractActionItem * actionAt (
intindex)

void setContent (
bb::cascades::Control *content)

Q_SLOT void setResizeBehavior (
bb::cascades::PageResizeBehavior::TyperesizeBehavior)

void setActionBarVisibility (
const bb::cascades::ChromeVisibility::Typevisibility)

Q_SLOT void setActionBarAutoHideBehavior (
bb::cascades::ActionBarAutoHideBehavior::TypeactionBarAutoHideBehavior)

Q_INVOKABLE void addKeyListener (
bb::cascades::KeyListener *keyListener)

Q_INVOKABLE void addShortcut (
bb::cascades::AbstractShortcut *shortcut)

virtual bool event (
QEvent *event)

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

Q_INVOKABLE bool removeKeyListener (
bb::cascades::KeyListener *keyListener)

Q_INVOKABLE bool removeShortcut (
bb::cascades::AbstractShortcut *shortcut)

void setObjectName (
const QString &name)

Q_SLOT void setPaneProperties (
bb::cascades::PaneProperties *paneProperties)

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

BaseObject (
QObject *parent)

virtual void connectNotify (
const char *signal)

virtual void disconnectNotify (
const char *signal)

void actionBarAutoHideBehaviorChanged (
bb::cascades::ActionBarAutoHideBehavior::TypenewActionBarAutoHideBehavior)

void actionBarVisibilityChanged (
bb::cascades::ChromeVisibility::TypenewVisibility)

void resizeBehaviorChanged (
bb::cascades::PageResizeBehavior::TypenewResizeBehavior)

void titleBarChanged (
bb::cascades::TitleBar *titleBar)

void contentChanged (
bb::cascades::Control *content)

void actionAdded (
bb::cascades::AbstractActionItem *action)

void actionRemoved (
bb::cascades::AbstractActionItem *action)

void actionMenuVisualStateChanged (
bb::cascades::ActionMenuVisualState::TypenewActionMenuVisualState)

void objectNameChanged (
const QString &objectName)

void panePropertiesChanged (
bb::cascades::PaneProperties *paneProperties)

void peekedAtChanged (
boolpeekedAt)