Класс QHeaderView

Класс QHeaderView предоставляет строку или столбец заголовка для представлений элементов. Подробнее...

• Список всех членов, включая наследуемые
• Устаревшие члены

Типы

Свойства

Открытые функции

Reimplemented Public Functions

Public Slots

Signals

Protected Functions

Reimplemented Protected Functions

Protected Slots

Detailed Description

A QHeaderView отображает заголовки, используемые в представлениях элементов, таких как QTableView и QTreeView. Он заменяет класс Qt3 QHeader, ранее использовавшийся для той же цели, но использует архитектуру модели/представления Qt для согласованности с классами представлений элементов.

Класс QHeaderView является одним из классов модели/представления и входит в фреймворк модели/представления Qt.

Заголовок получает данные для каждого раздела из модели с помощью функции QAbstractItemModel::headerData(). Вы можете установить данные, используя QAbstractItemModel::setHeaderData().

Каждый заголовок имеет ориентацию orientation() и количество разделов, задаваемое функцией count(). Раздел относится к части заголовка — строке или столбцу в зависимости от ориентации.

Разделы можно перемещать и изменять размер с помощью moveSection() и resizeSection(); их также можно скрывать и показывать с помощью hideSection() и showSection().

Каждый раздел заголовка описывается идентификатором раздела, заданным section(), и может быть расположен в определённом visualIndex() в заголовке. В разделе можно установить индикатор сортировки с помощью setSortIndicator(); это указывает, будут ли элементы в связанном представлении элементов отсортированы в порядке, заданном разделом.

Для горизонтального заголовка раздел эквивалентен столбцу в модели, а для вертикального заголовка — строке в модели.

Перемещение разделов заголовка

Заголовок может быть зафиксирован на месте или перемещаемым с помощью setSectionsMovable(). Он может быть настраиваемым для нажатия с помощью setSectionsClickable(), и его поведение при изменении размера соответствует setSectionResizeMode().

Примечание: Двойной щелчок по заголовку для изменения размера раздела применяется только для видимых строк.

Заголовок будет излучать sectionMoved(), если пользователь перемещает раздел, sectionResized(), если пользователь изменяет размер раздела, и sectionClicked() , а также sectionHandleDoubleClicked() в ответ на щелчки мыши. Заголовок также будет излучать sectionCountChanged().

Раздел можно идентифицировать с помощью функций logicalIndex() и logicalIndexAt() или по его индексу, используя функции visualIndex() и visualIndexAt(). Визуальный индекс изменится, если раздел будет перемещён, но логический индекс останется неизменным.

Внешний вид

QTableWidget и QTableView создают заголовки по умолчанию. Если вы хотите, чтобы заголовки были видимыми, используйте setVisible().

Не все ItemDataRole окажут влияние на QHeaderView. Если вам нужно отображать другие роли, вы можете создать подкласс QHeaderView и переопределить paintEvent(). QHeaderView учитывает следующие роли данных элементов, если они не противоречат стилю (что может произойти для стилей, которые следуют за темой рабочего стола):

TextAlignmentRole, DisplayRole, FontRole, DecorationRole, ForegroundRole и BackgroundRole.

Примечание: Каждый заголовок сам отображает данные для каждого раздела и не полагается на делегат. В результате вызов функции setItemDelegate() заголовка не окажет никакого эффекта.

См. также Моделирование/Представление, QListView, QTableView и QTreeView.

Документация по типам членов

enum QHeaderView::ResizeMode

Режим изменения размера определяет поведение разделов заголовка. Его можно установить для всего представления заголовка или для отдельных разделов с помощью setSectionResizeMode().

Следующие значения устарели:

См. также setResizeMode(), setSectionResizeMode(), stretchLastSection и minimumSectionSize.

Документация по членам-функциям

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

Создаёт новый общий заголовок с заданной orientation и parent.

[signal] void QHeaderView::geometriesChanged()

