summaryrefslogtreecommitdiffstats
path: root/basicsuite
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2013-12-20 14:56:35 +0100
committerTopi Reiniƶ <topi.reinio@digia.com>2014-01-14 15:57:06 +0200
commite80e8e67554708a69d74bab5c22c6644b419eae1 (patch)
tree61728bb1ab1e4171c96f32931dd887dc64bf13f2 /basicsuite
parent06ed12c66d7d8a58e37228c3d4785b4070be5d6a (diff)
Introduce documentation for Qt Enterprise Embedded Examples
Create documentation structure for Qt Enterprise Embedded Examples and Demos, including the subprojects from the /basicsuite subdirectory. Task-number: QTEE-137 Change-Id: Ic6f9f9fa8cea8b7fa4821508fda93822c0b99ea3 Reviewed-by: Samuli Piippo <samuli.piippo@digia.com> Reviewed-by: Eirik Aavitsland <eirik.aavitsland@digia.com>
Diffstat (limited to 'basicsuite')
-rw-r--r--basicsuite/About Boot to Qt/About Boot to Qt.qmlproject18
-rw-r--r--basicsuite/Controls Layouts/Controls Layouts.qmlproject18
-rw-r--r--basicsuite/Controls Touch/Controls Touch.qmlproject18
-rw-r--r--basicsuite/Graphical Effects/Graphical Effects.qmlproject18
-rw-r--r--basicsuite/Media Player/Media Player.qmlproject18
-rw-r--r--basicsuite/Photo Gallery/Photo Gallery.qmlproject18
-rw-r--r--basicsuite/Qt5 Cinematic Demo/Qt5 Cinematic Demo.qmlproject (renamed from basicsuite/Qt5 Cinematic Demo/Qt5_CinematicExperience.qmlproject)2
-rw-r--r--basicsuite/Qt5 Particles Demo/Qt5 Particles Demo.qmlproject18
-rw-r--r--basicsuite/Qt5 Particles Demo/doc/src/emitters.qdoc18
-rw-r--r--basicsuite/SensorExplorer/doc/src/sensor_explorer.qdoc34
-rw-r--r--basicsuite/Sensors/Sensors.qmlproject18
-rw-r--r--basicsuite/Text Input/Text Input.qmlproject18
12 files changed, 183 insertions, 33 deletions
diff --git a/basicsuite/About Boot to Qt/About Boot to Qt.qmlproject b/basicsuite/About Boot to Qt/About Boot to Qt.qmlproject
new file mode 100644
index 0000000..4d32f75
--- /dev/null
+++ b/basicsuite/About Boot to Qt/About Boot to Qt.qmlproject
@@ -0,0 +1,18 @@
+import QmlProject 1.1
+
+Project {
+ mainFile: "main.qml"
+
+ /* Include .qml, .js, and image files from current directory and subdirectories */
+ QmlFiles {
+ directory: "."
+ }
+ JavaScriptFiles {
+ directory: "."
+ }
+ ImageFiles {
+ directory: "."
+ }
+ /* List of plugin directories passed to QML runtime */
+ // importPaths: [ "../exampleplugin" ]
+}
diff --git a/basicsuite/Controls Layouts/Controls Layouts.qmlproject b/basicsuite/Controls Layouts/Controls Layouts.qmlproject
new file mode 100644
index 0000000..4d32f75
--- /dev/null
+++ b/basicsuite/Controls Layouts/Controls Layouts.qmlproject
@@ -0,0 +1,18 @@
+import QmlProject 1.1
+
+Project {
+ mainFile: "main.qml"
+
+ /* Include .qml, .js, and image files from current directory and subdirectories */
+ QmlFiles {
+ directory: "."
+ }
+ JavaScriptFiles {
+ directory: "."
+ }
+ ImageFiles {
+ directory: "."
+ }
+ /* List of plugin directories passed to QML runtime */
+ // importPaths: [ "../exampleplugin" ]
+}
diff --git a/basicsuite/Controls Touch/Controls Touch.qmlproject b/basicsuite/Controls Touch/Controls Touch.qmlproject
new file mode 100644
index 0000000..4d32f75
--- /dev/null
+++ b/basicsuite/Controls Touch/Controls Touch.qmlproject
@@ -0,0 +1,18 @@
+import QmlProject 1.1
+
+Project {
+ mainFile: "main.qml"
+
+ /* Include .qml, .js, and image files from current directory and subdirectories */
+ QmlFiles {
+ directory: "."
+ }
+ JavaScriptFiles {
+ directory: "."
+ }
+ ImageFiles {
+ directory: "."
+ }
+ /* List of plugin directories passed to QML runtime */
+ // importPaths: [ "../exampleplugin" ]
+}
diff --git a/basicsuite/Graphical Effects/Graphical Effects.qmlproject b/basicsuite/Graphical Effects/Graphical Effects.qmlproject
new file mode 100644
index 0000000..4d32f75
--- /dev/null
+++ b/basicsuite/Graphical Effects/Graphical Effects.qmlproject
@@ -0,0 +1,18 @@
+import QmlProject 1.1
+
+Project {
+ mainFile: "main.qml"
+
+ /* Include .qml, .js, and image files from current directory and subdirectories */
+ QmlFiles {
+ directory: "."
+ }
+ JavaScriptFiles {
+ directory: "."
+ }
+ ImageFiles {
+ directory: "."
+ }
+ /* List of plugin directories passed to QML runtime */
+ // importPaths: [ "../exampleplugin" ]
+}
diff --git a/basicsuite/Media Player/Media Player.qmlproject b/basicsuite/Media Player/Media Player.qmlproject
new file mode 100644
index 0000000..4d32f75
--- /dev/null
+++ b/basicsuite/Media Player/Media Player.qmlproject
@@ -0,0 +1,18 @@
+import QmlProject 1.1
+
+Project {
+ mainFile: "main.qml"
+
+ /* Include .qml, .js, and image files from current directory and subdirectories */
+ QmlFiles {
+ directory: "."
+ }
+ JavaScriptFiles {
+ directory: "."
+ }
+ ImageFiles {
+ directory: "."
+ }
+ /* List of plugin directories passed to QML runtime */
+ // importPaths: [ "../exampleplugin" ]
+}
diff --git a/basicsuite/Photo Gallery/Photo Gallery.qmlproject b/basicsuite/Photo Gallery/Photo Gallery.qmlproject
new file mode 100644
index 0000000..4d32f75
--- /dev/null
+++ b/basicsuite/Photo Gallery/Photo Gallery.qmlproject
@@ -0,0 +1,18 @@
+import QmlProject 1.1
+
+Project {
+ mainFile: "main.qml"
+
+ /* Include .qml, .js, and image files from current directory and subdirectories */
+ QmlFiles {
+ directory: "."
+ }
+ JavaScriptFiles {
+ directory: "."
+ }
+ ImageFiles {
+ directory: "."
+ }
+ /* List of plugin directories passed to QML runtime */
+ // importPaths: [ "../exampleplugin" ]
+}
diff --git a/basicsuite/Qt5 Cinematic Demo/Qt5_CinematicExperience.qmlproject b/basicsuite/Qt5 Cinematic Demo/Qt5 Cinematic Demo.qmlproject
index fd24655..eabee43 100644
--- a/basicsuite/Qt5 Cinematic Demo/Qt5_CinematicExperience.qmlproject
+++ b/basicsuite/Qt5 Cinematic Demo/Qt5 Cinematic Demo.qmlproject
@@ -3,7 +3,7 @@
import QmlProject 1.1
Project {
- mainFile: "Qt5_CinematicExperience.qml"
+ mainFile: "main.qml"
/* Include .qml, .js, and image files from current directory and subdirectories */
QmlFiles {
diff --git a/basicsuite/Qt5 Particles Demo/Qt5 Particles Demo.qmlproject b/basicsuite/Qt5 Particles Demo/Qt5 Particles Demo.qmlproject
new file mode 100644
index 0000000..4d32f75
--- /dev/null
+++ b/basicsuite/Qt5 Particles Demo/Qt5 Particles Demo.qmlproject
@@ -0,0 +1,18 @@
+import QmlProject 1.1
+
+Project {
+ mainFile: "main.qml"
+
+ /* Include .qml, .js, and image files from current directory and subdirectories */
+ QmlFiles {
+ directory: "."
+ }
+ JavaScriptFiles {
+ directory: "."
+ }
+ ImageFiles {
+ directory: "."
+ }
+ /* List of plugin directories passed to QML runtime */
+ // importPaths: [ "../exampleplugin" ]
+}
diff --git a/basicsuite/Qt5 Particles Demo/doc/src/emitters.qdoc b/basicsuite/Qt5 Particles Demo/doc/src/emitters.qdoc
index 5644ab1..9577b06 100644
--- a/basicsuite/Qt5 Particles Demo/doc/src/emitters.qdoc
+++ b/basicsuite/Qt5 Particles Demo/doc/src/emitters.qdoc
@@ -25,36 +25,36 @@
**
****************************************************************************/
/*!
- \title QtQuick.Particles Examples - Emitters
- \example quick/particles/emitters
+ \title QtQuick Particles Emitters
+ \example Qt5 Particles Demo
+ \ingroup b2qt-demos
\brief This is a collection of examples using Emitters in the QML particle system.
- \image qml-emitters-example.png
This is a collection of small QML examples relating to using Emitters in the particle system.
Each example is a small QML file emphasizing a particular element or feature.
Velocity from motion gives the effect of strong particle motion through primarily moving the emitters:
- \snippet quick/particles/emitters/content/velocityfrommotion.qml 0
+ \snippet Qt5\ Particles\ Demo/content/velocityfrommotion.qml 0
Burst and pulse calls the burst and pulse methods on two idential emitters.
- \snippet quick/particles/emitters/content/burstandpulse.qml 0
+ \snippet Qt5\ Particles\ Demo/content/burstandpulse.qml 0
Note how burst takes an argument of number of particles to emit, and pulse takes an argument of number of milliseconds to emit for.
This gives a slightly different behaviour, which is easy to see in this example.
Custom Emitter connects to the emitParticles signal to set arbitrary values on particle data as they're emitted;
- \snippet quick/particles/emitters/content/customemitter.qml 0
+ \snippet Qt5\ Particles\ Demo/content/customemitter.qml 0
This is used to emit curving particles in six rotating spokes.
Emit mask sets an image mask on the Emitter, to emit out of an arbitrary shape.
- \snippet quick/particles/emitters/content/emitmask.qml 0
+ \snippet Qt5\ Particles\ Demo/content/emitmask.qml 0
Maximum emitted emits no more than a certain number of particles at a time. This example makes it easy to see what happens when the limit is reached.
Shape and Direction emits particles out of an unfilled Ellipse shape, using a TargetDirection
- \snippet quick/particles/emitters/content/shapeanddirection.qml 0
+ \snippet Qt5\ Particles\ Demo/content/shapeanddirection.qml 0
This sends the particles towards the center of the ellipse with proportional speed, keeping the ellipse outline as they move to the center.
TrailEmitter uses that element to add smoke particles to trail the fire particles in the scene.
- \snippet quick/particles/emitters/content/customemitter.qml 0
+ \snippet Qt5\ Particles\ Demo/content/customemitter.qml 0
*/
diff --git a/basicsuite/SensorExplorer/doc/src/sensor_explorer.qdoc b/basicsuite/SensorExplorer/doc/src/sensor_explorer.qdoc
index be04215..001642f 100644
--- a/basicsuite/SensorExplorer/doc/src/sensor_explorer.qdoc
+++ b/basicsuite/SensorExplorer/doc/src/sensor_explorer.qdoc
@@ -26,18 +26,18 @@
****************************************************************************/
/*!
- \example sensor_explorer
- \title Qt Sensors - Explorer QML example
- \ingroup qtsensors-examples
+ \example SensorExplorer
+ \title Sensor Explorer
+ \brief The Sensor Explorer example demonstrates how to read the meta-data of available sensors.
+ \ingroup b2qt-demos
\section2 Sensor Explorer in QML
- \brief The Sensor Explorer example demonstrates how to read the meta-data of available sensors.
This example is divided into two parts:
\list
- \li A \l{Sensor Explorer QML Import}{C++ plug-in} that provides QML alternatives for QSensorExplorer, QPropertyInfo and the QSensorItem classes.
+ \li A C++ plug-in that provides QML alternatives for QSensorExplorer, QPropertyInfo and the QSensorItem classes.
\li A QML Application that uses the QML alternatives to read the sensors meta-data and present it.
\endlist
@@ -54,38 +54,26 @@
Import the Explorer 1.0 declarative plugin:
- \snippet sensor_explorer/sensor_explorer.qml 0
+ \snippet SensorExplorer/main.qml 0
Create a SensorExplorer QML item:
- \snippet sensor_explorer/sensor_explorer.qml 1
+ \snippet SensorExplorer/main.qml 1
You can retrieve a list of all available sensors using the SensorExplorer:
- \snippet sensor_explorer/sensor_explorer.qml 2
+ \snippet SensorExplorer/main.qml 2
To retrieve the properties of a SensorItem use:
- \snippet sensor_explorer/sensor_explorer.qml 3
+ \snippet SensorExplorer/main.qml 3
Changing a property value can be done like:
- \snippet sensor_explorer/sensor_explorer.qml 4
+ \snippet SensorExplorer/main.qml 4
Starting and stopping a sensor can be done like:
- \snippet sensor_explorer/sensor_explorer.qml 5
-*/
-
-/*!
- \example sensor_explorer/import
- \title Sensor Explorer QML Import
-
- \section2 Sensor Explorer Declarative Plugin
- \brief The Sensor Explorer QML import exports the QSensorExplorer, QPropertyInfo and the QSensorItem class as a QML type.
-
- This example creates the \e {Explorer 1.0} import.
-
- \sa {Qt Sensors - Explorer QML example}
+ \snippet SensorExplorer/main.qml 5
*/
diff --git a/basicsuite/Sensors/Sensors.qmlproject b/basicsuite/Sensors/Sensors.qmlproject
new file mode 100644
index 0000000..4d32f75
--- /dev/null
+++ b/basicsuite/Sensors/Sensors.qmlproject
@@ -0,0 +1,18 @@
+import QmlProject 1.1
+
+Project {
+ mainFile: "main.qml"
+
+ /* Include .qml, .js, and image files from current directory and subdirectories */
+ QmlFiles {
+ directory: "."
+ }
+ JavaScriptFiles {
+ directory: "."
+ }
+ ImageFiles {
+ directory: "."
+ }
+ /* List of plugin directories passed to QML runtime */
+ // importPaths: [ "../exampleplugin" ]
+}
diff --git a/basicsuite/Text Input/Text Input.qmlproject b/basicsuite/Text Input/Text Input.qmlproject
new file mode 100644
index 0000000..4d32f75
--- /dev/null
+++ b/basicsuite/Text Input/Text Input.qmlproject
@@ -0,0 +1,18 @@
+import QmlProject 1.1
+
+Project {
+ mainFile: "main.qml"
+
+ /* Include .qml, .js, and image files from current directory and subdirectories */
+ QmlFiles {
+ directory: "."
+ }
+ JavaScriptFiles {
+ directory: "."
+ }
+ ImageFiles {
+ directory: "."
+ }
+ /* List of plugin directories passed to QML runtime */
+ // importPaths: [ "../exampleplugin" ]
+}