StackLayoutProperties
#include <bb/cascades/StackLayoutProperties>
LayoutProperties that are assigned to controls within a StackLayout.
By using StackLayoutProperties, you can specify a control's space quota. The space quota determines what percentage of space the control should assume in relation to its siblings.
This class can only be used with children of a container that uses a StackLayout. If you attempt to use this class with another type of Layout, it's ignored.
BlackBerry 10.0.0
Inheritance
| bb::cascades::BaseObject | ||||
| bb::cascades::UIObject | ||||
| bb::cascades::LayoutProperties | ||||
| bb::cascades::StackLayoutProperties | ||||
QML properties
| spaceQuota | : float |
| attachedObjects | : QDeclarativeListProperty< QObject > [read-only] |
| objectName | : QString |
| parent | : QObject [read-only] |
QML signals
Properties Index
| float | spaceQuota |
| QDeclarativeListProperty< QObject > | attachedObjects [read-only] |
| QString | objectName |
| QObject | parent [read-only] |
Public Functions Index
| StackLayoutProperties () | |
| virtual | ~StackLayoutProperties () |
| float | spaceQuota () const |
| Q_SLOT void | setSpaceQuota (float _spaceQuota) |
| Q_SLOT void | resetSpaceQuota () |
| virtual bool | event (QEvent *event) |
| void | setObjectName (const QString &name) |
| virtual Q_INVOKABLE QString | toDebugString () const |
Static Public Functions Index
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 | spaceQuotaChanged (float spaceQuota) |
| void | creationCompleted () |
| void | objectNameChanged (const QString &objectName) |
Properties
float
Specifies how size in the orientation is divided between child controls.
Controls with a negative spaceQuota are treated as preferred sized controls and are given the size requested by the controls itself. These controls are given priority over dynamic controls, i.e. controls with a spaceQuota larger than 0. The space remaining in the orientation after the preferred sized controls have been given space is divided amongst the dynamic controls using spaceQuota. The remaining space is divided in accordance with each dynamic contol's spaceQuota divided by the sum of all the spaceQuotas. Two controls with a spaceQuota of 1.0 will divide the remaining space equally amongst them, whereas two controls with spaceQuotas of 1.0 and 3.0 will give the first control one quarter of the remaining space and give the second control three quarters of the remaining space.
The default value of this property is negative. A value of 0 is not allowed.
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
Constructs a StackLayoutProperties object.
BlackBerry 10.0.0
virtual
Destructor.
float
Returns the space quota for the control.
The spaceQuota for the control.
BlackBerry 10.0.0
Q_SLOT void
Sets the space quota for the control.
After the spaceQuota is set, the spaceQuotaChanged() signal is emitted.
| Parameters | |
|---|---|
| _spaceQuota |
The spaceQuota of the control. |
BlackBerry 10.0.0
Q_SLOT void
Resets the space quota to its default.
The default spaceQuota is a negative value.
After the space quota is reset, the spaceQuotaChanged() signal is emitted.
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
Static Public Functions
Builder
Creates and returns a builder for constructing stack layout properties.
StackLayoutProperties* layoutProperties = StackLayoutProperties::create()
.spaceQuota(0.5);
A builder used for constructing a StackLayoutProperties object.
BlackBerry 10.0.0
Builder
Builds and sets the stack layout properties for a control.
If the control already has StackLayoutProperties set on it, the original layout properties remain as is. Otherwise, a new StackLayoutProperties object is created and set as the layout properties for the control.
Label *pLabel = Label::create().text("Hello World!");
StackLayoutProperties::updateFor(pLabel).spaceQuota(2.0f);
| Parameters | |
|---|---|
| targetControl |
The control to set the layout properties on. |
A builder used for constructing a StackLayoutProperties 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 spaceQuota property changes.
| Parameters | |
|---|---|
| spaceQuota |
The new spaceQuota for the control. |
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