Этот сигнал испускается, когда геометрия заголовка изменилась.

Эта функция была добавлена в Qt 4.2.

[slot] void QHeaderView::headerDataChanged(Qt::Orientation orientation, int logicalFirst, int logicalLast)

Обновляет изменённые разделы заголовка с заданной orientation, от logicalFirst до logicalLast включительно.

[protected slot] void QHeaderView::resizeSections()

Изменяет размер разделов в соответствии с их размерами. Обычно вызывать эту функцию не нужно.

[signal] void QHeaderView::sectionClicked(int logicalIndex)

Этот сигнал испускается, когда раздел нажат. Логический индекс раздела задаётся параметром logicalIndex.

Обратите внимание, что сигнал sectionPressed также будет испущен.

См. также setSectionsClickable() и sectionPressed().

[signal] void QHeaderView::sectionCountChanged(int oldCount, int newCount)

Этот сигнал генерируется при изменении количества секций, например, при добавлении или удалении секций. Исходное количество указано параметром oldCount, а новое количество — параметром newCount.

См. также count(), length() и headerDataChanged().

[signal] void QHeaderView::sectionDoubleClicked(int logicalIndex)

Этот сигнал генерируется при двойном щелчке по секции. Логический индекс секции указан в параметре logicalIndex.

См. также setSectionsClickable().

[signal] void QHeaderView::sectionEntered(int logicalIndex)

Этот сигнал генерируется, когда курсор перемещается над секцией и нажимается левая кнопка мыши. Логический индекс секции указан в параметре logicalIndex.

Эта функция была добавлена в Qt 4.3.

См. также setSectionsClickable() и sectionPressed().

[signal] void QHeaderView::sectionHandleDoubleClicked(int logicalIndex)

Этот сигнал генерируется при двойном щелчке по секции. Логический индекс секции указан в параметре logicalIndex.

См. также setSectionsClickable().

[signal] void QHeaderView::sectionMoved(int logicalIndex, int oldVisualIndex, int newVisualIndex)

Этот сигнал генерируется при перемещении секции. Логический индекс секции указан в параметре logicalIndex, старый индекс — в oldVisualIndex, а новый индекс — в newVisualIndex.

См. также moveSection().

[signal] void QHeaderView::sectionPressed(int logicalIndex)

Этот сигнал генерируется при нажатии на секцию. Логический индекс секции указан в параметре logicalIndex.

См. также setSectionsClickable().

[signal] void QHeaderView::sectionResized(int logicalIndex, int oldSize, int newSize)

Этот сигнал генерируется при изменении размера секции. Логический индекс секции указан в параметре logicalIndex, старый размер — в oldSize, а новый размер — в newSize.

См. также resizeSection().

[protected slot] void QHeaderView::sectionsAboutToBeRemoved(const QModelIndex &parent, int logicalFirst, int logicalLast)

Этот слот вызывается, когда секции удаляются из parent. Значения logicalFirst и logicalLast обозначают, где были удалены секции.

Если удаляется только одна секция, logicalFirst и logicalLast будут одинаковыми.

[protected slot] void QHeaderView::sectionsInserted(const QModelIndex &parent, int logicalFirst, int logicalLast)

Этот слот вызывается, когда секции вставляются в parent. Индексы logicalFirst и logicalLast обозначают, куда были вставлены новые секции.

Если вставляется только одна секция, logicalFirst и logicalLast будут одинаковыми.

[slot] void QHeaderView::setOffset(int offset)

Устанавливает смещение заголовка в offset.

См. также offset() и length().

[slot] void QHeaderView::setOffsetToLastSection()

Устанавливает смещение, чтобы последняя секция была видимой.

Эта функция была добавлена в Qt 4.2.

См. также setOffset(), sectionPosition() и setOffsetToSectionPosition().

[slot] void QHeaderView::setOffsetToSectionPosition(int visualSectionNumber)

