Home · All Classes · Modules

QHeaderView Class Reference
^{^{[QtGui module]}}

The QHeaderView class provides a header row or header column for item views. More...

Inherits QAbstractItemView.

Types

enum ResizeMode { Interactive, Fixed, Stretch, ResizeToContents, Custom }

Methods

__init__ (self, Qt.Orientation orientation, QWidget parent = None)
bool cascadingSectionResizes (self)
int count (self)
currentChanged (self, QModelIndex current, QModelIndex old)
dataChanged (self, QModelIndex topLeft, QModelIndex bottomRight)
Qt.Alignment defaultAlignment (self)
int defaultSectionSize (self)
bool event (self, QEvent e)
headerDataChanged (self, Qt.Orientation orientation, int logicalFirst, int logicalLast)
int hiddenSectionCount (self)
hideSection (self, int alogicalIndex)
bool highlightSections (self)
int horizontalOffset (self)
QModelIndex indexAt (self, QPoint p)
initialize (self)
initializeSections (self)
initializeSections (self, int start, int end)
initStyleOption (self, QStyleOptionHeader option)
bool isClickable (self)
bool isIndexHidden (self, QModelIndex index)
bool isMovable (self)
bool isSectionHidden (self, int logicalIndex)
bool isSortIndicatorShown (self)
int length (self)
int logicalIndex (self, int visualIndex)
int logicalIndexAt (self, int position)
int logicalIndexAt (self, int ax, int ay)
int logicalIndexAt (self, QPoint apos)
int minimumSectionSize (self)
mouseDoubleClickEvent (self, QMouseEvent e)
mouseMoveEvent (self, QMouseEvent e)
mousePressEvent (self, QMouseEvent e)
mouseReleaseEvent (self, QMouseEvent e)
QModelIndex moveCursor (self, QAbstractItemView.CursorAction, Qt.KeyboardModifiers)
moveSection (self, int from, int to)
int offset (self)
Qt.Orientation orientation (self)
paintEvent (self, QPaintEvent e)
paintSection (self, QPainter painter, QRect rect, int logicalIndex)
reset (self)
ResizeMode resizeMode (self, int logicalIndex)
resizeSection (self, int logicalIndex, int size)
resizeSections (self)
resizeSections (self, ResizeMode mode)
bool restoreState (self, QByteArray state)
rowsInserted (self, QModelIndex parent, int start, int end)
QByteArray saveState (self)
scrollContentsBy (self, int dx, int dy)
scrollTo (self, QModelIndex index, QAbstractItemView.ScrollHint hint)
int sectionPosition (self, int logicalIndex)
sectionsAboutToBeRemoved (self, QModelIndex parent, int logicalFirst, int logicalLast)
bool sectionsHidden (self)
sectionsInserted (self, QModelIndex parent, int logicalFirst, int logicalLast)
int sectionSize (self, int logicalIndex)
QSize sectionSizeFromContents (self, int logicalIndex)
int sectionSizeHint (self, int logicalIndex)
bool sectionsMoved (self)
int sectionViewportPosition (self, int logicalIndex)
setCascadingSectionResizes (self, bool enable)
setClickable (self, bool clickable)
setDefaultAlignment (self, Qt.Alignment alignment)
setDefaultSectionSize (self, int size)
setHighlightSections (self, bool highlight)
setMinimumSectionSize (self, int size)
setModel (self, QAbstractItemModel model)
setMovable (self, bool movable)
setOffset (self, int offset)
setOffsetToLastSection (self)
setOffsetToSectionPosition (self, int visualIndex)
setResizeMode (self, ResizeMode mode)
setResizeMode (self, int logicalIndex, ResizeMode mode)
setSectionHidden (self, int logicalIndex, bool hide)
setSelection (self, QRect, QItemSelectionModel.SelectionFlags)
setSortIndicator (self, int logicalIndex, Qt.SortOrder order)
setSortIndicatorShown (self, bool show)
setStretchLastSection (self, bool stretch)
showSection (self, int alogicalIndex)
QSize sizeHint (self)
Qt.SortOrder sortIndicatorOrder (self)
int sortIndicatorSection (self)
bool stretchLastSection (self)
int stretchSectionCount (self)
swapSections (self, int first, int second)
updateGeometries (self)
updateSection (self, int logicalIndex)
int verticalOffset (self)
bool viewportEvent (self, QEvent e)
int visualIndex (self, int logicalIndex)
int visualIndexAt (self, int position)
QRect visualRect (self, QModelIndex index)
QRegion visualRegionForSelection (self, QItemSelection selection)

Special Methods

__len__ (self)

Qt Signals

