Spacings

Since: BlackBerry 10.2.0

#include <bb/cascades/Spacings>

A description of the white space allocated adjacent to the border of a component, inside or outside.


Overview

Inheritance

bb::cascades::BaseObject
bb::cascades::Spacings

QML properties

bottomOffset: float
leftOffset: float
rightOffset: float
topOffset: float
objectName: QStringInherited
parent: QObject [read-only]Inherited

Properties Index

floatbottomOffset
floatleftOffset
floatrightOffset
floattopOffset
QStringobjectNameInherited
QObjectparent [read-only]Inherited

Public Functions Index

Spacings ()
Spacings (ControlPrivate *pcv)
virtual ~Spacings ()
floatbottomOffset ()
floatleftOffset ()
Q_SLOT voidresetBottomOffset ()
Q_SLOT voidresetLeftOffset ()
Q_SLOT voidresetRightOffset ()
Q_SLOT voidresetTopOffset ()
floatrightOffset ()
Q_SLOT voidsetBottomOffset (float fOffset)
Q_SLOT voidsetLeftOffset (float fOffset)
Q_SLOT voidsetRightOffset (float fOffset)
Q_SLOT voidsetTopOffset (float fOffset)
floattopOffset ()
voidsetObjectName (const QString &name)Inherited
virtual Q_INVOKABLE QStringtoDebugString () const Inherited

Protected Functions Index

Only has inherited protected functions

BaseObject (QObject *parent=0)Inherited

Signals Index

voidbottomOffsetChanged (float fOffset)
voidleftOffsetChanged (float fOffset)
voidrightOffsetChanged (float fOffset)
voidtopOffsetChanged (float fOffset)
voidcreationCompleted ()Inherited
voidobjectNameChanged (const QString &objectName)Inherited

Properties

float bottomOffset

The bottom offset for the Spacings group.

This is the space specified to the compent adjacent to its bottom boundary, the default is not defined, i.e. NaN.

float leftOffset

The left offset for the Spacings group.

This is the space specified to the compent adjacent to its left boundary, the default is not defined, i.e. NaN.

float rightOffset

The right offset for the Spacings group.

This is the space specified to the compent adjacent to its right boundary, the default is not defined, i.e. NaN.

float topOffset

The top offset for the Spacings group.

This is the space specified to the compent adjacent to its top boundary, the default is not defined, i.e. NaN.

QString objectNameInherited

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

Public Functions

Spacings ()

Spacings (
  • ControlPrivate *pcv)

virtual~Spacings ()

Destructor.

float bottomOffset ()

Returns the bottom offset.

Return:

The bottom offset.

float leftOffset ()

Returns the left offset.

Return:

The left offset.

Q_SLOT void resetBottomOffset ()

Resets the bottomOffset to its default value.

Q_SLOT void resetLeftOffset ()

Resets the leftOffset to its default value.

Q_SLOT void resetRightOffset ()

Resets the rightOffset to its default value.

Q_SLOT void resetTopOffset ()

Resets the topOffset to its default value.

float rightOffset ()

Returns the right offset.

Return:

The right offset.

Q_SLOT void setBottomOffset (
  • floatfOffset)

Sets the bottom offset for the control.

After the is offset is changed, the bottomOffsetChanged( float ) signal is emitted.

Parameters
fOffset

The new value.

Q_SLOT void setLeftOffset (
  • floatfOffset)

Sets the left offset.

After the offset is set, the leftOffsetChanged( float ) signal is emitted.

Parameters
fOffset

The new left.

Q_SLOT void setRightOffset (
  • floatfOffset)

Sets the right offset.

After the offset is set, the rightOffsetChanged() signal is emitted.

Parameters
fOffset

The new right.

Q_SLOT void setTopOffset (
  • floatfOffset)

Sets the top offset.

After the offset is set, the topOffsetChanged( float ) signal is emitted.

Parameters
fOffset

The new value.

float topOffset ()

Returns the top offset.

Return:

The top offset.

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

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

Signals

void bottomOffsetChanged (
  • floatfOffset)

Emitted when the bottomOffset property changes.

Parameters
fOffset

The new bottom offset.

void leftOffsetChanged (
  • floatfOffset)

Emitted when the leftOffset property changes.

Parameters
fOffset

The new left offset.

void rightOffsetChanged (
  • floatfOffset)

Emitted when the rightOffset property changes.

Parameters
fOffset

The new right offset.

void topOffsetChanged (
  • floatfOffset)

Emitted when the topOffset property changes.

Parameters
fOffset

The new top offset.

void creationCompleted ()Inherited

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

comments powered by Disqus