src/dolphincontextmenu.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Peter Penz                                      *
   3  *   peter.penz@gmx.at                                                     *
   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 DOLPHINCONTEXTMENU_H
  22 #define DOLPHINCONTEXTMENU_H
  23
  24 #include <QString>
  25 #include <QVector>
  26
  27 #include <kservice.h>
  28 #include <kpropertiesdialog.h>
  29 #include <kdedesktopmimetype.h>
  30
  31 class KMenu;
  32 class KFileItem;
  33 class QPoint;
  34 class QWidget;
  35 class DolphinView;
  36
  37 /**
  38  * @brief Represents the context menu which appears when doing a right
  39  * click on an item or the viewport of the file manager.
  40  *
  41  * Beside static menu entries (e. g. 'Paste' or 'Properties') two
  42  * dynamic sub menus are shown when opening a context menu above
  43  * an item:
  44  * - 'Open With': Contains all applications which are registered to
  45  *                open items of the given MIME type.
  46  * - 'Actions':   Contains all actions which can be applied to the
  47  *                given item.
  48  *
  49  *      @author Peter Penz <peter.penz@gmx.at>
  50  */
  51 class DolphinContextMenu
  52 {
  53 public:
  54     /**
  55      * @parent    Pointer to the dolphin view the context menu
  56      *            belongs to.
  57      * @fileInfo  Pointer to the file item the context menu
  58      *            is applied. If 0 is passed, the context menu
  59      *            is above the viewport.
  60      */
  61     DolphinContextMenu(DolphinView* parent,
  62                        KFileItem* fileInfo);
  63
  64     virtual ~DolphinContextMenu();
  65
  66     /** Opens the context menu modal. */
  67     void open();
  68
  69 private:
  70     void openViewportContextMenu();
  71     void openItemContextMenu();
  72
  73     /**
  74      * Inserts the 'Open With...' submenu to \a popup.
  75      * @param popup          Menu where the 'Open With...' sub menu should
  76      *                       be added.
  77      * @param openWithVector Output parameter which contains all 'Open with...'
  78      *                       services.
  79      * @return               Identifier of the first 'Open With...' entry.
  80      *                       All succeeding identifiers have an increased value of 1
  81      *                       to the predecessor.
  82      */
  83     QList<QAction*> insertOpenWithItems(KMenu* popup,
  84                                         QVector<KService::Ptr>& openWithVector);
  85
  86     /**
  87      * Inserts the 'Actions...' submenu to \a popup.
  88      * @param popup          Menu where the 'Actions...' sub menu should
  89      *                       be added.
  90      * @param openWithVector Output parameter which contains all 'Actions...'
  91      *                       services.
  92      */
  93     QList<QAction*> insertActionItems(KMenu* popup,
  94                                       QVector<KDEDesktopMimeType::Service>& actionsVector);
  95
  96     /**
  97      * Returns true, if 'menu' contains already
  98      * an entry with the name 'entryName'.
  99      */
 100     bool containsEntry(const KMenu* menu,
 101                        const QString& entryName) const;
 102
 103     DolphinView* m_dolphinView;
 104     KFileItem* m_fileInfo;
 105
 106     struct Entry {
 107         int type;
 108         QString name;
 109         QString filePath;     // empty for separator
 110         QString templatePath; // same as filePath for template
 111         QString icon;
 112         QString comment;
 113     };
 114 };
 115
 116 #endif