job_base.h

/* This file is part of the KDE libraries
    Copyright (C) 2000 Stephan Kulow <[email protected]>
                  2000-2009 David Faure <[email protected]>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef KIO_JOB_BASE_H
#define KIO_JOB_BASE_H

#include <kcompositejob.h>
#include <kio/metadata.h>

namespace KIO
{

class JobUiDelegateExtension;

class JobPrivate;
class KIOCORE_EXPORT Job : public KCompositeJob
{
    Q_OBJECT

protected:
    Job();
    Job(JobPrivate &dd);

public:
    virtual ~Job();
    void start() override {} // Since KIO autostarts its jobs

#if KIOCORE_ENABLE_DEPRECATED_SINCE(5, 0)

    KIOCORE_DEPRECATED_VERSION(5, 0, "Use KJob::uiDelegate()")
    KJobUiDelegate *ui() const;
#endif

    JobUiDelegateExtension *uiDelegateExtension() const;

    void setUiDelegateExtension(JobUiDelegateExtension *extension);

protected:
    bool doKill() override;

    bool doSuspend() override;

    bool doResume() override;

public:
    QString errorString() const override;

    QStringList detailedErrorStrings(const QUrl *reqUrl = nullptr,
                                     int method = -1) const;

    void setParentJob(Job *parentJob);

    Job *parentJob() const;

    void setMetaData(const KIO::MetaData &metaData);

    void addMetaData(const QString &key, const QString &value);

    void addMetaData(const QMap<QString, QString> &values);

    void mergeMetaData(const QMap<QString, QString> &values);

    MetaData outgoingMetaData() const;

    MetaData metaData() const;

    QString queryMetaData(const QString &key);

protected:

Q_SIGNALS:
#if KIOCORE_ENABLE_DEPRECATED_SINCE(5, 0)

    KIOCORE_DEPRECATED_VERSION(5, 0, "Do not use")
    void canceled(KJob *job);
#endif

    void connected(KIO::Job *job);

protected:
    bool addSubjob(KJob *job) override;

    bool removeSubjob(KJob *job) override;

protected:
    JobPrivate *const d_ptr;

private:
    Q_DECLARE_PRIVATE(Job)
};

enum JobFlag {
    DefaultFlags = 0,

    HideProgressInfo = 1,

    Resume = 2,

    Overwrite = 4,

    NoPrivilegeExecution = 8,
};
Q_DECLARE_FLAGS(JobFlags, JobFlag)
Q_DECLARE_OPERATORS_FOR_FLAGS(JobFlags)

enum LoadType { Reload, NoReload };

}

#endif