aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/doc
Commit message (Collapse)AuthorAgeFilesLines
* Update license headers and add new licensesJani Heikkinen2014-08-2512-228/+132
| | | | | | | | | - Renamed LICENSE.LGPL to LICENSE.LGPLv21 - Added LICENSE.LGPLv3 & LICENSE.GPLv2 - Removed LICENSE.GPL Change-Id: I84a565e2e0caa3b76bf291a7d188a57a4b00e1b0 Reviewed-by: Jani Heikkinen <jani.heikkinen@digia.com>
* Doc: Removing url variable from qdocconf file.Topi Reinio2014-08-161-1/+0
| | | | | | | | -url inherited from the url variable set in qtbase/doc/global Change-Id: I94a0da7aa98af1fdd6140168fe9feb27b11c0bdb Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Remove duplicated wordsTopi Reinio2014-08-123-5/+5
| | | | | | | | Removes duplicated (repeated) words and fixes other minor documentation issues. Change-Id: I891f2b3e60194b207737425c1dcc1d35a5bd921a Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Doc: Merged two pages titled "Qt Quick QML Types".Jerome Pasion2014-07-243-290/+21
| | | | | | | | | | | | | | -kept the \qmlmodule page. -there are two pages with the same titles and it is difficult to discern between the two. -the grouping is lost, but those can be restored in either the use case or concept topic pages. -modified landing page and other pages which link to the unmerged document. Change-Id: I58468c22f0621506e477f30ae2411a382d57b982 Reviewed-by: Mitch Curtis <mitch.curtis@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Merge remote-tracking branch 'origin/5.3' into devFrederik Gladhorn2014-07-107-8/+10
|\ | | | | | | Change-Id: Iba61035910c46627e5e1c3824757da7b3d573657
| * Doc: correct link/compilation errors in Qt DeclarativeNico Vertriest2014-07-027-8/+10
| | | | | | | | | | | | | | Task-number: QTBUG-34749 Change-Id: I507d54b0568d77c6099a0bd99f5c369b8667032a Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* | Merge remote-tracking branch 'origin/5.3' into devFrederik Gladhorn2014-07-021-4/+4
|\| | | | | | | | | | | | | | | | | | | Conflicts: .qmake.conf examples/quick/scenegraph/openglunderqml/squircle.h src/quick/doc/src/qmltypereference.qdoc src/quick/scenegraph/qsgthreadedrenderloop.cpp Change-Id: Ife4f4b897044a7ffcd0710493c6aed1d87cf1ef9
| * Update QtQuick import value to 2.3Samuel Gaist2014-06-231-4/+4
| | | | | | | | | | | | | | | | | | | | The current documentation uses import QtQuick 2.2 which is wrong since there are new APIs like mipmap for the QML Image element. Task-number: QTBUG-39302 Change-Id: I3cc3a1522efd85090c3b4011429fa16b95e79435 Reviewed-by: J-P Nurmi <jpnurmi@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Use categorized logging for all things scenegraph.Gunnar Sletta2014-07-011-0/+22
| | | | | | | | | | Change-Id: I865ee838b0fd6c257b7189f24130012b98206fd1 Reviewed-by: Shawn Rutledge <shawn.rutledge@digia.com>
* | Make QQuickRenderControl publicLaszlo Agocs2014-06-241-5/+15
| | | | | | | | | | | | | | | | | | | | | | | | QQuickRenderControl allows rendering Qt Quick 2 scenes into framebuffer objects which can then be used in arbitrary ways in Qt-based or 3rd party OpenGL renderers. [ChangeLog][QtQuick] Introduced QQuickRenderControl as a public API. Task-number: QTBUG-37944 Change-Id: I84262243b261b35cefdf67ec6bba8127a0f29275 Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
* | Merge remote-tracking branch 'origin/5.3' into devSimon Hausmann2014-06-131-5/+3
|\| | | | | | | | | | | | | Conflicts: src/quickwidgets/qquickwidget.cpp Change-Id: Id4b080aea713df68608847bb82570231e37ce536
| * Doc: Removed redundant link to section in the same page.Jerome Pasion2014-06-051-5/+3
| | | | | | | | | | | | | | | | There is no need to refer to a different section as it is understood that those instructions apply to all examples. Change-Id: I2d0d2d6cbf84790bc4ca2f3deda57ab5d3d1c6c1 Reviewed-by: Martin Smith <martin.smith@digia.com>
* | Doc: Fix qmlclass selector used in documentation configTopi Reinio2014-06-111-1/+1
| | | | | | | | | | | | | | | | | | | | A recent change (46959875) in qdoc raised QML types from subnodes to top-level nodes. This change modifies the documentation configuration file(s) accordingly. Change-Id: Ic457d20368979aa15b546dceaf84fa2fb2d31091 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* | Merge remote-tracking branch 'origin/stable' into devSimon Hausmann2014-05-221-8/+5
|\| | | | | | | Change-Id: I0dd91626837276f5811e4830f4a4e9f89bf1e1bd
| * Doc: Describe property bindings in terms of relationshipsSze Howe Koh2014-05-161-8/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - This patch aims to help readers think about bindings more "declaratively" by introducing a new (albeit very leaky) level of abstraction: Treat bindings as finitary relations, rather than mere JavaScript expressions. - In essence, property bindings are for describing relationships between properties. The fact that the QML engine reactively updates a property's value when its dependencies change, and the fact that arbitrarily complex expressions are valid bindings, are simply implementation details. - Discourage the use of side effects in property bindings. They are not essential for the main purpose of property bindings, they break the finitary relation model, and their use can reduce code readability/maintainability/toolability. - Discourage complex property bindings for similar reasons. Change-Id: I5a0a03bd02768d4c504797a0f86569f3ac066e96 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2014-05-1013-21/+161
|\| | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: .qmake.conf src/plugins/accessible/quick/quick.pro src/quick/items/qquickpincharea.cpp src/quick/scenegraph/coreapi/qsgbatchrenderer.cpp src/quick/scenegraph/qsgthreadedrenderloop.cpp Manually adjusted for TestHTTPServer constructor change: tests/auto/quick/qquickimage/tst_qquickimage.cpp Change-Id: I5e58a7c08ea92d6fc5e3bce98571c54f7b2ce08f
| * Remove references of QML as a 'declarative' languageKai Koehne2014-05-071-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | Though the core of QML is declarative, it incorporates JavaScript, a multi-paradigm language on its own. It's therefore correct to call it a multi-paradigm language, too. Change-Id: Ia72acedafefb68ea8c49b9f6ab195ca9e73dad5f Reviewed-by: hjk <hjk121@nokiamail.com> Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com> Reviewed-by: Christopher Adams <chris.adams@jollamobile.com> Reviewed-by: Lars Knoll <lars.knoll@digia.com>
| * Document the QSG_VISUALIZE environment variable.Mitch Curtis2014-03-316-0/+117
| | | | | | | | | | | | | | The explanations are taken from 3f8d5d0. Change-Id: I9901b5f2c42f7bec6573101eb91eb9116089d4e9 Reviewed-by: Gunnar Sletta <gunnar.sletta@jollamobile.com>
| * Fix some documentation errors.Friedemann Kleint2014-03-242-10/+9
| | | | | | | | | | Change-Id: I5d4b3e26742202c4b634d0001fd3658c7263c50a Reviewed-by: Alan Alpert <aalpert@blackberry.com>
| * Doc: Fix broken \qmlsignal linksSze Howe Koh2014-03-182-6/+6
| | | | | | | | | | | | | | | | Fix the breaks caused by the re-categorizing of \qmlsignal pages Task-number: QTBUG-35846 Change-Id: I528ae16ec522fc902133e22d8f53c87a7f0d56ad Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * Doc: Reintroduce missing sample XML file for XMLRole documentationTopi Reinio2014-03-182-2/+24
| | | | | | | | | | | | | | | | | | | | | | | | | | XMLRole documentation talks about sample XML content, but erraenously quoted a QML file instead. This change brings back the sample file from Qt 4.8, and updates it to cover the use of boolean role. Change-Id: Id71550fab15c761320551f6583a138cd7cc88376 Reviewed-by: Bea Lam <bea.lam@jollamobile.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Alan Alpert <aalpert@blackberry.com>
| * Add docs on using a query in XMLRole with the less obvious boolean()David Greaves2014-03-171-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | Added to a documentation snippet since a direct boolean map is useful in QML for toggles and using "@wanted/boolean()" as the @type example does, would be wrong. Change-Id: If412ec0f4891db39fe1a219f9cb89e1f7103fd38 Signed-off-by: David Greaves <david@dgreaves.com> Reviewed-by: Alan Alpert <aalpert@blackberry.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
| * Move Qt Quick Widgets example and document itTopi Reinio2014-03-141-1/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Because QtQuickWidgets is part of Qt Quick module documentation, its examples need to also be moved under the examples/quick directory structure. This change moves the example, creates minimal documentation for it, and adds a link to it from the QQuickWidget class reference. Task-number: QTBUG-37272 Change-Id: Iffb67849f150b9aaf0edaef5852364e93f7752b8 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* | Say hello to QQuickItem::grabToImage().Gunnar Sletta2014-05-011-0/+87
| | | | | | | | | | | | | | | | | | [ChangeLog][QtQuick][Item] Added functions QQuickItem::grabToImage() and Item::grabToImage() to allow grabbing of items into system-memory images. Change-Id: I76cd73bb62f7440569c6fce63d63528559845721 Reviewed-by: Michael Brasser <michael.brasser@live.com>
* | doc: Minor group/module page changes.Martin Smith2014-03-261-1/+2
|/ | | | | | | | | | These changes were made in conjunction with the large update to qdoc to teach it to use multiple trees. Task-number: QTBUG-35377 Change-Id: If16bfdf9186483c0b313c999c61fa4dc5cf49048 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Re-organized Qt Quick's examples page.Jerome Pasion2014-03-121-90/+119
| | | | | | | | | | -Organized into "Demo", "Tutorials", and "Examples". -Added Controls, Dialogs, and other Qt Quick examples. -Added links to Qt Creator tutorials related to Qt Quick. Task-number: QTBUG-36838 Change-Id: I9ca000a73465217a2c42ebac9288e6462afa4cf5 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Adding QQuickWidget's path to the qtquick.qdocconfJerome Pasion2014-03-111-2/+5
| | | | | | | | -allows QDoc to detect and generate documentation. Task-number: QTBUG-37272 Change-Id: I83aedead99c7fccb03fe4a7fa34be45fc94ae010 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>
* Doc: Fix "Right-to-left User Interfaces"Takumi Asaki2014-03-061-8/+8
| | | | | | | | * Change from QApplication to QGuiApplication * Change from qmlviewer to qmlscene Change-Id: I6ceee763c125c4896905884f55437e3f375408d7 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Fix some typosSergio Ahumada2014-03-032-3/+3
| | | | | Change-Id: Iea540b768232ea423ea7f04e41655198931cf36d Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Renamed Qt Quick Code Samples page.Jerome Pasion2014-03-033-3/+3
| | | | | | | | | -new name is Qt Quick Examples and Tutorials -includes tutorials, not just examples or code samples. Task-number: QTBUG-36838 Change-Id: I660770cac1cdd71cd3b34bad878b0e59a088924b Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Add Image::mipmap to support mipmapping of images.Gunnar Sletta2014-02-121-0/+3
| | | | | | | | | [ChangeLog][QtQuick] New feature: Image.mipmap Task-number: QTBUG-19961 Change-Id: I13acb2408d5b126790adaf9d324ad4beda1e3646 Reviewed-by: Michael Brasser <michael.brasser@live.com>
* fix whitespaceOswald Buddenhagen2014-01-2215-24/+24
| | | | | | | remove trailing spaces and expand tabs Change-Id: Ieacb9d096b612c45d1a64700044c114d1f7522bc Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>
* Remove the two default role names listed in cppmodels documentation.Mitch Curtis2014-01-161-14/+1
| | | | | | | | | The list is incomplete, and they are now fully documented under QAbstractItemModel::roleNames(). This saves us maintaining two lists that can easily get out of sync. Change-Id: I4895a8ba19a4f48c26b4077e8bf2eba8c4c8407c Reviewed-by: Stephen Kelly <stephen.kelly@kdab.com>
* Doc: Fix current QtQuick module version.Takumi Asaki2014-01-101-2/+2
| | | | | Change-Id: I8056757967ff2693f69b5a7afa11a00ca826ece0 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: QtTest - Fix documentation for TestCase and SignalSpyCaroline Chao2014-01-093-2/+13
| | | | | | | | | | | | | | | | | The property/methods documentation needs to be available in the components qml file. Thus we now import those components from the qml files directly instead of using fake header files. Rename the Qt Quick Test page to Qt Quick Test Qml Types to be consistent with the other submodules. Task-number: QTBUG-33587 Change-Id: Ifb1df8e7d15f2e23b4b4268e5df138934e62fc42 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Doc: Fix broken linksSze Howe Koh2013-12-3014-31/+28
| | | | | Change-Id: I4c4577edde96978a986606bf30fbb925f871bd42 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Context2D: don't use an arrow to illustrate scaling in the docs.Mitch Curtis2013-12-261-0/+0
| | | | | | | | | | The example image scales an arrow, but uses an arrow to indicate that the next image (an arrow) is a result of the first arrow being scaled. Instead, use a circle. Change-Id: I8de18d4c2f3cb309681f63c31b0c9f7255d1868c Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Doc: Fixed a few broken links and snippetsVenu2013-12-231-2/+2
| | | | | | | | | | Couple of \snippet references in the ListModel docs were pointing to files outside the exampledirs boundary. Update those references to use the relative path. Change-Id: Ibf9d0fda9e5280345b08cb66a4fe0db9142a42a6 Reviewed-by: Nico Vertriest <nico.vertriest@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Performance note about QQuickWindow::setColor vs top-level RectangleGunnar Sletta2013-11-251-0/+5
| | | | | Change-Id: I58d271b108734958b6e0cd55ff62417d5b649a63 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Fixed list of animation types.Jerome Pasion2013-11-181-10/+1
| | | | | | | | | -manually created list duplicates the generated list. -\generatelist{related} doesn't do anything for a regular \page. Task-number: QTBUG-33360 Change-Id: I0bf870c71d3985e232fa8c0d5ef7ad572f596e99 Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Doc: Updated url variable in qdocconf files.Jerome Pasion2013-11-061-1/+1
| | | | | | | | | | | | | | | In 5.2, the HTML output is in a flatter structure and when they are hosted in qt-project.org/doc, the documentation will be found at http://qt-project.org/doc/qt-$QT_VER The url variable is used by projects outside of Qt 5 which need to link to Qt 5 documentation, such as Qt Creator. Task-number: QTBUG-34584 Change-Id: Ie23c3748fbe780fa00f98404238099809df5ef06 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: J-P Nurmi <jpnurmi@digia.com>
* Doc: Fix broken linksSze Howe Koh2013-11-055-7/+5
| | | | | | Change-Id: Ie7408409ddbaa354370267f2dd74326ec56a4186 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Fix typosSze Howe Koh2013-11-051-1/+0
| | | | | | Task-number: QTBUG-33360 Change-Id: I913c14d3d6a90d2c20e40e246ad11f50a26c3ad9 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Add missing image to XmlListModel documentationTopi Reinio2013-11-041-0/+0
| | | | | | | | | | The image was originally part of QtQuick1 docs - copy it over to qtdeclarative repository. Task-number: QTBUG-34556 Change-Id: Ic7089ce157ff7722e5f42b201ff4b01dcff2564e Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Add references to Animators from the QML Type ReferenceGunnar Sletta2013-10-291-0/+6
| | | | | | | Task-number: QTBUG-34221 Change-Id: Iaa1d7f4dd70d2d8150e8360545a33ac984e6bebd Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Fixed broken linksVenu2013-10-243-46/+47
| | | | | | | | | | | | | | | | | There were many links (including the broken) on the Qt Quick index page and QML type reference page using the html file name to link to a page or a section within a page. Using html file reference in a link is not a good approach as qdoc does not give complete control to the author to define the html file name. This change updates all such links to use the page \title and \target names, which are considered to be better ways to link. Task-number:QTBUG-33360 Change-Id: Ibd1b1e3223a7e205bbdcf21b1b7f6e515749c5c9 Reviewed-by: Nico Vertriest <nico.vertriest@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Added a QML module page for Qt Quick TestVenu2013-10-231-1/+15
| | | | | | | | | | | | This should avoid the TestCase and SignalSpy types being listed in the All Classes page, which is meant for the C++ classes. Task-number: QTBUG-33316 Change-Id: I0f2f9e557df89f46f656a8820602fe5712c64073 Reviewed-by: Caroline Chao <caroline.chao@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Renamed links to "QML Applications".Jerome Pasion2013-10-151-3/+3
| | | | | | | | | | | "QML Application Developer Resources" is too long and the visible text is usually shortened to "QML Applications". The article in qt5/qtdoc changed title to "QML Applications". Change-Id: I301f3b4659bd87631269b912bcc36f6f00fdeb2c Reviewed-by: Mitch Curtis <mitch.curtis@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Animator overview docs and example.Gunnar Sletta2013-10-031-0/+19
| | | | | Change-Id: If0852e48dbbfea4fadca9c897ea0e62393763055 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: no longer recognizes the version nr in QML refsMartin Smith2013-10-024-22/+22
| | | | | | | | | | All QML references of the form <QML-module-name><QML-module-version>::<QML-type>::<member-name> have had the <QML-module-version> removed i. Task-number: QTBUG-33776 Change-Id: Idde279e0f254cd24ea44f9841662dd81a2c5bbc6 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-21 03:13:40 +0000