#include <QtCore/QObject>
#include <libdolphin_export.h>
+class QAbstractItemView;
+class DolphinView;
class KUrl;
class QBrush;
-class QModelIndex;
class QPoint;
class QRect;
class QWidget;
+// TODO: get rid of all the state duplications in the controller and allow read access
+// to the Dolphin view for all view implementations
+
/**
- * @brief Allows to control Dolphin views and to react on state changes.
+ * @brief Acts as mediator between the abstract Dolphin view and the view
+ * implementations.
*
- * One instance of a DolphinController can be assigned to a variable number of
- * Dolphin views (DolphinIconsView, DolphinDetailsView) by passing it in
- * the constructor:
+ * 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 and informing the controller about the change
+ * of the view implementation:
*
* \code
- * DolphinController* controller = new DolphinController(parent);
- * DolphinDetailsView* detailsView = new DolphinDetailsView(parent, controller);
- * DolphinIconsView* iconsView = new DolphinIconsView(parent, controller);
+ * QAbstractItemView* view = new DolphinIconsView(parent, controller);
+ * controller->setItemView(view);
* \endcode
*
- * The Dolphin view assures that the controller gets informed about selection changes,
- * when an item should be triggered and a lot more. The controller emits the corresponding signals
- * so that the receiver may react on those changes.
+ * The communication of the view implementations to the abstract view is done by:
+ * - triggerContextMenuRequest()
+ * - requestActivation()
+ * - triggerUrlChangeRequest()
+ * - indicateDroppedUrls()
+ * - indicateSortingChange()
+ * - indicateSortOrderChanged()
+ * - indicateSortFoldersFirstChanged()
+ * - triggerItem()
+ * - requestTab()
+ * - handleKeyPressEvent()
+ * - emitItemEntered()
+ * - emitViewportEntered()
+ * - replaceUrlByClipboard()
+ * - hideToolTip()
+ *
+ * The communication of the abstract view to the view implementations is done by:
+ * - setUrl()
+ * - setShowHiddenFiles()
+ * - setShowPreview()
+ * - indicateActivationChange()
+ * - setZoomLevel()
*/
class LIBDOLPHINPRIVATE_EXPORT DolphinController : public QObject
{
Q_OBJECT
public:
- explicit DolphinController(QObject* parent);
+ explicit DolphinController(DolphinView* dolphinView);
virtual ~DolphinController();
- /** Sets the URL to \a url and emits the signal urlChanged(). */
+ /**
+ * Allows read access for the view implementation to the abstract
+ * Dolphin view.
+ */
+ const DolphinView* dolphinView() const;
+
+ /**
+ * Sets the URL to \a url and emits the signal urlChanged() if
+ * \a url is different for the current URL. This method should
+ * be invoked by the abstract Dolphin view whenever the current
+ * URL has been changed.
+ */
void setUrl(const KUrl& url);
- inline const KUrl& url() const;
+ const KUrl& url() const;
- void triggerContextMenuRequest(const QPoint& pos);
+ /**
+ * 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);
- void triggerActivation();
+ QAbstractItemView* itemView() const;
- void indicateDroppedUrls(const KUrl::List& urls,
+ /**
+ * Allows a view implementation to request an URL change to \a url.
+ * The signal requestUrlChange() is emitted and the abstract Dolphin view
+ * will assure that the URL of the Dolphin Controller will be updated
+ * later. Invoking this method makes only sense if the view implementation
+ * shows a hierarchy of URLs and allows to change the URL within
+ * the view (e. g. this is the case in the column view).
+ */
+ void triggerUrlChangeRequest(const KUrl& url);
+
+ /**
+ * Requests a context menu for the position \a pos. This method
+ * 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. It is possible to define a custom list of actions for
+ * the context menu by \a customActions.
+ */
+ void triggerContextMenuRequest(const QPoint& pos,
+ const QList<QAction*>& customActions = QList<QAction*>());
+
+ /**
+ * Requests an activation of the view and emits the signal
+ * activated(). This method should be invoked by the view implementation
+ * if e. g. a mouse click on the view has been done.
+ * After the activation has been changed, the view implementation
+ * might listen to the activationChanged() signal.
+ */
+ void requestActivation();
+
+ /**
+ * 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 destItem Item of the destination (can be null, see KFileItem::isNull()).
+ * @param destPath Path of the destination.
+ * @param event Drop event
+ */
+ void indicateDroppedUrls(const KFileItem& destItem,
const KUrl& destPath,
- const QModelIndex& destIndex,
- QWidget* source);
+ QDropEvent* event);
+ /**
+ * Informs the abstract Dolphin view about a sorting change done inside
+ * the view implementation. This method should be invoked by the view
+ * implementation (e. g. the details view uses this method in combination
+ * with the details header).
+ */
void indicateSortingChange(DolphinView::Sorting sorting);
+ /**
+ * Informs the abstract Dolphin view about a sort order change done inside
+ * the view implementation. This method should be invoked by the view
+ * implementation (e. g. the details view uses this method in combination
+ * with the details header).
+ */
void indicateSortOrderChange(Qt::SortOrder order);
- void setShowPreview(bool show);
- inline bool showPreview() const;
+ /**
+ * Informs the abstract Dolphin view about a change between separate sorting
+ * (with folders first) and mixed sorting of files and folders done inside
+ * the view implementation. This method should be invoked by the view
+ * implementation (e. g. the details view uses this method in combination
+ * with the details header).
+ */
+ void indicateSortFoldersFirstChange(bool foldersFirst);
+
+ /**
+ * Informs the abstract Dolphin view about an additional information change
+ * done inside the view implementation. This method should be invoked by the
+ * view implementation (e. g. the details view uses this method in combination
+ * with the details header).
+ */
+ void indicateAdditionalInfoChange(const KFileItemDelegate::InformationList& info);
- void setShowAdditionalInfo(bool show);
- inline bool showAdditionalInfo() const;
+ /**
+ * Informs the view implementation about a change of the activation
+ * state and is invoked by the abstract Dolphin view. The signal
+ * activationChanged() is emitted.
+ */
+ void indicateActivationChange(bool active);
- void triggerZoomIn();
- inline void setZoomInPossible(bool possible);
- inline bool isZoomInPossible() const;
+ /**
+ * 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 triggerZoomOut();
- inline void setZoomOutPossible(bool possible);
- inline bool isZoomOutPossible() const;
- // TODO: remove this method when the issue #160611 is solved in Qt 4.4
- static void drawHoverIndication(QWidget* widget,
- const QRect& bounds,
- const QBrush& brush);
+ /**
+ * 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 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.
+ */
+ 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. */
+ * 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 itemEntered(). The method should be invoked by
- * the controller parent whenever the mouse cursor is above an item.
+ * 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
+ * whenever the mouse cursor is above an item.
*/
void emitItemEntered(const QModelIndex& index);
void urlChanged(const KUrl& url);
/**
- * Is emitted if a context menu should be opened.
- * @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.
+ * Is emitted if the view implementation requests a changing of the current
+ * URL to \a url (see triggerUrlChangeRequest()).
*/
- void requestContextMenu(const QPoint& pos);
+ void requestUrlChange(const KUrl& url);
+
+ /**
+ * 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 customActions List of actions that is added to the context menu when
+ * the menu is opened above the viewport.
+ */
+ void requestContextMenu(const QPoint& pos, QList<QAction*> customActions);
/**
* Is emitted if the view has been activated by e. g. a mouse click.
+ * The abstract Dolphin view connects to this signal to know the
+ * destination view for the menu actions.
*/
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 destIndex.
- * \a source indicates the widget where the dragging has been started from.
+ * 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 QModelIndex& destIndex,
- QWidget* source);
+ QDropEvent* event);
- /** Is emitted if the sorting has been changed to \a sorting. */
+ /**
+ * Is emitted if the sorting has been changed to \a sorting by
+ * the view implementation (see indicateSortingChanged().
+ * The abstract Dolphin view connects to
+ * this signal to update its menu action.
+ */
void sortingChanged(DolphinView::Sorting sorting);
- /** Is emitted if the sort order has been changed to \a sort order. */
+ /**
+ * Is emitted if the sort order has been changed to \a order
+ * by the view implementation (see indicateSortOrderChanged().
+ * The abstract Dolphin view connects
+ * to this signal to update its menu actions.
+ */
void sortOrderChanged(Qt::SortOrder order);
/**
- * Is emitted if the state for showing previews has been
- * changed to \a show.
+ * Is emitted if 'sort folders first' has been changed to \a foldersFirst
+ * by the view implementation (see indicateSortOrderChanged().
+ * The abstract Dolphin view connects
+ * to this signal to update its menu actions.
+ */
+ void sortFoldersFirstChanged(bool foldersFirst);
+
+ /**
+ * Is emitted if the additional info has been changed to \a info
+ * by the view implementation. The abstract Dolphin view connects
+ * to this signal to update its menu actions.
*/
- void showPreviewChanged(bool show);
+ void additionalInfoChanged(const KFileItemDelegate::InformationList& info);
/**
- * Is emitted if the state for showing additional info has been
- * changed to \a show.
+ * Is emitted if the activation state has been changed to \a active
+ * by the abstract Dolphin view.
+ * The view implementation might connect to this signal if custom
+ * updates are required in this case.
*/
- void showAdditionalInfoChanged(bool show);
+ void activationChanged(bool active);
/**
- * Is emitted if the item with the index \a index should be triggered.
- * Usually triggering on a directory opens the directory, triggering
- * on a file opens the corresponding application.
- * Emitted with an invalid \a index when clicking on the viewport itself.
+ * Is emitted if the item \a item should be triggered. The abstract
+ * Dolphin view connects to this signal. If the item represents a directory,
+ * the directory is opened. On a file the corresponding application is opened.
+ * The item is null (see KFileItem::isNull()), when clicking on the viewport itself.
*/
- void itemTriggered(const QModelIndex& index);
+ void itemTriggered(const KFileItem& item);
/**
* Is emitted if the mouse cursor has entered the item
- * given by \a index.
+ * given by \a index (see emitItemEntered()).
+ * The abstract Dolphin view connects to this signal.
*/
- void itemEntered(const QModelIndex& index);
+ 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. */
+ * the viewport (see emitViewportEntered().
+ * The abstract Dolphin view connects to this signal.
+ */
void viewportEntered();
- /** Is emitted if the view should zoom in. */
- void zoomIn();
+ /**
+ * 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 zoomLevelChanged(int level);
+
+ /**
+ * Is emitted if the abstract view should hide an open tooltip.
+ */
+ void hideToolTip();
- /** Is emitted if the view should zoom out. */
- void zoomOut();
+private slots:
+ void updateMouseButtonState();
private:
- bool m_showPreview;
- bool m_showAdditionalInfo;
- 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;
};
-const KUrl& DolphinController::url() const
-{
- return m_url;
-}
-
-bool DolphinController::showPreview() const
-{
- return m_showPreview;
-}
-
-bool DolphinController::showAdditionalInfo() const
+inline const DolphinView* DolphinController::dolphinView() const
{
- return m_showAdditionalInfo;
+ return m_dolphinView;
}
-void DolphinController::setZoomInPossible(bool possible)
+inline const KUrl& DolphinController::url() const
{
- m_zoomInPossible = possible;
-}
-
-bool DolphinController::isZoomInPossible() const
-{
- return m_zoomInPossible;
+ return m_url;
}
-void DolphinController::setZoomOutPossible(bool possible)
+inline QAbstractItemView* DolphinController::itemView() const
{
- m_zoomOutPossible = possible;
+ return m_itemView;
}
-bool DolphinController::isZoomOutPossible() const
+inline int DolphinController::zoomLevel() const
{
- return m_zoomOutPossible;
+ return m_zoomLevel;
}
#endif
projects / dolphin.git / blobdiff