Developer Documentation
ProcessInterface.hh
Go to the documentation of this file.
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41 
42 /*===========================================================================*\
43 * *
44 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49 
50 #ifndef PROCESSINTERFACE_HH
51 #define PROCESSINTERFACE_HH
52 
53 #include <OpenFlipper/threads/OpenFlipperThread.hh>
54 
55 #if QT_VERSION >= 0x050000
56  #include <QtWidgets>
57 #else
58  #include <QtGui>
59 #endif
60 
61 
76 
77  public :
78 
80  virtual ~ProcessInterface() {};
81 
82  signals :
83 
99  virtual void startJob( QString _jobId, QString _description , int _min , int _max , bool _blocking = false) {};
100 
108  virtual void setJobState(QString _jobId, int _value ) {};
109 
117  virtual void setJobName(QString _jobId, QString _name ) {};
118 
126  virtual void setJobDescription(QString _jobId, QString _text ) {};
127 
132  virtual void cancelJob(QString _jobId ) {};
133 
141  virtual void finishJob(QString _jobId ) {};
142 
143  private slots :
144 
152  virtual void canceledJob (QString _job ) {};
153 
154 };
155 
156 
313 Q_DECLARE_INTERFACE(ProcessInterface,"OpenFlipper.ProcessInterface/1.0")
314 
315 #endif // PROCESSINTERFACE_HH
virtual void startJob(QString _jobId, QString _description, int _min, int _max, bool _blocking=false)
announce a new job
virtual void setJobState(QString _jobId, int _value)
update job state
virtual void finishJob(QString _jobId)
Finish your job.
virtual void canceledJob(QString _job)
A job has been canceled.
virtual void cancelJob(QString _jobId)
Cancel your job.
Interface class for Thread handling.
virtual ~ProcessInterface()
Destructor.
virtual void setJobDescription(QString _jobId, QString _text)
update job&#39;s description text
virtual void setJobName(QString _jobId, QString _name)
update job&#39;s name