void geometriesChanged ()
void sectionAutoResize (int,QHeaderView::ResizeMode)
void sectionClicked (int)
void sectionCountChanged (int,int)
void sectionDoubleClicked (int)
void sectionEntered (int)
void sectionHandleDoubleClicked (int)
void sectionMoved (int,int,int)
void sectionPressed (int)
void sectionResized (int,int,int)
void sortIndicatorChanged (int,Qt::SortOrder)

Detailed Description

The QHeaderView class provides a header row or header column for item views.

A QHeaderView displays the headers used in item views such as the QTableView and QTreeView classes. It takes the place of Qt3's QHeader class previously used for the same purpose, but uses the Qt's model/view architecture for consistency with the item view classes.

The QHeaderView class is one of the Model/View Classes and is part of Qt's model/view framework.

The header gets the data for each section from the model using the QAbstractItemModel.headerData() function. You can set the data by using QAbstractItemModel.setHeaderData().

Each header has an orientation() and a number of sections, given by the count() function. A section refers to a part of the header - either a row or a column, depending on the orientation.

Sections can be moved and resized using moveSection() and resizeSection(); they can also be hidden and shown with hideSection() and showSection().

Each section of a header is described by a section ID, specified by its section(), and can be located at a particular visualIndex() in the header. A section can have a sort indicator set with setSortIndicator(); this indicates whether the items in the associated item view will be sorted in the order given by the section.

For a horizontal header the section is equivalent to a column in the model, and for a vertical header the section is equivalent to a row in the model.

Moving Header Sections

A header can be fixed in place, or made movable with setMovable(). It can be made clickable with setClickable(), and has resizing behavior in accordance with setResizeMode().

Note: Double-clicking on a header to resize a section only applies for visible rows.

A header will emit sectionMoved() if the user moves a section, sectionResized() if the user resizes a section, and sectionClicked() as well as sectionHandleDoubleClicked() in response to mouse clicks. A header will also emit sectionCountChanged() and sectionAutoResize().

You can identify a section using the logicalIndex() and logicalIndexAt() functions, or by its index position, using the visualIndex() and visualIndexAt() functions. The visual index will change if a section is moved, but the logical index will not change.

Appearance

QTableWidget and QTableView create default headers. If you want the headers to be visible, you can use setVisible().

Not all ItemDataRoles will have an effect on a QHeaderView. If you need to draw other roles, you can subclass QHeaderView and reimplement paintEvent(). QHeaderView respects the following item data roles: TextAlignmentRole, DisplayRole, FontRole, DecorationRole, ForegroundRole, and BackgroundRole.

Note: Each header renders the data for each section itself, and does not rely on a delegate. As a result, calling a header's setItemDelegate() function will have no effect.

Type Documentation

QHeaderView.ResizeMode

The resize mode specifies the behavior of the header sections. It can be set on the entire header view or on individual sections using setResizeMode().

Constant	Value	Description
`QHeaderView.Interactive`	`0`	The user can resize the section. The section can also be resized programmatically using resizeSection(). The section size defaults to defaultSectionSize. (See also cascadingSectionResizes.)
`QHeaderView.Fixed`	`2`	The user cannot resize the section. The section can only be resized programmatically using resizeSection(). The section size defaults to defaultSectionSize.
`QHeaderView.Stretch`	`1`	QHeaderView will automatically resize the section to fill the available space. The size cannot be changed by the user or programmatically.
`QHeaderView.ResizeToContents`	`3`	QHeaderView will automatically resize the section to its optimal size based on the contents of the entire column or row. The size cannot be changed by the user or programmatically. (This value was introduced in 4.2)

The following values are obsolete:

Constant	Value	Description
`QHeaderView.Custom`	`Fixed`	Use Fixed instead.

See also setResizeMode(), stretchLastSection, and minimumSectionSize.

Method Documentation

