Commit 80811537 authored by Topi Reinio's avatar Topi Reinio Committed by The Qt Project
Browse files

Doc: Create documentation for Qt Quick Controls examples


Create an initial set of documentation for the examples - brief
descriptions and screenshots.

Change-Id: I29939ab4ab81b78d1c83718a696d56932a3a285c
Reviewed-by: default avatarJerome Pasion <jerome.pasion@digia.com>
parent 390c6fa6
No related merge requests found
Showing with 100 additions and 1 deletion
src/controls/doc/images/qtquickcontrols-example-applicationtemplate.png

11.3 KiB

src/controls/doc/images/qtquickcontrols-example-basiclayouts.png

24.2 KiB

src/controls/doc/images/qtquickcontrols-example-gallery.png

52.4 KiB

src/controls/doc/images/qtquickcontrols-example-splitview.png

398 B

src/controls/doc/images/qtquickcontrols-example-tableview.png

37.6 KiB

src/controls/doc/images/qtquickcontrols-example-text.png

74.5 KiB

src/controls/doc/images/qtquickcontrols-example-touch.png

14 KiB

...@@ -33,6 +33,9 @@ depends = qtqml qtquick qtwidgets qtdoc qtquicklayouts ...@@ -33,6 +33,9 @@ depends = qtqml qtquick qtwidgets qtdoc qtquicklayouts
exampledirs += ../../../examples/quick/controls exampledirs += ../../../examples/quick/controls
# Specify the install path under QT_INSTALL_EXAMPLES
examplesinstallpath = quick/controls
headerdirs += ../ headerdirs += ../
sourcedirs += ../ sourcedirs += ../
......
...@@ -29,5 +29,101 @@ ...@@ -29,5 +29,101 @@
\group qtquickcontrols_examples \group qtquickcontrols_examples
\ingroup all-examples \ingroup all-examples
\title Qt Quick Controls Examples \title Qt Quick Controls Examples
\brief Demonstrates the ... functionality provided by Qt. \brief A Collection of examples for \l{Qt Quick Controls}, written in QML.
These examples show how to create user interfaces using
\l{Qt Quick Controls}.
*/
/*!
\example gallery
\title Qt Quick Controls - Gallery
\ingroup qtquickcontrols_examples
\brief A collection of components for a classic desktop-style UI.
\image qtquickcontrols-example-gallery.png
This example project demonstrates the various UI components provided by
\l{Qt Quick Controls}.
*/
/*!
\example basiclayouts
\title Qt Quick Controls - Basic Layouts Example
\ingroup qtquickcontrols_examples
\brief Demonstrates how to use layout types to arrange a UI
\image qtquickcontrols-example-basiclayouts.png
This example shows how to easily arrange UI components into
\l{Qt Quick Layouts}{layouts} with \l{GridLayout}, \l{RowLayout}, and
\l{ColumnLayout}.
*/
/*!
\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.
*/
/*!
\example ApplicationTemplate
\title Qt Quick Controls - Application Template
\ingroup qtquickcontrols_examples
\brief A simple application template with a few basic UI components.
\image qtquickcontrols-example-applicationtemplate.png
This is a simple, easily extensible template project for a
desktop application using \l{Qt Quick Controls}.
*/ */
/*!
\example stackview
\title Qt Quick Controls - Stack View Example
\ingroup qtquickcontrols_examples
\brief An example for a stack-based navigation model.
This example shows how to implement a stack-based navigation model
in a Qt Quick application using a \l{StackView} component from
\l{Qt Quick Controls}.
*/
/*!
\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.
*/
/*!
\example text
\title Qt Quick Controls - Text Editor Example
\ingroup qtquickcontrols_examples
\brief A text editor application.
\image qtquickcontrols-example-text.png
This example implements a text editor using \l{Qt Quick Controls},
complete with text formatting options, copy-paste and undo/redo.
*/
/*!
\example touch
\title Qt Quick Controls - Touch Gallery
\ingroup qtquickcontrols_examples
\brief Demonstrates UI controls for a touch interface
\image qtquickcontrols-example-touch.png
This example shows how to implement a UI suitable
for touch input using \l{Qt Quick Controls}.
*/
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment