AbsoluteLayoutProperties

Since: BlackBerry 10.0.0

#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.


Overview

Inheritance

QML properties

positionX: float
positionY: float
attachedObjects: QDeclarativeListProperty< QObject > [read-only]Inherited
objectName: QStringInherited
parent: QObject [read-only]Inherited
ui: bb::cascades::UIConfig [read-only]Inherited

QML signals

Properties Index

floatpositionX
floatpositionY
QDeclarativeListProperty< QObject >attachedObjects [read-only]Inherited
QStringobjectNameInherited
QObjectparent [read-only]Inherited
bb::cascades::UIConfigui [read-only]Inherited

Public Functions Index

AbsoluteLayoutProperties ()
virtual ~AbsoluteLayoutProperties ()
floatpositionX () const
floatpositionY () const
Q_SLOT voidresetPositionX ()
Q_SLOT voidresetPositionY ()
Q_SLOT voidsetPositionX (float posX)
Q_SLOT voidsetPositionY (float posY)
virtual boolevent (QEvent *event)Inherited
voidsetObjectName (const QString &name)Inherited
virtual Q_INVOKABLE QStringtoDebugString () const Inherited
Q_INVOKABLE bb::cascades::UIConfig *ui () const Inherited

Static Public Functions Index

Buildercreate (QObject *parent=0)
BuilderupdateFor (Control *targetControl)

Protected Functions Index

Only has inherited protected functions

BaseObject (QObject *parent=0)Inherited
virtual voidconnectNotify (const char *signal)Inherited
virtual voiddisconnectNotify (const char *signal)Inherited

Signals Index

voidpositionXChanged (float positionX)
voidpositionYChanged (float positionY)
voidcreationCompleted ()Inherited
voidobjectNameChanged (const QString &objectName)Inherited

Properties

float positionX

The X coordinate for the control.

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 > attachedObjectsInherited[read-only]

A hierarchical list of the UIObject's attached objects.

Since:

BlackBerry 10.0.0

QString objectNameInherited

This property is overridden from QObject.

See also:

QObject::objectName().

Since:

BlackBerry 10.0.0

QObject parentInherited[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

bb::cascades::UIConfig uiInherited[read-only]

An object that gives access to unit conversion routines.

QML use:
        // Size using design units
        Container {
            preferredWidth: ui.du(12)
            preferredHeight: ui.du(5)
        }

        // Size using design units, snap to whole pixels
        Container {
            preferredWidth: ui.sdu(13.5)
            preferredHeight: ui.sdu(7.5)
        }

        // Size using absolute pixel values
        Container {
            preferredWidth: ui.px(150)
            preferredHeight: ui.px(50)
        }
C++ use:
Container *container1 = Container::create().background(Color::Red);
UIConfig *ui = container1->ui();
container1->setPreferredWidth(ui->du(12));
container1->setPreferredHeight(ui->du(5));

Container *container2 = Container::create().background(Color::Green);
container2->setPreferredWidth(ui->sdu(13.5));
container2->setPreferredHeight(ui->sdu(7.5));

Container *container3 = Container::create().background(Color::Blue);
container3->setPreferredWidth(ui->px(150));
container3->setPreferredHeight(ui->sdu(50));
Since:

Blackberry 10.3.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

float positionY ()

Returns the Y coordinate for the control.

Return:

The Y 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

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

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 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

virtual bool event (Inherited

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 (Inherited

Sets the objectName property.

Parameters
name

The new name for the object.

Since:

BlackBerry 10.0.0

virtual Q_INVOKABLE QString toDebugString ()Inherited

Returns a debug string representing this object.

Return:

A debug string for the object.

Since:

BlackBerry 10.0.0

Q_INVOKABLE bb::cascades::UIConfig * ui ()Inherited

Returns the UIConfig for this ui object.

The UIConfig can be used to perform unit conversions from design units (du) and snapped design units (sdu) to pixels.

Ownership remains with Cascades.

C++ use:
Container *container1 = Container::create().background(Color::Red);
UIConfig *ui = container1->ui();
container1->setPreferredWidth(ui->du(12));
container1->setPreferredHeight(ui->du(5));

Container *container2 = Container::create().background(Color::Green);
container2->setPreferredWidth(ui->sdu(13.5));
container2->setPreferredHeight(ui->sdu(7.5));

Container *container3 = Container::create().background(Color::Blue);
container3->setPreferredWidth(ui->px(150));
container3->setPreferredHeight(ui->sdu(50));
Return:

The UIConfig for this ui object.

Since:

BlackBerry 10.3.0

Static Public Functions

Builder create (

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 (

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 (Inherited

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)
Inherited

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)
Inherited

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

Emitted 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 indicates 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 also:

QmlDocument

Since:

BlackBerry 10.0.0

void objectNameChanged (Inherited

This signal is emitted when the objectName property is changed.

Since:

BlackBerry 10.0.0

Last modified: 2014-06-24



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus