db/d19/qheaderview_8h_source.html

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


#ifndef QHEADERVIEW_H

#define QHEADERVIEW_H


#include <QtWidgets/qtwidgetsglobal.h>

#include <QtWidgets/qabstractitemview.h>


QT_REQUIRE_CONFIG(itemviews);


QT_BEGIN_NAMESPACE


class QHeaderViewPrivate;

class QStyleOptionHeader;


class Q_WIDGETS_EXPORT QHeaderView : public QAbstractItemView

{

    Q_OBJECT

    Q_PROPERTY(bool firstSectionMovable READ isFirstSectionMovable WRITE setFirstSectionMovable)

    Q_PROPERTY(bool showSortIndicator READ isSortIndicatorShown WRITE setSortIndicatorShown)

    Q_PROPERTY(bool sectionsMovable READ sectionsMovable WRITE setSectionsMovable)

    Q_PROPERTY(bool sectionsClickable READ sectionsClickable WRITE setSectionsClickable)

    Q_PROPERTY(bool highlightSections READ highlightSections WRITE setHighlightSections)

    Q_PROPERTY(bool stretchLastSection READ stretchLastSection WRITE setStretchLastSection)

    Q_PROPERTY(bool cascadingSectionResizes READ cascadingSectionResizes

               WRITE setCascadingSectionResizes)

    Q_PROPERTY(int defaultSectionSize READ defaultSectionSize WRITE setDefaultSectionSize

               RESET resetDefaultSectionSize)

    Q_PROPERTY(int minimumSectionSize READ minimumSectionSize WRITE setMinimumSectionSize)

    Q_PROPERTY(int maximumSectionSize READ maximumSectionSize WRITE setMaximumSectionSize)

    Q_PROPERTY(Qt::Alignment defaultAlignment READ defaultAlignment WRITE setDefaultAlignment)

    Q_PROPERTY(bool sortIndicatorClearable READ isSortIndicatorClearable

               WRITE setSortIndicatorClearable NOTIFY sortIndicatorClearableChanged)


public:


    enum ResizeMode

    {

        Interactive,

        Stretch,

        Fixed,

        ResizeToContents,

        Custom = Fixed

    };


    Q_ENUM(ResizeMode)


    explicit QHeaderView(Qt::Orientation orientation, QWidget *parent = nullptr);

    virtual ~QHeaderView();


    void setModel(QAbstractItemModel *model) override;


    Qt::Orientation orientation() const;

    int offset() const;

    int length() const;

    QSize sizeHint() const override;

    void setVisible(bool v) override;

    int sectionSizeHint(int logicalIndex) const;


    int visualIndexAt(int position) const;

    int logicalIndexAt(int position) const;


    inline int logicalIndexAt(int x, int y) const;

    inline int logicalIndexAt(const QPoint &pos) const;


    int sectionSize(int logicalIndex) const;

    int sectionPosition(int logicalIndex) const;

    int sectionViewportPosition(int logicalIndex) const;


    void moveSection(int from, int to);

    void swapSections(int first, int second);

    void resizeSection(int logicalIndex, int size);

    void resizeSections(QHeaderView::ResizeMode mode);


    bool isSectionHidden(int logicalIndex) const;

    void setSectionHidden(int logicalIndex, bool hide);

    int hiddenSectionCount() const;


    inline void hideSection(int logicalIndex);

    inline void showSection(int logicalIndex);


    int count() const;

    int visualIndex(int logicalIndex) const;

    int logicalIndex(int visualIndex) const;


    void setSectionsMovable(bool movable);

    bool sectionsMovable() const;

    void setFirstSectionMovable(bool movable);

    bool isFirstSectionMovable() const;


    void setSectionsClickable(bool clickable);

    bool sectionsClickable() const;


    void setHighlightSections(bool highlight);

    bool highlightSections() const;


    ResizeMode sectionResizeMode(int logicalIndex) const;

    void setSectionResizeMode(ResizeMode mode);

    void setSectionResizeMode(int logicalIndex, ResizeMode mode);


    void setResizeContentsPrecision(int precision);

    int  resizeContentsPrecision() const;


    int stretchSectionCount() const;


    void setSortIndicatorShown(bool show);

    bool isSortIndicatorShown() const;


    void setSortIndicator(int logicalIndex, Qt::SortOrder order);

    int sortIndicatorSection() const;

