ijobholder.h

Go to the documentation of this file.

/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2006-2014  Georg Rudoy
 *
 * Distributed under the Boost Software License, Version 1.0.
 * (See accompanying file LICENSE or copy at https://www.boost.org/LICENSE_1_0.txt)
 **********************************************************************/

#pragma once

#include <memory>
#include <QtPlugin>
#include "interfaces/structures.h"

class QAbstractItemModel;
class QMenu;
class QModelIndex;
class QToolBar;

template<typename>
class QList;

namespace LC
{
    enum class ProcessKind : std::uint8_t
    {
        Download,
        Upload,
        Generic,
    };

    struct ProcessInfo
    {
        TaskParameters Parameters_ {};

        ProcessKind Kind_;

        bool operator== (const ProcessInfo& other) const = default;
    };

    struct NewsInfo
    {
        qlonglong Count_ = 0;
        QDateTime LastUpdate_;

        bool operator== (const NewsInfo& other) const = default;
    };

    using SpecificInfo = std::variant<
            ProcessInfo,
            NewsInfo
        >;

    struct RowInfo
    {
        QString Name_;
        SpecificInfo Specific_;

        bool operator== (const RowInfo& other) const = default;
    };

    enum class ProcessState : std::uint8_t
    {
        Running,
        Paused,
        Finished,
        Error,
        Unknown,
    };

    enum class JobHolderRole
    {
        RowInfo = MaxValue<CustomDataRoles> + 1,
    };

    constexpr int operator+ (JobHolderRole role) noexcept
    {
        return static_cast<int> (role);
    }

    template<>
    inline constexpr int MaxValue<JobHolderRole> = +JobHolderRole::RowInfo;

    enum class JobHolderProcessRole
    {
        Done = MaxValue<JobHolderRole> + 1, // qint64
        Total, // qint64
        ProgressCustomText, // QString
        State, // ProcessState
        StateCustomText, // QString
    };

    constexpr int operator+ (JobHolderProcessRole role) noexcept
    {
        return static_cast<int> (role);
    }

    template<>
    inline constexpr int MaxValue<JobHolderProcessRole> = +JobHolderProcessRole::StateCustomText;
}

class IJobHolderRepresentationHandler
{
public:
    virtual ~IJobHolderRepresentationHandler () = default;

    virtual QAbstractItemModel& GetRepresentation () = 0;

    virtual void HandleCurrentChanged (const QModelIndex&) {}
    virtual void HandleCurrentColumnChanged (const QModelIndex&) {}
    virtual void HandleCurrentRowChanged (const QModelIndex&) {}
    virtual void HandleSelectedRowsChanged (const QList<QModelIndex>&) {}

    virtual void HandleActivated (const QModelIndex&) {}
    virtual void HandleClicked (const QModelIndex&) {}
    virtual void HandleDoubleClicked (const QModelIndex&) {}
    virtual void HandleEntered (const QModelIndex&) {}
    virtual void HandlePressed (const QModelIndex&) {}

    virtual QWidget* GetInfoWidget () { return nullptr; }
    virtual QToolBar* GetControls () { return nullptr; }
    virtual QMenu* GetContextMenu () { return nullptr; }
};

using IJobHolderRepresentationHandler_ptr = std::unique_ptr<IJobHolderRepresentationHandler>;

class Q_DECL_EXPORT IJobHolder
{
protected:
    virtual ~IJobHolder () = default;
public:
    virtual IJobHolderRepresentationHandler_ptr CreateRepresentationHandler () = 0;
};

Q_DECLARE_METATYPE (LC::RowInfo)
Q_DECLARE_METATYPE (LC::ProcessState)

Q_DECLARE_INTERFACE (IJobHolder, "org.Deviant.LeechCraft.IJobHolder/1.0")