Merge branch for accessibility

[dolphin.git] / src / dolphincontextmenu.h

diff --git a/src/dolphincontextmenu.h b/src/dolphincontextmenu.h
index 052149ba382b12c55346387355bb9557a41fbb84..3d0005d30a21810546dabd754ea166427ada5870 100644 (file)
--- a/src/dolphincontextmenu.h
+++ b/src/dolphincontextmenu.h
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2006 by Peter Penz <peter.penz@gmx.at>                  *
+ *   Copyright (C) 2006 by Peter Penz <peter.penz19@gmail.com>             *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
@@ -20,16 +20,14 @@
 #ifndef DOLPHINCONTEXTMENU_H
 #define DOLPHINCONTEXTMENU_H
 
-#include <kdesktopfileactions.h>
-#include <kfileitem.h>
-#include <kservice.h>
-#include <kurl.h>
+#include <KFileItem>
+#include <KService>
+#include <KUrl>
 #include <konq_copytomenu.h>
-#include <kmodifierkeyinfo.h>
 
-#include <QtCore/QObject>
+#include <QObject>
 
-#include <QtCore/QVector>
+#include <QVector>
 
 #include <QScopedPointer>
 
@@ -57,9 +55,17 @@ class DolphinContextMenu : public QObject
     Q_OBJECT
 
 public:
+    enum Command
+    {
+        None,
+        OpenParentFolderInNewWindow,
+        OpenParentFolderInNewTab
+    };
+
     /**
      * @parent        Pointer to the main window the context menu
      *                belongs to.
+     * @pos           Position in screen coordinates.
      * @fileInfo      Pointer to the file item the context menu
      *                is applied. If 0 is passed, the context menu
      *                is above the viewport.
@@ -67,19 +73,48 @@ public:
      *                should be opened.
      */
     DolphinContextMenu(DolphinMainWindow* parent,
+                       const QPoint& pos,
                        const KFileItem& fileInfo,
                        const KUrl& baseUrl);
 
     virtual ~DolphinContextMenu();
 
     void setCustomActions(const QList<QAction*>& actions);
-    void setShiftIsPressed(bool pressed);
 
-    /** Opens the context menu model. */
-    void open();
+    /**
+     * Opens the context menu model and returns the requested
+     * command, that should be triggered by the caller. If
+     * Command::None has been returned, either the context-menu
+     * had been closed without executing an action or an
+     * already available action from the main-window has been
+     * executed.
+     */
+    Command open();
+
+    /**
+     * TODO: This method is a workaround for a X11-issue in combination
+     * with KModifierKeyInfo: When constructing KModifierKeyInfo in the
+     * constructor of the context menu, the user interface might freeze.
+     * To bypass this, the KModifierKeyInfo is constructed in DolphinMainWindow
+     * directly after starting the application. Remove this method, if
+     * the X11-issue got fixed (contact the maintainer of KModifierKeyInfo for
+     * more details).
+     */
+    static void initializeModifierKeyInfo();
+
+private slots:
+    /**
+     * Is invoked if a key modifier has been pressed and updates the context
+     * menu to show the 'Delete' action instead of the 'Move To Trash' action
+     * if the shift-key has been pressed.
+     */
+    void slotKeyModifierPressed(Qt::Key key, bool pressed);
 
-public slots:
-    void deleteOrTrashMenuEntry(Qt::Key key, bool pressed);
+    /**
+     * Triggers the 'Delete'-action if the shift-key has been pressed, otherwise
+     * the 'Move to Trash'-action gets triggered.
+     */
+    void slotRemoveActionTriggered();
 
 private:
     void openTrashContextMenu();
@@ -93,23 +128,55 @@ private:
      * Adds the "Show menubar" action to the menu if the
      * menubar is hidden.
      */
-    void addShowMenubarAction();
-
-    /**
-     * Returns a name for adding the URL \a url to the Places panel.
-     */
-    QString placesName(const KUrl& url) const;
+    void addShowMenuBarAction();
 
     bool placeExists(const KUrl& url) const;
 
     QAction* createPasteAction();
 
-private:
-    KFileItemListProperties& capabilities();
+    KFileItemListProperties& selectedItemsProperties() const;
+
+    /**
+     * Returns the file item for m_baseUrl.
+     */
+    KFileItem baseFileItem();
+
+    /**
+     * Adds actions that have been installed as service-menu.
+     * (see http://techbase.kde.org/index.php?title=Development/Tutorials/Creating_Konqueror_Service_Menus)
+     */
     void addServiceActions(KFileItemActions& fileItemActions);
-    void addVersionControlActions();
+
+    /**
+     * Adds actions that are provided by a KFileItemActionPlugin.
+     */
+    void addFileItemPluginActions();
+
+    /**
+     * Adds actions that are provided by a KVersionControlPlugin.
+     */
+    void addVersionControlPluginActions();
+
+    /**
+     * Adds custom actions e.g. like the "[x] Expandable Folders"-action
+     * provided in the details view.
+     */
     void addCustomActions();
 
+    /**
+     * Updates m_removeAction to represent the 'Delete'-action if the shift-key
+     * has been pressed or the selection is not local. Otherwise it represents
+     * the 'Move to Trash'-action.
+     */
+    void updateRemoveAction();
+
+    /**
+     * @return True if a moving to the trash should be done instead of
+     *         deleting the selected items.
+     * @see updateRemoveAction(), slotRemoveActionTriggered()
+     */
+    bool moveToTrash() const;
+
 private:
     struct Entry
     {
@@ -128,18 +195,26 @@ private:
         TrashContext = 2
     };
 
+    QPoint m_pos;
     DolphinMainWindow* m_mainWindow;
-    KFileItemListProperties* m_capabilities;
+
     KFileItem m_fileInfo;
+
     KUrl m_baseUrl;
+    KFileItem* m_baseFileItem;  /// File item for m_baseUrl
+
     KFileItemList m_selectedItems;
-    KUrl::List m_selectedUrls;
+    mutable KFileItemListProperties* m_selectedItemsProperties;
+
     int m_context;
     KonqCopyToMenu m_copyToMenu;
     QList<QAction*> m_customActions;
-    QScopedPointer<KMenu> m_popup;
-    bool m_showDeleteCommand;
-    bool m_shiftIsPressed;
+    KMenu* m_popup;
+
+    Command m_command;
+
+    bool m_shiftPressed;
+    QAction* m_removeAction; // Action that represents either 'Move To Trash' or 'Delete'
 };
 
 #endif