Устанавливает смещение до начала секции с заданным visualSectionNumber. visualSectionNumber — это фактическая видимая секция, если скрытые секции не учитываются. Это не всегда то же самое, что visualIndex().

Эта функция была добавлена в Qt 4.2.

См. также setOffset() и sectionPosition().

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

Этот сигнал генерируется при изменении секции, содержащей индикатор сортировки, или при изменении порядка. Логический индекс секции указан в параметре logicalIndex, а порядок сортировки — в параметре order.

Эта функция была добавлена в Qt 4.3.

См. также setSortIndicator().

[virtual] QHeaderView::~QHeaderView()

Удаляет заголовок.

int QHeaderView::count() const

Возвращает количество секций в заголовке.

См. также sectionCountChanged() и length().

[override virtual protected] void QHeaderView::currentChanged(const QModelIndex &current, const QModelIndex &old)

Переопределяет: QAbstractItemView::currentChanged(const QModelIndex &current, const QModelIndex &previous).

[override virtual protected] bool QHeaderView::event(QEvent *e)

Переопределяет: QAbstractItemView::event(QEvent *event).

int QHeaderView::hiddenSectionCount() const

Возвращает количество скрытых секций в заголовке.

Эта функция была добавлена в Qt 4.1.

См. также setSectionHidden() и isSectionHidden().

void QHeaderView::hideSection(int logicalIndex)

Скрывает секцию, указанную параметром logicalIndex.

См. также showSection(), isSectionHidden(), hiddenSectionCount() и setSectionHidden().

[override virtual protected] int QHeaderView::horizontalOffset() const

Переопределяет: QAbstractItemView::horizontalOffset() const.

Возвращает горизонтальное смещение заголовка. Для вертикальных заголовков это 0.

См. также offset().

[protected] void QHeaderView::initStyleOption(QStyleOptionHeader *option) const

Инициализирует option значениями из этого QHeaderView. Этот метод полезен для подклассов, когда им нужен QStyleOptionHeader, но они не хотят сами заполнять всю информацию.

См. также QStyleOption::initFrom().

bool QHeaderView::isSectionHidden(int logicalIndex) const

Возвращает true, если секция, указанная параметром logicalIndex, явно скрыта от пользователя; в противном случае возвращает false.

См. также hideSection(), showSection(), setSectionHidden() и hiddenSectionCount().

int QHeaderView::length() const

Возвращает длину по ориентации заголовка.

См. также sizeHint(), setSectionResizeMode() и offset().

int QHeaderView::logicalIndex(int visualIndex) const

Возвращает логический индекс секции по заданному индексу visualIndex, или -1, если visualIndex < 0 или visualIndex >= QHeaderView::count().

Обратите внимание, что visualIndex не зависит от скрытых секций.

См. также visualIndex() и sectionPosition().

int QHeaderView::logicalIndexAt(int position) const

Возвращает секцию, которая покрывает данную position в области просмотра.

См. также visualIndexAt() и isSectionHidden().

int QHeaderView::logicalIndexAt(int x, int y) const

Возвращает логический индекс секции по заданным координатам. Если заголовок горизонтальный, будет использоваться x, в противном случае — y для поиска логического индекса.

int QHeaderView::logicalIndexAt(const QPoint &pos) const

Возвращает логический индекс секции в позиции, заданной в pos. Если заголовок горизонтальный, будет использоваться координата x, в противном случае — координата y для поиска логического индекса.

См. также sectionPosition().

[override virtual protected] void QHeaderView::mouseDoubleClickEvent(QMouseEvent *e)

Переопределяет: QAbstractItemView::mouseDoubleClickEvent(QMouseEvent *event).

[override virtual protected] void QHeaderView::mouseMoveEvent(QMouseEvent *e)

Переопределяет: QAbstractItemView::mouseMoveEvent(QMouseEvent *event).

[override virtual protected] void QHeaderView::mousePressEvent(QMouseEvent *e)

