]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/dolphindetailsview.h
Restore the "Edit->Selection" menu from Konqueror 3 for file
[dolphin.git] / src / dolphindetailsview.h
index 86f579cce6fb5ff978cd19ab0e5ab53ff18a1dda..f9a795560ce5ef27d2cc619ec6c604705eae2a2e 100644 (file)
@@ -1,6 +1,6 @@
 /***************************************************************************
- *   Copyright (C) 2006 by Peter Penz                                      *
- *   peter.penz@gmx.at                                                     *
+ *   Copyright (C) 2006 by Peter Penz (peter.penz@gmx.at)                  *
+ *   Copyright (C) 2008 by Simon St. James (kdedevel@etotheipiplusone.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  *
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  ***************************************************************************/
 
 #ifndef DOLPHINDETAILSVIEW_H
 #define DOLPHINDETAILSVIEW_H
 
-#include <kfiledetailview.h>
-#include <itemeffectsmanager.h>
-//Added by qt3to4:
-#include <QPixmap>
-#include <QResizeEvent>
-#include <QEvent>
-#include <QDropEvent>
-#include <QMouseEvent>
-#include <QDragMoveEvent>
-#include <QPaintEvent>
-
-class QRect;
-class QTimer;
-class DolphinView;
+#include <dolphinview.h>
+#include <QTreeView>
+#include <libdolphin_export.h>
+
+class DolphinController;
+class DolphinSortFilterProxyModel;
+class ViewExtensionsFactory;
 
 /**
  * @brief Represents the details view which shows the name, size,
- * date, permissions, owner and group of an item.
+ *        date, permissions, owner and group of an item.
  *
- * The width of the columns are automatically adjusted in a way
+ * The width of the columns is automatically adjusted in a way
  * that full available width of the view is used by stretching the width
  * of the name column.
- *
- * @author Peter Penz
  */
