LeechCraft  0.6.70-3565-g2d86529
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ijobholder.h
Go to the documentation of this file.
1 /**********************************************************************
2  * LeechCraft - modular cross-platform feature rich internet client.
3  * Copyright (C) 2006-2014 Georg Rudoy
4  *
5  * Boost Software License - Version 1.0 - August 17th, 2003
6  *
7  * Permission is hereby granted, free of charge, to any person or organization
8  * obtaining a copy of the software and accompanying documentation covered by
9  * this license (the "Software") to use, reproduce, display, distribute,
10  * execute, and transmit the Software, and to prepare derivative works of the
11  * Software, and to permit third-parties to whom the Software is furnished to
12  * do so, all subject to the following:
13  *
14  * The copyright notices in the Software and this entire statement, including
15  * the above license grant, this restriction and the following disclaimer,
16  * must be included in all copies of the Software, in whole or in part, and
17  * all derivative works of the Software, unless such copies or derivative
18  * works are solely in the form of machine-executable object code generated by
19  * a source language processor.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
24  * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
25  * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
26  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  **********************************************************************/
29 
30 #pragma once
31 
32 #include <QtPlugin>
33 
34 #if QT_VERSION >= 0x050000
35 #include <QAbstractItemModel>
36 #endif
37 
38 #include "interfaces/structures.h"
39 
40 class QModelIndex;
41 class QAbstractItemModel;
42 class QWidget;
43 
44 namespace LeechCraft
45 {
52  {
57 
62 
67  };
68 
78  {
83 
88 
96 
104  };
105 
120  {
127  qlonglong Done_ = 0;
128 
135  qlonglong Total_ = 0;
136 
145  TaskParameters Params_ = {};
146 
149  enum class State
150  {
153  Unknown,
154 
157  Running,
158 
161  Paused,
162 
165  Error
167 
170  ProcessStateInfo () = default;
171 
182  ProcessStateInfo (qlonglong done, qlonglong total, TaskParameters params)
183  : ProcessStateInfo { done, total, params, State::Unknown }
184  {
185  }
186 
200  ProcessStateInfo (qlonglong done, qlonglong total, TaskParameters params, State state)
201  : Done_ { done }
202  , Total_ { total }
203  , Params_ { params }
204  , State_ { state }
205  {
206  }
207  };
208 
212  {
224  };
225 }
226 
251 class Q_DECL_EXPORT IJobHolder
252 {
253 public:
283  virtual QAbstractItemModel* GetRepresentation () const = 0;
284 
287  virtual ~IJobHolder () {}
288 };
289 
292 Q_DECLARE_METATYPE (QAbstractItemModel*);
293 
294 Q_DECLARE_INTERFACE (IJobHolder, "org.Deviant.LeechCraft.IJobHolder/1.0");
qlonglong Total_
The total amount of items to be processed or downloaded.
Definition: ijobholder.h:135
virtual ~IJobHolder()
Virtual destructor.
Definition: ijobholder.h:287
Q_DECLARE_METATYPE(LeechCraft::JobHolderRow)
ProcessStateInfo()=default
Default-constructs a process description.
The column with the status of the task, like the download status or the unread items count of an RSS ...
Definition: ijobholder.h:61
ProcessStateInfo(qlonglong done, qlonglong total, TaskParameters params, State state)
Constructs the description with the given values and state.
Definition: ijobholder.h:200
Describes the state of a process.
Definition: ijobholder.h:223
JobHolderRole
This enum contains roles that are used to query job states.
Definition: ijobholder.h:211
The process is running just fine.
Interface for plugins holding jobs or persistent notifications.
Definition: ijobholder.h:251
State of a single process represented in a IJobHolder model.
Definition: ijobholder.h:119
JobHolderRow
Describes the semantics of a row in a job holder model.
Definition: ijobholder.h:77
TaskParameters Params_
The flags of the task as it was originally added to the downloader, if relevant.
Definition: ijobholder.h:145
The column with the name of the task, like a torrent name or an RSS feed name.
Definition: ijobholder.h:56
State
Describes the state of the process.
Definition: ijobholder.h:149
qlonglong Done_
The amount of items already processed or downloaded.
Definition: ijobholder.h:127
JobHolderColumn
Describes the columns in a job holder model.
Definition: ijobholder.h:51
enum LeechCraft::ProcessStateInfo::State State_
ProcessStateInfo(qlonglong done, qlonglong total, TaskParameters params)
Constructs the description with the given values.
Definition: ijobholder.h:182
The column with the progress of the task, like the amount of data downloaded so far or last update...
Definition: ijobholder.h:66
There was an error completing the process.
Q_DECLARE_INTERFACE(IJobHolder,"org.Deviant.LeechCraft.IJobHolder/1.0")