fileundomanager.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 2000 Simon Hausmann <hausmann@kde.org>
   Copyright (C) 2006, 2008 David Faure <faure@kde.org>

   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_FILEUNDOMANAGER_H
#define KIO_FILEUNDOMANAGER_H

#include <QtCore/QObject>
#include <kurl.h>

#include <kio/kio_export.h>

class KDateTime;

namespace KIO
{
class Job;
class CopyJob;
class FileUndoManagerPrivate;
class FileUndoManagerSingleton;
class CommandRecorder;
class UndoCommand;
class UndoJob;

class KIO_EXPORT FileUndoManager : public QObject
{
    Q_OBJECT
public:
    static FileUndoManager *self();

    class KIO_EXPORT UiInterface
    {
    public:
        UiInterface();
        virtual ~UiInterface();

        void setShowProgressInfo(bool b);
        bool showProgressInfo() const;

        void setParentWidget(QWidget* parentWidget);

        QWidget* parentWidget() const;

        virtual void jobError(KIO::Job* job);

        virtual bool confirmDeletion(const KUrl::List& files);

        virtual bool copiedFileWasModified(const KUrl& src, const KUrl& dest, const KDateTime& srcTime, const KDateTime& destTime);

        virtual void virtual_hook(int id, void* data);

    private:
        class UiInterfacePrivate;
        UiInterfacePrivate *d;
    };

    void setUiInterface(UiInterface* ui);

    UiInterface* uiInterface() const;

    enum CommandType { Copy, Move, Rename, Link, Mkdir, Trash };

    void recordJob(CommandType op, const KUrl::List &src, const KUrl &dst, KIO::Job *job);

    void recordCopyJob(KIO::CopyJob* copyJob);

    bool undoAvailable() const;
    QString undoText() const;

    quint64 newCommandSerialNumber();
    quint64 currentCommandSerialNumber() const;

public Q_SLOTS:
    void undo();

Q_SIGNALS:
    void undoAvailable(bool avail);

    void undoTextChanged(const QString &text);

    void undoJobFinished();
    
    void jobRecordingStarted(CommandType op);
    
    void jobRecordingFinished(CommandType op);

private:
    FileUndoManager();
    virtual ~FileUndoManager();
    friend class FileUndoManagerSingleton;

    friend class UndoJob;
    friend class CommandRecorder;

    friend class FileUndoManagerPrivate;
    FileUndoManagerPrivate *d;
};

} // namespace

#endif