diff options
| author | Chris Adams <christopher.adams@nokia.com> | 2011-09-16 16:32:19 +1000 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2011-09-30 10:37:05 +0200 |
| commit | c263c6c832be3be85beb83e1ee2cce396874bf04 (patch) | |
| tree | 4b3c9c4659f1abb21f8b9af65620f90af0e4189c /src/declarative/qml/qdeclarative.h | |
| parent | 9619737a4c951d7f2abc80b59e287896b735e01d (diff) | |
Expand documentation for QObject Module APIs
Previously, it was unclear whether or not a QObject Module API property
could be the target of an alias property. This commit makes it clear
that a QObject Module API property cannot be aliased as the import
qualifier of the Module API does not identify an object within the
same component of any item which may wish to alias the module API.
Task-Number: QTBUG-21420
Change-Id: Ia286edfee4dcf1250e883738f219f8aef67c32eb
Reviewed-on: http://codereview.qt-project.org/5057
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Aaron Kennedy <aaron.kennedy@nokia.com>
Diffstat (limited to 'src/declarative/qml/qdeclarative.h')
| -rw-r--r-- | src/declarative/qml/qdeclarative.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/declarative/qml/qdeclarative.h b/src/declarative/qml/qdeclarative.h index 312aecbf76..566a420b9d 100644 --- a/src/declarative/qml/qdeclarative.h +++ b/src/declarative/qml/qdeclarative.h @@ -480,6 +480,11 @@ inline int qmlRegisterModuleApi(const char *uri, int versionMajor, int versionMi may be registered into any given namespace (combination of \a uri, \a majorVersion and \a minorVersion). This function should be used to register a module API provider function which returns a QObject as a module API. + A QObject module API must be imported with a qualifier, and that qualifier may be used as + the target in a \l Connections element or otherwise used as any other element id would. + One exception to this is that a QObject module API property may not be aliased (because the + module API qualifier does not identify an object within the same component as any other item). + Usage: \code // first, define your QObject which provides the functionality. |