alecs/plasma-framework
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added documentation for the Application class

Browse Source
This commit is contained in:
Ivan Čukić 2013-09-01 13:33:02 +02:00
parent f786c74020
commit 6657090107
1 changed files with 22 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
src/declarativeimports/platformcomponents/application.h
View File

@ -25,10 +25,29 @@
#include "utils/d_ptr.h" #include "utils/d_ptr.h"
/**
* Class which handles an application execution.
*
* Example:
* <code>
* Application {
* application: "xterm"
* running: terminalRunningCheckbox.checked
* }
* </code>
*/
class Application: public QObject { class Application: public QObject {
Q_OBJECT Q_OBJECT
/**
* The name or path of the applications
*/
Q_PROPERTY(QString application READ application WRITE setApplication NOTIFY applicationChanged); 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); Q_PROPERTY(bool running READ running WRITE setRunning NOTIFY runningChanged);
public: public:
@ -38,14 +57,14 @@ public:
QString application() const; QString application() const;
bool running() const; bool running() const;
public Q_SLOTS: public:
void setApplication(const QString & application); void setApplication(const QString & application);
void setRunning(bool run);
public Q_SLOTS:
void start(); void start();
void terminate(); void terminate();
void setRunning(bool run);
Q_SIGNALS: Q_SIGNALS:
void applicationChanged(const QString & application); void applicationChanged(const QString & application);
void runningChanged(bool running); void runningChanged(bool running);