From 665709010729ac1d0cb035fef50a7d8ae762674e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=C4=8Cuki=C4=87?= Date: Sun, 1 Sep 2013 13:33:02 +0200 Subject: [PATCH] Added documentation for the Application class --- .../platformcomponents/application.h | 25 ++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/src/declarativeimports/platformcomponents/application.h b/src/declarativeimports/platformcomponents/application.h index eb700f7a2..da1a053d0 100644 --- a/src/declarativeimports/platformcomponents/application.h +++ b/src/declarativeimports/platformcomponents/application.h @@ -25,10 +25,29 @@ #include "utils/d_ptr.h" +/** + * Class which handles an application execution. + * + * Example: + * + * Application { + * application: "xterm" + * running: terminalRunningCheckbox.checked + * } + * + */ class Application: public QObject { Q_OBJECT + /** + * The name or path of the applications + */ Q_PROPERTY(QString application READ application WRITE setApplication NOTIFY applicationChanged); + + /** + * Indicates whether the user wants the application to be running or not. + * It does not refer to the actual state of the application. + */ Q_PROPERTY(bool running READ running WRITE setRunning NOTIFY runningChanged); public: @@ -38,14 +57,14 @@ public: QString application() const; bool running() const; -public Q_SLOTS: +public: void setApplication(const QString & application); + void setRunning(bool run); +public Q_SLOTS: void start(); void terminate(); - void setRunning(bool run); - Q_SIGNALS: void applicationChanged(const QString & application); void runningChanged(bool running);