aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc/snippets
Commit message (Collapse)AuthorAgeFilesLines
* Merge remote-tracking branch 'origin/5.9' into 5.105.10Liang Qi2018-02-071-0/+20
|\ | | | | | | Change-Id: I3b250545e334f50dcef1a75acdef51820d34079a
| * Document that Q_GADGET classes cannot be used with newQMetaObject()Mitch Curtis2018-02-051-0/+20
| | | | | | | | | | | | Task-number: QTBUG-62007 Change-Id: I63d5a57163b36bc8629930e1cda8d5afa1e77d15 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* | Merge remote-tracking branch 'origin/5.9' into 5.10Liang Qi2017-10-24106-333/+1370
|\| | | | | | | | | | | | | | | | | | | Conflicts: src/qml/qml/qqmlimport.cpp src/qml/qml/qqmlimport_p.h src/qml/qml/qqmltypenamecache.cpp Done-with: Ulf Hermann<ulf.hermann@qt.io> Change-Id: I41ba7a592b2659ddf53da6952ea3b456a7bba319
| * Fix qdoc files to always use FDLKai Koehne2017-10-181-31/+18
| | | | | | | | | | Change-Id: If20d71aa85360ad94a2ef12a25ab37cd2d90abf9 Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
| * Fix outdated BSD license headerKai Koehne2017-10-17105-302/+1352
| | | | | | | | | | Change-Id: Icc08925454445fc9497fb3bfd2c26efe90605983 Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
* | Doc: fix QJSEngine code snippetSamuel Gaist2017-09-301-1/+1
|/ | | | | | | | The code snippet showing how to use QJSValue::call was wrong. This patch corrects that. Change-Id: Ib4c6479f3ef63f4f95af845d0af228d3c71f0731 Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com>
* QJSEngine: document limitation of dynamic QObject propertiesMitch Curtis2017-07-271-0/+13
| | | | | | | | | Dynamic QObject properties can not be accessed through C++ (via QJSValue) nor JavaScript. Task-number: QTBUG-38181 Change-Id: I78bb9898fef615a647234ae8df444e8855870258 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Doc: Avoid copyright text in the codeblock by using \snippetVenugopal Shivashankar2017-06-164-5/+8
| | | | | | Change-Id: Ib6f1a1e796a085d0f274c7e87d4ed1314e958a06 Reviewed-by: Nico Vertriest <nico.vertriest@qt.io> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Doc: Simplify documentation about integrating QML and C++Venugopal Shivashankar2017-06-084-0/+290
| | | | | Change-Id: If110d02aad991646054ee6e522549c07f00946e1 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Add Qt.callLater() function.Michael Brasser2016-03-081-0/+109
| | | | | | | | | | | | | Calling the new Qt.callLater() multiple times in quick succession with the same JS function as argument will result in a single call to that function, thus eliminating redundant unnecessary calls. Based on previous patches by Mathias Malmqvist <mathias.malmqvist@nokia.com> and Chris Adams <chris.adams@jollamobile.com> Change-Id: Ie71b60d4d48fa73d3deae723775cf36662d199ae Task-number: QTBUG-22400 Reviewed-by: Simon Hausmann <simon.hausmann@theqtcompany.com>
* Make obj2's text consistent between qtBinding.[23].qmlEdward Welbourne2015-10-161-1/+1
| | | | | | | | The expected text output sides with .3.qml, so fix .2.qml Task-number: QTBUG-48652 Change-Id: I91ac0ab0854df95e06225938d195cd5e3be5abc3 Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>
* Doc: resize tables with overflowNico Vertriest2015-06-252-2/+4
| | | | | | Task-number: QTBUG-46475 Change-Id: Iebb2f7677f8b514d2b3e08480abfc98a0e155c1c Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Purge use of VisualDataModel from docs where DelegateModel is requiredAlex Blasche2015-05-283-7/+10
| | | | | | | | | They are the same types except that VisualDataModel is deprecated and uses a different import statement. Now, references to VisualDataModel are only used where we explicitly refer to the replacement/deprecation. Change-Id: I1e68eb5784235a00233b3882c3d91e21e32af7d1 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Expand on QJSEngine exception handlingSze Howe Koh2015-04-181-1/+4
| | | | | | | | | | | - List the properties provided by the Error object. They consist of the standard properties and a subset of the Mozilla extensions. - Add QJSValue::property() usage to the example code. - Add cross-referencing. - Some rephrasing for clarity and conciseness. Change-Id: I1eb6943899fee2bd81851ccb03660a7a474a975d Reviewed-by: Joerg Bornemann <joerg.bornemann@theqtcompany.com>
* Fixed license headersJani Heikkinen2015-02-17105-315/+315
| | | | | Change-Id: I4d5640ff95e1361ec7e65fb3e87d7726d8185ff5 Reviewed-by: Sergio Ahumada <sahumada@texla.cl>
* Update copyright headersJani Heikkinen2015-02-12105-513/+513
| | | | | | | | | 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>
* doc: Fixed copy/paste errors in DSM snippetsAlejandro Exojo2014-12-303-3/+0
| | | | | | | | | The comments make sense only for the first button, the one that changes the text label. Change-Id: I984f3eff7c797cbccafcba2a0eeaaff9001094e6 Reviewed-by: Brett Stottlemyer <bstottle@ford.com> Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>
* Fix non-compiling QtQml code snippetAlex Blasche2014-10-231-1/+1
| | | | | | | Task-number: QTBUG-42006 Change-Id: I3c59b0ba27518750cba667f414f58edaa136d250 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qmlstatemachine: Rename StateBase to StateKevin Funk2014-10-2112-61/+60
| | | | | | | | | | | | As discussed with Brett Stottlmyer and Alan Alpert. Add a section about the implications when importing both QtQml.StateMachine and QtQuick in one single QML file. Change-Id: I8755f4b578e2a6ff4c2377c7a8a0b996ba9b7129 Reviewed-by: BogDan Vatra <bogdan@kde.org> Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>
* Fix broken QJSEngine snippet in documentation.Mitch Curtis2014-09-111-3/+3
| | | | | | | | toBoolean() isn't even a function in that class, and declaring the button on the stack causes crashes upon closing the application. Change-Id: I063cac2bb144cfb9786f20bbc122d5af92a4c2c0 Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com>
* QSM: Reintroduce guard argument evaluationSebastian Sauer2014-08-251-0/+69
| | | | | | | | | | | | | | Implements the suggestion from Simon Hausmann (codereview 89716 from 08-05 14:46) to use QQmlScriptString rather then the previous used MetaObject-manipulation. This also introduces comparison operators for QQmlScriptString to be able to determinate if a QQmlScriptString changed what is needed cause there is otherwise no way to access (all) the needed details within QQmlScriptStringPrivate. Change-Id: I198479eac8fd37cbdd98a99aacdd8eebf7b75d21 Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>
* Say hello to the Declarative State Machine FrameworkBrett Stottlemyer2014-08-0812-0/+1079
| | | | | | | | | | | | | | | | | | The Declarative State Machine Framework extends Qt's State Machine Framework (QSM) into QML to provide types for creating and executing state graphs in QML. This gives you the power of deterministic state machines, but declaratively and without having to write all of the boilerplate code. It is an alternative to the existing QML State type, intended for more complex models. [ChangeLog][QtQML] The Declarative State Machine Framework extends Qt's State Machine Framework (QSM) into QML. This gives you the power of deterministic state machines, but declaratively. Change-Id: I02390ba7f1baed50935364530925bd75087299cb Reviewed-by: Sebastian Sauer <sebastian.sauer@kdab.com> Reviewed-by: BogDan Vatra <bogdan@kde.org> Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
* fix whitespaceOswald Buddenhagen2014-01-229-13/+13
| | | | | | | remove trailing spaces and expand tabs Change-Id: Ieacb9d096b612c45d1a64700044c114d1f7522bc Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>
* Doc: Made copy of the QML files in the snippets directoryVenu2013-12-132-0/+171
| | | | | | | | | | | | | | The Delegate.qml and view.qml files were not in the scope of Qt QML exampledirs. These files were in the example directory under quick, so had to make of copy of them in the snippets directory and update the snippet path to get the snippets in the html output. Task-number: QTBUG-35445 Change-Id: Ic3fa19dbd36b91d76fbc497ab524f5c0ff91325f Reviewed-by: J-P Nurmi <jpnurmi@digia.com> Reviewed-by: Nico Vertriest <nico.vertriest@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Inline a short snippetSze Howe Koh2013-05-161-61/+0
| | | | | | | | | | An indirect way of fixing a broken snippet path. The entire (but very short) file is included as a snippet in only one place, and the license text takes far more space than the snippet. Change-Id: I6f4bf588b8701b655d418a71f83a2f9263d6b532 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Move snippet into correct moduleSze Howe Koh2013-05-161-125/+0
| | | | | | | | The snippet belongs to Qt Quick's "QML Basic Type: color" (src/quick/doc/src/qmltypereference.qdoc) Change-Id: I47defee04c34f9c98ec57d840c377c680d114d71 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Fixed a bunch of missing snippets.Jerome Pasion2013-05-154-0/+272
| | | | | | | | -moved delegate model related snippets from Qt Quick to Qt QML. -corrected snippet paths Change-Id: If688f97fb9317def16f343d5502a6a54d6761e95 Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
* Move xmlrole.qml to the correct locationJan Arve Saether2013-05-081-81/+0
| | | | | | | | | The snippets that qqmlxmllistmodel.cpp referred to could not be found. xmlrole.qml is only referenced from src/imports/xmllistmodel/qqmlxmllistmodel.cpp Change-Id: I95f962927097cd9d3295fbc2b376a9ab27ae6e5c Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Moved "QML Application Developer Resources" to qtdoc repository.Jerome Pasion2013-04-293-107/+0
| | | | | | | | | | The guide is more relevant to Qt, not just Qt QML and Qt Quick. It would need to include information about the tools and other Qt modules which provide QML types. Change-Id: I0cab0db015022dd27f08811a88ea4a6c3c6e917d Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com> Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
* Doc: corrected snippet issue by changing extension snippet file.Nico Vertriest2013-04-252-10/+51
| | | | | | | | | | | | Task-number: QTBUG-30746 Changed in deployment.qdoc Deleted example.qrc Created example.qdoc Added license text to example.qdoc Change-Id: I9699dcdb4977506c0a62d1a9e952c98babfaf03d Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Expand example (importing multiple modules into 1 namespace)Sze Howe Koh2013-04-251-2/+9
| | | | | | | | | Snippet is for the Qt QML "Import Statements" page. Show how to use the namespace to reference types from different modules Change-Id: I8c49703194a18657439afdef75e47ff7e97be653 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Doc: Replace some references to NokiaSze Howe Koh2013-04-241-2/+2
| | | | | | | Link to internal QDoc pages, or to qt-project.org Change-Id: I5d9adae711213873ab57ccfc5bb2d8f74cf5689b Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Update copyright year in Digia's license headersSergio Ahumada2013-01-1090-90/+90
| | | | | | Change-Id: I6c3bd7bebe3d62d1cfd0fa6334544c9db8398c76 Reviewed-by: Akseli Salovaara <akseli.salovaara@digia.com> Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
* Changed the plugin module nameVenugopal Shivashankar2012-10-291-1/+1
| | | | | | | | | | The earlier name, com.nokia.TimeExample is irrelevant now. Also updated all instances of documentation where this older module name was referred. Change-Id: Ic252d0e72af23c2d39d5fed55f242e47c1b6bde9 Reviewed-by: J-P Nurmi <jpnurmi@digia.com> Reviewed-by: Jens Bache-Wiig <jens.bache-wiig@digia.com>
* Change copyrights from Nokia to DigiaIikka Eklund2012-09-2390-540/+540
| | | | | | | Change copyrights and license headers from Nokia to Digia Change-Id: Ie7f5d49ed8235d7a7845ab68f99ad1c220e64d5c Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Update usage of smooth and antialiasing.Michael Brasser2012-08-283-3/+3
| | | | | | Change-Id: Icc8b28bdd466389ed3f269f076f1bdb6e9abe3f2 Reviewed-by: Yunqiao Yin <charles.yin@nokia.com> Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Fix snippets to compile to ensure they are validBea Lam2012-08-2221-851/+20
| | | | | | | | | Also deletes snippets that are no longer used by docs. Task-number: QTBUG-26637 Change-Id: I63e129f3169ae78aeb7ac840b6f5b5925dbd06b4 Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
* Add basic documentation for QML translation functions.Michael Brasser2012-06-287-0/+330
| | | | | Change-Id: I50932ffd956061dd172616c4de863eb1a322394d Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Document the concept of creation context for QML Components.Michael Brasser2012-06-272-0/+108
| | | | | | Task-number: QTBUG-18011 Change-Id: I78d13df70a20fd9286a20fad4cc09f21591d3f9a Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Create new documentation structureChris Adams2012-06-217-393/+0
| | | | | | | | | | | | | | | | | | | | 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>
* Fix doc snippets paths and parsing errorsBea Lam2012-05-3189-5245/+64
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | qtqml.qdocconf and qtquick.qdocconf now refer to the correct snippets and source directories. Snippet paths in .qdoc and .cpp files have been updated to refer to the new shortened path references, e.g. \snippet qml/file.cpp instead of \snippet doc/src/snippets/qml/file.cpp. This also deletes snippets from src/qml/doc/snippets that belonged under src/quick/doc/snippets (and were already duplicated there anyway) and restores some snippet files that shouldn't have been deleted. Also fixes some inline snippets to use \code .. \endcode instead of \qml .. \endqml as they contained javascript or partial QML snippets that were causing parsing errors from qdoc. There are still snippet errors arising from qmlintro.qdoc as the qmlintro snippets directory that it refers to cannot be located. There are also two references to a removed snippet identifier in examples/qml/cppextensions/plugins/plugin.cpp that need to be fixed in conjunction with the related docs in a later commit as the relevant code has changed and the docs are now invalid. Task-number: QTBUG-25721 Change-Id: I50c665245a74c140470c58a32546591d187dfe4b Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Remove duplicated doc files and imagesBea Lam2012-05-243-0/+209
| | | | | | | | | | | | | - Remove doc/ files which were duplicated under src/quick/doc and src/qml/doc - Remove duplicated images under src/doc/qml/images which were already under src/doc/quick/images - Merged 0102413396c91e97ed856235cd1a52f7185c4862 and 3b04bbde6356797368114fce1b45b85271e9fed8 which made it into doc/src but not src/qml/doc Change-Id: I275b7d29f9fc2222dcf801c257c1f67b5880446b Reviewed-by: Alan Alpert <alan.alpert@nokia.com>
* doc: Remove references to QScript*Girish Ramakrishnan2012-05-151-13/+4
| | | | | | | | The second document snippet won't work anymore since the equivalent of QScriptValue::PropertyFlag doesn't exist. It is thus removed. Change-Id: Ib8fadef6c6aec4bc257cc245bb58948f64b69945 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* Doc: Moving QML docs for new doc structureJerome Pasion2012-05-09176-0/+11549
Change-Id: Id51e2cf10e8b5c5559bc4a375cb2db46c40bdf0a Reviewed-by: Alan Alpert <alan.alpert@nokia.com>