File indexing completed on 2024-04-21 04:18:48

0001 // vim: set tabstop=4 shiftwidth=4 expandtab:
0002 /*
0003 Gwenview: an image viewer
0004 Copyright 2009 Aurélien Gâteau <agateau@kde.org>
0005 
0006 This program is free software; you can redistribute it and/or
0007 modify it under the terms of the GNU General Public License
0008 as published by the Free Software Foundation; either version 2
0009 of the License, or (at your option) any later version.
0010 
0011 This program is distributed in the hope that it will be useful,
0012 but WITHOUT ANY WARRANTY; without even the implied warranty of
0013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0014 GNU General Public License for more details.
0015 
0016 You should have received a copy of the GNU General Public License
0017 along with this program; if not, write to the Free Software
0018 Foundation, Inc., 51 Franklin Street, Fifth Floor, Cambridge, MA 02110-1301, USA.
0019 
0020 */
0021 #ifndef IMPORTER_H
0022 #define IMPORTER_H
0023 
0024 // Qt
0025 #include <QObject>
0026 #include <QUrl>
0027 
0028 // KF
0029 
0030 // Local
0031 
0032 class KJob;
0033 
0034 namespace Gwenview
0035 {
0036 struct ImporterPrivate;
0037 class Importer : public QObject
0038 {
0039     Q_OBJECT
0040 public:
0041     explicit Importer(QWidget *authWindow);
0042     ~Importer() override;
0043 
0044     /**
0045      * Defines the auto-rename format applied to imported documents
0046      * Set to QString() to reset
0047      */
0048     void setAutoRenameFormat(const QString &);
0049 
0050     void start(const QList<QUrl> &list, const QUrl &destUrl);
0051 
0052     QList<QUrl> importedUrlList() const;
0053 
0054     /**
0055      * Documents which have been skipped during import
0056      */
0057     QList<QUrl> skippedUrlList() const;
0058 
0059     /**
0060      * Documents which have failed during import
0061      */
0062     QList<QUrl> failedUrlList() const;
0063 
0064     /**
0065      * Subfolders which failed to create during import
0066      */
0067     QList<QUrl> failedSubFolderList() const;
0068 
0069     /**
0070      * How many documents have been renamed during import
0071      */
0072     int renamedCount() const;
0073 
0074 Q_SIGNALS:
0075     void importFinished();
0076 
0077     void progressChanged(int);
0078 
0079     void maximumChanged(int);
0080 
0081     /**
0082      * An error has occurred and caused the whole process to stop without
0083      * importing anything
0084      */
0085     void error(const QString &message);
0086 
0087 private Q_SLOTS:
0088     void slotCopyDone(KJob *);
0089     void slotPercent(KJob *, unsigned long);
0090     void emitProgressChanged();
0091 
0092 private:
0093     friend struct ImporterPrivate;
0094     ImporterPrivate *const d;
0095     void advance();
0096     void finalizeImport();
0097 };
0098 
0099 } // namespace
0100 
0101 #endif /* IMPORTER_H */