src/views/draganddrophelper.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007-2011 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
  26 #include <QString>
  27
  28 class KFileItem;
  29 class KUrl;
  30 class QDropEvent;
  31 class QWidget;
  32
  33 class LIBDOLPHINPRIVATE_EXPORT DragAndDropHelper
  34 {
  35 public:
  36     /**
  37      * Handles the dropping of URLs to the given destination. A context menu
  38      * with the options 'Move Here', 'Copy Here', 'Link Here' and 'Cancel' is
  39      * offered to the user. The drag destination must represent a directory or
  40      * a desktop-file, otherwise the dropping gets ignored.
  41      *
  42      * @param destItem  Item of the destination. Can be 0 (KFileItem::isNull()) if
  43      *                  no file-item is available for the destination. In this case
  44      *                  destUrl is used as fallback. For performance reasons it is
  45      *                  recommended to pass a file-item if available.
  46      * @param destUrl   URL of the item destination. Is used only if destItem::isNull()
  47      *                  is true.
  48      * @param event     Drop event.
  49      * @return          Error message intended to be shown for users if dropping is not
  50      *                  possible. If an empty string is returned, the dropping has been
  51      *                  successful.
  52      */
  53     static QString dropUrls(const KFileItem& destItem,
  54                             const KUrl& destUrl,
  55                             QDropEvent* event);
  56 };
  57
  58 #endif