LeechCraft  0.6.70-13729-g7046a9d2a7
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 "interfaces/structures.h"
34 
35 class QAbstractItemModel;
36 class QWidget;
37 
38 namespace LC
39 {
46  {
51 
56 
61  };
62 
72  {
77 
82 
90 
98  };
99 
114  {
121  qlonglong Done_ = 0;
122 
129  qlonglong Total_ = 0;
130 
139  TaskParameters Params_ = {};
140 
143  enum class State
144  {
147  Unknown,
148 
151  Running,
152 
155  Paused,
156 
159  Error
161 
164  ProcessStateInfo () = default;
165 
176  ProcessStateInfo (qlonglong done, qlonglong total, TaskParameters params)
177  : ProcessStateInfo { done, total, params, State::Unknown }
178  {
179  }
180 
194  ProcessStateInfo (qlonglong done, qlonglong total, TaskParameters params, State state)
195  : Done_ { done }
196  , Total_ { total }
197  , Params_ { params }
198  , State_ { state }
199  {
200  }
201  };
202 
206  {
218  };
219 }
220 
222 using IJobHolderRepresentationHandler_ptr = std::shared_ptr<IJobHolderRepresentationHandler>;
223 
248 class Q_DECL_EXPORT IJobHolder
249 {
250 public:
280  virtual QAbstractItemModel* GetRepresentation () const = 0;
281 
283 
286  virtual ~IJobHolder () {}
287 };
288 
291 
292 Q_DECLARE_INTERFACE (IJobHolder, "org.Deviant.LeechCraft.IJobHolder/1.0")
The process is running just fine.
ProcessStateInfo(qlonglong done, qlonglong total, TaskParameters params, State state)
Constructs the description with the given values and state.
Definition: ijobholder.h:194
State
Describes the state of the process.
Definition: ijobholder.h:143
virtual ~IJobHolder()
Virtual destructor.
Definition: ijobholder.h:286
ProcessStateInfo(qlonglong done, qlonglong total, TaskParameters params)
Constructs the description with the given values.
Definition: ijobholder.h:176
JobHolderColumn
Describes the columns in a job holder model.
Definition: ijobholder.h:45
The column with the progress of the task, like the amount of data downloaded so far or last update...
Definition: ijobholder.h:60
The column with the name of the task, like a torrent name or an RSS feed name.
Definition: ijobholder.h:50
ProcessStateInfo()=default
Default-constructs a process description.
qlonglong Total_
The total amount of items to be processed or downloaded.
Definition: ijobholder.h:129
State of a single process represented in a IJobHolder model.
Definition: ijobholder.h:113
JobHolderRole
This enum contains roles that are used to query job states.
Definition: ijobholder.h:205
The column with the status of the task, like the download status or the unread items count of an RSS ...
Definition: ijobholder.h:55
Interface for plugins holding jobs or persistent notifications.
Definition: ijobholder.h:248
Q_DECLARE_METATYPE(QVariantList *)
There was an error completing the process.
qlonglong Done_
The amount of items already processed or downloaded.
Definition: ijobholder.h:121
JobHolderRow
Describes the semantics of a row in a job holder model.
Definition: ijobholder.h:71
virtual IJobHolderRepresentationHandler_ptr CreateRepresentationHandler()
Definition: ijobholder.h:282
enum LC::ProcessStateInfo::State State_
std::shared_ptr< IJobHolderRepresentationHandler > IJobHolderRepresentationHandler_ptr
Definition: ijobholder.h:222
Definition: constants.h:35
TaskParameters Params_
The flags of the task as it was originally added to the downloader, if relevant.
Definition: ijobholder.h:139
Describes the state of a process.
Definition: ijobholder.h:217