-class DolphinDetailsView : public KFileDetailView, public ItemEffectsManager
+class LIBDOLPHINPRIVATE_EXPORT DolphinDetailsView : public QTreeView
 {
     Q_OBJECT
 
 public:
-    /**
-     * Maps the column indices of KFileDetailView to a
-     * descriptive column name.
-     */
-    enum ColumnName {
-        NameColumn        = 0,
-        SizeColumn        = 1,
-        DateColumn        = 2,
-        PermissionsColumn = 3,
-        OwnerColumn       = 4,
-        GroupColumn       = 5
-    };
-
-    DolphinDetailsView(DolphinView* parent);
-
+    explicit DolphinDetailsView(QWidget* parent,
+                                DolphinController* controller,
+                                DolphinSortFilterProxyModel* model);
     virtual ~DolphinDetailsView();
 
-    /** @see ItemEffectsManager::updateItems */
-    virtual void beginItemUpdates();
-
-    /** @see ItemEffectsManager::updateItems */
-    virtual void endItemUpdates();
+    /**
+     * Returns a set containing the URLs of all expanded items.
+     */
+    QSet<KUrl> expandedUrls() const;
 
-    /** @see KFileView::insertItem */
-    virtual void insertItem(KFileItem* fileItem);
+protected:
+    virtual bool event(QEvent* event);
+    virtual QStyleOptionViewItem viewOptions() const;
+    virtual void contextMenuEvent(QContextMenuEvent* event);
+    virtual void mousePressEvent(QMouseEvent* event);
+    virtual void mouseMoveEvent(QMouseEvent* event);
+    virtual void mouseReleaseEvent(QMouseEvent* event);
+    virtual void startDrag(Qt::DropActions supportedActions);
+    virtual void dragEnterEvent(QDragEnterEvent* event);
+    virtual void dragLeaveEvent(QDragLeaveEvent* event);
+    virtual void dragMoveEvent(QDragMoveEvent* event);
+    virtual void dropEvent(QDropEvent* event);
+    virtual void paintEvent(QPaintEvent* event);
+    virtual void keyPressEvent(QKeyEvent* event);
+    virtual void keyReleaseEvent(QKeyEvent* event);
+    virtual void resizeEvent(QResizeEvent* event);
+    virtual void wheelEvent(QWheelEvent* event);
+    virtual void currentChanged(const QModelIndex& current, const QModelIndex& previous);
+    virtual bool eventFilter(QObject* watched, QEvent* event);
+    virtual QModelIndex indexAt (const QPoint& point) const;
+    virtual void setSelection(const QRect& rect, QItemSelectionModel::SelectionFlags command);
+    virtual void scrollTo(const QModelIndex& index, ScrollHint hint = EnsureVisible);
 
+private slots:
     /**
-     * @return  True, if the position \a pos is above the name of
-     *          item \a item.
+     * Sets the sort indicator section of the header view
+     * corresponding to \a sorting.
      */
-    bool isOnFilename(const Q3ListViewItem* item, const QPoint& pos) const;
+    void setSortIndicatorSection(DolphinView::Sorting sorting);
 
     /**
-     * Reads out the dolphin settings for the details view and refreshs
-     * the details view.
+     * Sets the sort indicator order of the header view
+     * corresponding to \a sortOrder.
      */
-    // TODO: Other view implementations use a similar interface. When using
-    // Interview in Qt4 this method should be moved to a base class (currently
-    // not possible due to having different base classes for the views).
-    void refreshSettings();
+    void setSortIndicatorOrder(Qt::SortOrder sortOrder);
 
-    /** @see ItemEffectsManager::zoomIn() */
-    virtual void zoomIn();
-
-    /** @see ItemEffectsManager::zoomOut() */
-    virtual void zoomOut();
+    /**
+     * Synchronizes the sorting state of the Dolphin menu 'View -> Sort'
+     * with the current state of the details view.
+     * @param column Index of the current sorting column.
+     */
+    void synchronizeSortingState(int column);
 
-    /** @see ItemEffectsManager::isZoomInPossible() */
-    virtual bool isZoomInPossible() const;
+    /**
+     * Is invoked when the mouse cursor has entered an item. The controller
+     * gets informed to emit the itemEntered() signal if the mouse cursor
+     * is above the name column. Otherwise the controller gets informed
+     * to emit the itemViewportEntered() signal (all other columns should
+     * behave as viewport area).
+     */
+    void slotEntered(const QModelIndex& index);
 
-    /** @see ItemEffectsManager::isZoomOutPossible() */
-    virtual bool isZoomOutPossible() const;
+    /**
+     * Updates the destination \a destination from
+     * the elastic band to the current mouse position and triggers
+     * an update.
+     */
+    void updateElasticBand();
 
-signals:
     /**
-     * Is send, if the details view should be activated. Usually an activation
-     * is triggered by a mouse click.
+     * Returns the rectangle for the elastic band dependent from the
+     * origin \a origin, the current destination
+     * \a destination and the viewport position.
      */
-    void signalRequestActivation();
+    QRect elasticBandRect() const;
 
-public slots:
-    /** @see KFileDetailView::resizeContents */
-    virtual void resizeContents(int width, int height);
+    void setZoomLevel(int level);
 
-    /** Is connected to the onItem-signal from KFileDetailView. */
-    void slotOnItem(Q3ListViewItem* item);
+    void slotShowPreviewChanged();
 
-    /** Is connected to the onViewport-signal from KFileDetailView. */
-    void slotOnViewport();
+    /**
+     * Opens a context menu at the position \a pos and allows to
+     * configure the visibility of the header columns and whether
+     * expandable folders should be shown.
+     */
+    void configureSettings(const QPoint& pos);
 
-protected:
-    /** @see ItemEffectsManager::setContextPixmap() */
-    virtual void setContextPixmap(void* context,
-                                  const QPixmap& pixmap);
+    /**
+     * Updates the visibilty state of columns and their order.
+     */
+    void updateColumnVisibility();
 
-    /** @see ItemEffectsManager::setContextPixmap() */
-    virtual const QPixmap* contextPixmap(void* context);
+    /**
+     * Saves order of the columns as global setting.
+     */
+    void saveColumnPositions();
 
-    /** @see ItemEffectsManager::setContextPixmap() */
-    virtual void* firstContext();
+    /**
+     * Disables the automatical resizing of columns, if the user has resized the columns
+     * with the mouse.
+     */
+    void slotHeaderSectionResized(int logicalIndex, int oldSize, int newSize);
 
-    /** @see ItemEffectsManager::setContextPixmap() */
-    virtual void* nextContext(void* context);
+    /**
+     * Changes the alternating row colors setting depending from
+     * the activation state \a active.
+     */
+    void slotActivationChanged(bool active);
 
-    /** @see ItemEffectsManager::setContextPixmap() */
-    virtual KFileItem* contextFileInfo(void* context);
+    /**
+     * Disables the automatical resizing of the columns. Per default all columns
+     * are resized to use the maximum available width of the view as good as possible.
+     */
+    void disableAutoResizing();
 
-    /** @see KFileDetailView::contentsDragMoveEvent() */
-    virtual void contentsDragMoveEvent(QDragMoveEvent* event);
+    void requestActivation();
 
-    /** @see KFileDetailView::resizeEvent() */
-    virtual void resizeEvent(QResizeEvent* event);
+    void slotGlobalSettingsChanged(int category);
 
-    /** @see KFileDetailView::acceptDrag() */
-    virtual bool acceptDrag (QDropEvent* event) const;
+    /**
+     * If the elastic band is currently shown, update the elastic band based on
+     * the current mouse position and ensure that the selection is the set of items
+     * intersecting it.
+     */
+    void updateElasticBandSelection();
 
-    /** @see KFileDetailView::contentsDropEvent() */
-    virtual void contentsDropEvent(QDropEvent* event);
+    /**
+     * If \a expandable is true, the details view acts as tree view.
+     * The current expandable state is remembered in the settings.
+     */
+    void setFoldersExpandable(bool expandable);
 
-    /** @see KFileDetailView::contentsMousePressEvent() */
-    virtual void contentsMousePressEvent(QMouseEvent* event);
+    /**
+     * These slots update the list of expanded items.
+     */
+    void slotExpanded(const QModelIndex& index);
+    void slotCollapsed(const QModelIndex& index);
 
-    /** @see KFileDetailView::contentsMouseMoveEvent() */
-    virtual void contentsMouseMoveEvent(QMouseEvent* event);
+protected slots:
 
-    /** @see KFileDetailView::contentsMouseReleaseEvent() */
-    virtual void contentsMouseReleaseEvent(QMouseEvent* event);
+    virtual void rowsAboutToBeRemoved(const QModelIndex &parent, int start, int end);
 
-    /** @see QListView::paintEmptyArea() */
-    virtual void paintEmptyArea(QPainter* painter, const QRect& rect);
+private:
+    /**
+     * Removes the URLs corresponding to the children of \a index in the rows
+     * between \a start and \a end inclusive from the set of expanded URLs.
+     */
+    void removeExpandedIndexes(const QModelIndex& parent, int start, int end);
 
-    /** Draws the selection rubber. */
-    void drawRubber();
+    /**
+     * Updates the size of the decoration dependent on the
+     * icon size of the DetailsModeSettings. The controller
+     * will get informed about possible zoom in/zoom out
+     * operations.
+     */
+    void updateDecorationSize(bool showPreview);
 
-    /** @see QListView::viewportPaintEvent() */
-    virtual void viewportPaintEvent(QPaintEvent* paintEvent);
+    KFileItemDelegate::Information infoForColumn(int columnIndex) const;
 
-    /** @see QWidget::leaveEvent() */
-    virtual void leaveEvent(QEvent* event);
+    /**
+     * Resizes all columns in a way to use the whole available width of the view.
+     */
+    void resizeColumns();
 
-private slots:
-    void slotActivationUpdate();
-    void slotContextMenuRequested(Q3ListViewItem* item,
-                                  const QPoint& pos,
-                                  int col);
-    void slotUpdateDisabledItems();
-    void slotAutoScroll();
-    void updateColumnsWidth();
-    void slotItemRenamed(Q3ListViewItem* item,
-                         const QString& name,
-                         int column);
+    QRect nameColumnRect(const QModelIndex& index) const;
 
     /**
-     * Is invoked when a section from the header has
-     * been clicked and stores the sort column and sort
-     * order.
+     * Returns true, if \a pos is within the expanding toggle of a tree.
      */
-    void slotHeaderClicked(int section);
+    bool isAboveExpandingToggle(const QPoint& pos) const;
 
 private:
-    class DolphinListViewItem : public KFileListViewItem {
-    public:
-        DolphinListViewItem(Q3ListView* parent,
-                            KFileItem* fileItem);
-        virtual ~DolphinListViewItem();
-        virtual void paintCell(QPainter* painter,
-                               const QColorGroup& colorGroup,
-                               int column,
-                               int cellWidth,
-                               int alignment);
-
-        virtual void paintFocus(QPainter* painter,
-                                const QColorGroup& colorGroup,
-                                const QRect& rect);
-    };
-
-    DolphinView* m_dolphinView;
-    QTimer* m_resizeTimer;
-    QTimer* m_scrollTimer;
-    QRect* m_rubber;
-
-    /**
-     * Returns the width of the filename in pixels including
-     * the icon. It is assured that the returned width is
-     * <= the width of the filename column.
-     */
-    int filenameWidth(const Q3ListViewItem* item) const;
-
+    bool m_autoResize : 1;        // if true, the columns are resized automatically to the available width
+    bool m_expandingTogglePressed : 1;
+    bool m_keyPressed : 1;        // true if a key is pressed currently; info used by currentChanged()
+    bool m_useDefaultIndexAt : 1; // true, if QTreeView::indexAt() should be used
+    bool m_ignoreScrollTo : 1;    // true if calls to scrollTo(...) should do nothing.
+
+    DolphinController* m_controller;
+    ViewExtensionsFactory* m_extensionsFactory;
+    QAction* m_expandableFoldersAction;
+
+    // A set containing the URLs of all currently expanded folders.
+    // We cannot use a QSet<QModelIndex> because a QModelIndex is not guaranteed to remain valid over time.
+    // Also a QSet<QPersistentModelIndex> does not work as expected because it is not guaranteed that
+    // subsequent expand/collapse events of the same file item will yield the same QPersistentModelIndex.
+    QSet<KUrl> m_expandedUrls;
+
+    QFont m_font;
+    QSize m_decorationSize;
+
+    QRect m_dropRect;
+
+    struct ElasticBand
+    {
+        ElasticBand();
+
+        // Elastic band origin and destination coordinates are relative to t
+        // he origin of the view, not the viewport.
+        bool show;
+        QPoint origin;
+        QPoint destination;
+
+        // Optimization mechanisms for use with elastic band selection.
+        // Basically, allow "incremental" updates to the selection based
+        // on the last elastic band shape.
+        QPoint lastSelectionOrigin;
+        QPoint lastSelectionDestination;
+
+        // If true, compute the set of selected elements from scratch (slower)
+        bool ignoreOldInfo;
+
+        // Edges of the filenames that are closest to the edges of oldSelectionRect.
+        // Used to decide whether horizontal changes in the elastic band are likely
+        // to require us to re-check which items are selected.
+        int outsideNearestLeftEdge;
+        int outsideNearestRightEdge;
+        int insideNearestLeftEdge;
+        int insideNearestRightEdge;
+        // The set of items that were selected at the time this band was shown.
+        // NOTE: Unless CTRL was pressed when the band was created, this is always empty.
+        QItemSelection originalSelection;
+    } m_band;
 };
 
 #endif