DockLayout

#include <bb/cascades/DockLayout>

A Layout that docks children to a specified area of the container.

By using the Control::horizontalAlignment and Control::verticalAlignment properties you can specify where controls are docked horizontally (left, center, or right) and vertically (top, center, bottom) within the layout. Controls can also be expanded/contracted to fill the container in a specified direction.

In cases where the container of the layout should force children to be positioned within a border of its container, the padding concept can be used. Each boundary of a container can be set with padding, so left, right, top and bottom padding can be specified.

For example, setting the left padding to 10 would mean that the left-most 10 pixels of the layout container will not be available to the child controls.

The following examples demonstrate how to use DockLayout to position buttons within a Container. One button is docked to the top-center and the other is docked to the right-center.

QML:

Container {
    layout: DockLayout {}
  
    Button {
        text: "Button1"
        horizontalAlignment: HorizontalAlignment.Center
        verticalAlignment: VerticalAlignment.Top                
    }
  
    Button {
        text: "Button2"
        horizontalAlignment: HorizontalAlignment.Right
        verticalAlignment: VerticalAlignment.Center
    }           
}

C++:

Container* pContainer = new Container();
DockLayout *pDockLayout = new DockLayout();
pContainer->setLayout(pDockLayout);


// Position button 1 horizontally centered and docked to the top
// of the container
Button* pButton1 = Button::create().text("Button1");

pButton1->setHorizontalAlignment(HorizontalAlignment::Center);
pButton1->setVerticalAlignment(VerticalAlignment::Top);

// Position button 2 vertically centered and docked to the 
// right edge of the container
Button* pButton2 = Button::create().text("Button2");

pButton2->setHorizontalAlignment(HorizontalAlignment::Right);
pButton2->setVerticalAlignment(VerticalAlignment::Center);

pContainer->add( pButton1 );
pContainer->add( pButton2 );

Since:

BlackBerry 10.0.0

Inheritance

bb::cascades::BaseObject
	bb::cascades::UIObject
		bb::cascades::Layout
			bb::cascades::DockLayout

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

	DockLayout ()
virtual	~DockLayout ()
virtual bool	event (QEvent *event)
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

Only has inherited signals

void	creationCompleted ()
void	objectNameChanged (const QString &objectName)

Properties

(Only has inherited properties)

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

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

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

Public Functions

DockLayout ()

Constructs a DockLayout object.

When you set a layout on a container using Container::setLayout() the container assumes ownership of this instance.

Since:

BlackBerry 10.0.0

virtual~DockLayout ()

Destructor.

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

void setObjectName (
const QString &name)

Sets the objectName property.

Parameters
name	The new name for the object.

Since:

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

Using the builder to create a dock layout:

DockLayout* pDockLayout = DockLayout::create()

Return:

A builder used for constructing a DockLayout.

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

(Only has inherited signals)

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

DockLayout

Inheritance

QML properties

QML signals

Properties Index

Public Functions Index

Static Public Functions Index

Protected Functions Index

Signals Index

Properties

QDeclarativeListProperty< QObject > attachedObjects[read-only]

QString objectName

QObject parent[read-only]

Public Functions

DockLayout ()

virtual~DockLayout ()

virtual bool event (QEvent *event)

void setObjectName (const QString &name)

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

void objectNameChanged (const QString &objectName)

virtual bool event (
QEvent *event)

void setObjectName (
const QString &name)

BaseObject (
QObject *parent)

virtual void connectNotify (
const char *signal)

virtual void disconnectNotify (
const char *signal)

void objectNameChanged (
const QString &objectName)