src/kitemviews/kitemlistviewlayouter.cpp

   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 #include "kitemlistviewlayouter_p.h"
  21
  22 #include "kitemmodelbase.h"
  23 #include "kitemlistsizehintresolver_p.h"
  24
  25 #include <KDebug>
  26
  27 // #define KITEMLISTVIEWLAYOUTER_DEBUG
  28
  29 KItemListViewLayouter::KItemListViewLayouter(QObject* parent) :
  30     QObject(parent),
  31     m_dirty(true),
  32     m_visibleIndexesDirty(true),
  33     m_scrollOrientation(Qt::Vertical),
  34     m_size(),
  35     m_itemSize(128, 128),
  36     m_headerHeight(0),
  37     m_model(0),
  38     m_sizeHintResolver(0),
  39     m_scrollOffset(0),
  40     m_maximumScrollOffset(0),
  41     m_itemOffset(0),
  42     m_maximumItemOffset(0),
  43     m_firstVisibleIndex(-1),
  44     m_lastVisibleIndex(-1),
  45     m_columnWidth(0),
  46     m_xPosInc(0),
  47     m_columnCount(0),
  48     m_groupItemIndexes(),
  49     m_groupHeaderHeight(0),
  50     m_itemRects()
  51 {
  52 }
  53
  54 KItemListViewLayouter::~KItemListViewLayouter()
  55 {
  56 }
  57
  58 void KItemListViewLayouter::setScrollOrientation(Qt::Orientation orientation)
  59 {
  60     if (m_scrollOrientation != orientation) {
  61         m_scrollOrientation = orientation;
  62         m_dirty = true;
  63     }
  64 }
  65
  66 Qt::Orientation KItemListViewLayouter::scrollOrientation() const
  67 {
  68     return m_scrollOrientation;
  69 }
  70
  71 void KItemListViewLayouter::setSize(const QSizeF& size)
  72 {
  73     if (m_size != size) {
  74         m_size = size;
  75         m_dirty = true;
  76     }
  77 }
  78
  79 QSizeF KItemListViewLayouter::size() const
  80 {
  81     return m_size;
  82 }
  83
  84 void KItemListViewLayouter::setItemSize(const QSizeF& size)
  85 {
  86     if (m_itemSize != size) {
  87         m_itemSize = size;
  88         m_dirty = true;
  89     }
  90 }
  91
  92 QSizeF KItemListViewLayouter::itemSize() const
  93 {
  94     return m_itemSize;
  95 }
  96
  97 void KItemListViewLayouter::setHeaderHeight(qreal height)
  98 {
  99     if (m_headerHeight != height) {
 100         m_headerHeight = height;
 101         m_dirty = true;
 102     }
 103 }
 104
 105 qreal KItemListViewLayouter::headerHeight() const
 106 {
 107     return m_headerHeight;
 108 }
 109
 110 void KItemListViewLayouter::setGroupHeaderHeight(qreal height)
 111 {
 112     if (m_groupHeaderHeight != height) {
 113         m_groupHeaderHeight = height;
 114         m_dirty = true;
 115     }
 116 }
 117
 118 qreal KItemListViewLayouter::groupHeaderHeight() const
 119 {
 120     return m_groupHeaderHeight;
 121 }
 122
 123 void KItemListViewLayouter::setScrollOffset(qreal offset)
 124 {
 125     if (m_scrollOffset != offset) {
 126         m_scrollOffset = offset;
 127         m_visibleIndexesDirty = true;
 128     }
 129 }
 130
 131 qreal KItemListViewLayouter::scrollOffset() const
 132 {
 133     return m_scrollOffset;
 134 }
 135
 136 qreal KItemListViewLayouter::maximumScrollOffset() const
 137 {
 138     const_cast<KItemListViewLayouter*>(this)->doLayout();
 139     return m_maximumScrollOffset;
 140 }
 141
 142 void KItemListViewLayouter::setItemOffset(qreal offset)
 143 {
 144     if (m_itemOffset != offset) {
 145         m_itemOffset = offset;
 146         m_visibleIndexesDirty = true;
 147     }
 148 }
 149
 150 qreal KItemListViewLayouter::itemOffset() const
 151 {
 152     return m_itemOffset;
 153 }
 154
 155 qreal KItemListViewLayouter::maximumItemOffset() const
 156 {
 157     const_cast<KItemListViewLayouter*>(this)->doLayout();
 158     return m_maximumItemOffset;
 159 }
 160
 161 void KItemListViewLayouter::setModel(const KItemModelBase* model)
 162 {
 163     if (m_model != model) {
 164         m_model = model;
 165         m_dirty = true;
 166     }
 167 }
 168
 169 const KItemModelBase* KItemListViewLayouter::model() const
 170 {
 171     return m_model;
 172 }
 173
 174 void KItemListViewLayouter::setSizeHintResolver(const KItemListSizeHintResolver* sizeHintResolver)
 175 {
 176     if (m_sizeHintResolver != sizeHintResolver) {
 177         m_sizeHintResolver = sizeHintResolver;
 178         m_dirty = true;
 179     }
 180 }
 181
 182 const KItemListSizeHintResolver* KItemListViewLayouter::sizeHintResolver() const
 183 {
 184     return m_sizeHintResolver;
 185 }
 186
 187 int KItemListViewLayouter::firstVisibleIndex() const
 188 {
 189     const_cast<KItemListViewLayouter*>(this)->doLayout();
 190     return m_firstVisibleIndex;
 191 }
 192
 193 int KItemListViewLayouter::lastVisibleIndex() const
 194 {
 195     const_cast<KItemListViewLayouter*>(this)->doLayout();
 196     return m_lastVisibleIndex;
 197 }
 198
 199 QRectF KItemListViewLayouter::itemRect(int index) const
 200 {
 201     const_cast<KItemListViewLayouter*>(this)->doLayout();
 202     if (index < 0 || index >= m_itemRects.count()) {
 203         return QRectF();
 204     }
 205
 206     if (m_scrollOrientation == Qt::Horizontal) {
 207         // Rotate the logical direction which is always vertical by 90°
 208         // to get the physical horizontal direction
 209         const QRectF& b = m_itemRects[index];
 210         QRectF bounds(b.y(), b.x(), b.height(), b.width());
 211         QPointF pos = bounds.topLeft();
 212         pos.rx() -= m_scrollOffset;
 213         bounds.moveTo(pos);
 214         return bounds;
 215     }
 216
 217     QRectF bounds = m_itemRects[index];
 218     bounds.moveTo(bounds.topLeft() - QPointF(m_itemOffset, m_scrollOffset));
 219     return bounds;
 220 }
 221
 222 QRectF KItemListViewLayouter::groupHeaderRect(int index) const
 223 {
 224     const QRectF firstItemRect = itemRect(index);
 225     QPointF pos = firstItemRect.topLeft();
 226     if (pos.isNull()) {
 227         return QRectF();
 228     }
 229
 230     pos.ry() -= m_groupHeaderHeight;
 231
 232     QSizeF size;
 233     if (m_scrollOrientation == Qt::Vertical) {
 234         pos.rx() = 0;
 235         size = QSizeF(m_size.width(), m_groupHeaderHeight);
 236     } else {
 237         size = QSizeF(minimumGroupHeaderWidth(), m_groupHeaderHeight);
 238     }
 239     return QRectF(pos, size);
 240 }
 241
 242 int KItemListViewLayouter::maximumVisibleItems() const
 243 {
 244     const_cast<KItemListViewLayouter*>(this)->doLayout();
 245
 246     const int height = static_cast<int>(m_size.height());
 247     const int rowHeight = static_cast<int>(m_itemSize.height());
 248     int rows = height / rowHeight;
 249     if (height % rowHeight != 0) {
 250         ++rows;
 251     }
 252
 253     return rows * m_columnCount;
 254 }
 255
 256 bool KItemListViewLayouter::isFirstGroupItem(int itemIndex) const
 257 {
 258     const_cast<KItemListViewLayouter*>(this)->doLayout();
 259     return m_groupItemIndexes.contains(itemIndex);
 260 }
 261
 262 void KItemListViewLayouter::markAsDirty()
 263 {
 264     m_dirty = true;
 265 }
 266
 267 void KItemListViewLayouter::doLayout()
 268 {
 269     if (m_dirty) {
 270 #ifdef KITEMLISTVIEWLAYOUTER_DEBUG
 271         QElapsedTimer timer;
 272         timer.start();
 273 #endif
 274         m_visibleIndexesDirty = true;
 275
 276         QSizeF itemSize = m_itemSize;
 277         QSizeF size = m_size;
 278
 279         const bool horizontalScrolling = (m_scrollOrientation == Qt::Horizontal);
 280         if (horizontalScrolling) {
 281             itemSize.setWidth(m_itemSize.height());
 282             itemSize.setHeight(m_itemSize.width());
 283             size.setWidth(m_size.height());
 284             size.setHeight(m_size.width());
 285         }
 286
 287         m_columnWidth = itemSize.width();
 288         m_columnCount = qMax(1, int(size.width() / m_columnWidth));
 289         m_xPosInc = 0;
 290
 291         const int itemCount = m_model->count();
 292         if (itemCount > m_columnCount) {
 293             // Apply the unused width equally to each column
 294             const qreal unusedWidth = size.width() - m_columnCount * m_columnWidth;
 295             if (unusedWidth > 0) {
 296                 const qreal columnInc = unusedWidth / (m_columnCount + 1);
 297                 m_columnWidth += columnInc;
 298                 m_xPosInc += columnInc;
 299             }
 300         }
 301
 302         int rowCount = itemCount / m_columnCount;
 303         if (itemCount % m_columnCount != 0) {
 304             ++rowCount;
 305         }
 306
 307         m_itemRects.reserve(itemCount);
 308
 309         qreal y = m_headerHeight;
 310         int rowIndex = 0;
 311
 312         const bool grouped = createGroupHeaders();
 313
 314         int index = 0;
 315         while (index < itemCount) {
 316             qreal x = m_xPosInc;
 317             qreal maxItemHeight = itemSize.height();
 318
 319             if (grouped) {
 320                 if (horizontalScrolling) {
 321                     // All group headers will always be aligned on the top and not
 322                     // flipped like the other properties
 323                     x += m_groupHeaderHeight;
 324                 }
 325
 326                 if (m_groupItemIndexes.contains(index)) {
 327                     if (!horizontalScrolling) {
 328                         // The item is the first item of a group.
 329                         // Increase the y-position to provide space
 330                         // for the group header.
 331                         y += m_groupHeaderHeight;
 332                     }
 333                 }
 334             }
 335
 336             int column = 0;
 337             while (index < itemCount && column < m_columnCount) {
 338                 qreal requiredItemHeight = itemSize.height();
 339                 if (m_sizeHintResolver) {
 340                     const QSizeF sizeHint = m_sizeHintResolver->sizeHint(index);
 341                     const qreal sizeHintHeight = horizontalScrolling ? sizeHint.width() : sizeHint.height();
 342                     if (sizeHintHeight > requiredItemHeight) {
 343                         requiredItemHeight = sizeHintHeight;
 344                     }
 345                 }
 346
 347                 const QRectF bounds(x, y, itemSize.width(), requiredItemHeight);
 348                 if (index < m_itemRects.count()) {
 349                     m_itemRects[index] = bounds;
 350                 } else {
 351                     m_itemRects.append(bounds);
 352                 }
 353
 354                 if (grouped && horizontalScrolling) {
 355                     // When grouping is enabled in the horizontal mode, the header alignment
 356                     // looks like this:
 357                     //   Header-1 Header-2 Header-3
 358                     //   Item 1   Item 4   Item 7
 359                     //   Item 2   Item 5   Item 8
 360                     //   Item 3   Item 6   Item 9
 361                     // In this case 'requiredItemHeight' represents the column-width. We don't
 362                     // check the content of the header in the layouter to determine the required
 363                     // width, hence assure that at least a minimal width of 15 characters is given
 364                     // (in average a character requires the halve width of the font height).
 365                     //
 366                     // TODO: Let the group headers provide a minimum width and respect this width here
 367                     const qreal headerWidth = minimumGroupHeaderWidth();
 368                     if (requiredItemHeight < headerWidth) {
 369                         requiredItemHeight = headerWidth;
 370                     }
 371                 }
 372
 373                 maxItemHeight = qMax(maxItemHeight, requiredItemHeight);
 374                 x += m_columnWidth;
 375                 ++index;
 376                 ++column;
 377
 378                 if (grouped && m_groupItemIndexes.contains(index)) {
 379                     // The item represents the first index of a group
 380                     // and must aligned in the first column
 381                     break;
 382                 }
 383             }
 384
 385             y += maxItemHeight;
 386             ++rowIndex;
 387         }
 388         if (m_itemRects.count() > itemCount) {
 389             m_itemRects.erase(m_itemRects.begin() + itemCount,
 390                                       m_itemRects.end());
 391         }
 392
 393         if (itemCount > 0) {
 394             // Calculate the maximum y-range of the last row for m_maximumScrollOffset
 395             m_maximumScrollOffset = m_itemRects.last().bottom();
 396             const qreal rowY = m_itemRects.last().y();
 397
 398             int index = m_itemRects.count() - 2;
 399             while (index >= 0 && m_itemRects.at(index).bottom() >= rowY) {
 400                 m_maximumScrollOffset = qMax(m_maximumScrollOffset, m_itemRects.at(index).bottom());
 401                 --index;
 402             }
 403
 404             m_maximumItemOffset = m_columnCount * m_columnWidth;
 405         } else {
 406             m_maximumScrollOffset = 0;
 407             m_maximumItemOffset = 0;
 408         }
 409
 410 #ifdef KITEMLISTVIEWLAYOUTER_DEBUG
 411         kDebug() << "[TIME] doLayout() for " << m_model->count() << "items:" << timer.elapsed();
 412 #endif
 413         m_dirty = false;
 414     }
 415
 416     updateVisibleIndexes();
 417 }
 418
 419 void KItemListViewLayouter::updateVisibleIndexes()
 420 {
 421     if (!m_visibleIndexesDirty) {
 422         return;
 423     }
 424
 425     Q_ASSERT(!m_dirty);
 426
 427     if (m_model->count() <= 0) {
 428         m_firstVisibleIndex = -1;
 429         m_lastVisibleIndex = -1;
 430         m_visibleIndexesDirty = false;
 431         return;
 432     }
 433
 434     const int maxIndex = m_model->count() - 1;
 435
 436     // Calculate the first visible index that is fully visible
 437     int min = 0;
 438     int max = maxIndex;
 439     int mid = 0;
 440     do {
 441         mid = (min + max) / 2;
 442         if (m_itemRects[mid].top() < m_scrollOffset) {
 443             min = mid + 1;
 444         } else {
 445             max = mid - 1;
 446         }
 447     } while (min <= max);
 448
 449     if (mid > 0) {
 450         // Include the row before the first fully visible index, as it might
 451         // be partly visible
 452         if (m_itemRects[mid].top() >= m_scrollOffset) {
 453             --mid;
 454             Q_ASSERT(m_itemRects[mid].top() < m_scrollOffset);
 455         }
 456
 457         const qreal rowTop = m_itemRects[mid].top();
 458         while (mid > 0 && m_itemRects[mid - 1].top() == rowTop) {
 459             --mid;
 460         }
 461     }
 462     m_firstVisibleIndex = mid;
 463
 464     // Calculate the last visible index that is (at least partly) visible
 465     const int visibleHeight = (m_scrollOrientation == Qt::Horizontal) ? m_size.width() : m_size.height();
 466     qreal bottom = m_scrollOffset + visibleHeight;
 467     if (m_model->groupedSorting()) {
 468         bottom += m_groupHeaderHeight;
 469     }
 470
 471     min = m_firstVisibleIndex;
 472     max = maxIndex;
 473     do {
 474         mid = (min + max) / 2;
 475         if (m_itemRects[mid].y() <= bottom) {
 476             min = mid + 1;
 477         } else {
 478             max = mid - 1;
 479         }
 480     } while (min <= max);
 481
 482     while (mid > 0 && m_itemRects[mid].y() > bottom) {
 483         --mid;
 484     }
 485     m_lastVisibleIndex = mid;
 486
 487     m_visibleIndexesDirty = false;
 488 }
 489
 490 bool KItemListViewLayouter::createGroupHeaders()
 491 {
 492     if (!m_model->groupedSorting()) {
 493         return false;
 494     }
 495
 496     m_groupItemIndexes.clear();
 497
 498     const QList<QPair<int, QVariant> > groups = m_model->groups();
 499     if (groups.isEmpty()) {
 500         return false;
 501     }
 502
 503     for (int i = 0; i < groups.count(); ++i) {
 504         const int firstItemIndex = groups.at(i).first;
 505         m_groupItemIndexes.insert(firstItemIndex);
 506     }
 507
 508     return true;
 509 }
 510
 511 qreal KItemListViewLayouter::minimumGroupHeaderWidth() const
 512 {
 513     return m_groupHeaderHeight * 15 / 2;
 514 }
 515
 516 #include "kitemlistviewlayouter_p.moc"