qlistview.h - mozsearch

Enable keyboard shortcuts

// 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_H

#define QLISTVIEW_H

#include <QtWidgets/qtwidgetsglobal.h>

#include <QtWidgets/qabstractitemview.h>

QT_REQUIRE_CONFIG(listview);

QT_BEGIN_NAMESPACE

class QListViewPrivate;

class Q_WIDGETS_EXPORT QListView : public QAbstractItemView

    Q_OBJECT

    Q_PROPERTY(Movement movement READ movement WRITE setMovement)

    Q_PROPERTY(Flow flow READ flow WRITE setFlow)

    Q_PROPERTY(bool isWrapping READ isWrapping WRITE setWrapping)

    Q_PROPERTY(ResizeMode resizeMode READ resizeMode WRITE setResizeMode)

    Q_PROPERTY(LayoutMode layoutMode READ layoutMode WRITE setLayoutMode)

    Q_PROPERTY(int spacing READ spacing WRITE setSpacing)

    Q_PROPERTY(QSize gridSize READ gridSize WRITE setGridSize)

    Q_PROPERTY(ViewMode viewMode READ viewMode WRITE setViewMode)

    Q_PROPERTY(int modelColumn READ modelColumn WRITE setModelColumn)

    Q_PROPERTY(bool uniformItemSizes READ uniformItemSizes WRITE setUniformItemSizes)

    Q_PROPERTY(int batchSize READ batchSize WRITE setBatchSize)

    Q_PROPERTY(bool wordWrap READ wordWrap WRITE setWordWrap)

    Q_PROPERTY(bool selectionRectVisible READ isSelectionRectVisible WRITE setSelectionRectVisible)

    Q_PROPERTY(Qt::Alignment itemAlignment READ itemAlignment WRITE setItemAlignment)

public:

    enum Movement { Static, Free, Snap };

    Q_ENUM(Movement)

    enum Flow { LeftToRight, TopToBottom };

    Q_ENUM(Flow)

    enum ResizeMode { Fixed, Adjust };

    Q_ENUM(ResizeMode)

    enum LayoutMode { SinglePass, Batched };

    Q_ENUM(LayoutMode)

    enum ViewMode { ListMode, IconMode };

    Q_ENUM(ViewMode)

    explicit QListView(QWidget *parent = nullptr);

    ~QListView();

    void setMovement(Movement movement);

    Movement movement() const;

    void setFlow(Flow flow);

    Flow flow() const;

    void setWrapping(bool enable);

    bool isWrapping() const;

    void setResizeMode(ResizeMode mode);

    ResizeMode resizeMode() const;

    void setLayoutMode(LayoutMode mode);

    LayoutMode layoutMode() const;

    void setSpacing(int space);

    int spacing() const;

    void setBatchSize(int batchSize);

    int batchSize() const;

    void setGridSize(const QSize &size);

    QSize gridSize() const;

    void setViewMode(ViewMode mode);

    ViewMode viewMode() const;

    void clearPropertyFlags();

    bool isRowHidden(int row) const;

    void setRowHidden(int row, bool hide);

    void setModelColumn(int column);

    int modelColumn() const;

    void setUniformItemSizes(bool enable);

    bool uniformItemSizes() const;

    void setWordWrap(bool on);

    bool wordWrap() const;

    void setSelectionRectVisible(bool show);

    bool isSelectionRectVisible() const;

    void setItemAlignment(Qt::Alignment alignment);

    Qt::Alignment itemAlignment() const;

    QRect visualRect(const QModelIndex &index) const override;

    void scrollTo(const QModelIndex &index, ScrollHint hint = EnsureVisible) override;

    QModelIndex indexAt(const QPoint &p) const override;

    void doItemsLayout() override;

    void reset() override;

    void setRootIndex(const QModelIndex &index) override;

Q_SIGNALS:

    void indexesMoved(const QModelIndexList &indexes);

protected:

    QListView(QListViewPrivate &, QWidget *parent = nullptr);

    bool event(QEvent *e) override;

    void scrollContentsBy(int dx, int dy) override;

    void resizeContents(int width, int height);

    QSize contentsSize() const;

    void dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight,

                     const QList<int> &roles = QList<int>()) override;

    void rowsInserted(const QModelIndex &parent, int start, int end) override;

    void rowsAboutToBeRemoved(const QModelIndex &parent, int start, int end) override;

    void mouseMoveEvent(QMouseEvent *e) override;

    void mouseReleaseEvent(QMouseEvent *e) override;

#if QT_CONFIG(wheelevent)

    void wheelEvent(QWheelEvent *e) override;

#endif

    void timerEvent(QTimerEvent *e) override;

    void resizeEvent(QResizeEvent *e) override;

#if QT_CONFIG(draganddrop)

    void dragMoveEvent(QDragMoveEvent *e) override;

    void dragLeaveEvent(QDragLeaveEvent *e) override;

    void dropEvent(QDropEvent *e) override;

    void startDrag(Qt::DropActions supportedActions) override;

#endif // QT_CONFIG(draganddrop)

    void initViewItemOption(QStyleOptionViewItem *option) const override;

    void paintEvent(QPaintEvent *e) override;

    int horizontalOffset() const override;

    int verticalOffset() const override;

    QModelIndex moveCursor(CursorAction cursorAction, Qt::KeyboardModifiers modifiers) override;

    QRect rectForIndex(const QModelIndex &index) const;

    void setPositionForIndex(const QPoint &position, const QModelIndex &index);

    void setSelection(const QRect &rect, QItemSelectionModel::SelectionFlags command) override;

    QRegion visualRegionForSelection(const QItemSelection &selection) const override;

    QModelIndexList selectedIndexes() const override;

    void updateGeometries() override;

    bool isIndexHidden(const QModelIndex &index) const override;

    void selectionChanged(const QItemSelection &selected, const QItemSelection &deselected) override;

    void currentChanged(const QModelIndex &current, const QModelIndex &previous) override;

    QSize viewportSizeHint() const override;

private:

    int visualIndex(const QModelIndex &index) const;

    friend class QCommonListViewBase;

    Q_DECLARE_PRIVATE(QListView)

    Q_DISABLE_COPY(QListView)

};

QT_END_NAMESPACE

#endif // QLISTVIEW_H