aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc/src/qmlfunctions.qdoc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Add \keyword for "Grouped" and "Attached" property topicsVenugopal Shivashankar2017-07-031-1/+1
| | | | | | | This enables searching the index list for the \keyword in Qt Creator Change-Id: Ic8fde82def48c4d0f4cbf0e75bc862e00ca3ca65 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Merge remote-tracking branch 'origin/5.8' into 5.9Liang Qi2017-02-241-5/+9
|\ | | | | | | | | | | | | | | | | | | | | Conflicts: src/qml/compiler/qv4ssa.cpp src/quick/accessible/qaccessiblequickview_p.h src/quick/items/qquickmousearea.cpp src/quick/util/qquickanimatorjob.cpp tools/qmlplugindump/main.cpp Change-Id: I84474cf39895b9b757403971d2e9196e8c9d1809
| * Doc: Fix documentation warningsTopi Reinio2017-01-301-5/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | src/qml/jsapi/qjsengine.cpp:524: warning: Undocumented parameter 'metaObject' in QJSEngine::newQMetaObject() src/qml/qml/qqmlengine.cpp:1023: warning: Undocumented parameter 'retCode' in QQmlEngine::exit() src/qml/doc/src/qmlfunctions.qdoc:182: warning: Undocumented parameter 'reason' in qmlRegisterUncreatableMetaObject() src/qml/qml/qqmllist.cpp:393: warning: Undocumented parameter 'at' in QQmlListProperty::QQmlListProperty() src/qml/qml/qqmllist.cpp:393: warning: Undocumented parameter 'count' in QQmlListProperty::QQmlListProperty() src/qml/qml/qqmllist.cpp:402: warning: Undocumented parameter 'at' in QQmlListProperty::QQmlListProperty() src/qml/qml/qqmllist.cpp:402: warning: Undocumented parameter 'count' in QQmlListProperty::QQmlListProperty() src/qml/qml/qqmllist.cpp:402: warning: Undocumented parameter 'append' in QQmlListProperty::QQmlListProperty() src/qml/qml/qqmllist.cpp:402: warning: Undocumented parameter 'clear' in QQmlListProperty::QQmlListProperty() src/quick/items/qquickwindow.cpp:4461: warning: No such parameter 'backend' in QQuickWindow::setSceneGraphBackend() Also do some minor language editing. Change-Id: I2e806d1a77e3c4264d709c27d2bfc4542a782716 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* | Introduce qmlRegisterModule()J-P Nurmi2016-11-181-0/+12
|/ | | | | | | | | | | | | | | | This is particularly useful for keeping the versions of related modules in sync. For example, when QtQuick.Controls introduces new types or revisions and bumps up the minor version, qmlRegisterModule() can be used to make the same version available for QtQuick.Controls.Styles in case it doesn't have new types or revisions to register. [ChangeLog][QtQml] Introduced qmlRegisterModule() that can be used to make a certain module version available, even if no types or revisions are registered for that version. Change-Id: I5ec457465cd778bb0adda55771d195f69cd4b31a Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Add qmlRegisterUncreatableMetaObject convenience functionBogDan Vatra2016-09-071-0/+36
| | | | | | | | | qmlRegisterUncreatableMetaObject is needed to register Q_NAMESPACE QMetaObjects. Task-number: QTBUG-54982 Change-Id: I767dfcb15db647e0dceb0c37b17e64f2a5c1dd8f Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Merge remote-tracking branch 'origin/5.6' into 5.7Liang Qi2016-04-081-3/+2
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This change also fixes the build of two benchmarks, tst_affectors and tst_emission. Conflicts: src/plugins/qmltooling/qmldbg_native/qmldbg_native.pro src/qml/qml/ftw/qhashfield_p.h tests/benchmarks/particles/affectors/tst_affectors.cpp tests/benchmarks/particles/emission/tst_emission.cpp tests/benchmarks/qml/pointers/pointers.pro tests/benchmarks/qml/pointers/tst_pointers.cpp tests/benchmarks/qml/qmltime/qmltime.pro tests/benchmarks/qml/qquickwindow/qquickwindow.pro Change-Id: I595309d1e183c18371cb9b07af6e4681059de3b2
| * Fix qmlRegisterSingletonType documentationBogDan Vatra2016-03-241-3/+2
| | | | | | | | | | Change-Id: I36d22343976a2164c396bb17c13526b63ab7579c Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
* | Include qqml.h in qqmlengine.h for convenienceMitch Curtis2016-02-051-37/+0
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | When a user creates a Qt Quick Application Project in Creator, they get this main.cpp: int main(int argc, char *argv[]) { QGuiApplication app(argc, argv); QQmlApplicationEngine engine; engine.load(QUrl(QStringLiteral("qrc:/main.qml"))); return app.exec(); } According to the current documentation, if they then want to register a C++ type for use in QML, they need to add a separate "#include <QtQml>" (which is actually a module-wide include and brings a lot of unnecessary files with it). If the most common (or perhaps only) use case for that function (and all of the others declared in qqml.h but documented as requiring QtQml) is related to QQmlEngine, then it makes sense for qqmlengine.h to include qqml.h. This change makes it so that users can use these functions with no changes to the code that Creator provides, as QQmlApplicationEngine includes QQmlEngine. Change-Id: I9d6be2e1abfd4cc831ca04dab4c2a9e50021f748 Task-number: QTBUG-50343 Reviewed-by: J-P Nurmi <jpnurmi@theqtcompany.com> Reviewed-by: Lars Knoll <lars.knoll@theqtcompany.com>
* Fix incorrectly formatted code in QQmlEngine documentation.Mitch Curtis2015-08-111-1/+1
| | | | | Change-Id: I70832871cbd697b77cfcbbe425ba5936be1c01d5 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Merge remote-tracking branch 'origin/5.4' into 5.5Simon Hausmann2015-04-271-1/+1
|\ | | | | | | | | | | | | | | Conflicts: .qmake.conf tests/auto/qml/qqmlxmlhttprequest/tst_qqmlxmlhttprequest.cpp Change-Id: I715b8a78b74cbe0dcaf599367fd6e08af4858e11
| * Doc: corrected error on return value qmlRegisterTypeNico Vertriest2015-04-241-1/+1
| | | | | | | | | | | | Task-number: QTBUG-45584 Change-Id: I97508aabe47c49d8e27329a7856dd921ee0505dd Reviewed-by: Martin Smith <martin.smith@digia.com>
* | Fix some qdoc warnings.Friedemann Kleint2015-03-311-1/+1
| | | | | | | | | | | | | | | | | | | | | | qtdeclarative/src/qml/qml/qqmlinfo.cpp:46: warning: Cannot find 'qmlInfo(...)' in '\fn' QQmlInfo qmlInfo(const QObject *object) qtdeclarative/src/qml/qml/qqmlexpression.cpp:366: warning: Undocumented parameter 'column' in QQmlExpression::setSourceLocation() qtdeclarative/src/qml/doc/src/qmlfunctions.qdoc:176: warning: Undocumented parameter 'reason' in qmlRegisterExtendedUncreatableType() qtdeclarative/src/qml/doc/src/qmlfunctions.qdoc:176: warning: No such parameter 'message' in qmlRegisterExtendedUncreatableType() Change-Id: Iec801b33b11bd57abadd968a90c49f8eba1280d5 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Alan Alpert (Personal) <416365416c@gmail.com>
* | Update copyright headersJani Heikkinen2015-02-121-6/+6
|/ | | | | | | | | Qt copyrights are now in The Qt Company, so we could update the source code headers accordingly. In the same go we should also fix the links to point to qt.io. Change-Id: I61120571787870c0ed17066afb31779b1e6e30e9 Reviewed-by: Iikka Eklund <iikka.eklund@theqtcompany.com>
* Mark qmlRegisterCustomExtendedType as \internalAlejandro Exojo2014-12-121-0/+1
| | | | | | | | | | | | | | The function was added in 5.4, but it makes use of QQmlCustomParser, which at the moment is private API. This way Qt3D or bleeding edge users can still use the function, while keeping freedom to change QQmlCustomParser. Since 5.4.0 had the typo in the \relates, users won't see a change from 5.4.0 to 5.4.1. Change-Id: I7f791f5b39e2a2c9fc83f4c450e6da9eec5b5e46 Reviewed-by: Simon Hausmann <simon.hausmann@digia.com> Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* Restore extension types documentationAlejandro Exojo2014-12-101-3/+20
| | | | | | | | | | | | | | | | | | The documentation on QML extension types was accidentally removed on the big restructuring of commit 28def0bdd084989c17a157e0c4ab80c259081caa. This restores it to a section on the "Defining QML Types from C++" page mostly unchanged, and makes the source of the example that was already there visible. The reference documentation of the qmlRegisterExtendedType is added as well, and the one for qmlRegisterExtendedUncreatableType and qmlRegisterCustomExtendedType that was added in fcb40ff6d71f4561401e6b2bd4d7fc706fff8eee is now fixed. It was not being generated because referred to "QQmlEgine" instead of "QQmlEngine". Change-Id: I1403b10076c64a4c0d760f72b06dd52c38b351a5 Reviewed-by: Paul Lemire <paul.lemire@kdab.com> Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>
* qmlRegisterCustomExtendedType, qmlRegisterExtendedUncreatableTypePaul Lemire2014-07-251-0/+38
| | | | | | | | | | | | | | | | | | There are cases in Qt3D where we'd like to be able to register uncreatable extended types. The main use case is having an abstract class that has an extension class so as to have a clean separation between the C++ and QML API. Implementations of the abstract can then be easily registered to QML and rely on the extension class for QML specific properties. The other feature we'll need in the near future is the ability to create extended QML types that use a custom parser. Two new type registration method were added to qqml.h to fulfill those needs. Unit tests for those are present in qqmlecmascript and qqmllanguage. Change-Id: I15b2cd791ffd36b537305af1873491c079d4094e Reviewed-by: Sean Harmer <sean.harmer@kdab.com> Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>
* QQmlEngine - fix example in documentationKimmo Leppälä2014-01-191-1/+1
| | | | | | | | | example_qjsvalue_singletontype_provider example code snippet returns QJSValue instead of QJSValue*. Change-Id: If4d5592fcee25ada9870602c8f92197980ef9b77 Reviewed-by: Nico Vertriest <nico.vertriest@digia.com> Reviewed-by: Gunnar Sletta <gunnar.sletta@jollamobile.com>
* Doc: Fix broken linksSze Howe Koh2013-12-301-2/+3
| | | | | Change-Id: I4c4577edde96978a986606bf30fbb925f871bd42 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Add a new variant of qmlRegisterSingletonType for QML singletons.Antti Piira2013-11-091-1/+50
| | | | | | | | | | | | | | Adds a new public API to register a QML based singleton type from C++. This is the equivalent of the the qmlRegisterType, but for singletons. qmldir file is not needed for types registered through this function, but the type still needs to include the following pragma statement among the import statements: pragma Singleton Change-Id: Icb35b665fe2a8605667fe8ac575347be2a60490c Reviewed-by: Alan Alpert <aalpert@blackberry.com> Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Doc: Fix broken linksSze Howe Koh2013-11-051-1/+1
| | | | | | Change-Id: Ie7408409ddbaa354370267f2dd74326ec56a4186 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Fix documentation of qmlProtectModuleTopi Reinio2013-09-251-3/+5
| | | | | | | | Fix the function signature used in \fn command and document the parameters. Change-Id: Ieda9b2b402886b81691195dbad17663fd454f282 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Add qmlProtectModuleAlan Alpert2013-09-201-0/+25
| | | | | | | | | A C++ analog to the protected qmldir syntax, this is also a potential performance improvement because we can avoid some file system accesses. Change-Id: I41781a6cc72aa65bd2d397800345ea16ef442e90 Reviewed-by: Antti Piira <apiira@blackberry.com> Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>
* Add qmlClearRegisteredTypes FunctionAlan Alpert2013-05-071-0/+14
| | | | | | | | | | | Registered types are stored in a global static variable, not on an engine instance. For applications managing multiple engines over their lifetime, there needs to be a way to clear the existing types so they can register new ones and avoid memory leaks. Task-Number: QTBUG-28572 Change-Id: Ic70a4dd1e29d99399b21fb42eaf10d4a52bf2adf Reviewed-by: Christopher Adams <chris.adams@jollamobile.com>
* Doc: Un-overload the word "module"Sze Howe Koh2013-04-241-1/+1
| | | | | | | | | | | "The Qt Quick module contains the QtQuick QML module and the Qt Quick C++ module" is an odd way to describe things. The concept of a "QML module" is deeply entrenched so this patch won't touch it, but at least we can get rid of references to "C++ module"s. Change-Id: Ib06f8e3152551901dc6016cb37507cb9608d7863 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Add required include statement for qmlRegisterSingletonType docsTopi Reinio2013-04-161-5/+7
| | | | | | | | | Adds a missing include for QtQml into QQmlEngine class reference code snippets. Task-number: QTBUG-30642 Change-Id: I2ec10de5b31b4854d5aaea08987b9d75926d2ef4 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Fixed some uses of terminolgies in qdoc files.Jerome Pasion2013-03-261-1/+1
| | | | | | | | | | | -"element" -> "type" or "object" (not in all cases where this change applies) -some instances of QtQuick. It should be "Qt Quick". -only in qdoc files. Examples and source code changes will be done later. Task-number: QTBUG-30180 Change-Id: Ie587461a138e97606f761ad1e90909c91b479303 Reviewed-by: Alan Alpert <aalpert@blackberry.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* Add qmlRegisterType for Composite TypesAlan Alpert2013-02-181-0/+17
| | | | | | | | | This is equivalent functionality to registering a composite type in a qmldir file, a type name in a versioned module is associated with a given file. This function now allows that to be done easily from C++. Change-Id: I1cf44b92c3ad7fee593f4f84773c35b56253e628 Reviewed-by: Shawn Rutledge <shawn.rutledge@digia.com>
* Update copyright year in Digia's license headersSergio Ahumada2013-01-101-1/+1
| | | | | | Change-Id: I6c3bd7bebe3d62d1cfd0fa6334544c9db8398c76 Reviewed-by: Akseli Salovaara <akseli.salovaara@digia.com> Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
* Change copyrights from Nokia to DigiaIikka Eklund2012-09-231-14/+14
| | | | | | | Change copyrights and license headers from Nokia to Digia Change-Id: Ie7f5d49ed8235d7a7845ab68f99ad1c220e64d5c Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Update imports and module documentationChris Adams2012-08-081-7/+7
| | | | | | | | | | | | | | | | | | Recently, the qmldir syntax was modified to allow a module identifier directive to be specified. This allows us to guarantee that types provided in that namespace are not overridden by other modules. Given this fundamental change, the documentation needed to be updated to reflect the new terminology surrounding imports: - modules - identified vs legacy - directories - local and remote directory imports - JavaScript resources - scripts which can be imported directly Change-Id: I5a3d38de93d0186e79b87f2b3050f2b802088348 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Add type name to singleton (module api) implementations.Glenn Watson2012-08-081-46/+46
| | | | | | | | | | | | | This change renames the previous module api implementation to singleton types. When a singleton type is registered, a type name must be provided that is used when accessing the API from QML. This makes the implementation more consistent with the rest of QML. Task-number: QTBUG-26549 Change-Id: Iab0bb1ccf516bd3ae20aee562a64d22976e0aecd Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Fix various broken links in documentationBea Lam2012-08-031-2/+2
| | | | | Change-Id: I9e2dac37d18e3ca62e4a92be25e5c2e60ffeba00 Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
* Document qmlAttachedPropertiesObject()Bea Lam2012-08-011-0/+23
| | | | | | | | This is discussed in the documentation on writing QML extensions from C++ but is not actually documented in the list of qml* functions. Change-Id: Id24be88dc3fa6d54cc5ee29e3da1686ea2732b39 Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Document lack of qmlContext/qmlEngine in module API classesMatthew Vogt2012-07-161-0/+25
| | | | | | | Task-number: QTBUG-23116 Change-Id: Ia6620b4046ac3e72c8b304633fcad40cf0efe2ed Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Fix qmlRegisterModuleApi function linkageChris Adams2012-07-041-1/+1
| | | | | | | | The qdoc tag for the \fn doc was incorrect, leading to linkage errors. Task-number: QTBUG-26236 Change-Id: Ifd407915d9a1461bb2b48a6bf54bb085425ba76b Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Create new documentation structureChris Adams2012-06-211-0/+334
The documentation currently has no clear separation between Qt QML and Qt Quick. With recent commits like: 6c8378eaf1edbbefe6aaa3672b0127816a004fd7 and ab1e510121c8a679fdaca12ccd30e0f7ac12a26b the separation between the language definition and implementation, provided by Qt QML, and the standard library for the QML language, provided by Qt Quick, is clear. This commit creates a new documentation structure that is more navigable and separates concepts into logical categories, with clear separation between QtQML and QtQuick. It also provides a more generic QML Application Developer Resources page which contains links to information for QML application developers. Change-Id: Ia807ccfbfd24ffa0e1c7f0a51ed9d2ed3aa6a733 Reviewed-by: Martin Jones <martin.jones@nokia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-11 06:13:03 +0000