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