LeechCraft  0.6.70-10870-g558588d6ec
Modular cross-platform feature rich live environment.
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 #include <QAbstractItemModel>
34 #include "interfaces/structures.h"
35 
36 class QModelIndex;
37 class QWidget;
38 
39 namespace LeechCraft
40 {
47  {
52 
57 
62  };
63 
73  {
78 
83 
91 
99  };
100 
115  {
122  qlonglong Done_ = 0;
123 
130  qlonglong Total_ = 0;
131 
140  TaskParameters Params_ = {};
141 
144  enum class State
145  {
148  Unknown,
149 
152  Running,
153 
156  Paused,
157 
160  Error
162 
165  ProcessStateInfo () = default;
166 
177  ProcessStateInfo (qlonglong done, qlonglong total, TaskParameters params)
178  : ProcessStateInfo { done, total, params, State::Unknown }
179  {
180  }
181 
195  ProcessStateInfo (qlonglong done, qlonglong total, TaskParameters params, State state)
196  : Done_ { done }
197  , Total_ { total }
198  , Params_ { params }
199  , State_ { state }
200  {
201  }
202  };
203 
207  {
219  };
220 }
221 
246 class Q_DECL_EXPORT IJobHolder
247 {
248 public:
278  virtual QAbstractItemModel* GetRepresentation () const = 0;
279 
282  virtual ~IJobHolder () {}
283 };
284 
287 Q_DECLARE_METATYPE (QAbstractItemModel*)
288 
289 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:130
virtual ~IJobHolder()
Virtual destructor.
Definition: ijobholder.h:282
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:56
ProcessStateInfo(qlonglong done, qlonglong total, TaskParameters params, State state)
Constructs the description with the given values and state.
Definition: ijobholder.h:195
Describes the state of a process.
Definition: ijobholder.h:218
JobHolderRole
This enum contains roles that are used to query job states.
Definition: ijobholder.h:206
The process is running just fine.
Interface for plugins holding jobs or persistent notifications.
Definition: ijobholder.h:246
State of a single process represented in a IJobHolder model.
Definition: ijobholder.h:114
JobHolderRow
Describes the semantics of a row in a job holder model.
Definition: ijobholder.h:72
TaskParameters Params_
The flags of the task as it was originally added to the downloader, if relevant.
Definition: ijobholder.h:140
Q_DECLARE_METATYPE(QVariantList *)
The column with the name of the task, like a torrent name or an RSS feed name.
Definition: ijobholder.h:51
State
Describes the state of the process.
Definition: ijobholder.h:144
qlonglong Done_
The amount of items already processed or downloaded.
Definition: ijobholder.h:122
JobHolderColumn
Describes the columns in a job holder model.
Definition: ijobholder.h:46
enum LeechCraft::ProcessStateInfo::State State_
ProcessStateInfo(qlonglong done, qlonglong total, TaskParameters params)
Constructs the description with the given values.
Definition: ijobholder.h:177
The column with the progress of the task, like the amount of data downloaded so far or last update...
Definition: ijobholder.h:61
There was an error completing the process.