BaseObject

Since: BlackBerry 10.0.0

#include <bb/cascades/BaseObject>

The base object for the classes in the framework.

This class can be used as a base for class exposed to QML or just any user class to be used with the framework.

The class exposes a parent property (which returns the current parent of the object as returned by QObject::parent()) and it provides a creationCompleted() signal that is emitted when the object's construction and configuration has been completed.

The signal is emitted when a class deriving from this class has been instantiated from QML or constructed using its builder class.


Overview

QML properties

objectName: QString
parent: QObject [read-only]

Properties Index

Public Functions Index

virtual ~BaseObject ()
voidsetObjectName (const QString &name)
virtual Q_INVOKABLE QStringtoDebugString () const

Protected Functions Index

BaseObject (QObject *parent=0)

Signals Index

voidcreationCompleted ()
voidobjectNameChanged (const QString &objectName)

Properties

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

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

virtual~BaseObject ()

Destructor.

void setObjectName (

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

Protected Functions

BaseObject (

Constructs an instance of BaseObject's subclass.

Parameters
parent

An optional parent, defaults to 0.

Since:

BlackBerry 10.0.0

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

QmlDocument

Since:

BlackBerry 10.0.0

void objectNameChanged (

This signal is emitted when the objectName property is changed.

Since:

BlackBerry 10.0.0

Last modified: 2014-03-13

comments powered by Disqus