Переопределяет: QAbstractItemView::mousePressEvent(QMouseEvent *event).

[override virtual protected] void QHeaderView::mouseReleaseEvent(QMouseEvent *e)

Переопределяет: QAbstractItemView::mouseReleaseEvent(QMouseEvent *event).

void QHeaderView::moveSection(int from, int to)

Перемещает секцию с визуальным индексом from на визуальный индекс to.

См. также sectionsMoved().

int QHeaderView::offset() const

Возвращает смещение заголовка: это самая левая (или самая верхняя для вертикальных заголовков) видимая пиксель заголовка.

См. также setOffset().

Qt::Orientation QHeaderView::orientation() const

Возвращает ориентацию заголовка.

См. также Qt::Orientation.

[override virtual protected] void QHeaderView::paintEvent(QPaintEvent *e)

Переопределяет: QAbstractScrollArea::paintEvent(QPaintEvent *event).

[virtual protected] void QHeaderView::paintSection(QPainter *painter, const QRect &rect, int logicalIndex) const

Рисует секцию, указанную заданным logicalIndex, используя заданный painter и rect.

Обычно, вам не нужно вызывать эту функцию.

[override virtual] void QHeaderView::reset()

Переопределяет: QAbstractItemView::reset().

int QHeaderView::resizeContentsPrecision() const

Возвращает, насколько точно QHeaderView будет рассчитывать размер при ResizeToContents.

Эта функция была добавлена в Qt 5.2.

См. также setResizeContentsPrecision() и setSectionResizeMode().

void QHeaderView::resizeSection(int logicalIndex, int size)

Изменяет размер секции, указанной logicalIndex, на size пикселей. Параметр size должен быть значением, большим или равным нулю. Однако размер, равный нулю, не рекомендуется. В этом случае следует использовать hideSection вместо этого.

См. также sectionResized(), resizeMode(), sectionSize(), и hideSection().

void QHeaderView::resizeSections(QHeaderView::ResizeMode mode)

Изменяет размер секций в соответствии с заданным mode, игнорируя текущий режим изменения размера.

См. также resizeMode() и sectionResized().

bool QHeaderView::restoreState(const QByteArray &state)

Восстанавливает состояние этого представления заголовка. Эта функция возвращает true если состояние было восстановлено; в противном случае возвращает false.

Эта функция была добавлена в Qt 4.3.

См. также saveState().

QByteArray QHeaderView::saveState() const

Сохраняет текущее состояние этого представления заголовка.

Для восстановления сохранённого состояния передайте возвращаемое значение в restoreState().

Эта функция была добавлена в Qt 4.3.

См. также restoreState().

int QHeaderView::sectionPosition(int logicalIndex) const

Возвращает позицию секции для данного logicalIndex, или -1, если секция скрыта. Позиция измеряется в пикселях от левого верхнего угла первого видимого элемента до левого верхнего угла элемента с logicalIndex. Измерение выполняется по оси x для горизонтальных заголовков и по оси y для вертикальных заголовков.

См. также sectionViewportPosition().

QHeaderView::ResizeMode QHeaderView::sectionResizeMode(int logicalIndex) const

Возвращает режим изменения размера, который применяется к секции, указанной заданным logicalIndex.

Эта функция была добавлена в Qt 5.0.

См. также setSectionResizeMode().

int QHeaderView::sectionSize(int logicalIndex) const

Возвращает ширину (или высоту для вертикальных заголовков) заданного logicalIndex.

См. также length(), setSectionResizeMode(), и defaultSectionSize().

[virtual protected] QSize QHeaderView::sectionSizeFromContents(int logicalIndex) const

Возвращает размер содержимого секции, заданной заданным logicalIndex.

См. также defaultSectionSize().

int QHeaderView::sectionSizeHint(int logicalIndex) const

Возвращает подходящий размер подсказки для секции, указанной logicalIndex.

