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