    Qt::SortOrder sortIndicatorOrder() const;


    void setSortIndicatorClearable(bool clearable);

    bool isSortIndicatorClearable() const;


    bool stretchLastSection() const;

    void setStretchLastSection(bool stretch);


    bool cascadingSectionResizes() const;

    void setCascadingSectionResizes(bool enable);


    int defaultSectionSize() const;

    void setDefaultSectionSize(int size);

    void resetDefaultSectionSize();


    int minimumSectionSize() const;

    void setMinimumSectionSize(int size);

    int maximumSectionSize() const;

    void setMaximumSectionSize(int size);


    Qt::Alignment defaultAlignment() const;

    void setDefaultAlignment(Qt::Alignment alignment);


    void doItemsLayout() override;

    bool sectionsMoved() const;

    bool sectionsHidden() const;


#ifndef QT_NO_DATASTREAM

    QByteArray saveState() const;

    bool restoreState(const QByteArray &state);

#endif


    void reset() override;


public Q_SLOTS:

    void setOffset(int offset);

    void setOffsetToSectionPosition(int visualIndex);

    void setOffsetToLastSection();

    void headerDataChanged(Qt::Orientation orientation, int logicalFirst, int logicalLast);


Q_SIGNALS:

    void sectionMoved(int logicalIndex, int oldVisualIndex, int newVisualIndex);

    void sectionResized(int logicalIndex, int oldSize, int newSize);

    void sectionPressed(int logicalIndex);

    void sectionClicked(int logicalIndex);

    void sectionEntered(int logicalIndex);

    void sectionDoubleClicked(int logicalIndex);

    void sectionCountChanged(int oldCount, int newCount);

    void sectionHandleDoubleClicked(int logicalIndex);

    void geometriesChanged();

    void sortIndicatorChanged(int logicalIndex, Qt::SortOrder order);

    void sortIndicatorClearableChanged(bool clearable);


protected Q_SLOTS:

    void updateSection(int logicalIndex);

    void resizeSections();

    void sectionsInserted(const QModelIndex &parent, int logicalFirst, int logicalLast);

    void sectionsAboutToBeRemoved(const QModelIndex &parent, int logicalFirst, int logicalLast);


protected:

    QHeaderView(QHeaderViewPrivate &dd, Qt::Orientation orientation, QWidget *parent = nullptr);

    void initialize();


    void initializeSections();

    void initializeSections(int start, int end);

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


    bool event(QEvent *e) override;

    void paintEvent(QPaintEvent *e) override;

    void mousePressEvent(QMouseEvent *e) override;

    void mouseMoveEvent(QMouseEvent *e) override;

    void mouseReleaseEvent(QMouseEvent *e) override;

    void mouseDoubleClickEvent(QMouseEvent *e) override;

    bool viewportEvent(QEvent *e) override;


    virtual void paintSection(QPainter *painter, const QRect &rect, int logicalIndex) const;

    virtual QSize sectionSizeFromContents(int logicalIndex) const;


    int horizontalOffset() const override;

    int verticalOffset() const override;

    void updateGeometries() override;

    void scrollContentsBy(int dx, int dy) override;


    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;


    QRect visualRect(const QModelIndex &index) const override;

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


    QModelIndex indexAt(const QPoint &p) const override;

    bool isIndexHidden(const QModelIndex &index) const override;


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

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

    QRegion visualRegionForSelection(const QItemSelection &selection) const override;

    virtual void initStyleOptionForIndex(QStyleOptionHeader *option, int logicalIndex) const;

    virtual void initStyleOption(QStyleOptionHeader *option) const;


    friend class QTableView;

    friend class QTreeView;


private:

    void initStyleOption(QStyleOptionFrame *option) const override;


    Q_DECLARE_PRIVATE(QHeaderView)

    Q_DISABLE_COPY(QHeaderView)

};


inline int QHeaderView::logicalIndexAt(int ax, int ay) const

{ return orientation() == Qt::Horizontal ? logicalIndexAt(ax) : logicalIndexAt(ay); }


inline int QHeaderView::logicalIndexAt(const QPoint &apos) const

{ return logicalIndexAt(apos.x(), apos.y()); }


inline void QHeaderView::hideSection(int alogicalIndex)

{ setSectionHidden(alogicalIndex, true); }


inline void QHeaderView::showSection(int alogicalIndex)

{ setSectionHidden(alogicalIndex, false); }


