Класс QHeaderView

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

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

Типы публичного доступа

Свойства

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

Публичные функции

Реализованные общедоступные функции

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

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

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

Сигналы

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

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

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

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

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

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

Дополнительные унаследованные члены

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

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

Класс 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().

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

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

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

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

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

[virtual] QHeaderView::~QHeaderView()

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

int QHeaderView::count() const

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

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

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

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

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

Переопределено из QObject::event().

[signal] void QHeaderView::geometriesChanged()

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

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

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

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

int QHeaderView::hiddenSectionCount() const

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

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

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

void QHeaderView::hideSection(int logicalIndex)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

int QHeaderView::offset() const

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

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

Qt::Orientation QHeaderView::orientation() const

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

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

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

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

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

Отрисовывает раздел, указанный заданным logicalIndex, используя заданный painter и rect.

Как правило, вам не нужно вызывать эту функцию.

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

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

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.

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

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

bool QHeaderView::sectionsMoved() const

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

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

[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(ResizeMode mode)

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

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

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

void QHeaderView::setSectionResizeMode(int logicalIndex, 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, заголовок может быть перемещён пользователем; в противном случае он фиксирован.

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

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

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

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

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

void QHeaderView::showSection(int logicalIndex)

Отображает раздел, указанный logicalIndex.

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

[virtual] QSize QHeaderView::sizeHint() const

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

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

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

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

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

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

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

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

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

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

int QHeaderView::visualIndex(int logicalIndex) const

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

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

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

int QHeaderView::visualIndexAt(int position) const

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

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