diff options
author | Dominik Holland <dominik.holland@pelagicore.com> | 2018-04-13 13:41:02 +0200 |
---|---|---|
committer | Jędrzej Nowacki <jedrzej.nowacki@qt.io> | 2018-04-17 06:24:26 +0000 |
commit | 2437c9cb79edd3f4a904548d03d307f89356e9e9 (patch) | |
tree | 04991c12bbcae251ab916913f557bd50964e6217 /doc/elements-systemui.qdoc | |
parent | 6aa3295386b0a0f0b8c7ae1b0f827dd28b6323ca (diff) | |
download | qtapplicationmanager-2437c9cb79edd3f4a904548d03d307f89356e9e9.tar.gz |
Introduce qdoc groups for all qml types
This makes it possible to auto generate the listings for every group
and makes it easier to add new documented types to those groups.
Change-Id: I04c261ac065332b29f981b8da5c43d5dd7eafab8
Reviewed-by: Robert Griebl <robert.griebl@pelagicore.com>
Diffstat (limited to 'doc/elements-systemui.qdoc')
-rw-r--r-- | doc/elements-systemui.qdoc | 35 |
1 files changed, 6 insertions, 29 deletions
diff --git a/doc/elements-systemui.qdoc b/doc/elements-systemui.qdoc index cbae72f3..355e9538 100644 --- a/doc/elements-systemui.qdoc +++ b/doc/elements-systemui.qdoc @@ -44,47 +44,24 @@ direct access to data that would otherwise only be available (partially) through item models. \section1 QML Singletons -\list - \li ApplicationManager - The application model and controller. - \li ApplicationInstaller - The package installation/removal/update part of the application-manager. - \li WindowManager - The window model and controller. - \li NotificationManager - The notification model, which handles freedesktop.org compliant - notification requests. - \li ApplicationIPCManager - Central registry for interfaces for System-UI-to-app communication. - \li SystemMonitor - The system monitoring model, giving access to a range of measurements, e.g. - CPU load, frame rate, etc. - \li ProcessMonitor - The process monitoring model, providing measurements like memory usage and - frame rate, etc. - \li StartupTimer - A tool for startup performance analysis. -\endlist +\annotatedlist system-ui-singletons \section1 Instantiable QML Types These types are only available for the System-UI: -\list - \li ApplicationModel - A proxy model for the ApplicationManager singleton. - \li ApplicationIPCInterface - System-UI side definition of interfaces for System-UI-to-app communication. -\endlist +\annotatedlist system-ui -The following types work the same way within the System-UI, as they would within a single-process -application. Depending on your System-UI design, this can be very helpful at times. +The following types are generic and can be used within an application as well as within the System-UI. +There is no need to use a single-process application when using these types. -\list - \li ApplicationManagerWindow - The window root item required in a multi-process environment. - \li \l Notification - Abstraction for freedesktop.org Notifications on the client side. - \li ApplicationInterfaceExtension - Client side access to System-UI-to-app communication interfaces. -\endlist +\annotatedlist system-ui-and-app \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 +\annotatedlist system-ui-non-instantiable */ |