Revision control
Copy as Markdown
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
#ifndef QLISTVIEW_P_H
#define QLISTVIEW_P_H
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists for the convenience
// of other Qt classes. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
#include <QtWidgets/private/qtwidgetsglobal_p.h>
#include "qlistview.h"
#include "private/qabstractitemview_p.h"
#include "qbitarray.h"
#include "qbsptree_p.h"
#include <limits.h>
#include <qscrollbar.h>
QT_REQUIRE_CONFIG(listview);
QT_BEGIN_NAMESPACE
class QListViewItem
{
friend class QListViewPrivate;
friend class QListModeViewBase;
friend class QIconModeViewBase;
public:
constexpr QListViewItem()
: x(-1), y(-1), w(0), h(0), indexHint(-1), visited(0xffff) {}
constexpr QListViewItem(QRect r, int i)
: x(r.x()), y(r.y()), w(qMin(r.width(), SHRT_MAX)), h(qMin(r.height(), SHRT_MAX)),
indexHint(i), visited(0xffff) {}
constexpr bool operator==(const QListViewItem &other) const {
return (x == other.x && y == other.y && w == other.w && h == other.h &&
indexHint == other.indexHint); }
constexpr bool operator!=(const QListViewItem &other) const
{ return !(*this == other); }
constexpr bool isValid() const
{ return rect().isValid() && (indexHint > -1); }
constexpr void invalidate()
{ x = -1; y = -1; w = 0; h = 0; }
constexpr void resize(QSize size)
{ w = qMin(size.width(), SHRT_MAX); h = qMin(size.height(), SHRT_MAX); }
constexpr void move(QPoint position)
{ x = position.x(); y = position.y(); }
constexpr int width() const { return w; }
constexpr int height() const { return h; }
private:
constexpr QRect rect() const
{ return QRect(x, y, w, h); }
int x, y;
short w, h;
mutable int indexHint;
uint visited;
};
Q_DECLARE_TYPEINFO(QListViewItem, Q_PRIMITIVE_TYPE);
struct QListViewLayoutInfo
{
QRect bounds;
QSize grid;
int spacing;
int first;
int last;
bool wrap;
QListView::Flow flow;
int max;
};
Q_DECLARE_TYPEINFO(QListViewLayoutInfo, Q_PRIMITIVE_TYPE);
class QListView;
class QListViewPrivate;
class QCommonListViewBase
{
public:
inline QCommonListViewBase(QListView *q, QListViewPrivate *d) : dd(d), qq(q), batchStartRow(0), batchSavedDeltaSeg(0) {}
virtual ~QCommonListViewBase() {}
//common interface
virtual int itemIndex(const QListViewItem &item) const = 0;
virtual QListViewItem indexToListViewItem(const QModelIndex &index) const = 0;
virtual bool doBatchedItemLayout(const QListViewLayoutInfo &info, int max) = 0;
virtual void clear() = 0;
virtual void setRowCount(int) = 0;
virtual QList<QModelIndex> intersectingSet(const QRect &area) const = 0;
virtual void dataChanged(const QModelIndex &, const QModelIndex &) = 0;
virtual int horizontalScrollToValue(int index, QListView::ScrollHint hint,
bool leftOf, bool rightOf, const QRect &area, const QRect &rect) const;
virtual int verticalScrollToValue(int index, QListView::ScrollHint hint,
bool above, bool below, const QRect &area, const QRect &rect) const;
virtual void scrollContentsBy(int dx, int dy, bool scrollElasticBand);
virtual QRect mapToViewport(const QRect &rect) const {return rect;}
virtual int horizontalOffset() const;
virtual int verticalOffset() const { return verticalScrollBar()->value(); }
virtual void updateHorizontalScrollBar(const QSize &step);
virtual void updateVerticalScrollBar(const QSize &step);
virtual void appendHiddenRow(int row);
virtual void removeHiddenRow(int row);
virtual void setPositionForIndex(const QPoint &, const QModelIndex &) { }
#if QT_CONFIG(draganddrop)
virtual void paintDragDrop(QPainter *painter);
virtual bool filterDragMoveEvent(QDragMoveEvent *) { return false; }
virtual bool filterDragLeaveEvent(QDragLeaveEvent *) { return false; }
virtual bool filterDropEvent(QDropEvent *) { return false; }
virtual bool filterStartDrag(Qt::DropActions) { return false; }
#endif
//other inline members
inline int spacing() const;
inline bool isWrapping() const;
inline QSize gridSize() const;
inline QListView::Flow flow() const;
inline QListView::Movement movement() const;
inline QPoint offset() const;
inline QPoint pressedPosition() const;
inline bool uniformItemSizes() const;
inline int column() const;
inline QScrollBar *verticalScrollBar() const;
inline QScrollBar *horizontalScrollBar() const;
inline QListView::ScrollMode verticalScrollMode() const;
inline QListView::ScrollMode horizontalScrollMode() const;
inline QModelIndex modelIndex(int row) const;
inline int rowCount() const;
inline void initViewItemOption(QStyleOptionViewItem *option) const;
inline QWidget *viewport() const;
inline QRect clipRect() const;
inline QSize cachedItemSize() const;
inline QRect viewItemRect(const QListViewItem &item) const;
inline QSize itemSize(const QStyleOptionViewItem &opt, const QModelIndex &idx) const;
inline QAbstractItemDelegate *delegate(const QModelIndex &idx) const;
inline bool isHidden(int row) const;
inline int hiddenCount() const;
inline bool isRightToLeft() const;
QListViewPrivate *dd;
QListView *qq;
QSize contentsSize;
int batchStartRow;
int batchSavedDeltaSeg;
};
class QListModeViewBase : public QCommonListViewBase
{
public:
QListModeViewBase(QListView *q, QListViewPrivate *d);
QList<int> flowPositions;
QList<int> segmentPositions;
QList<int> segmentStartRows;
QList<int> segmentExtents;
QList<int> scrollValueMap;
// used when laying out in batches
int batchSavedPosition;
//reimplementations
int itemIndex(const QListViewItem &item) const override { return item.indexHint; }
QListViewItem indexToListViewItem(const QModelIndex &index) const override;
bool doBatchedItemLayout(const QListViewLayoutInfo &info, int max) override;
void clear() override;
void setRowCount(int rowCount) override { flowPositions.resize(rowCount); }
QList<QModelIndex> intersectingSet(const QRect &area) const override;
void dataChanged(const QModelIndex &, const QModelIndex &) override;
int horizontalScrollToValue(int index, QListView::ScrollHint hint,
bool leftOf, bool rightOf,const QRect &area, const QRect &rect) const override;
int verticalScrollToValue(int index, QListView::ScrollHint hint,
bool above, bool below, const QRect &area, const QRect &rect) const override;
void scrollContentsBy(int dx, int dy, bool scrollElasticBand) override;
QRect mapToViewport(const QRect &rect) const override;
int horizontalOffset() const override;
int verticalOffset() const override;
inline static QSize viewportSize(const QAbstractItemView *v);
void updateHorizontalScrollBar(const QSize &step) override;
void updateVerticalScrollBar(const QSize &step) override;
#if QT_CONFIG(draganddrop)
// The next two methods are to be used on LefToRight flow only.
// WARNING: Plenty of duplicated code from QAbstractItemView{,Private}.
QAbstractItemView::DropIndicatorPosition position(const QPoint &pos, const QRect &rect, const QModelIndex &idx) const;
void dragMoveEvent(QDragMoveEvent *e);
bool dropOn(QDropEvent *event, int *row, int *col, QModelIndex *index);
#endif
private:
QPoint initStaticLayout(const QListViewLayoutInfo &info);
void doStaticLayout(const QListViewLayoutInfo &info);
int perItemScrollToValue(int index, int value, int height,
QAbstractItemView::ScrollHint hint,
Qt::Orientation orientation, bool wrap, int extent) const;
int perItemScrollingPageSteps(int length, int bounds, bool wrap) const;
};
class QIconModeViewBase : public QCommonListViewBase
{
public:
QIconModeViewBase(QListView *q, QListViewPrivate *d) : QCommonListViewBase(q, d), interSectingVector(nullptr) {}
QBspTree tree;
QList<QListViewItem> items;
QBitArray moved;
QList<QModelIndex> draggedItems; // indices to the tree.itemVector
mutable QPoint draggedItemsPos;
// used when laying out in batches
QList<QModelIndex> *interSectingVector; // used from within intersectingSet
//reimplementations
int itemIndex(const QListViewItem &item) const override;
QListViewItem indexToListViewItem(const QModelIndex &index) const override;
bool doBatchedItemLayout(const QListViewLayoutInfo &info, int max) override;
void clear() override;
void setRowCount(int rowCount) override;
QList<QModelIndex> intersectingSet(const QRect &area) const override;
void scrollContentsBy(int dx, int dy, bool scrollElasticBand) override;
void dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight) override;
void appendHiddenRow(int row) override;
void removeHiddenRow(int row) override;
void setPositionForIndex(const QPoint &position, const QModelIndex &index) override;
#if QT_CONFIG(draganddrop)
bool filterDragMoveEvent(QDragMoveEvent *) override;
bool filterDragLeaveEvent(QDragLeaveEvent *) override;
bool filterDropEvent(QDropEvent *e) override;
bool filterStartDrag(Qt::DropActions) override;
#endif
private:
void initBspTree(const QSize &contents);
QPoint initDynamicLayout(const QListViewLayoutInfo &info);
void doDynamicLayout(const QListViewLayoutInfo &info);
static void addLeaf(QList<int> &leaf, const QRect &area, uint visited, QBspTree::Data data);
QRect itemsRect(const QList<QModelIndex> &indexes) const;
QRect draggedItemsRect() const;
QPoint snapToGrid(const QPoint &pos) const;
void updateContentsSize();
QPoint draggedItemsDelta() const;
void drawItems(QPainter *painter, const QList<QModelIndex> &indexes) const;
void moveItem(int index, const QPoint &dest);
};
class Q_AUTOTEST_EXPORT QListViewPrivate: public QAbstractItemViewPrivate
{
Q_DECLARE_PUBLIC(QListView)
public:
QListViewPrivate();
~QListViewPrivate();
void clear();
void prepareItemsLayout();
bool doItemsLayout(int num);
inline QList<QModelIndex> intersectingSet(const QRect &area, bool doLayout = true) const
{
if (doLayout) executePostedLayout();
QRect a = (q_func()->isRightToLeft() ? flipX(area.normalized()) : area.normalized());
return commonListView->intersectingSet(a);
}
inline void resetBatchStartRow() { commonListView->batchStartRow = 0; }
inline int batchStartRow() const { return commonListView->batchStartRow; }
inline QSize contentsSize() const { return commonListView->contentsSize; }
inline void setContentsSize(int w, int h) { commonListView->contentsSize = QSize(w, h); }
inline int flipX(int x) const
{ return qMax(viewport->width(), contentsSize().width()) - x; }
inline QPoint flipX(const QPoint &p) const
{ return QPoint(flipX(p.x()), p.y()); }
inline QRect flipX(const QRect &r) const
{ return QRect(flipX(r.x()) - r.width(), r.y(), r.width(), r.height()); }
inline QRect viewItemRect(const QListViewItem &item) const
{ if (q_func()->isRightToLeft()) return flipX(item.rect()); return item.rect(); }
QListViewItem indexToListViewItem(const QModelIndex &index) const;
inline QModelIndex listViewItemToIndex(const QListViewItem &item) const
{ return model->index(commonListView->itemIndex(item), column, root); }
inline bool hasRectForIndex(const QModelIndex &index) const
{
return isIndexValid(index) && index.parent() == root && index.column() == column && !isHidden(index.row());
}
QRect rectForIndex(const QModelIndex &index) const
{
if (!hasRectForIndex(index))
return QRect();
executePostedLayout();
return viewItemRect(indexToListViewItem(index));
}
QRect cellRectForIndex(const QModelIndex &index)
{
if (!hasRectForIndex(index))
return QRect();
executePostedLayout();
auto oldItemAlignment = itemAlignment;
itemAlignment = Qt::Alignment();
const QRect rect = rectForIndex(index);
itemAlignment = oldItemAlignment;
return rect;
}
void viewUpdateGeometries() { q_func()->updateGeometries(); }
QRect mapToViewport(const QRect &rect, bool extend = true) const;
QModelIndex closestIndex(const QRect &target, const QList<QModelIndex> &candidates) const;
QSize itemSize(const QStyleOptionViewItem &option, const QModelIndex &index) const;
bool selectionAllowed(const QModelIndex &index) const override
{ if (viewMode == QListView::ListMode && !showElasticBand) return index.isValid(); return true; }
int horizontalScrollToValue(const QModelIndex &index, const QRect &rect, QListView::ScrollHint hint) const;
int verticalScrollToValue(const QModelIndex &index, const QRect &rect, QListView::ScrollHint hint) const;
QItemSelection selection(const QRect &rect) const;
void selectAll(QItemSelectionModel::SelectionFlags command) override;
#if QT_CONFIG(draganddrop)
QAbstractItemView::DropIndicatorPosition position(const QPoint &pos, const QRect &rect, const QModelIndex &idx) const override;
bool dropOn(QDropEvent *event, int *row, int *col, QModelIndex *index) override;
#endif
#if QT_CONFIG(accessibility)
int accessibleChildIndex(const QModelIndex &index) const override;
#endif
inline void setGridSize(const QSize &size) { grid = size; }
inline QSize gridSize() const { return grid; }
inline void setWrapping(bool b) { wrap = b; }
inline bool isWrapping() const { return wrap; }
inline void setSpacing(int s) { space = s; }
inline int spacing() const { return space; }
inline void setSelectionRectVisible(bool visible) { showElasticBand = visible; }
inline bool isSelectionRectVisible() const { return showElasticBand; }
inline QModelIndex modelIndex(int row) const { return model->index(row, column, root); }
inline bool isHidden(int row) const {
QModelIndex idx = model->index(row, 0, root);
return isPersistent(idx) && hiddenRows.contains(idx);
}
// helper to avoid checking for isPersistent and creating persistent indexes as above in isHidden
QList<int> hiddenRowIds() const
{
QList<int> rowIds;
rowIds.reserve(hiddenRows.size());
for (const auto &idx : hiddenRows)
rowIds += idx.row();
return rowIds;
}
inline bool isHiddenOrDisabled(int row) const { return isHidden(row) || !isIndexEnabled(modelIndex(row)); }
void removeCurrentAndDisabled(QList<QModelIndex> *indexes, const QModelIndex ¤t) const;
void scrollElasticBandBy(int dx, int dy);
QItemViewPaintPairs draggablePaintPairs(const QModelIndexList &indexes, QRect *r) const override;
void emitIndexesMoved(const QModelIndexList &indexes) { emit q_func()->indexesMoved(indexes); }
QCommonListViewBase *commonListView;
// ### FIXME: see if we can move the members into the dynamic/static classes
bool wrap;
int space;
QSize grid;
QListView::Flow flow;
QListView::Movement movement;
QListView::ResizeMode resizeMode;
QListView::LayoutMode layoutMode;
QListView::ViewMode viewMode;
// the properties controlling the
// icon- or list-view modes
enum ModeProperties {
Wrap = 1,
Spacing = 2,
GridSize = 4,
Flow = 8,
Movement = 16,
ResizeMode = 32,
SelectionRectVisible = 64
};
uint modeProperties : 8;
QRect layoutBounds;
// timers
QBasicTimer batchLayoutTimer;
// used for hidden items
QSet<QPersistentModelIndex> hiddenRows;
int column;
bool uniformItemSizes;
mutable QSize cachedItemSize;
int batchSize;
QRect elasticBand;
bool showElasticBand;
Qt::Alignment itemAlignment;
};
// inline implementations
inline int QCommonListViewBase::spacing() const { return dd->spacing(); }
inline bool QCommonListViewBase::isWrapping() const { return dd->isWrapping(); }
inline QSize QCommonListViewBase::gridSize() const { return dd->gridSize(); }
inline QListView::Flow QCommonListViewBase::flow() const { return dd->flow; }
inline QListView::Movement QCommonListViewBase::movement() const { return dd->movement; }
inline QPoint QCommonListViewBase::offset() const { return dd->offset(); }
inline QPoint QCommonListViewBase::pressedPosition() const { return dd->pressedPosition; }
inline bool QCommonListViewBase::uniformItemSizes() const { return dd->uniformItemSizes; }
inline int QCommonListViewBase::column() const { return dd->column; }
inline QScrollBar *QCommonListViewBase::verticalScrollBar() const { return qq->verticalScrollBar(); }
inline QScrollBar *QCommonListViewBase::horizontalScrollBar() const { return qq->horizontalScrollBar(); }
inline QListView::ScrollMode QCommonListViewBase::verticalScrollMode() const { return qq->verticalScrollMode(); }
inline QListView::ScrollMode QCommonListViewBase::horizontalScrollMode() const { return qq->horizontalScrollMode(); }
inline QModelIndex QCommonListViewBase::modelIndex(int row) const
{ return dd->model->index(row, dd->column, dd->root); }
inline int QCommonListViewBase::rowCount() const { return dd->model->rowCount(dd->root); }
inline void QCommonListViewBase::initViewItemOption(QStyleOptionViewItem *option) const { qq->initViewItemOption(option); }
inline QWidget *QCommonListViewBase::viewport() const { return dd->viewport; }
inline QRect QCommonListViewBase::clipRect() const { return dd->clipRect(); }
inline QSize QCommonListViewBase::cachedItemSize() const { return dd->cachedItemSize; }
inline QRect QCommonListViewBase::viewItemRect(const QListViewItem &item) const { return dd->viewItemRect(item); }
inline QSize QCommonListViewBase::itemSize(const QStyleOptionViewItem &opt, const QModelIndex &idx) const
{ return dd->itemSize(opt, idx); }
inline QAbstractItemDelegate *QCommonListViewBase::delegate(const QModelIndex &idx) const
{ return qq->itemDelegateForIndex(idx); }
inline bool QCommonListViewBase::isHidden(int row) const { return dd->isHidden(row); }
inline int QCommonListViewBase::hiddenCount() const { return dd->hiddenRows.size(); }
inline bool QCommonListViewBase::isRightToLeft() const { return qq->isRightToLeft(); }
QT_END_NAMESPACE
#endif // QLISTVIEW_P_H