AbsoluteLayoutProperties

#include <bb/cascades/AbsoluteLayoutProperties>

LayoutProperties that can be assigned to controls in an AbsoluteLayout.

By using AbsoluteLayoutProperties, you can provide specific X and Y coordinates that are used to position a control within its parent container.

This class can only be used for children of a container that uses an AbsoluteLayout. If you attempt to use this class with another type of Layout, it's ignored.

Since:

BlackBerry 10.0.0

Inheritance

bb::cascades::BaseObject
	bb::cascades::UIObject
		bb::cascades::LayoutProperties
			bb::cascades::AbsoluteLayoutProperties

QML properties

positionX	: float
positionY	: float
attachedObjects	: QDeclarativeListProperty< QObject > [read-only]
objectName	: QString
parent	: QObject [read-only]

QML signals

onPositionXChanged	: {}
onPositionYChanged	: {}
onCreationCompleted	: {}
onObjectNameChanged	: {}

Properties Index

float	positionX
float	positionY
QDeclarativeListProperty< QObject >	attachedObjects [read-only]
QString	objectName
QObject	parent [read-only]

Public Functions Index

	AbsoluteLayoutProperties ()
virtual	~AbsoluteLayoutProperties ()
float	positionX () const
Q_SLOT void	setPositionX (float posX)
Q_SLOT void	resetPositionX ()
float	positionY () const
Q_SLOT void	setPositionY (float posY)
Q_SLOT void	resetPositionY ()
virtual bool	event (QEvent *event)
void	setObjectName (const QString &name)
virtual Q_INVOKABLE QString	toDebugString () const

Static Public Functions Index

Builder	create (QObject *parent=0)
Builder	updateFor (Control *targetControl)

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	positionXChanged (float positionX)
void	positionYChanged (float positionY)
void	creationCompleted ()
void	objectNameChanged (const QString &objectName)

Properties

float positionX

The X coordinate for the control.

The origin of the coordinate system in an absolute layout is the top-left corner of the container. The default value is 0.0.

Since:

BlackBerry 10.0.0

float positionY

The Y coordinate for the control.

The origin of the coordinate system in an absolute layout is the top-left corner of the container. The default value is 0.0.

Since:

BlackBerry 10.0.0

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

AbsoluteLayoutProperties ()

Constructs an AbsoluteLayoutProperties object.

Since:

BlackBerry 10.0.0

virtual~AbsoluteLayoutProperties ()

Destructor.

float positionX ()

Returns the X coordinate for the control.

Return:

The X coordinate for the control.

Since:

BlackBerry 10.0.0

Q_SLOT void setPositionX (
floatposX)

Sets the X coordinate for the control.

After the X coordinate is set, the positionYChanged() signal is emitted.

Parameters
posX	The X coordinate for the control.

Since:

BlackBerry 10.0.0

Q_SLOT void resetPositionX ()

Resets the X coordinate to its default.

The default value is 0.0.

After the X coordinate is reset, the positionYChanged() signal is emitted.

Since:

BlackBerry 10.0.0

float positionY ()

Returns the Y coordinate for the control.

Return:

The Y coordinate for the control.

Since:

BlackBerry 10.0.0

Q_SLOT void setPositionY (
floatposY)

Sets the Y coordinate for the control.

After the Y coordinate is reset, the positionYChanged() signal is emitted.

Parameters
posY	The Y coordinate for the control.

Since:

BlackBerry 10.0.0

Q_SLOT void resetPositionY ()

Resets the Y coordinate to its default.

The default value is 0.0.

After the Y coordinate is reset, the positionYChanged() signal is emitted.

Since:

BlackBerry 10.0.0

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 (
QObject *parent)

Creates and returns a builder for constructing absolute layout properties.

Using the builder to create an AbsoluteLayoutProperties object:

AbsoluteLayoutProperties* layoutProperties = AbsoluteLayoutProperties::create()
        .posX(100.0)
        .posY(150.0);

Return:

A builder used for constructing an AbsoluteLayoutProperties object.

Since:

BlackBerry 10.0.0

Builder updateFor (
Control *targetControl)

Builds and sets the absolute layout properties for a control.

If the control already has AbsoluteLayoutProperties set on it, the original layout properties remain as is. Otherwise, a new AbsoluteLayoutProperties object is created and set as the layout properties for the control.

Using the builder to set a control's AbsoluteLayoutProperties:

Label *pLabel = Label::create().text("Hello World!");
AbsoluteLayoutProperties::updateFor(pLabel).x(50.0f).y(25.0f);

Parameters
targetControl	The control to set the layout properties on.

Return:

A builder used for constructing an AbsoluteLayoutProperties object.

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

void positionXChanged (
floatpositionX)

Emitted when the positionX property changes.

Parameters
positionX	The new X coordinate.

Since:

BlackBerry 10.0.0

void positionYChanged (
floatpositionY)

Emitted when the positionY property changes.

Parameters
positionY	The new Y coordinate.

Since:

BlackBerry 10.0.0

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

Inheritance

QML properties

QML signals

Properties Index

Public Functions Index

Static Public Functions Index

Protected Functions Index

Signals Index

Properties

float positionX

float positionY

QDeclarativeListProperty< QObject > attachedObjects[read-only]

QString objectName

QObject parent[read-only]

Public Functions

AbsoluteLayoutProperties ()

virtual~AbsoluteLayoutProperties ()

float positionX ()

Q_SLOT void setPositionX (floatposX)

Q_SLOT void resetPositionX ()

float positionY ()

Q_SLOT void setPositionY (floatposY)

Q_SLOT void resetPositionY ()

virtual bool event (QEvent *event)

void setObjectName (const QString &name)

virtual Q_INVOKABLE QString toDebugString ()

Static Public Functions

Builder create (QObject *parent)

Builder updateFor (Control *targetControl)

Protected Functions

BaseObject (QObject *parent)

virtual void connectNotify (const char *signal)

virtual void disconnectNotify (const char *signal)

Signals

void positionXChanged (floatpositionX)

void positionYChanged (floatpositionY)

void creationCompleted ()

void objectNameChanged (const QString &objectName)

Q_SLOT void setPositionX (
floatposX)

Q_SLOT void setPositionY (
floatposY)

virtual bool event (
QEvent *event)

void setObjectName (
const QString &name)

Builder create (
QObject *parent)

Builder updateFor (
Control *targetControl)

BaseObject (
QObject *parent)

virtual void connectNotify (
const char *signal)

virtual void disconnectNotify (
const char *signal)

void positionXChanged (
floatpositionX)

void positionYChanged (
floatpositionY)

void objectNameChanged (
const QString &objectName)