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
  28 #include <QObject>
  29
  30 #include <QVector>
  31
  32 #include <QScopedPointer>
  33
  34 class KMenu;
  35 class KFileItem;
  36 class QAction;
  37 class DolphinMainWindow;
  38 class KFileItemActions;
  39 class KFileItemListProperties;
  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 QObject
  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      * @fileInfo      Pointer to the file item the context menu
  69      *                is applied. If 0 is passed, the context menu
  70      *                is above the viewport.
  71      * @baseUrl       Base URL of the viewport where the context menu
  72      *                should be opened.
  73      */
  74     DolphinContextMenu(DolphinMainWindow* parent,
  75                        const KFileItem& fileInfo,
  76                        const KUrl& baseUrl);
  77
  78     virtual ~DolphinContextMenu();
  79
  80     void setCustomActions(const QList<QAction*>& actions);
  81
  82     /**
  83      * Opens the context menu model and returns the requested
  84      * command, that should be triggered by the caller. If
  85      * Command::None has been returned, either the context-menu
  86      * had been closed without executing an action or an
  87      * already available action from the main-window has been
  88      * executed.
  89      */
  90     Command open();
  91
  92     /**
  93      * TODO: This method is a workaround for a X11-issue in combination
  94      * with KModifierKeyInfo: When constructing KModifierKeyInfo in the
  95      * constructor of the context menu, the user interface might freeze.
  96      * To bypass this, the KModifierKeyInfo is constructed in DolphinMainWindow
  97      * directly after starting the application. Remove this method, if
  98      * the X11-issue got fixed (contact the maintainer of KModifierKeyInfo for
  99      * more details).
 100      */
 101     static void initializeModifierKeyInfo();
 102
 103 private slots:
 104     /**
 105      * Is invoked if a key modifier has been pressed and updates the context
 106      * menu to show the 'Delete' action instead of the 'Move To Trash' action
 107      * if the shift-key has been pressed.
 108      */
 109     void slotKeyModifierPressed(Qt::Key key, bool pressed);
 110
 111     /**
 112      * Triggers the 'Delete'-action if the shift-key has been pressed, otherwise
 113      * the 'Move to Trash'-action gets triggered.
 114      */
 115     void slotRemoveActionTriggered();
 116
 117 private:
 118     void openTrashContextMenu();
 119     void openTrashItemContextMenu();
 120     void openItemContextMenu();
 121     void openViewportContextMenu();
 122
 123     void insertDefaultItemActions();
 124
 125     /**
 126      * Returns a name for adding the URL \a url to the Places panel.
 127      */
 128     QString placesName(const KUrl& url) const;
 129
 130     bool placeExists(const KUrl& url) const;
 131
 132     QAction* createPasteAction();
 133
 134     KFileItemListProperties& selectedItemsProperties();
 135
 136     /**
 137      * Returns the file item for m_baseUrl.
 138      */
 139     KFileItem baseFileItem();
 140
 141     /**
 142      * Adds actions that have been installed as service-menu.
 143      * (see http://techbase.kde.org/index.php?title=Development/Tutorials/Creating_Konqueror_Service_Menus)
 144      */
 145     void addServiceActions(KFileItemActions& fileItemActions);
 146
 147     /**
 148      * Adds actions that are provided by a KFileItemActionPlugin.
 149      */
 150     void addFileItemPluginActions();
 151
 152     /**
 153      * Adds actions that are provided by a KVersionControlPlugin.
 154      */
 155     void addVersionControlPluginActions();
 156
 157     /**
 158      * Adds custom actions e.g. like the "[x] Expandable Folders"-action
 159      * provided in the details view.
 160      */
 161     void addCustomActions();
 162
 163     /**
 164      * Updates m_removeAction to represent the 'Delete'-action if the shift-key
 165      * has been pressed. Otherwise it represents the 'Move to Trash'-action.
 166      */
 167     void updateRemoveAction();
 168
 169 private:
 170     struct Entry
 171     {
 172         int type;
 173         QString name;
 174         QString filePath;     // empty for separator
 175         QString templatePath; // same as filePath for template
 176         QString icon;
 177         QString comment;
 178     };
 179
 180     enum ContextType
 181     {
 182         NoContext = 0,
 183         ItemContext = 1,
 184         TrashContext = 2
 185     };
 186
 187     DolphinMainWindow* m_mainWindow;
 188
 189     KFileItem m_fileInfo;
 190
 191     KUrl m_baseUrl;
 192     KFileItem* m_baseFileItem;  /// File item for m_baseUrl
 193
 194     KFileItemList m_selectedItems;
 195     KFileItemListProperties* m_selectedItemsProperties;
 196
 197     int m_context;
 198     KonqCopyToMenu m_copyToMenu;
 199     QList<QAction*> m_customActions;
 200     KMenu* m_popup;
 201
 202     Command m_command;
 203
 204     bool m_shiftPressed;
 205     QAction* m_removeAction; // Action that represents either 'Move To Trash' or 'Delete'
 206 };
 207
 208 #endif