src/dolphincolumnwidget.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Peter Penz <peter.penz@gmx.at>                  *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef DOLPHINCOLUMNWIDGET_H
  21 #define DOLPHINCOLUMNWIDGET_H
  22
  23 #include <QListView>
  24 #include <QStyleOption>
  25
  26 #include <kurl.h>
  27
  28 class DolphinColumnView;
  29 class DolphinModel;
  30 class DolphinSortFilterProxyModel;
  31 class KDirLister;
  32 class KFileItem;
  33 class KFileItemList;
  34 class QPixmap;
  35
  36 /**
  37  * Represents one column inside the DolphinColumnView and has been
  38  * extended to respect view options and hovering information.
  39  */
  40 class DolphinColumnWidget : public QListView
  41 {
  42     Q_OBJECT
  43
  44 public:
  45     DolphinColumnWidget(QWidget* parent,
  46                         DolphinColumnView* columnView,
  47                         const KUrl& url);
  48     virtual ~DolphinColumnWidget();
  49
  50     /** Sets the size of the icons. */
  51     void setDecorationSize(const QSize& size);
  52
  53     /**
  54      * An active column is defined as column, which shows the same URL
  55      * as indicated by the URL navigator. The active column is usually
  56      * drawn in a lighter color. All operations are applied to this column.
  57      */
  58     void setActive(bool active);
  59     bool isActive() const;
  60
  61     /**
  62      * Sets the directory URL of the child column that is shown next to
  63      * this column. This property is only used for a visual indication
  64      * of the shown directory, it does not trigger a loading of the model.
  65      */
  66     void setChildUrl(const KUrl& url);
  67     const KUrl& childUrl() const;
  68
  69     /** Sets the directory URL that is shown inside the column widget. */
  70     void setUrl(const KUrl& url);
  71
  72     /** Returns the directory URL that is shown inside the column widget. */
  73     const KUrl& url() const;
  74
  75     /** Reloads the directory DolphinColumnWidget::url(). */
  76     void reload();
  77
  78     void setShowHiddenFiles(bool show);
  79     void setShowPreview(bool show);
  80
  81     /**
  82      * Updates the background color dependent from the activation state
  83      * \a isViewActive of the column view.
  84      */
  85     void updateBackground();
  86
  87     /**
  88      * Filters the currently shown items by \a nameFilter. All items
  89      * which contain the given filter string will be shown.
  90      */
  91     void setNameFilter(const QString& nameFilter);
  92
  93 protected:
  94     virtual QStyleOptionViewItem viewOptions() const;
  95     virtual void dragEnterEvent(QDragEnterEvent* event);
  96     virtual void dragLeaveEvent(QDragLeaveEvent* event);
  97     virtual void dragMoveEvent(QDragMoveEvent* event);
  98     virtual void dropEvent(QDropEvent* event);
  99     virtual void paintEvent(QPaintEvent* event);
 100     virtual void mousePressEvent(QMouseEvent* event);
 101     virtual void keyPressEvent(QKeyEvent* event);
 102     virtual void contextMenuEvent(QContextMenuEvent* event);
 103     virtual void selectionChanged(const QItemSelection& selected, const QItemSelection& deselected);
 104
 105 private slots:
 106     /**
 107      * If the item specified by \a index is a directory, then this
 108      * directory will be loaded in a new column. If the  item is a
 109      * file, the corresponding application will get started.
 110      */
 111     void triggerItem(const QModelIndex& index);
 112
 113     /**
 114      * Generates a preview image for each file item in \a items.
 115      * The current preview settings (maximum size, 'Show Preview' menu)
 116      * are respected.
 117      */
 118     void generatePreviews(const KFileItemList& items);
 119
 120     /**
 121      * Replaces the icon of the item \a item by the preview pixmap
 122      * \a pixmap.
 123      */
 124     void showPreview(const KFileItem& item, const QPixmap& pixmap);
 125
 126     void slotEntered(const QModelIndex& index);
 127
 128 private:
 129     /** Used by DolphinColumnWidget::setActive(). */
 130     void activate();
 131
 132     /** Used by DolphinColumnWidget::setActive(). */
 133     void deactivate();
 134
 135     /**
 136      * Returns true, if the item \a item has been cut into
 137      * the clipboard.
 138      */
 139     bool isCutItem(const KFileItem& item) const;
 140
 141     KFileItem itemForIndex(const QModelIndex& index) const;
 142
 143 private:
 144     bool m_active;
 145     bool m_showPreview;
 146     DolphinColumnView* m_view;
 147     KUrl m_url;      // URL of the directory that is shown
 148     KUrl m_childUrl; // URL of the next column that is shown
 149     QStyleOptionViewItem m_viewOptions;
 150     KDirLister* m_dirLister;
 151     DolphinModel* m_dolphinModel;
 152     DolphinSortFilterProxyModel* m_proxyModel;
 153
 154     bool m_dragging;   // TODO: remove this property when the issue #160611 is solved in Qt 4.4
 155     QRect m_dropRect;  // TODO: remove this property when the issue #160611 is solved in Qt 4.4
 156 };
 157
 158 inline bool DolphinColumnWidget::isActive() const
 159 {
 160     return m_active;
 161 }
 162
 163 inline void DolphinColumnWidget::setChildUrl(const KUrl& url)
 164 {
 165     m_childUrl = url;
 166 }
 167
 168 inline const KUrl& DolphinColumnWidget::childUrl() const
 169 {
 170     return m_childUrl;
 171 }
 172
 173 inline void DolphinColumnWidget::setUrl(const KUrl& url)
 174 {
 175     if (url != m_url) {
 176         m_url = url;
 177         reload();
 178     }
 179 }
 180
 181 inline const KUrl& DolphinColumnWidget::url() const
 182 {
 183     return m_url;
 184 }
 185
 186 inline QStyleOptionViewItem DolphinColumnWidget::viewOptions() const
 187 {
 188     return m_viewOptions;
 189 }
 190
 191 #endif