]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/dolphincontroller.h
- allow the view implementations to attach custom actions to the context menu
[dolphin.git] / src / dolphincontroller.h
index 191bd1e6339d6bd1c1d329b34a3ef52189159257..29dd7dfb1bfcc56dd7fa9d03226e88914a2a640e 100644 (file)
@@ -59,20 +59,20 @@ class QWidget;
  * - indicateDroppedUrls()
  * - indicateSortingChange()
  * - indicateSortOrderChanged()
- * - setZoomInPossible()
- * - setZoomOutPossible()
  * - triggerItem()
+ * - requestTab()
  * - handleKeyPressEvent()
  * - emitItemEntered()
  * - emitViewportEntered()
+ * - replaceUrlByClipboard()
+ * - hideToolTip()
  *
  * The communication of the abstract view to the view implementations is done by:
  * - setUrl()
  * - setShowHiddenFiles()
  * - setShowPreview()
  * - indicateActivationChange()
- * - triggerZoomIn()
- * - triggerZoomOut()
+ * - setZoomLevel()
  */
 class LIBDOLPHINPRIVATE_EXPORT DolphinController : public QObject
 {
@@ -83,7 +83,7 @@ public:
     virtual ~DolphinController();
 
     /**
-     * Allows read access for the the view implementation to the abstract
+     * Allows read access for the view implementation to the abstract
      * Dolphin view.
      */
     const DolphinView* dolphinView() const;
@@ -121,9 +121,11 @@ public:
      * should be invoked by the view implementation when a context
      * menu should be opened. The abstract Dolphin view itself
      * takes care itself to get the selected items depending from
-     * \a pos.
+     * \a pos. It is possible to define a custom list of actions for
+     * the context menu by \a customActions.
      */
-    void triggerContextMenuRequest(const QPoint& pos);
+    void triggerContextMenuRequest(const QPoint& pos,
+                                   const QList<QAction*>& customActions = QList<QAction*>());
 
     /**
      * Requests an activation of the view and emits the signal
@@ -138,13 +140,13 @@ public:
      * Indicates that URLs are dropped above a destination. This method
      * should be invoked by the view implementation. The abstract Dolphin view
      * will start the corresponding action (copy, move, link).
-     * @param urls      URLs that are dropped above a destination.
+     * @param destItem  Item of the destination (can be null, see KFileItem::isNull()).
      * @param destPath  Path of the destination.
-     * @param destItem  Destination item (can be null, see KFileItem::isNull()).
+     * @param event     Drop event
      */
-    void indicateDroppedUrls(const KUrl::List& urls,
+    void indicateDroppedUrls(const KFileItem& destItem,
                              const KUrl& destPath,
-                             const KFileItem& destItem);
+                             QDropEvent* event);
 
     /**
      * Informs the abstract Dolphin view about a sorting change done inside
@@ -178,18 +180,14 @@ public:
     void indicateActivationChange(bool active);
 
     /**
-     * Tells the view implementation to zoom in by emitting the signal zoomIn()
-     * and is invoked by the abstract Dolphin view.
-     */
-    void triggerZoomIn();
-
-    /**
-     * Is invoked by the view implementation to indicate whether a zooming in
-     * is possible. The abstract Dolphin view updates the corresponding menu
-     * action depending on this state.
+     * Sets the zoom level to \a level and emits the signal zoomLevelChanged().
+     * It must be assured that the used level is inside the range
+     * DolphinController::zoomLevelMinimum() and
+     * DolphinController::zoomLevelMaximum().
+     * Is invoked by the abstract Dolphin view.
      */
-    void setZoomInPossible(bool possible);
-    bool isZoomInPossible() const;
+    void setZoomLevel(int level);
+    int zoomLevel() const;
 
     /**
      * Tells the view implementation to zoom out by emitting the signal zoomOut()
@@ -197,14 +195,6 @@ public:
      */
     void triggerZoomOut();
 
-    /**
-     * Is invoked by the view implementation to indicate whether a zooming out
-     * is possible. The abstract Dolphin view updates the corresponding menu
-     * action depending on this state.
-     */
-    void setZoomOutPossible(bool possible);
-    bool isZoomOutPossible() const;
-
     /**
      * Should be invoked in each view implementation whenever a key has been
      * pressed. If the selection model of \a view is not empty and
@@ -212,6 +202,26 @@ public:
      */
     void handleKeyPressEvent(QKeyEvent* event);
 
+    /**
+     * Replaces the URL of the abstract Dolphin view  with the content
+     * of the clipboard as URL. If the clipboard contains no text,
+     * nothing will be done.
+     */
+    void replaceUrlByClipboard();
+
+    /** Emits the signal hideToolTip(). */
+    void emitHideToolTip();
+
+    /**
+     * Emits the signal itemTriggered() for the item \a item.
+     * The method can be used by the view implementations to
+     * trigger an item directly without mouse interaction.
+     * If the item triggering is done by the mouse, it is recommended
+     * to use QAbstractItemView::triggerItem(), as this will check
+     * the used mouse buttons to execute the correct action.
+     */
+    void emitItemTriggered(const KFileItem& item);
+
     /**
      * Returns the file item for the proxy index \a index of the view \a view.
      */
@@ -220,11 +230,21 @@ public:
 public slots:
     /**
      * Emits the signal itemTriggered() if the file item for the index \a index
-     * is not null. The method should be invoked by the
-     * controller parent whenever the user has triggered an item.
+     * is not null and the left mouse button has been pressed. If the item is
+     * null, the signal itemEntered() is emitted.
+     * The method should be invoked by the view implementations whenever the
+     * user has triggered an item with the mouse (see
+     * QAbstractItemView::clicked() or QAbstractItemView::doubleClicked()).
      */
     void triggerItem(const QModelIndex& index);
 
+    /**
+     * Emits the signal tabRequested(), if the file item for the index \a index
+     * represents a directory and when the middle mouse button has been pressed.
+     * The method should be invoked by the controller parent.
+     */
+    void requestTab(const QModelIndex& index);
+
     /**
      * Emits the signal itemEntered() if the file item for the index \a index
      * is not null. The method should be invoked by the controller parent
@@ -254,12 +274,14 @@ signals:
     /**
      * Is emitted if a context menu should be opened (see triggerContextMenuRequest()).
      * The abstract Dolphin view connects to this signal and will open the context menu.
-     * @param pos       Position relative to the view widget where the
-     *                  context menu should be opened. It is recommended
-     *                  to get the corresponding model index from
-     *                  this position.
+     * @param pos           Position relative to the view widget where the
+     *                      context menu should be opened. It is recommended
+     *                      to get the corresponding model index from
+     *                      this position.
+     * @param customActions List of actions that is added to the context menu when
+     *                      the menu is opened above the viewport.
      */
-    void requestContextMenu(const QPoint& pos);
+    void requestContextMenu(const QPoint& pos, QList<QAction*> customActions);
 
     /**
      * Is emitted if the view has been activated by e. g. a mouse click.
@@ -269,14 +291,14 @@ signals:
     void activated();
 
     /**
-     * Is emitted if the URLs \a urls have been dropped to the destination
+     * Is emitted if URLs have been dropped to the destination
      * path \a destPath. If the URLs have been dropped above an item of
      * the destination path, the item is indicated by \a destItem
      * (can be null, see KFileItem::isNull()).
      */
-    void urlsDropped(const KUrl::List& urls,
+    void urlsDropped(const KFileItem& destItem,
                      const KUrl& destPath,
-                     const KFileItem& destItem);
+                     QDropEvent* event);
 
     /**
      * Is emitted if the sorting has been changed to \a sorting by
@@ -337,24 +359,22 @@ signals:
     void viewportEntered();
 
     /**
-     * Is emitted if the view should zoom in. The view implementation
+     * Is emitted if the view should change the zoom to \a level. The view implementation
      * must connect to this signal if it supports zooming.
      */
-    void zoomIn();
+    void zoomLevelChanged(int level);
 
     /**
-     * Is emitted if the view should zoom out. The view implementation
-     * must connect to this signal if it supports zooming.
+     * Is emitted if the abstract view should hide an open tooltip.
      */
-    void zoomOut();
+    void hideToolTip();
 
 private slots:
-    void updateOpenTabState();
+    void updateMouseButtonState();
 
 private:
-    bool m_zoomInPossible;
-    bool m_zoomOutPossible;
-    bool m_openTab; // TODO: this is a workaround until  Qt-issue 176832 has been fixed
+    int m_zoomLevel;
+    static Qt::MouseButtons m_mouseButtons; // TODO: this is a workaround until  Qt-issue 176832 has been fixed
     KUrl m_url;
     DolphinView* m_dolphinView;
     QAbstractItemView* m_itemView;
@@ -375,24 +395,9 @@ inline QAbstractItemView* DolphinController::itemView() const
     return m_itemView;
 }
 
-inline void DolphinController::setZoomInPossible(bool possible)
-{
-    m_zoomInPossible = possible;
-}
-
-inline bool DolphinController::isZoomInPossible() const
-{
-    return m_zoomInPossible;
-}
-
-inline void DolphinController::setZoomOutPossible(bool possible)
-{
-    m_zoomOutPossible = possible;
-}
-
-inline bool DolphinController::isZoomOutPossible() const
+inline int DolphinController::zoomLevel() const
 {
-    return m_zoomOutPossible;
+    return m_zoomLevel;
 }
 
 #endif