QT_END_NAMESPACE


#endif // QHEADERVIEW_H

QAbstractItemModel
\inmodule QtCore
Definition qabstractitemmodel.h:234

QAbstractItemView
The QAbstractItemView class provides the basic functionality for item view classes.
Definition qabstractitemview.h:26

QAbstractItemView::CursorAction
CursorAction
This enum describes the different ways to navigate between items,.
Definition qabstractitemview.h:248

QAbstractItemView::ScrollHint
ScrollHint
\value EnsureVisible Scroll to ensure that the item is visible.
Definition qabstractitemview.h:67

QByteArray
\inmodule QtCore
Definition qbytearray.h:57

QEvent
\inmodule QtCore
Definition qcoreevent.h:45

QHeaderViewPrivate
Definition qheaderview_p.h:35

QHeaderView
The QHeaderView class provides a header row or header column for item views.
Definition qheaderview.h:18

QHeaderView::geometriesChanged
void geometriesChanged()

QHeaderView::sectionClicked
void sectionClicked(int logicalIndex)
This signal is emitted when a section is clicked.

QHeaderView::sectionCountChanged
void sectionCountChanged(int oldCount, int newCount)
This signal is emitted when the number of sections changes, i.e., when sections are added or deleted.

QHeaderView::sectionResized
void sectionResized(int logicalIndex, int oldSize, int newSize)
This signal is emitted when a section is resized.

QHeaderView::ResizeMode
ResizeMode
The resize mode specifies the behavior of the header sections.
Definition qheaderview.h:39

QHeaderView::Fixed
@ Fixed
Definition qheaderview.h:42

QHeaderView::ResizeToContents
@ ResizeToContents
Definition qheaderview.h:43

QHeaderView::Stretch
@ Stretch
Definition qheaderview.h:41

QHeaderView::Interactive
@ Interactive
Definition qheaderview.h:40

QHeaderView::sectionPressed
void sectionPressed(int logicalIndex)
This signal is emitted when a section is pressed.

QHeaderView::sortIndicatorChanged
void sortIndicatorChanged(int logicalIndex, Qt::SortOrder order)

QHeaderView::hideSection
void hideSection(int logicalIndex)
Hides the section specified by logicalIndex.
Definition qheaderview.h:224

QHeaderView::logicalIndexAt
int logicalIndexAt(int position) const
Returns the section that covers the given position in the viewport.
Definition qheaderview.cpp:585

QHeaderView::setSectionHidden
void setSectionHidden(int logicalIndex, bool hide)
If hide is true the section specified by logicalIndex is hidden; otherwise the section is shown.
Definition qheaderview.cpp:962

QHeaderView::sectionHandleDoubleClicked
void sectionHandleDoubleClicked(int logicalIndex)
This signal is emitted when a section is double-clicked.

QHeaderView::sectionEntered
void sectionEntered(int logicalIndex)

QHeaderView::sortIndicatorClearableChanged
void sortIndicatorClearableChanged(bool clearable)

QHeaderView::showSection
void showSection(int logicalIndex)
Shows the section specified by logicalIndex.
Definition qheaderview.h:226

QHeaderView::orientation
Qt::Orientation orientation() const
Returns the orientation of the header.
Definition qheaderview.cpp:374

QHeaderView::sectionMoved
void sectionMoved(int logicalIndex, int oldVisualIndex, int newVisualIndex)
This signal is emitted when a section is moved.

QHeaderView::sectionDoubleClicked
void sectionDoubleClicked(int logicalIndex)
This signal is emitted when a section is double-clicked.

QItemSelection
\inmodule QtCore
Definition qitemselectionmodel.h:181

QModelIndex
\inmodule QtCore
Definition qabstractitemmodel.h:124

QMouseEvent
\inmodule QtGui
Definition qevent.h:196

QPaintEvent
The QPaintEvent class contains event parameters for paint events.
Definition qevent.h:486

QPainter
The QPainter class performs low-level painting on widgets and other paint devices.
Definition qpainter.h:46

QPoint
\inmodule QtCore\reentrant
Definition qpoint.h:25

QRect
\inmodule QtCore\reentrant
Definition qrect.h:30

QRegion
The QRegion class specifies a clip region for a painter.
Definition qregion.h:27

QSize
\inmodule QtCore
Definition qsize.h:25