Qt::SizeHintRole

См. также sizeHint(), defaultSectionSize(), minimumSectionSize(), и maximumSectionSize().

int QHeaderView::sectionViewportPosition(int logicalIndex) const

Возвращает позицию области просмотра секции для данного logicalIndex.

Если секция скрыта, возвращаемое значение не определено.

См. также sectionPosition() и isSectionHidden().

bool QHeaderView::sectionsClickable() const

Возвращает true если заголовок нажимаем; в противном случае возвращает false. Нажимаемый заголовок может быть настроен для изменения представления данных в представлении, связанных с заголовком.

Эта функция была добавлена в Qt 5.0.

См. также setSectionsClickable().

bool QHeaderView::sectionsHidden() const

Возвращает true если секции в заголовке скрыты; в противном случае возвращает false;

Эта функция была добавлена в Qt 4.1.

См. также setSectionHidden().

bool QHeaderView::sectionsMovable() const

Возвращает true если пользователь может перемещать заголовок; в противном случае возвращает false.

По умолчанию, секции перемещаемы в QTreeView (кроме первой), и не перемещаемы в QTableView.

Данная функция была введена в Qt 5.0.

См. также setSectionsMovable().

bool QHeaderView::sectionsMoved() const

Возвращает true если секции в заголовке были перемещены; в противном случае возвращает false.

См. также moveSection().

[override virtual] void QHeaderView::setModel(QAbstractItemModel *model)

Реализует: QAbstractItemView::setModel(QAbstractItemModel *model).

void QHeaderView::setResizeContentsPrecision(int precision)

Устанавливает точность, с которой QHeaderView должен рассчитывать размер при использовании ResizeToContents. Низкое значение обеспечит менее точный, но быстрый автоматический размер, в то время как более высокое значение обеспечит более точный, но потенциально медленный расчет.

Число precision указывает, сколько секций следует учитывать при расчете предпочтительного размера.

Значение по умолчанию — 1000, что означает, что горизонтальная колонка с автоматическим изменением размера будет рассматривать максимум 1000 строк при расчете автоматического изменения размера.

Специальное значение 0 означает, что он будет учитывать только видимую область. Специальное значение -1 означает рассмотрение всех элементов.

Это значение используется в QTableView::sizeHintForColumn(), QTableView::sizeHintForRow() и QTreeView::sizeHintForColumn(). Переопределение этих функций может привести к тому, что эта функция не будет иметь эффекта.

Данная функция была введена в Qt 5.2.

См. также resizeContentsPrecision(), setSectionResizeMode(), resizeSections(), QTableView::sizeHintForColumn(), QTableView::sizeHintForRow(), и QTreeView::sizeHintForColumn().

void QHeaderView::setSectionHidden(int logicalIndex, bool hide)

Если hide имеет значение true, секция, указанная logicalIndex, скрывается; в противном случае секция отображается.

См. также isSectionHidden() и hiddenSectionCount().

void QHeaderView::setSectionResizeMode(QHeaderView::ResizeMode mode)

Устанавливает ограничения на изменение размера заголовка, описанные в заданном mode.

Данная функция была введена в Qt 5.0.

См. также sectionResizeMode(), resizeMode(), length(), и sectionResized().

void QHeaderView::setSectionResizeMode(int logicalIndex, QHeaderView::ResizeMode mode)

Устанавливает ограничения на изменение размера секции, указанной logicalIndex в заголовке, описанные в заданном mode. Логический индекс должен существовать в момент вызова этой функции.

Примечание: Это значение будет проигнорировано для последней секции, если свойство stretchLastSection установлено в true. Это значение по умолчанию для горизонтальных заголовков, предоставляемых QTreeView.

Данная функция была введена в Qt 5.0.

См. также setStretchLastSection() и resizeContentsPrecision().

void QHeaderView::setSectionsClickable(bool clickable)

