Layout
#include <bb/cascades/Layout>
Abstract base class inherited by all layouts.
When a layout is set on a Container using Container::setLayout(), the container arranges its children according to the rules of that particular layout. Depending on how you want to position a container's children, there are three different types of layouts to choose from:
StackLayout: Arranges children vertically or horizontally in a stack. This is the default layout for containers.
DockLayout: Docks children to a particular area of the container.
AbsoluteLayout: Places children on their specified x and y coordinates.
Another form of input that determines how a container's children are positioned is the LayoutProperties associated with each child. LayoutProperties can be used to specify properties such as the space quota, alignment, and x and y coordinates (depending on the type of layout). One thing to note is that each Layout has a corresponding LayoutProperties class, and they must be used together. For example, if a container uses a StackLayout, its children must use StackLayoutProperties.
An application can use a LayoutUpdateHandler to receive updates about the position and dimensions of laid out controls.
The origin of the coordinate system is the top-left corner of the container.
BlackBerry 10.0.0
Inheritance
QML properties
Only has inherited QML properties
| attachedObjects | : QDeclarativeListProperty< QObject > [read-only] |
| objectName | : QString |
| parent | : QObject [read-only] |
QML signals
Only has inherited QML signals
| onCreationCompleted | |
| onObjectNameChanged |
Properties Index
Only has inherited properties
| QDeclarativeListProperty< QObject > | attachedObjects [read-only] |
| QString | objectName |
| QObject | parent [read-only] |
Public Functions Index
| virtual | ~Layout () |
| 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
Only has inherited signals
| void | creationCompleted () |
| void | objectNameChanged (const QString &objectName) |
Properties
(Only has inherited properties)
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.
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
(Only has inherited signals)
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