src/kitemviews/kitemlistwidget.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2011 by Peter Penz <peter.penz19@gmail.com>             *
   3  *                                                                         *
   4  *   Based on the Itemviews NG project from Trolltech Labs:                *
   5  *   http://qt.gitorious.org/qt-labs/itemviews-ng                          *
   6  *                                                                         *
   7  *   This program is free software; you can redistribute it and/or modify  *
   8  *   it under the terms of the GNU General Public License as published by  *
   9  *   the Free Software Foundation; either version 2 of the License, or     *
  10  *   (at your option) any later version.                                   *
  11  *                                                                         *
  12  *   This program is distributed in the hope that it will be useful,       *
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  15  *   GNU General Public License for more details.                          *
  16  *                                                                         *
  17  *   You should have received a copy of the GNU General Public License     *
  18  *   along with this program; if not, write to the                         *
  19  *   Free Software Foundation, Inc.,                                       *
  20  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  21  ***************************************************************************/
  22
  23 #include "kitemlistwidget.h"
  24
  25 #include "kitemlistview.h"
  26 #include "kitemmodelbase.h"
  27
  28 #include "private/kitemlistselectiontoggle.h"
  29
  30 #include <QDebug>
  31
  32 #include <QApplication>
  33 #include <QPainter>
  34 #include <QPropertyAnimation>
  35 #include <QStyleOption>
  36
  37 KItemListWidgetInformant::KItemListWidgetInformant()
  38 {
  39 }
  40
  41 KItemListWidgetInformant::~KItemListWidgetInformant()
  42 {
  43 }
  44
  45 KItemListWidget::KItemListWidget(KItemListWidgetInformant* informant, QGraphicsItem* parent) :
  46     QGraphicsWidget(parent, 0),
  47     m_informant(informant),
  48     m_index(-1),
  49     m_selected(false),
  50     m_current(false),
  51     m_hovered(false),
  52     m_alternateBackground(false),
  53     m_enabledSelectionToggle(false),
  54     m_data(),
  55     m_visibleRoles(),
  56     m_columnWidths(),
  57     m_styleOption(),
  58     m_siblingsInfo(),
  59     m_hoverOpacity(0),
  60     m_hoverCache(0),
  61     m_hoverAnimation(0),
  62     m_selectionToggle(0),
  63     m_editedRole()
  64 {
  65 }
  66
  67 KItemListWidget::~KItemListWidget()
  68 {
  69     clearHoverCache();
  70 }
  71
  72 void KItemListWidget::setIndex(int index)
  73 {
  74     if (m_index != index) {
  75         delete m_selectionToggle;
  76         m_selectionToggle = 0;
  77
  78         if (m_hoverAnimation) {
  79             m_hoverAnimation->stop();
  80             m_hoverOpacity = 0;
  81         }
  82         clearHoverCache();
  83
  84         m_index = index;
  85     }
  86 }
  87
  88 int KItemListWidget::index() const
  89 {
  90     return m_index;
  91 }
  92
  93 void KItemListWidget::setData(const QHash<QByteArray, QVariant>& data,
  94                               const QSet<QByteArray>& roles)
  95 {
  96     clearHoverCache();
  97     if (roles.isEmpty()) {
  98         m_data = data;
  99         dataChanged(m_data);
 100     } else {
 101         foreach (const QByteArray& role, roles) {
 102             m_data[role] = data[role];
 103         }
 104         dataChanged(m_data, roles);
 105     }
 106     update();
 107 }
 108
 109 QHash<QByteArray, QVariant> KItemListWidget::data() const
 110 {
 111     return m_data;
 112 }
 113
 114 void KItemListWidget::paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget)
 115 {
 116     Q_UNUSED(option);
 117
 118     if (m_alternateBackground) {
 119         const QColor backgroundColor = m_styleOption.palette.color(QPalette::AlternateBase);
 120         const QRectF backgroundRect(0, 0, size().width(), size().height());
 121         painter->fillRect(backgroundRect, backgroundColor);
 122     }
 123
 124     if (m_selected && m_editedRole.isEmpty()) {
 125         const QStyle::State activeState(isActiveWindow() ? QStyle::State_Active : 0);
 126         drawItemStyleOption(painter, widget, activeState |
 127                                              QStyle::State_Enabled |
 128                                              QStyle::State_Selected |
 129                                              QStyle::State_Item);
 130     }
 131
 132     if (m_current && m_editedRole.isEmpty()) {
 133         QStyleOptionFocusRect focusRectOption;
 134         focusRectOption.initFrom(widget);
 135         focusRectOption.rect = textFocusRect().toRect();
 136         focusRectOption.state = QStyle::State_Enabled | QStyle::State_Item | QStyle::State_KeyboardFocusChange;
 137         if (m_selected) {
 138             focusRectOption.state |= QStyle::State_Selected;
 139         }
 140
 141         style()->drawPrimitive(QStyle::PE_FrameFocusRect, &focusRectOption, painter, widget);
 142     }
 143
 144     if (m_hoverOpacity > 0.0) {
 145         if (!m_hoverCache) {
 146             // Initialize the m_hoverCache pixmap to improve the drawing performance
 147             // when fading the hover background
 148             m_hoverCache = new QPixmap(size().toSize());
 149             m_hoverCache->fill(Qt::transparent);
 150
 151             QPainter pixmapPainter(m_hoverCache);
 152             const QStyle::State activeState(isActiveWindow() ? QStyle::State_Active : 0);
 153             drawItemStyleOption(&pixmapPainter, widget, activeState |
 154                                                         QStyle::State_Enabled |
 155                                                         QStyle::State_MouseOver |
 156                                                         QStyle::State_Item);
 157         }
 158
 159         const qreal opacity = painter->opacity();
 160         painter->setOpacity(m_hoverOpacity * opacity);
 161         painter->drawPixmap(0, 0, *m_hoverCache);
 162         painter->setOpacity(opacity);
 163     }
 164 }
 165
 166 void KItemListWidget::setVisibleRoles(const QList<QByteArray>& roles)
 167 {
 168     const QList<QByteArray> previousRoles = m_visibleRoles;
 169     m_visibleRoles = roles;
 170
 171     visibleRolesChanged(roles, previousRoles);
 172     update();
 173 }
 174
 175 QList<QByteArray> KItemListWidget::visibleRoles() const
 176 {
 177     return m_visibleRoles;
 178 }
 179
 180
 181 void KItemListWidget::setColumnWidth(const QByteArray& role, qreal width)
 182 {
 183     if (m_columnWidths.value(role) != width) {
 184         const qreal previousWidth = width;
 185         m_columnWidths.insert(role, width);
 186         columnWidthChanged(role, width, previousWidth);
 187         update();
 188     }
 189 }
 190
 191 qreal KItemListWidget::columnWidth(const QByteArray& role) const
 192 {
 193     return m_columnWidths.value(role);
 194 }
 195
 196 void KItemListWidget::setStyleOption(const KItemListStyleOption& option)
 197 {
 198     const KItemListStyleOption previous = m_styleOption;
 199     clearHoverCache();
 200     m_styleOption = option;
 201
 202     styleOptionChanged(option, previous);
 203     update();
 204 }
 205
 206 const KItemListStyleOption& KItemListWidget::styleOption() const
 207 {
 208     return m_styleOption;
 209 }
 210
 211 void KItemListWidget::setSelected(bool selected)
 212 {
 213     if (m_selected != selected) {
 214         m_selected = selected;
 215         if (m_selectionToggle) {
 216             m_selectionToggle->setChecked(selected);
 217         }
 218         selectedChanged(selected);
 219         update();
 220     }
 221 }
 222
 223 bool KItemListWidget::isSelected() const
 224 {
 225     return m_selected;
 226 }
 227
 228 void KItemListWidget::setCurrent(bool current)
 229 {
 230     if (m_current != current) {
 231         m_current = current;
 232         currentChanged(current);
 233         update();
 234     }
 235 }
 236
 237 bool KItemListWidget::isCurrent() const
 238 {
 239     return m_current;
 240 }
 241
 242 void KItemListWidget::setHovered(bool hovered)
 243 {
 244     if (hovered == m_hovered) {
 245         return;
 246     }
 247
 248     m_hovered = hovered;
 249
 250     if (!m_hoverAnimation) {
 251         m_hoverAnimation = new QPropertyAnimation(this, "hoverOpacity", this);
 252         const int duration = style()->styleHint(QStyle::SH_Widget_Animate) ? 200 : 1;
 253         m_hoverAnimation->setDuration(duration);
 254         connect(m_hoverAnimation, &QPropertyAnimation::finished, this, &KItemListWidget::slotHoverAnimationFinished);
 255     }
 256     m_hoverAnimation->stop();
 257
 258     if (hovered) {
 259         const qreal startValue = qMax(hoverOpacity(), qreal(0.1));
 260         m_hoverAnimation->setStartValue(startValue);
 261         m_hoverAnimation->setEndValue(1.0);
 262         if (m_enabledSelectionToggle && !(QApplication::mouseButtons() & Qt::LeftButton)) {
 263             initializeSelectionToggle();
 264         }
 265     } else {
 266         m_hoverAnimation->setStartValue(hoverOpacity());
 267         m_hoverAnimation->setEndValue(0.0);
 268     }
 269
 270     m_hoverAnimation->start();
 271
 272     hoveredChanged(hovered);
 273     update();
 274 }
 275
 276 bool KItemListWidget::isHovered() const
 277 {
 278     return m_hovered;
 279 }
 280
 281 void KItemListWidget::setHoverPosition(const QPointF& pos)
 282 {
 283     if (m_selectionToggle) {
 284         m_selectionToggle->setHovered(selectionToggleRect().contains(pos));
 285     }
 286 }
 287
 288 void KItemListWidget::setAlternateBackground(bool enable)
 289 {
 290     if (m_alternateBackground != enable) {
 291         m_alternateBackground = enable;
 292         alternateBackgroundChanged(enable);
 293         update();
 294     }
 295 }
 296
 297 bool KItemListWidget::alternateBackground() const
 298 {
 299     return m_alternateBackground;
 300 }
 301
 302 void KItemListWidget::setEnabledSelectionToggle(bool enable)
 303 {
 304     if (m_enabledSelectionToggle != enable) {
 305         m_enabledSelectionToggle = enable;
 306         update();
 307     }
 308 }
 309
 310 bool KItemListWidget::enabledSelectionToggle() const
 311 {
 312     return m_enabledSelectionToggle;
 313 }
 314
 315 void KItemListWidget::setSiblingsInformation(const QBitArray& siblings)
 316 {
 317     const QBitArray previous = m_siblingsInfo;
 318     m_siblingsInfo = siblings;
 319     siblingsInformationChanged(m_siblingsInfo, previous);
 320     update();
 321 }
 322
 323 QBitArray KItemListWidget::siblingsInformation() const
 324 {
 325     return m_siblingsInfo;
 326 }
 327
 328 void KItemListWidget::setEditedRole(const QByteArray& role)
 329 {
 330     if (m_editedRole != role) {
 331         const QByteArray previous = m_editedRole;
 332         m_editedRole = role;
 333         editedRoleChanged(role, previous);
 334     }
 335 }
 336
 337 QByteArray KItemListWidget::editedRole() const
 338 {
 339     return m_editedRole;
 340 }
 341
 342 bool KItemListWidget::contains(const QPointF& point) const
 343 {
 344     if (!QGraphicsWidget::contains(point)) {
 345         return false;
 346     }
 347
 348     return iconRect().contains(point) ||
 349            textRect().contains(point) ||
 350            expansionToggleRect().contains(point) ||
 351            selectionToggleRect().contains(point);
 352 }
 353
 354 QRectF KItemListWidget::textFocusRect() const
 355 {
 356     return textRect();
 357 }
 358
 359 QRectF KItemListWidget::selectionToggleRect() const
 360 {
 361     return QRectF();
 362 }
 363
 364 QRectF KItemListWidget::expansionToggleRect() const
 365 {
 366     return QRectF();
 367 }
 368
 369 QPixmap KItemListWidget::createDragPixmap(const QStyleOptionGraphicsItem* option,
 370                                           QWidget* widget)
 371 {
 372     QPixmap pixmap(size().toSize());
 373     pixmap.fill(Qt::transparent);
 374
 375     QPainter painter(&pixmap);
 376
 377     const bool oldAlternateBackground = m_alternateBackground;
 378     const bool wasSelected = m_selected;
 379     const bool wasHovered = m_hovered;
 380
 381     setAlternateBackground(false);
 382     setSelected(false);
 383     setHovered(false);
 384
 385     paint(&painter, option, widget);
 386
 387     setAlternateBackground(oldAlternateBackground);
 388     setSelected(wasSelected);
 389     setHovered(wasHovered);
 390
 391     return pixmap;
 392 }
 393
 394 void KItemListWidget::dataChanged(const QHash<QByteArray, QVariant>& current,
 395                                   const QSet<QByteArray>& roles)
 396 {
 397     Q_UNUSED(current);
 398     Q_UNUSED(roles);
 399 }
 400
 401 void KItemListWidget::visibleRolesChanged(const QList<QByteArray>& current,
 402                                           const QList<QByteArray>& previous)
 403 {
 404     Q_UNUSED(current);
 405     Q_UNUSED(previous);
 406 }
 407
 408 void KItemListWidget::columnWidthChanged(const QByteArray& role,
 409                                          qreal current,
 410                                          qreal previous)
 411 {
 412     Q_UNUSED(role);
 413     Q_UNUSED(current);
 414     Q_UNUSED(previous);
 415 }
 416
 417 void KItemListWidget::styleOptionChanged(const KItemListStyleOption& current,
 418                                          const KItemListStyleOption& previous)
 419 {
 420     Q_UNUSED(current);
 421     Q_UNUSED(previous);
 422 }
 423
 424 void KItemListWidget::currentChanged(bool current)
 425 {
 426     Q_UNUSED(current);
 427 }
 428
 429 void KItemListWidget::selectedChanged(bool selected)
 430 {
 431     Q_UNUSED(selected);
 432 }
 433
 434 void KItemListWidget::hoveredChanged(bool hovered)
 435 {
 436     Q_UNUSED(hovered);
 437 }
 438
 439 void KItemListWidget::alternateBackgroundChanged(bool enabled)
 440 {
 441     Q_UNUSED(enabled);
 442 }
 443
 444 void KItemListWidget::siblingsInformationChanged(const QBitArray& current, const QBitArray& previous)
 445 {
 446     Q_UNUSED(current);
 447     Q_UNUSED(previous);
 448 }
 449
 450 void KItemListWidget::editedRoleChanged(const QByteArray& current, const QByteArray& previous)
 451 {
 452     Q_UNUSED(current);
 453     Q_UNUSED(previous);
 454 }
 455
 456 void KItemListWidget::resizeEvent(QGraphicsSceneResizeEvent* event)
 457 {
 458     QGraphicsWidget::resizeEvent(event);
 459     clearHoverCache();
 460
 461     if (m_selectionToggle) {
 462         const QRectF& toggleRect = selectionToggleRect();
 463         m_selectionToggle->setPos(toggleRect.topLeft());
 464         m_selectionToggle->resize(toggleRect.size());
 465     }
 466 }
 467
 468 qreal KItemListWidget::hoverOpacity() const
 469 {
 470     return m_hoverOpacity;
 471 }
 472
 473 void KItemListWidget::slotHoverAnimationFinished()
 474 {
 475     if (!m_hovered && m_selectionToggle) {
 476         m_selectionToggle->deleteLater();
 477         m_selectionToggle = 0;
 478     }
 479 }
 480
 481 void KItemListWidget::initializeSelectionToggle()
 482 {
 483     Q_ASSERT(m_enabledSelectionToggle);
 484
 485     if (!m_selectionToggle) {
 486         m_selectionToggle = new KItemListSelectionToggle(this);
 487     }
 488
 489     const QRectF toggleRect = selectionToggleRect();
 490     m_selectionToggle->setPos(toggleRect.topLeft());
 491     m_selectionToggle->resize(toggleRect.size());
 492
 493     m_selectionToggle->setChecked(isSelected());
 494 }
 495
 496 void KItemListWidget::setHoverOpacity(qreal opacity)
 497 {
 498     m_hoverOpacity = opacity;
 499     if (m_selectionToggle) {
 500         m_selectionToggle->setOpacity(opacity);
 501     }
 502
 503     if (m_hoverOpacity <= 0.0) {
 504         delete m_hoverCache;
 505         m_hoverCache = 0;
 506     }
 507
 508     update();
 509 }
 510
 511 void KItemListWidget::clearHoverCache()
 512 {
 513     delete m_hoverCache;
 514     m_hoverCache = 0;
 515 }
 516
 517 void KItemListWidget::drawItemStyleOption(QPainter* painter, QWidget* widget, QStyle::State styleState)
 518 {
 519     QStyleOptionViewItemV4 viewItemOption;
 520     viewItemOption.initFrom(widget);
 521     viewItemOption.state = styleState;
 522     viewItemOption.viewItemPosition = QStyleOptionViewItemV4::OnlyOne;
 523     viewItemOption.showDecorationSelected = true;
 524     viewItemOption.rect = selectionRect().toRect();
 525     widget->style()->drawPrimitive(QStyle::PE_PanelItemViewItem, &viewItemOption, painter, widget);
 526 }
 527