tstaskmonitor/client/src/tstaskmonitor.cpp
changeset 104 9b022b1f357c
parent 80 397d00875918
equal deleted inserted replaced
103:b99b84bcd2d1 104:9b022b1f357c
    18 #include "tstaskmonitor.h"
    18 #include "tstaskmonitor.h"
    19 #include "tstaskmonitor_p.h"
    19 #include "tstaskmonitor_p.h"
    20 
    20 
    21 #include "tstask.h"
    21 #include "tstask.h"
    22 
    22 
       
    23 /*!
       
    24     @class TsTaskMonitor
       
    25     @ingroup publicApi
       
    26     @brief TsTaskMonitor gives access to list of running tasks.
       
    27     
       
    28     This class is one of the Qt interfaces for Task Monitor server. It can be
       
    29     used to retrieve list of running tasks and receive notifications about the
       
    30     changes of this list.
       
    31 */
       
    32 
       
    33 /*!
       
    34     Constructor.
       
    35 */
    23 TsTaskMonitor::TsTaskMonitor(QObject *parent) : QObject(parent), d_ptr(0)
    36 TsTaskMonitor::TsTaskMonitor(QObject *parent) : QObject(parent), d_ptr(0)
    24 {
    37 {
    25     d_ptr = new TsTaskMonitorPrivate(this);
    38     d_ptr = new TsTaskMonitorPrivate(this);
    26 }
    39 }
    27 
    40 
       
    41 /*!
       
    42     Destructor.
       
    43 */
    28 TsTaskMonitor::~TsTaskMonitor()
    44 TsTaskMonitor::~TsTaskMonitor()
    29 {
    45 {
    30     delete d_ptr;
    46     delete d_ptr;
    31 }
    47 }
    32 
    48 
       
    49 /*!
       
    50     \return Current list of tasks from Task Monitor server.
       
    51 
       
    52     \sa TsTask, taskListChanged()
       
    53 */
    33 QList< QSharedPointer<TsTask> > TsTaskMonitor::taskList()
    54 QList< QSharedPointer<TsTask> > TsTaskMonitor::taskList()
    34 {
    55 {
    35     return d_ptr->taskList();
    56     return d_ptr->taskList();
    36 }
    57 }
       
    58 
       
    59 /*!
       
    60     @fn TsTaskMonitor::taskListChanged()
       
    61 
       
    62     This signal is emitted when task list changes in any way:
       
    63     - the new task is started
       
    64     - running task is terminated
       
    65     - parameters of one task change (for example image representing the task is updated)
       
    66 
       
    67     No data is passed within this signal, user should retrieve task list
       
    68     using taskList().
       
    69 
       
    70     \sa taskList()
       
    71 */