AbstractDialog
#include <bb/cascades/AbstractDialog>
A base class for UI elements that represent full-screen view.
The AbstractDialog class is an abstract class that is used as a base for UI elements that change the normal flow of an application. For example, in an email application, adding a new contact could be considered a subtask that is separate from the main flow of the application, and so could be implemented using any of AbstractDialog's subclasses e.g. Sheet or Dialog.
This class provides a way for subclasses to open or close the dialog using corresponding open() and close() functions.
The two concrete subclasses of this class are Sheet and Dialog.
BlackBerry 10.0.0
Inheritance
| bb::cascades::BaseObject | |||
| bb::cascades::UIObject | |||
| bb::cascades::AbstractDialog | |||
| bb::cascades::Dialog | |||
| bb::cascades::Sheet | |||
QML properties
| opened | : bool [read-only] |
| attachedObjects | : QDeclarativeListProperty< QObject > [read-only] |
| objectName | : QString |
| parent | : QObject [read-only] |
QML signals
| onOpenedChanged | : {} |
| onOpened | : {} |
| onClosed | : {} |
| onCreationCompleted | |
| onObjectNameChanged |
Properties Index
| bool | opened [read-only] |
| QDeclarativeListProperty< QObject > | attachedObjects [read-only] |
| QString | objectName |
| QObject | parent [read-only] |
Public Functions Index
| virtual | ~AbstractDialog () |
| Q_SLOT void | open () |
| Q_SLOT void | close () |
| bool | isOpened () const |
| virtual bool | event (QEvent *event) |
| void | setObjectName (const QString &name) |
| virtual Q_INVOKABLE QString | toDebugString () const |
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 | openedChanged (bool opened) |
| void | opened () |
| void | closed () |
| void | creationCompleted () |
| void | objectNameChanged (const QString &objectName) |
Properties
bool
Indicates whether the dialog is currently opened.
If the value is true, the dialog is opened. If it is false, the dialog is closed.
The default value of this property is false.
The openedChanged() signal is emitted when this property changes.
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
virtual
Destructor.
Q_SLOT void
Opens the dialog.
When the dialog is opened, the value of the opened property changes to true and the opened() signal is emitted. The opened() signal might not be emitted immediately when this function is called, but could happen asynchronously at a later time.
If called when the dialog is already opening or closing, this function has no effect.
BlackBerry 10.0.0
Q_SLOT void
Closes the dialog.
When the dialog is closed, the value of the opened property changes to false and the closed() signal is emitted. The closed() signal might not be emitted immediately when this function is called, but could happen asynchronously at a later time.
If called when the dialog is already opening or closing, this function has no effect.
BlackBerry 10.0.0
bool
Indicates whether the dialog is opened.
true if the dialog is opened, false otherwise.
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
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
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 opened property changes its value.
| Parameters | |
|---|---|
| opened |
If true the dialog is opened, if false the dialog is closed. |
BlackBerry 10.0.0
void
Emitted when the dialog is opened.
The signal is emitted asynchronously when the dialog is completely opened after the open animation is finished.
BlackBerry 10.0.0
void
Emitted when the dialog is closed.
The signal is emitted asynchronously when the dialog is completely closed after the close animation is finished.
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 
This signal is emitted when the objectName property is changed.
BlackBerry 10.0.0