Если clickable имеет значение true, заголовок будет реагировать на одиночные щелчки.

Данная функция была введена в Qt 5.0.

См. также sectionsClickable(), sectionClicked(), sectionPressed(), и setSortIndicatorShown().

void QHeaderView::setSectionsMovable(bool movable)

Если movable имеет значение true, секции заголовка могут быть перемещены пользователем; в противном случае они фиксируются на месте.

При использовании в сочетании с QTreeView первая колонка по умолчанию не может быть перемещена (поскольку она содержит структуру дерева). Можно сделать ее подвижной с помощью setFirstSectionMovable(true).

Данная функция была введена в Qt 5.0.

См. также sectionsMovable(), sectionMoved(), и setFirstSectionMovable().

[override virtual protected] void QHeaderView::setSelection(const QRect &rect, QItemSelectionModel::SelectionFlags flags)

Реализует: QAbstractItemView::setSelection(const QRect &rect, QItemSelectionModel::SelectionFlags flags).

Выделяет элементы в заданном rect в соответствии с указанными flags.

Реализация базового класса ничего не делает.

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

Устанавливает индикатор сортировки для секции, указанной logicalIndex, в направлении, указанном order, и удаляет индикатор сортировки из любой другой секции, которая его отображала.

logicalIndex может быть -1, в этом случае индикатор сортировки не будет отображаться, и модель вернется к своему естественному, несортированному порядку. Обратите внимание, что не все модели поддерживают это и могут даже аварийно завершить работу в этом случае.

См. также sortIndicatorSection() и sortIndicatorOrder().

[override virtual] void QHeaderView::setVisible(bool v)

Реализует: QWidget::setVisible(bool visible).

void QHeaderView::showSection(int logicalIndex)

Отображает секцию, указанную logicalIndex.

См. также hideSection(), isSectionHidden(), hiddenSectionCount(), и setSectionHidden().

[override virtual] QSize QHeaderView::sizeHint() const

Реализует: QAbstractScrollArea::sizeHint() const.

Возвращает подходящий размер подсказки для этого заголовка.

См. также sectionSizeHint().

Qt::SortOrder QHeaderView::sortIndicatorOrder() const

Возвращает порядок индикатора сортировки. Если ни одна секция не имеет индикатора сортировки, возвращаемое значение этой функции не определено.

См. также setSortIndicator() и sortIndicatorSection().

int QHeaderView::sortIndicatorSection() const

Возвращает логический индекс секции, имеющей индикатор сортировки. По умолчанию это секция 0.

См. также setSortIndicator(), sortIndicatorOrder(), и setSortIndicatorShown().

int QHeaderView::stretchSectionCount() const

Возвращает количество секций, установленных в режим изменения размера stretch. В представлениях это можно использовать для определения, нужно ли заголовку изменять размер секций при изменении геометрии представления.

Данная функция была введена в Qt 4.1.

См. также stretchLastSection и resizeMode().

void QHeaderView::swapSections(int first, int second)

Меняет местами секцию с визуальным индексом first и секцию с визуальным индексом second.

Данная функция была введена в Qt 4.2.

См. также moveSection().

[override virtual protected] int QHeaderView::verticalOffset() const

Реализует: QAbstractItemView::verticalOffset() const.

Возвращает вертикальное смещение заголовка. Для горизонтальных заголовков это 0.

См. также offset().

[override virtual protected] bool QHeaderView::viewportEvent(QEvent *e)

Реализует: QAbstractItemView::viewportEvent(QEvent *event).

int QHeaderView::visualIndex(int logicalIndex) const

Возвращает визуальную позицию индекса секции, указанной logicalIndex, или -1 в противном случае.

Скрытые секции все еще имеют допустимые визуальные индексы.

См. также logicalIndex().

int QHeaderView::visualIndexAt(int position) const

Возвращает визуальный индекс секции, которая покрывает данную position в области просмотра.

См. также logicalIndexAt().