X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/e46003aca365ca66ce7c7cccd47fb52d1da2fb91..b1c9b5126d:/src/dolphincontroller.h diff --git a/src/dolphincontroller.h b/src/dolphincontroller.h index e08e9e490..29dd7dfb1 100644 --- a/src/dolphincontroller.h +++ b/src/dolphincontroller.h @@ -25,6 +25,7 @@ #include #include +class QAbstractItemView; class DolphinView; class KUrl; class QBrush; @@ -40,13 +41,15 @@ class QWidget; * implementations. * * The abstract Dolphin view (see DolphinView) represents the parent of the controller. + * The lifetime of the controller is equal to the lifetime of the Dolphin view. * The controller is passed to the current view implementation * (see DolphinIconsView, DolphinDetailsView and DolphinColumnView) - * by passing it in the constructor: + * by passing it in the constructor and informing the controller about the change + * of the view implementation: * * \code - * DolphinController* controller = new DolphinController(dolphinView); * QAbstractItemView* view = new DolphinIconsView(parent, controller); + * controller->setItemView(view); * \endcode * * The communication of the view implementations to the abstract view is done by: @@ -56,19 +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 { @@ -79,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; @@ -93,6 +97,15 @@ public: void setUrl(const KUrl& url); const KUrl& url() const; + /** + * Changes the current item view where the controller is working. This + * is only necessary for views like the tree view, where internally + * several QAbstractItemView instances are used. + */ + void setItemView(QAbstractItemView* view); + + QAbstractItemView* itemView() const; + /** * Allows a view implementation to request an URL change to \a url. * The signal requestUrlChange() is emitted and the abstract Dolphin view @@ -108,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& customActions = QList()); /** * Requests an activation of the view and emits the signal @@ -125,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 @@ -165,44 +180,77 @@ public: void indicateActivationChange(bool active); /** - * Tells the view implementation to zoom in by emitting the signal zoomIn() + * 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 setZoomLevel(int level); + int zoomLevel() const; + + /** + * Tells the view implementation to zoom out by emitting the signal zoomOut() * and is invoked by the abstract Dolphin view. */ - void triggerZoomIn(); + void triggerZoomOut(); /** - * 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. + * Should be invoked in each view implementation whenever a key has been + * pressed. If the selection model of \a view is not empty and + * the return key has been pressed, the selected items will get triggered. */ - void setZoomInPossible(bool possible); - bool isZoomInPossible() const; + void handleKeyPressEvent(QKeyEvent* event); /** - * Tells the view implementation to zoom out by emitting the signal zoomOut() - * and is invoked by the abstract Dolphin view. + * 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 triggerZoomOut(); + 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); /** - * 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. + * Returns the file item for the proxy index \a index of the view \a view. */ - void setZoomOutPossible(bool possible); - bool isZoomOutPossible() const; + KFileItem itemForIndex(const QModelIndex& index) const; public slots: /** - * Emits the signal itemTriggered(). The method should be invoked by the - * controller parent whenever the user has triggered an item. */ - void triggerItem(const KFileItem& item); + * Emits the signal itemTriggered() if the file item for the index \a index + * 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(). The method should be invoked by - * the controller parent whenever the mouse cursor is above an item. + * 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 + * whenever the mouse cursor is above an item. */ - void emitItemEntered(const KFileItem& item); + void emitItemEntered(const QModelIndex& index); /** * Emits the signal viewportEntered(). The method should be invoked by @@ -226,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 customActions); /** * Is emitted if the view has been activated by e. g. a mouse click. @@ -241,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 @@ -296,6 +346,11 @@ signals: */ void itemEntered(const KFileItem& item); + /** + * Is emitted if a new tab should be opened for the URL \a url. + */ + void tabRequested(const KUrl& url); + /** * Is emitted if the mouse cursor has entered * the viewport (see emitViewportEntered(). @@ -304,22 +359,25 @@ 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 updateMouseButtonState(); private: - bool m_zoomInPossible; - bool m_zoomOutPossible; + 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; }; inline const DolphinView* DolphinController::dolphinView() const @@ -332,24 +390,14 @@ inline const KUrl& DolphinController::url() const return m_url; } -inline void DolphinController::setZoomInPossible(bool possible) -{ - m_zoomInPossible = possible; -} - -inline bool DolphinController::isZoomInPossible() const -{ - return m_zoomInPossible; -} - -inline void DolphinController::setZoomOutPossible(bool possible) +inline QAbstractItemView* DolphinController::itemView() const { - m_zoomOutPossible = possible; + return m_itemView; } -inline bool DolphinController::isZoomOutPossible() const +inline int DolphinController::zoomLevel() const { - return m_zoomOutPossible; + return m_zoomLevel; } #endif