src/dolphincontextmenu.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Peter Penz <peter.penz19@gmail.com>             *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef DOLPHINCONTEXTMENU_H
  21 #define DOLPHINCONTEXTMENU_H
  22
  23 #include <KFileItem>
  24 #include <KService>
  25 #include <KUrl>
  26 #include <konq_copytomenu.h>
  27 #include <KMenu>
  28
  29 #include <QObject>
  30
  31 #include <QVector>
  32
  33 #include <QScopedPointer>
  34
  35 class QAction;
  36 class DolphinMainWindow;
  37 class KFileItemActions;
  38 class KFileItemListProperties;
  39 class DolphinRemoveAction;
  40
  41 /**
  42  * @brief Represents the context menu which appears when doing a right
  43  *        click on an item or the viewport of the file manager.
  44  *
  45  * Beside static menu entries (e. g. 'Paste' or 'Properties') two
  46  * dynamic sub menus are shown when opening a context menu above
  47  * an item:
  48  * - 'Open With': Contains all applications which are registered to
  49  *                open items of the given MIME type.
  50  * - 'Actions':   Contains all actions which can be applied to the
  51  *                given item.
  52  */
  53 class DolphinContextMenu : public KMenu
  54 {
  55     Q_OBJECT
  56
  57 public:
  58     enum Command
  59     {
  60         None,
  61         OpenParentFolderInNewWindow,
  62         OpenParentFolderInNewTab
  63     };
  64
  65     /**
  66      * @parent        Pointer to the main window the context menu
  67      *                belongs to.
  68      * @pos           Position in screen coordinates.
  69      * @fileInfo      Pointer to the file item the context menu
  70      *                is applied. If 0 is passed, the context menu
  71      *                is above the viewport.
  72      * @baseUrl       Base URL of the viewport where the context menu
  73      *                should be opened.
  74      */
  75     DolphinContextMenu(DolphinMainWindow* parent,
  76                        const QPoint& pos,
  77                        const KFileItem& fileInfo,
  78                        const KUrl& baseUrl);
  79
  80     virtual ~DolphinContextMenu();
  81
  82     void setCustomActions(const QList<QAction*>& actions);
  83
  84     /**
  85      * Opens the context menu model and returns the requested
  86      * command, that should be triggered by the caller. If
  87      * Command::None has been returned, either the context-menu
  88      * had been closed without executing an action or an
  89      * already available action from the main-window has been
  90      * executed.
  91      */
  92     Command open();
  93
  94 protected:
  95     virtual void keyPressEvent(QKeyEvent *ev);
  96     virtual void keyReleaseEvent(QKeyEvent *ev);
  97
  98 signals:
  99     void errorMessage(const QString& error);
 100
 101 private:
 102     void openTrashContextMenu();
 103     void openTrashItemContextMenu();
 104     void openItemContextMenu();
 105     void openViewportContextMenu();
 106
 107     void insertDefaultItemActions(const KFileItemListProperties&);
 108
 109     /**
 110      * Adds the "Show menubar" action to the menu if the
 111      * menubar is hidden.
 112      */
 113     void addShowMenuBarAction();
 114
 115     bool placeExists(const KUrl& url) const;
 116
 117     QAction* createPasteAction();
 118
 119     KFileItemListProperties& selectedItemsProperties() const;
 120
 121     /**
 122      * Returns the file item for m_baseUrl.
 123      */
 124     KFileItem baseFileItem();
 125
 126     /**
 127      * Adds actions that have been installed as service-menu.
 128      * (see http://techbase.kde.org/index.php?title=Development/Tutorials/Creating_Konqueror_Service_Menus)
 129      */
 130     void addServiceActions(KFileItemActions& fileItemActions);
 131
 132     /**
 133      * Adds actions that are provided by a KFileItemActionPlugin.
 134      */
 135     void addFileItemPluginActions();
 136
 137     /**
 138      * Adds actions that are provided by a KVersionControlPlugin.
 139      */
 140     void addVersionControlPluginActions();
 141
 142     /**
 143      * Adds custom actions e.g. like the "[x] Expandable Folders"-action
 144      * provided in the details view.
 145      */
 146     void addCustomActions();
 147
 148 private:
 149     struct Entry
 150     {
 151         int type;
 152         QString name;
 153         QString filePath;     // empty for separator
 154         QString templatePath; // same as filePath for template
 155         QString icon;
 156         QString comment;
 157     };
 158
 159     enum ContextType
 160     {
 161         NoContext = 0,
 162         ItemContext = 1,
 163         TrashContext = 2
 164     };
 165
 166     QPoint m_pos;
 167     DolphinMainWindow* m_mainWindow;
 168
 169     KFileItem m_fileInfo;
 170
 171     KUrl m_baseUrl;
 172     KFileItem* m_baseFileItem;  /// File item for m_baseUrl
 173
 174     KFileItemList m_selectedItems;
 175     mutable KFileItemListProperties* m_selectedItemsProperties;
 176
 177     int m_context;
 178     KonqCopyToMenu m_copyToMenu;
 179     QList<QAction*> m_customActions;
 180
 181     Command m_command;
 182
 183     DolphinRemoveAction* m_removeAction; // Action that represents either 'Move To Trash' or 'Delete'
 184 };
 185
 186 #endif