ApplicationViewCover
#include <bb/cascades/ApplicationViewCover>
Cover which displays a scaled down or cropped version of the app as cover.
BlackBerry 10.0.0
Inheritance
| bb::cascades::BaseObject | ||||
| bb::cascades::UIObject | ||||
| bb::cascades::AbstractCover | ||||
| bb::cascades::ApplicationViewCover | ||||
QML properties
| coverArea | : QRectF |
| attachedObjects | : QDeclarativeListProperty< QObject > [read-only] |
| description | : QString |
| objectName | : QString |
| parent | : QObject [read-only] |
QML signals
Properties Index
| QRectF | coverArea |
| QDeclarativeListProperty< QObject > | attachedObjects [read-only] |
| QString | description |
| QString | objectName |
| QObject | parent [read-only] |
Public Functions Index
| ApplicationViewCover (QObject *parent=0) | |
| virtual | ~ApplicationViewCover () |
| QRectF | coverArea () const |
| Q_SLOT void | setCoverArea (const QRectF &coverArea) |
| Q_SLOT void | resetCoverArea () |
| QString | description () const |
| virtual bool | event (QEvent *event) |
| Q_SLOT void | setDescription (const QString &description) |
| void | setObjectName (const QString &name) |
| 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 | coverAreaChanged (const QRectF &coverArea) |
| void | creationCompleted () |
| void | descriptionChanged (const QString &description) |
| void | objectNameChanged (const QString &objectName) |
Properties
QRectF
The cover area rectangle in window coordinates that will be used as cover for the application.
A null rectangle is interpreted as "cover area should be selected by the framework" and will use the same size as the cover image when displayed in navigator.
Default is a null rectangle meaning the area is selected by the framework.
BlackBerry 10.0.0
QDeclarativeListProperty< QObject >
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"
}
]
}
BlackBerry 10.0.0
QString
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.
QObject::objectName().
BlackBerry 10.0.0
QObject
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.
BlackBerry 10.0.0
Public Functions
Creates the ApplicationViewCover.
The ownership of the cover is transferred to the parent if one is specified.
| Parameters | |
|---|---|
| parent |
The parent object, or 0. This parameter is optional and defaults to 0 if not specified. |
BlackBerry 10.0.0
virtual
Destructor.
BlackBerry 10.0.0
QRectF
Returns the cover area rectangle in window coordinates that will be used as cover for the application.
The coverArea rectangle or a null rectangle if the area hasn't been set
BlackBerry 10.0.0
Q_SLOT void
Sets the cover area rectangle in window coordinates that will be used as cover for the application.
Passing null rectangle is equivalent to calling resetCover();
| Parameters | |
|---|---|
| coverArea |
The coverArea rectangle. |
BlackBerry 10.0.0
Q_SLOT void
Sets the cover area rectangle to the default value which is null.
BlackBerry 10.0.0
QString 
Returns the description for the cover.
The description for the cover.
BlackBerry 10.0.0
virtual bool 
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 | |
|---|---|
| event |
The received event. |
True if the received event was recognized and processed, false otherwise.
BlackBerry 10.0.0
Q_SLOT void 
Sets the description for the cover.
| Parameters | |
|---|---|
| description |
The new description for the cover. |
BlackBerry 10.0.0
void 
Sets the objectName property.
| Parameters | |
|---|---|
| name |
The new name for the object. |
BlackBerry 10.0.0
virtual Q_INVOKABLE QString 
Returns a debug string representing this object.
A debug string for the object.
BlackBerry 10.0.0
Static Public Functions
Builder
Creates and returns a builder for constructing an ApplicationViewCover.
ApplicationViewCover* pCover = ApplicationViewCover::create();
A builder used for constructing a ApplicationViewCover.
BlackBerry 10.0.0
Protected Functions
(Only has inherited protected functions)
Constructs an instance of BaseObject's subclass.
| Parameters | |
|---|---|
| parent |
An optional parent, defaults to 0. |
BlackBerry 10.0.0
virtual void 
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. |
BlackBerry 10.0.0
virtual void 
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. |
BlackBerry 10.0.0
Signals
void
Emitted when the cover area rectangle changes.
| Parameters | |
|---|---|
| coverArea |
The new cover area rectangle in window coordinates that will be used as cover for the application. |
BlackBerry 10.0.0
void 
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.
BlackBerry 10.0.0
void 
Emitted when the description of the cover changes.
| Parameters | |
|---|---|
| description |
The new description for the cover. |
BlackBerry 10.0.0
void 
This signal is emitted when the objectName property is changed.
BlackBerry 10.0.0