summaryrefslogtreecommitdiff
path: root/doc/elements-systemui.qdoc
diff options
context:
space:
mode:
authorRobert Griebl <robert.griebl@pelagicore.com>2017-01-17 18:39:38 +0100
committerRobert Griebl <robert.griebl@pelagicore.com>2017-02-01 10:37:35 +0000
commit0897433d98cc8c465cc4b8dc3ca3638b2ebcb5cd (patch)
treea18f10a31df8f3a105421e4845b2d5f48239e8ed /doc/elements-systemui.qdoc
parent09217bd52457b815580b74ec3226ab66ea404007 (diff)
downloadqtapplicationmanager-0897433d98cc8c465cc4b8dc3ca3638b2ebcb5cd.tar.gz
Documentation update
Also removed the headless application type, since it was never really used besides a quick demo hack - you could achieve the same thing with custom capabilities. Change-Id: Ia7821f1dd66a6a26a81f87b1cf152d62652b2fed Reviewed-by: Dominik Holland <dominik.holland@pelagicore.com>
Diffstat (limited to 'doc/elements-systemui.qdoc')
-rw-r--r--doc/elements-systemui.qdoc17
1 files changed, 16 insertions, 1 deletions
diff --git a/doc/elements-systemui.qdoc b/doc/elements-systemui.qdoc
index c1ff4581..f5e23d51 100644
--- a/doc/elements-systemui.qdoc
+++ b/doc/elements-systemui.qdoc
@@ -39,6 +39,10 @@ Singleton QML types need not be declared, they are referenced by just their type
Instantiable QML types are declared with the their name followed by curly braces. These
declarations may be nested, creating parent-child relationships between the items.
+Non-Instantiable QML types are return values provided to the System-UI code, that allow the user
+direct access to data that would otherwise only be available (partially) through the singletons'
+item models.
+
\section1 QML Singletons
\list
\li ApplicationManager - The application model and controller.
@@ -48,7 +52,7 @@ declarations may be nested, creating parent-child relationships between the item
notification requests.
\li SystemMonitor - The system monitoring model, giving access to a range of measurements, e.g.
CPU load, frame rate, etc.
- \li ApplicationIPCManager - Central registry for interfaces for system-UI-to-app communication.
+ \li ApplicationIPCManager - Central registry for interfaces for System-UI-to-app communication.
\endlist
\section1 Instantiable QML Types
@@ -62,4 +66,15 @@ application. Depending on your System-UI design, this can be very helpful at tim
\li ApplicationInterfaceExtension - Client side access to IPC interface extensions.
\endlist
+\section1 Non-Instantiable QML Types
+
+All these types are return values provided through the ApplicationManager singleton - they are only
+available from within the System-UI.
+
+\list
+ \li \l Application - An application known to the ApplicationManager.
+ \li \l Runtime - A runtime that is executing an application.
+ \li \l Container - A container, that an application's Runtime is using.
+\endlist
+
*/