dio.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2005-05-17
 * Description : low level files management interface.
 *
 * Copyright (C) 2005      by Renchi Raju <renchi dot raju at gmail dot com>
 * Copyright (C) 2012-2013 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2018      by Maik Qualmann <metzpinguin at gmail dot com>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program 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 General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_DIO_H
#define DIGIKAM_DIO_H
 
// Qt includes
 
#include <QObject>
 
// Local includes
 
#include "digikam_export.h"
#include "dtrashiteminfo.h"
 
class QUrl;
 
namespace Digikam
{
 
class Album;
class PAlbum;
class ItemInfo;
class IOJobData;
class ProgressItem;
 
class DIGIKAM_GUI_EXPORT DIO : public QObject
{
    Q_OBJECT
 
public:
 
    static DIO* instance();
 
    static void cleanUp();
 
    static bool itemsUnderProcessing();
 
    static void copy(PAlbum* const src, PAlbum* const dest);
 
    static void copy(const QList<ItemInfo>& infos, PAlbum* const dest);
 
    static void copy(const QUrl& src, PAlbum* const dest);
 
    static void copy(const QList<QUrl>& srcList, PAlbum* const dest);
 
    static void copy(const QList<ItemInfo>& infos, const QUrl& dest);
 
    static void move(PAlbum* const src, PAlbum* const dest);
 
    static void move(const QList<ItemInfo>& infos, PAlbum* const dest);
 
    static void move(const QUrl& src, PAlbum* const dest);
 
    static void move(const QList<QUrl>& srcList, PAlbum* const dest);
 
    static void del(const QList<ItemInfo>& infos, bool useTrash);
    static void del(const ItemInfo& info, bool useTrash);
    static void del(PAlbum* const album, bool useTrash);
 
    static void rename(const QUrl& src, const QString& newName, bool overwrite = false);
 
    static void restoreTrash(const DTrashItemInfoList& infos);
    static void emptyTrash(const DTrashItemInfoList& infos);
 
Q_SIGNALS:
 
    void signalTrashFinished();
    void signalRenameFinished();
    void signalRenameFailed(const QUrl& url);
 
private:
 
    void processJob(IOJobData* const data);
    void createJob(IOJobData* const data);
 
    QString getItemString(IOJobData* const data)         const;
    ProgressItem* getProgressItem(IOJobData* const data) const;
    void addAlbumChildrenToList(QList<int>& list, Album* const album);
 
private Q_SLOTS:
 
    void slotResult();
    void slotOneProccessed(const QUrl& url);
    void slotCancel(ProgressItem* item);
 
private:
 
    // Disable
    DIO();
    explicit DIO(QObject*) = delete;
    ~DIO() override;
 
private:
 
    int          m_processingCount;
 
    friend class DIOCreator;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DIO_H