Класс QHeaderView

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

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

Общие типы

Свойства

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

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

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

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

Открытые слоты

• 9 открытых слотов, унаследованных от QAbstractItemView
• 19 открытых слотов, унаследованных от QWidget
• 1 открытый слот, унаследованный от QObject

Сигналы

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

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

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

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

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

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

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

• 1 открытая переменная, унаследованная от QObject
• 5 статические открытые члены, унаследованные от QWidget
• 10 статических открытых членов, унаследованных от QObject
• 2 защищенные переменные, унаследованные от QObject
• 1 защищенный тип, унаследованный от QPaintDevice

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

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

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

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

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

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

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

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

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

void QHeaderView::showSection(int logicalIndex)

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

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

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

Переопределено из QAbstractScrollArea::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().

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

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

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

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

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

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

int QHeaderView::visualIndex(int logicalIndex) const

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

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

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

int QHeaderView::visualIndexAt(int position) const

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

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