src/kitemviews/private/kitemlistheaderwidget.h

   1 /***************************************************************************
   2  *   Copyright (C) 2011 by Peter Penz <peter.penz19@gmail.com>             *
   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 KITEMLISTHEADERWIDGET_H
  21 #define KITEMLISTHEADERWIDGET_H
  22
  23 #include <libdolphin_export.h>
  24 #include <QGraphicsWidget>
  25 #include <QHash>
  26 #include <QList>
  27
  28 class KItemModelBase;
  29
  30 /**
  31  * @brief Widget the implements the header for KItemListView showing the currently used roles.
  32  *
  33  * The widget is an internal API, the user of KItemListView may only access the
  34  * class KItemListHeader.
  35  */
  36 class LIBDOLPHINPRIVATE_EXPORT KItemListHeaderWidget : public QGraphicsWidget
  37 {
  38     Q_OBJECT
  39
  40 public:
  41     KItemListHeaderWidget(QGraphicsWidget* parent = 0);
  42     virtual ~KItemListHeaderWidget();
  43
  44     void setModel(KItemModelBase* model);
  45     KItemModelBase* model() const;
  46
  47     void setAutomaticColumnResizing(bool automatic);
  48     bool automaticColumnResizing() const;
  49
  50     void setColumns(const QList<QByteArray>& roles);
  51     QList<QByteArray> columns() const;
  52
  53     void setColumnWidth(const QByteArray& role, qreal width);
  54     qreal columnWidth(const QByteArray& role) const;
  55
  56     /**
  57      * Sets the column-width that is required to show the role unclipped.
  58      */
  59     void setPreferredColumnWidth(const QByteArray& role, qreal width);
  60     qreal preferredColumnWidth(const QByteArray& role) const;
  61
  62     void setOffset(qreal offset);
  63     qreal offset() const;
  64
  65     qreal minimumColumnWidth() const;
  66
  67     virtual void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = 0);
  68
  69 signals:
  70     /**
  71      * Is emitted if the width of a visible role has been adjusted by the user with the mouse
  72      * (no signal is emitted if KItemListHeader::setVisibleRoleWidth() is invoked).
  73      */
  74     void columnWidthChanged(const QByteArray& role,
  75                             qreal currentWidth,
  76                             qreal previousWidth);
  77
  78     /**
  79      * Is emitted if the position of the column has been changed.
  80      */
  81     void columnMoved(const QByteArray& role, int currentIndex, int previousIndex);
  82
  83     /**
  84      * Is emitted if the user has changed the sort order by clicking on a
  85      * header item. The sort order of the model has already been adjusted to
  86      * the current sort order. Note that no signal will be emitted if the
  87      * sort order of the model has been changed without user interaction.
  88      */
  89     void sortOrderChanged(Qt::SortOrder current, Qt::SortOrder previous);
  90
  91     /**
  92      * Is emitted if the user has changed the sort role by clicking on a
  93      * header item. The sort role of the model has already been adjusted to
  94      * the current sort role. Note that no signal will be emitted if the
  95      * sort role of the model has been changed without user interaction.
  96      */
  97     void sortRoleChanged(const QByteArray& current, const QByteArray& previous);
  98
  99 protected:
 100     virtual void mousePressEvent(QGraphicsSceneMouseEvent* event);
 101     virtual void mouseReleaseEvent(QGraphicsSceneMouseEvent* event);
 102     virtual void mouseMoveEvent(QGraphicsSceneMouseEvent* event);
 103     virtual void hoverEnterEvent(QGraphicsSceneHoverEvent* event);
 104     virtual void hoverLeaveEvent(QGraphicsSceneHoverEvent* event);
 105     virtual void hoverMoveEvent(QGraphicsSceneHoverEvent* event);
 106
 107 private slots:
 108     void slotSortRoleChanged(const QByteArray& current, const QByteArray& previous);
 109     void slotSortOrderChanged(Qt::SortOrder current, Qt::SortOrder previous);
 110
 111 private:
 112     void paintRole(QPainter* painter,
 113                    const QByteArray& role,
 114                    const QRectF& rect,
 115                    int orderIndex,
 116                    QWidget* widget = 0) const;
 117
 118     void updatePressedRoleIndex(const QPointF& pos);
 119     void updateHoveredRoleIndex(const QPointF& pos);
 120     int roleIndexAt(const QPointF& pos) const;
 121     bool isAboveRoleGrip(const QPointF& pos, int roleIndex) const;
 122
 123     /**
 124      * Creates a pixmap of the role with the index \a roleIndex that is shown
 125      * during moving a role.
 126      */
 127     QPixmap createRolePixmap(int roleIndex) const;
 128
 129     /**
 130      * @return Target index of the currently moving visible role based on the current
 131      *         state of m_movingRole.
 132      */
 133     int targetOfMovingRole() const;
 134
 135     /**
 136      * @return x-position of the left border of the role \a role.
 137      */
 138     qreal roleXPosition(const QByteArray& role) const;
 139
 140 private:
 141     enum RoleOperation
 142     {
 143         NoRoleOperation,
 144         ResizeRoleOperation,
 145         MoveRoleOperation
 146     };
 147
 148     bool m_automaticColumnResizing;
 149     KItemModelBase* m_model;
 150     qreal m_offset;
 151     QList<QByteArray> m_columns;
 152     QHash<QByteArray, qreal> m_columnWidths;
 153     QHash<QByteArray, qreal> m_preferredColumnWidths;
 154
 155     int m_hoveredRoleIndex;
 156     int m_pressedRoleIndex;
 157     RoleOperation m_roleOperation;
 158     QPointF m_pressedMousePos;
 159
 160     struct MovingRole
 161     {
 162         QPixmap pixmap;
 163         int x;
 164         int xDec;
 165         int index;
 166     } m_movingRole;
 167 };
 168
 169 #endif
 170
 171