Класс QHeaderView

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

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

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

Свойства

• 16 свойств, унаследованных от QAbstractItemView
• 3 свойства, унаследованных от QAbstractScrollArea
• 6 свойств, унаследованных от QFrame
• 59 свойств, унаследованных от QWidget
• 1 свойство, унаследованное от QObject

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

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

• 60 публичных функций, унаследованных от QAbstractItemView
• 20 публичных функций, унаследованных от QAbstractScrollArea
• 14 публичных функций, унаследованных от QFrame
• 214 публичных функций, унаследованных от QWidget
• 31 публичных функций, унаследованных от QObject
• 14 публичных функций, унаследованных от QPaintDevice

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

• 9 публичных слотов, унаследованных от QAbstractItemView
• 19 публичных слотов, унаследованных от QWidget
• 1 публичный слот, унаследованный от QObject

Сигналы

• 7 сигналов, унаследованных от QAbstractItemView
• 3 сигнала, унаследованных от QWidget
• 2 сигнала, унаследованных от QObject

Статические публичные члены

• 5 статических публичных членов, унаследованных от QWidget
• 9 статических публичных членов, унаследованных от QObject

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

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

• 38 защищённых функций, унаследованных от QAbstractItemView
• 20 защищённых функций, унаследованных от QAbstractScrollArea
• 4 защищённых функций, унаследованных от QFrame
• 35 защищённых функций, унаследованных от QWidget
• 9 защищённых функций, унаследованных от QObject
• 1 защищённая функция, унаследованная от QPaintDevice

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

• 9 защищённых слотов, унаследованных от QAbstractItemView
• 1 защищённый слот, унаследованный от QWidget

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

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

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

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

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

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

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

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

[virtual] QHeaderView::~QHeaderView()

Уничтожает заголовок.

int QHeaderView::count() const

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

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

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

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

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

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

[signal] void QHeaderView::geometriesChanged()

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

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

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

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

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

Возвращает горизонтальное смещение заголовка. Для вертикальных заголовков оно равно 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

Возвращает logicalIndex для секции в заданной позиции 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().

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

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

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

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

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

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

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

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

[protected slot] void QHeaderView::resizeSections()

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

bool QHeaderView::restoreState(const QByteArray &state)

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

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

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

QByteArray QHeaderView::saveState() const

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

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

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

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

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

int QHeaderView::sectionPosition(int logicalIndex) const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

bool QHeaderView::sectionsClickable() const

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

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

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

bool QHeaderView::sectionsHidden() const

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

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

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

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

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

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

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

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

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

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

Переопределено из QAbstractItemView::setSelection().

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

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

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

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

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

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

void QHeaderView::setVisible(bool v)

Переопределено из QWidget::setVisible().

void QHeaderView::showSection(int logicalIndex)

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

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

QSize QHeaderView::sizeHint() const

Переопределено из QAbstractScrollArea::sizeHint().

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

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

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

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

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

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

Qt::SortOrder QHeaderView::sortIndicatorOrder() const

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

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

int QHeaderView::sortIndicatorSection() const

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

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

int QHeaderView::stretchSectionCount() const

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

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

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

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

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

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

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

int QHeaderView::verticalOffset() const

Переопределено из QAbstractItemView::verticalOffset().

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

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

bool QHeaderView::viewportEvent(QEvent *e)

Переопределено из QAbstractItemView::viewportEvent().

int QHeaderView::visualIndex(int logicalIndex) const

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

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

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

int QHeaderView::visualIndexAt(int position) const

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

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