Класс QHeaderView

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

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

Открытые типы

Свойства

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

Реализованные публичные функции

Публичные слоты

Сигналы

Защищенные функции

Переопределённые защищённые функции

Защищённые слоты

Подробное описание

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

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

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

Каждый заголовок имеет направление() и определённое количество разделов, задаваемое функцией 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().

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

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

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

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

Создаёт новый общий заголовок с заданной ориентацией и родительским элементом.

[signal] void QHeaderView::geometriesChanged()

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

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

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

Обновляет изменённые разделы заголовка с заданной ориентацией, от 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(), sectionSize() и hideSection().

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

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

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

bool QHeaderView::restoreState(const QByteArray &state)

Восстанавливает 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

Возвращает позицию раздела viewport данного 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(), 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::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

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

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

См. также stretchLastSection.

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().