ijobholder.h

Go to the documentation of this file.

/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2006-2014  Georg Rudoy
 *
 * Boost Software License - Version 1.0 - August 17th, 2003
 *
 * Permission is hereby granted, free of charge, to any person or organization
 * obtaining a copy of the software and accompanying documentation covered by
 * this license (the "Software") to use, reproduce, display, distribute,
 * execute, and transmit the Software, and to prepare derivative works of the
 * Software, and to permit third-parties to whom the Software is furnished to
 * do so, all subject to the following:
 *
 * The copyright notices in the Software and this entire statement, including
 * the above license grant, this restriction and the following disclaimer,
 * must be included in all copies of the Software, in whole or in part, and
 * all derivative works of the Software, unless such copies or derivative
 * works are solely in the form of machine-executable object code generated by
 * a source language processor.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 **********************************************************************/
 
#pragma once
 
#include <QtPlugin>
#include "interfaces/structures.h"
 
class QAbstractItemModel;
class QWidget;
 
namespace LC
{
    enum JobHolderColumn
    {
        JobName,
 
        JobStatus,
 
        JobProgress
    };
 
    enum JobHolderRow
    {
        Other,
 
        News,
 
        DownloadProgress,
 
        ProcessProgress
    };
 
    struct ProcessStateInfo
    {
        qlonglong Done_ = 0;
 
        qlonglong Total_ = 0;
 
        TaskParameters Params_ = {};
 
        enum class State
        {
            Unknown,
 
            Running,
 
            Paused,
 
            Error
        } State_ = State::Unknown;
 
        ProcessStateInfo () = default;
 
        ProcessStateInfo (qlonglong done, qlonglong total, TaskParameters params)
        : ProcessStateInfo { done, total, params, State::Unknown }
        {
        }
 
        ProcessStateInfo (qlonglong done, qlonglong total, TaskParameters params, State state)
        : Done_ { done }
        , Total_ { total }
        , Params_ { params }
        , State_ { state }
        {
        }
    };
 
    enum JobHolderRole
    {
        ProcessState = CustomDataRoles::RoleMAX + 1
    };
}
 
class IJobHolderRepresentationHandler;
using IJobHolderRepresentationHandler_ptr = std::shared_ptr<IJobHolderRepresentationHandler>;
 
class Q_DECL_EXPORT IJobHolder
{
public:
    virtual QAbstractItemModel* GetRepresentation () const = 0;
 
    virtual IJobHolderRepresentationHandler_ptr CreateRepresentationHandler () { return {}; }
 
    virtual ~IJobHolder () {}
};
 
Q_DECLARE_METATYPE (LC::JobHolderRow)
Q_DECLARE_METATYPE (LC::ProcessStateInfo)
 
Q_DECLARE_INTERFACE (IJobHolder, "org.Deviant.LeechCraft.IJobHolder/1.0")