Класс QHeaderView

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

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

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

Свойства

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

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

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

• 57 общедоступные функции, унаследованные от QAbstractItemView
• 20 общедоступные функции, унаследованные от QAbstractScrollArea
• 14 общедоступные функции, унаследованные от QFrame
• 211 общедоступные функции, унаследованные от QWidget
• 31 общедоступные функции, унаследованные от 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().

Каждый заголовок имеет 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 = 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

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

Восстанавливает 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 истинно, то раздел, указанный 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 истинно, заголовок будет реагировать на одиночные щелчки.

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

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

void QHeaderView::setSectionsMovable(bool movable)

Если movable истинно, заголовок может быть перемещен пользователем; в противном случае он закреплён на месте.

Эта функция была добавлена в 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().