QStyleOptionFrame
\variable QStyleOptionFocusRect::backgroundColor
Definition qstyleoption.h:91

QStyleOptionHeader
The QStyleOptionHeader class is used to describe the parameters for drawing a header.
Definition qstyleoption.h:168

QTableView
The QTableView class provides a default model/view implementation of a table view.
Definition qtableview.h:18

QTreeView
The QTreeView class provides a default model/view implementation of a tree view.
Definition qtreeview.h:20

QWidget
The QWidget class is the base class of all user interface objects.
Definition qwidget.h:99

rect
rect
[4]
Definition doc_src_styles.cpp:43

alignment
uint alignment
Definition doc_src_styles.cpp:74

state
else opt state
[0]
Definition doc_src_styles.cpp:11

QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition qstandardpaths_haiku.cpp:21

QT_END_NAMESPACE
Definition qsharedpointer.cpp:1590

Qt
Definition qcompare.h:63

Qt::Orientation
Orientation
Definition qnamespace.h:98

Qt::Horizontal
@ Horizontal
Definition qnamespace.h:99

Qt::SortOrder
SortOrder
Definition qnamespace.h:121

setSelection
static jboolean setSelection(JNIEnv *, jobject, jint start, jint end)
Definition qandroidinputcontext.cpp:237

initialize
static bool initialize()
Definition qctf.cpp:94

visualRect
static void visualRect(QRectF *geom, Qt::LayoutDirection dir, const QRectF &contentsRect)
Definition qgridlayoutengine.cpp:1019

v
GLsizei const GLfloat * v
[13]
Definition qopengles2ext.h:788

x
GLint GLint GLint GLint GLint x
[0]
Definition qopengles2ext.h:605

mode
GLenum mode
Definition qopengles2ext.h:333

size
GLenum GLuint GLintptr GLsizeiptr size
[1]
Definition qopengles2ext.h:660

index
GLuint index
[2]
Definition qopengles2ext.h:331

end
GLuint GLuint end
Definition qopengles2ext.h:354

length
GLenum GLuint GLenum GLsizei length
Definition qopengles2ext.h:151

count
GLenum GLenum GLsizei count
Definition qopengles2ext.h:150

flags
GLbitfield flags
Definition qopengles2ext.h:1026

enable
GLboolean enable
Definition qopengles2ext.h:855

start
GLuint start
Definition qopengles2ext.h:354

offset
GLenum GLuint GLintptr offset
Definition qopengles2ext.h:660

first
GLint first
Definition qopengles2ext.h:913

y
GLint y
Definition qopengles2ext.h:206

event
struct _cl_event * event
Definition qopenglext.h:2998

reset
GLboolean reset
Definition qopenglext.h:2748

p
GLfloat GLfloat p
[1]
Definition qopenglext.h:12698

option
GLuint GLenum option
Definition qopenglext.h:5929

order
GLfixed GLfixed GLint GLint order
Definition qopenglext.h:5206

precision
GLenum GLint GLint * precision
Definition qopenglext.h:1890

position
static qreal position(const QQuickItem *item, QQuickAnchors::Anchor anchorLine)
Definition qquickanchors.cpp:66

hint
static QT_BEGIN_NAMESPACE QVariant hint(QPlatformIntegration::StyleHint h)
Definition qstylehints.cpp:13

QT_REQUIRE_CONFIG
#define QT_REQUIRE_CONFIG(feature)
Definition qtconfigmacros.h:67

Q_ENUM
#define Q_ENUM(x)
Definition qtmetamacros.h:68

Q_PROPERTY
#define Q_PROPERTY(...)
Definition qtmetamacros.h:56

Q_OBJECT
#define Q_OBJECT
Definition qtmetamacros.h:119

Q_SLOTS
#define Q_SLOTS
Definition qtmetamacros.h:44

Q_SIGNALS
#define Q_SIGNALS
Definition qtmetamacros.h:45

setModel
view setModel(model)
[17] //! [18]

model
QSqlQueryModel * model
[16]
Definition sqldatabase_snippet.cpp:5

show
view show()
[18] //! [19]

pos
pos
[7]
Definition src_corelib_io_qsettings.cpp:57

hide
edit hide()

selection
QItemSelection * selection
[0]
Definition src_gui_itemviews_qitemselectionmodel.cpp:5

painter
QPainter painter(this)
[7]

scrollTo
scroller scrollTo(QPointF(100, 100))