src/views/draganddrophelper.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Peter Penz <peter.penz19@gmail.com>             *
   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 #include <QPixmap>
  27
  28 class DolphinViewController;
  29 class KFileItem;
  30 class KUrl;
  31 class QDropEvent;
  32 class QAbstractItemView;
  33 class QMimeData;
  34 class QWidget;
  35
  36 /**
  37  * @brief Helper class for having a common drag and drop behavior.
  38  *
  39  * The class is used by DolphinIconsView, DolphinDetailsView,
  40  * DolphinColumnView and PanelTreeView to have a consistent
  41  * drag and drop behavior between all views.
  42  */
  43 class LIBDOLPHINPRIVATE_EXPORT DragAndDropHelper : public QObject
  44 {
  45     Q_OBJECT
  46
  47 public:
  48     static DragAndDropHelper& instance();
  49
  50     /**
  51      * Creates a drag object for the view \a itemView for all selected items.
  52      */
  53     void startDrag(QAbstractItemView* itemView,
  54                    Qt::DropActions supportedActions,
  55                    DolphinViewController* dolphinViewController = 0);
  56
  57     /**
  58      * Returns true if and only if the view \a itemView was the last view to
  59      * be passed to startDrag(...), and that drag is still in progress.
  60      */
  61     bool isDragSource(QAbstractItemView* itemView) const;
  62
  63     /**
  64      * Handles the dropping of URLs to the given
  65      * destination. A context menu with the options
  66      * 'Move Here', 'Copy Here', 'Link Here' and
  67      * 'Cancel' is offered to the user.
  68      * @param destItem  Item of the destination (can be null, see KFileItem::isNull()).
  69      * @param destPath  Path of the destination.
  70      * @param event     Drop event.
  71      * @param widget    Source widget where the dragging has been started.
  72      */
  73     void dropUrls(const KFileItem& destItem,
  74                   const KUrl& destPath,
  75                   QDropEvent* event,
  76                   QWidget* widget);
  77 signals:
  78     void errorMessage(const QString& msg);
  79
  80 private:
  81     DragAndDropHelper();
  82
  83     /**
  84      * Creates a pixmap the contains the all icons of the items
  85      * that are dragged.
  86      */
  87     QPixmap createDragPixmap(QAbstractItemView* itemView) const;
  88
  89     // The last view passed in startDrag(...), or 0 if
  90     // no startDrag(...) initiated drag is in progress.
  91     QAbstractItemView *m_dragSource;
  92
  93     friend class DragAndDropHelperSingleton;
  94 };
  95
  96 #endif