src/draganddrophelper.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Peter Penz <peter.penz@gmx.at>                  *
   3  *   Copyright (C) 2007 by David Faure <faure@kde.org>                     *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  19  ***************************************************************************/
  20
  21 #ifndef DRAGANDDROPHELPER_H
  22 #define DRAGANDDROPHELPER_H
  23
  24 #include "libdolphin_export.h"
  25 #include <QObject>
  26
  27 class DolphinController;
  28 class KFileItem;
  29 class KUrl;
  30 class QDropEvent;
  31 class QMimeData;
  32 class QAbstractItemView;
  33 class QWidget;
  34
  35 /**
  36  * @brief Helper class for having a common drag and drop behavior.
  37  *
  38  * The class is used by DolphinIconsView, DolphinDetailsView,
  39  * DolphinColumnView and PanelTreeView to have a consistent
  40  * drag and drop behavior between all views.
  41  */
  42 class LIBDOLPHINPRIVATE_EXPORT DragAndDropHelper : public QObject
  43 {
  44     Q_OBJECT
  45
  46 public:
  47     static DragAndDropHelper& instance();
  48
  49     /**
  50      * Returns true, if Dolphin supports the dragging of
  51      * the given mime data.
  52      */
  53     bool isMimeDataSupported(const QMimeData* mimeData) const;
  54
  55     /**
  56      * Creates a drag object for the view \a itemView for all selected items.
  57      */
  58     void startDrag(QAbstractItemView* itemView,
  59                    Qt::DropActions supportedActions,
  60                    DolphinController* controller = 0);
  61
  62     /**
  63      * Returns true if and only if the view \a itemView was the last view to
  64      * be passed to startDrag(...), and that drag is still in progress.
  65      */
  66     bool isDragSource(QAbstractItemView* itemView);
  67
  68     /**
  69      * Handles the dropping of URLs to the given
  70      * destination. A context menu with the options
  71      * 'Move Here', 'Copy Here', 'Link Here' and
  72      * 'Cancel' is offered to the user.
  73      * @param destItem  Item of the destination (can be null, see KFileItem::isNull()).
  74      * @param destPath  Path of the destination.
  75      * @param event     Drop event.
  76      * @param widget    Source widget where the dragging has been started.
  77      */
  78     void dropUrls(const KFileItem& destItem,
  79                   const KUrl& destPath,
  80                   QDropEvent* event,
  81                   QWidget* widget);
  82 signals:
  83     void errorMessage(const QString& msg);
  84
  85 private:
  86     DragAndDropHelper();
  87     // The last view passed in startDrag(...), or 0 if
  88     // no startDrag(...) initiated drag is in progress.
  89     QAbstractItemView *m_dragSource;
  90
  91     friend class DragAndDropHelperSingleton;
  92 };
  93
  94 #endif