QHeaderView.init (self, Qt.Orientation orientation, QWidget parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

Creates a new generic header with the given orientation and parent.

bool QHeaderView.cascadingSectionResizes (self)

int QHeaderView.count (self)

Returns the number of sections in the header.

QHeaderView.currentChanged (self, QModelIndex current, QModelIndex old)

Reimplemented from QAbstractItemView.currentChanged().

QHeaderView.dataChanged (self, QModelIndex topLeft, QModelIndex bottomRight)

Qt.Alignment QHeaderView.defaultAlignment (self)

int QHeaderView.defaultSectionSize (self)

bool QHeaderView.event (self, QEvent e)

Reimplemented from QObject.event().

QHeaderView.headerDataChanged (self, Qt.Orientation orientation, int logicalFirst, int logicalLast)

This method is also a Qt slot with the C++ signature void headerDataChanged(Qt::Orientation,int,int).

Updates the changed header sections with the given orientation, from logicalFirst to logicalLast inclusive.

int QHeaderView.hiddenSectionCount (self)

Returns the number of sections in the header that has been hidden.

This function was introduced in Qt 4.1.

QHeaderView.hideSection (self, int alogicalIndex)

Hides the section specified by logicalIndex.

bool QHeaderView.highlightSections (self)

int QHeaderView.horizontalOffset (self)

Reimplemented from QAbstractItemView.horizontalOffset().

Returns the horizontal offset of the header. This is 0 for vertical headers.

See also offset().

QModelIndex QHeaderView.indexAt (self, QPoint p)

QHeaderView.initialize (self)

QHeaderView.initializeSections (self)

QHeaderView.initializeSections (self, int start, int end)

QHeaderView.initStyleOption (self, QStyleOptionHeader option)

Initialize option with the values from this QHeaderView. This method is useful for subclasses when they need a QStyleOptionHeader, but do not want to fill in all the information themselves.

See also QStyleOption.initFrom().

bool QHeaderView.isClickable (self)

Returns true if the header is clickable; otherwise returns false. A clickable header could be set up to allow the user to change the representation of the data in the view related to the header.

See also setClickable().

bool QHeaderView.isIndexHidden (self, QModelIndex index)

bool QHeaderView.isMovable (self)

Returns true if the header can be moved by the user; otherwise returns false.

See also setMovable().

bool QHeaderView.isSectionHidden (self, int logicalIndex)

Returns true if the section specified by logicalIndex is explicitly hidden from the user; otherwise returns false.

bool QHeaderView.isSortIndicatorShown (self)

int QHeaderView.length (self)

Returns the length along the orientation of the header.

int QHeaderView.logicalIndex (self, int visualIndex)

Returns the logicalIndex for the section at the given visualIndex position, or -1 if visualIndex < 0 or visualIndex >= QHeaderView.count().

Note that the visualIndex is not affected by hidden sections.

See also visualIndex() and sectionPosition().

int QHeaderView.logicalIndexAt (self, int position)

Returns the section that covers the given position in the viewport.

int QHeaderView.logicalIndexAt (self, int ax, int ay)

Returns the logical index of the section at the given coordinate. If the header is horizontal x will be used, otherwise y will be used to find the logical index.

int QHeaderView.logicalIndexAt (self, QPoint apos)

Returns the logical index of the section at the position given in pos. If the header is horizontal the x-coordinate will be used, otherwise the y-coordinate will be used to find the logical index.

See also sectionPosition().

int QHeaderView.minimumSectionSize (self)

QModelIndex QHeaderView.moveCursor (self, QAbstractItemView.CursorAction, Qt.KeyboardModifiers)

QHeaderView.moveSection (self, int from, int to)

Moves the section at visual index from to occupy visual index to.

See also sectionsMoved().

int QHeaderView.offset (self)

Returns the offset of the header: this is the header's left-most (or top-most for vertical headers) visible pixel.

See also setOffset().

Qt.Orientation QHeaderView.orientation (self)

Returns the orientation of the header.

See also Qt.Orientation.

QHeaderView.paintEvent (self, QPaintEvent e)

Reimplemented from QWidget.paintEvent().

QHeaderView.paintSection (self, QPainter painter, QRect rect, int logicalIndex)

Paints the section specified by the given logicalIndex, using the given painter and rect.

Normally, you do not have to call this function.

QHeaderView.reset (self)

Reimplemented from QAbstractItemView.reset().

ResizeMode QHeaderView.resizeMode (self, int logicalIndex)

Returns the resize mode that applies to the section specified by the given logicalIndex.

See also setResizeMode().

QHeaderView.resizeSection (self, int logicalIndex, int size)

Resizes the section specified by logicalIndex to size measured in pixels.

QHeaderView.resizeSections (self)

This method is also a Qt slot with the C++ signature void resizeSections().

Resizes the sections according to the given mode, ignoring the current resize mode.

QHeaderView.resizeSections (self, ResizeMode mode)

Resizes the sections according to their size hints. Normally, you do not have to call this function.

bool QHeaderView.restoreState (self, QByteArray state)

Restores the state of this header view. This function returns true if the state was restored; otherwise returns false.

This function was introduced in Qt 4.3.

See also saveState().

QHeaderView.rowsInserted (self, QModelIndex parent, int start, int end)

QByteArray QHeaderView.saveState (self)

Saves the current state of this header view.

To restore the saved state, pass the return value to restoreState().

This function was introduced in Qt 4.3.

See also restoreState().

QHeaderView.scrollContentsBy (self, int dx, int dy)

QHeaderView.scrollTo (self, QModelIndex index, QAbstractItemView.ScrollHint hint)

int QHeaderView.sectionPosition (self, int logicalIndex)

Returns the section position of the given logicalIndex, or -1 if the section is hidden. The position is measured in pixels from the first visible item's top-left corner to the top-left corner of the item with logicalIndex. The measurement is along the x-axis for horizontal headers and along the y-axis for vertical headers.

See also sectionViewportPosition().

QHeaderView.sectionsAboutToBeRemoved (self, QModelIndex parent, int logicalFirst, int logicalLast)

This method is also a Qt slot with the C++ signature void sectionsAboutToBeRemoved(const QModelIndex&,int,int).

This slot is called when sections are removed from the parent. logicalFirst and logicalLast signify where the sections were removed.

If only one section is removed, logicalFirst and logicalLast will be the same.

bool QHeaderView.sectionsHidden (self)

Returns true if sections in the header has been hidden; otherwise returns false;

This function was introduced in Qt 4.1.

See also setSectionHidden().

QHeaderView.sectionsInserted (self, QModelIndex parent, int logicalFirst, int logicalLast)

This method is also a Qt slot with the C++ signature void sectionsInserted(const QModelIndex&,int,int).

This slot is called when sections are inserted into the parent. logicalFirst and logicalLast indices signify where the new sections were inserted.

If only one section is inserted, logicalFirst and logicalLast will be the same.

int QHeaderView.sectionSize (self, int logicalIndex)

Returns the width (or height for vertical headers) of the given logicalIndex.

QSize QHeaderView.sectionSizeFromContents (self, int logicalIndex)

Returns the size of the contents of the section specified by the given logicalIndex.

See also defaultSectionSize().

int QHeaderView.sectionSizeHint (self, int logicalIndex)

Returns a suitable size hint for the section specified by logicalIndex.

bool QHeaderView.sectionsMoved (self)

Returns true if sections in the header has been moved; otherwise returns false;

See also moveSection().

int QHeaderView.sectionViewportPosition (self, int logicalIndex)

Returns the section viewport position of the given logicalIndex.

If the section is hidden, the return value is undefined.

QHeaderView.setCascadingSectionResizes (self, bool enable)

QHeaderView.setClickable (self, bool clickable)

If clickable is true, the header will respond to single clicks.

QHeaderView.setDefaultAlignment (self, Qt.Alignment alignment)

QHeaderView.setDefaultSectionSize (self, int size)

QHeaderView.setHighlightSections (self, bool highlight)

QHeaderView.setMinimumSectionSize (self, int size)

QHeaderView.setModel (self, QAbstractItemModel model)

Reimplemented from QAbstractItemView.setModel().

QHeaderView.setMovable (self, bool movable)

If movable is true, the header may be moved by the user; otherwise it is fixed in place.

QHeaderView.setOffset (self, int offset)

This method is also a Qt slot with the C++ signature void setOffset(int).

Sets the header's offset to offset.

See also offset() and length().

QHeaderView.setOffsetToLastSection (self)

This method is also a Qt slot with the C++ signature void setOffsetToLastSection().

Sets the offset to make the last section visible.

This function was introduced in Qt 4.2.

QHeaderView.setOffsetToSectionPosition (self, int visualIndex)

This method is also a Qt slot with the C++ signature void setOffsetToSectionPosition(int).

Sets the offset to the start of the section at the given visualIndex.

This function was introduced in Qt 4.2.

QHeaderView.setResizeMode (self, ResizeMode mode)

Sets the constraints on how the header can be resized to those described by the given mode.

See also resizeMode(), length(), sectionResized(), and sectionAutoResize().

QHeaderView.setResizeMode (self, int logicalIndex, ResizeMode mode)

This is an overloaded function.

Sets the constraints on how the section specified by logicalIndex in the header can be resized to those described by the given mode. The logical index should exist at the time this function is called.

Note: This setting will be ignored for the last section if the stretchLastSection property is set to true. This is the default for the horizontal headers provided by QTreeView.

See also setStretchLastSection().

QHeaderView.setSectionHidden (self, int logicalIndex, bool hide)

If hide is true the section specified by logicalIndex is hidden; otherwise the section is shown.

QHeaderView.setSelection (self, QRect, QItemSelectionModel.SelectionFlags)

Reimplemented from QAbstractItemView.setSelection().

Selects the items in the given rect according to the specified flags.

The base class implementation does nothing.

QHeaderView.setSortIndicator (self, int logicalIndex, Qt.SortOrder order)

Sets the sort indicator for the section specified by the given logicalIndex in the direction specified by order, and removes the sort indicator from any other section that was showing it.

logicalIndex may be -1, in which case no sort indicator will be shown and the model will return to its natural, unsorted order. Note that not all models support this and may even crash in this case.

See also sortIndicatorSection() and sortIndicatorOrder().