summaryrefslogtreecommitdiff
path: root/src/controls/doc
diff options
context:
space:
mode:
authorJani Heikkinen <jani.heikkinen@theqtcompany.com>2014-11-11 17:38:39 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-11-11 17:38:39 +0100
commit0bcb10542727e6f84459ba2779139a71effd965d (patch)
tree37320542f855e3e976cc7722a2ce24212a39a7b0 /src/controls/doc
parent313ae1c3b581a3e3a44f86793e158ba9e8eae9ab (diff)
parentd162d3b03cf5fb5c359c87ac841dd74a9909a548 (diff)
downloadqtquickcontrols-0bcb10542727e6f84459ba2779139a71effd965d.tar.gz
Merge "Merge remote-tracking branch 'origin/5.4' into 5.4.0" into refs/staging/5.4.0
Diffstat (limited to 'src/controls/doc')
-rw-r--r--src/controls/doc/images/qtquickcontrols-example-splitview.pngbin398 -> 0 bytes
-rw-r--r--src/controls/doc/images/qtquickcontrols-example-tableview.pngbin38463 -> 36290 bytes
-rw-r--r--src/controls/doc/src/qtquickcontrols-examples.qdoc46
-rw-r--r--src/controls/doc/src/qtquickcontrols-platformnotes.qdoc11
4 files changed, 33 insertions, 24 deletions
diff --git a/src/controls/doc/images/qtquickcontrols-example-splitview.png b/src/controls/doc/images/qtquickcontrols-example-splitview.png
deleted file mode 100644
index a82017b4..00000000
--- a/src/controls/doc/images/qtquickcontrols-example-splitview.png
+++ /dev/null
Binary files differ
diff --git a/src/controls/doc/images/qtquickcontrols-example-tableview.png b/src/controls/doc/images/qtquickcontrols-example-tableview.png
index b9dc67c3..c4ab8d99 100644
--- a/src/controls/doc/images/qtquickcontrols-example-tableview.png
+++ b/src/controls/doc/images/qtquickcontrols-example-tableview.png
Binary files differ
diff --git a/src/controls/doc/src/qtquickcontrols-examples.qdoc b/src/controls/doc/src/qtquickcontrols-examples.qdoc
index 5ff2b27b..29c8d2b5 100644
--- a/src/controls/doc/src/qtquickcontrols-examples.qdoc
+++ b/src/controls/doc/src/qtquickcontrols-examples.qdoc
@@ -78,30 +78,40 @@
*/
/*!
- \example splitview
- \title Qt Quick Controls - Split View Example
- \ingroup qtquickcontrols_examples
- \brief An example for the SplitView UI control.
- \image qtquickcontrols-example-splitview.png
-
- This example project demonstrates the usage of \l {SplitView} from
- \l{Qt Quick Controls} - a control that lays out items horizontally or
- vertically with a draggable splitter between each item.
-
- \include examples-run.qdocinc
-*/
-
-/*!
\example tableview
\title Qt Quick Controls - Table View Example
\ingroup qtquickcontrols_examples
\brief An example for the TableView control.
\image qtquickcontrols-example-tableview.png
- This example shows how a \l{TableView} from \l{Qt Quick Controls}
- can be used together with different types of data models to display
- lists of information with support for scroll bars, selections and
- resizable header sections.
+ This example project demonstrates the usage of \l {TableView} from
+ \l{Qt Quick Controls} - a control to display one or more columns of
+ information from a data list model. The example includes a model
+ that supports sorting and filtering.
+
+ The C++ class, SortFilterProxyModel, is registered as a QML type
+ under the namespace, "\c{org.qtproject.example 1.0}".
+
+ The following snippets show how the type is registered under
+ a namespace and later imported by \e main.qml.
+
+ QML type registration:
+
+ \code
+ #include <QtQml/qqml.h>
+ ...
+ qmlRegisterType<SortFilterProxyModel>("org.qtproject.example", 1, 0, "SortFilterProxyModel");
+ ...
+ \endcode
+
+ QML namespace import:
+
+ \qml
+ import org.qtproject.example 1.0
+ \endqml
+
+ For more information about registering C++ classses as QML types, see
+ \l {Defining QML Types from C++}.
\include examples-run.qdocinc
*/
diff --git a/src/controls/doc/src/qtquickcontrols-platformnotes.qdoc b/src/controls/doc/src/qtquickcontrols-platformnotes.qdoc
index 092dc45d..2d852445 100644
--- a/src/controls/doc/src/qtquickcontrols-platformnotes.qdoc
+++ b/src/controls/doc/src/qtquickcontrols-platformnotes.qdoc
@@ -33,7 +33,7 @@
This page contains platform specific notes for creating applications
that use \l{Qt Quick Controls}.
- \section1 Android
+ \section1 Android Style
Qt 5.4 introduced a native Android style for Qt Quick Controls.
@@ -41,8 +41,7 @@
\note The Android style requires Android 3.0 (API level 11) or later.
- No special actions are required to use the Android style. It is
- automatically selected and deployed on Android. See \l{Getting Started
+ It is automatically selected and deployed on Android. See \l{Getting Started
with Qt for Android} and \l{Deploying an Application on Android} for
more details on the Android essentials.
@@ -62,8 +61,8 @@
items declared in QML. Just to name a few possibilities:
\list
\li ToolButton actions,
- \li A TextField as a search field,
- \li A ComboBox for navigation, and
- \li A ProgressBar for displaying progress.
+ \li a TextField as a search field,
+ \li a ComboBox for navigation, and
+ \li a ProgressBar for displaying progress.
\endlist
*/