| Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions | |
The QHeader class provides a header row or column, e.g. for tables and listviews. More...
#include <qheader.h>
Inherits QWidget.
This class provides a header, e.g. a vertical header to display row labels, or a horizontal header to display column labels. It is used by QTable and QListView for example.
A header is composed of one or more sections, each of which can display a text label and an iconset. A sort indicator (an arrow) can also be displayed using setSortIndicator().
Sections are added with addLabel() and removed with removeLabel(). The label and iconset are set in addLabel() and can be changed later with setLabel(). Use count() to retrieve the number of sections in the header.
The orientation of the header is set with setOrientation(). If setStretchEnabled() is TRUE, the sections will expand to take up the full width (height for vertical headers) of the header. The user can resize the sections manually if setResizeEnabled() is TRUE. Call adjustHeaderSize() to have the sections resize to occupy the full width (or height).
A section can be moved with moveSection(). If setMovingEnabled() is TRUE (the default)the user may drag a section from one position to another. If a section is moved, the index positions at which sections were added (with addLabel()), may not be the same after the move. You don't have to worry about this in practice because the QHeader API works in terms of section numbers, so it doesn't matter where a particular section has been moved to.
If you want the current index position of a section call mapToIndex() giving it the section number. (This is the number returned by the addLabel() call which created the section.) If you want to get the section number of a section at a particular index position call mapToSection() giving it the index number.
Here's an example to clarify mapToSection() and mapToIndex():
| Index positions | |||
|---|---|---|---|
| 0 | 1 | 2 | 3 |
| Original section ordering | |||
| Sect 0 | Sect 1 | Sect 2 | Sect 3 |
| Ordering after the user moves a section | |||
| Sect 0 | Sect 2 | Sect 3 | Sect 1 |
| k | mapToSection(k) | mapToIndex(k) |
|---|---|---|
| 0 | 0 | 0 |
| 1 | 2 | 3 |
| 2 | 3 | 1 |
| 3 | 1 | 2 |
In the example above, if we wanted to find out which section is at index position 3 we'd call mapToSection(3) and get a section number of 1 since section 1 was moved. Similarly, if we wanted to know which index position section 2 occupied we'd call mapToIndex(2) and get an index of 1.
QHeader provides the clicked(), pressed() and released() signals. If the user changes the size of a section, the sizeChange() signal is emitted. If you want to have a sizeChange() signal emitted continuously whilst the user is resizing (rather than just after the resizing is finished), use setTracking(). If the user moves a section the indexChange() signal is emitted.
See also QListView, QTable, and Advanced Widgets.
Adds a new section with iconset iconset and label text s. Returns the index position where the section was added (at the right for horizontal headers, at the bottom for vertical headers). The section's width is set to size, unless size is negative in which case the size is calculated taking account of the size of the text.
Adjusts the size of the sections to fit the size of the header as completely as possible. Only sections for which isStretchEnabled() is TRUE will be resized.
Use sectionAt() instead.
Returns the index at which the section is displayed, which contains pos in widget coordinates, or -1 if pos is outside the header sections.
Use sectionPos() instead.
Returns the position in pixels of the section that is displayed at the index i. The position is measured from the start of the header.
Use sectionSize() instead.
Returns the size in pixels of the section that is displayed at the index i.
If isClickEnabled() is TRUE, this signal is emitted when the user clicks section section.
See also pressed() and released().
Returns the number of sections in the header. See the "count" property for details.
This signal is emitted when the user moves section section from index position fromIndex, to index position toIndex.
If section is out of range (negative or larger than count() - 1): returns TRUE if all sections are clickable; otherwise returns FALSE.
See also setClickEnabled().
Returns TRUE if the header sections can be moved; otherwise returns FALSE. See the "moving" property for details.
If section is -1 then this function applies to all sections, i.e. returns TRUE if all sections are resizeable; otherwise returns FALSE.
See also setResizeEnabled().
Returns TRUE if the header sections always take up the full width (or height) of the header; otherwise returns FALSE. See the "stretching" property for details.
Returns TRUE if section section will resize to take up the full width (or height) of the header; otherwise returns FALSE. If at least one section has stretch enabled the sections will always take up the full width of the header.
See also setStretchEnabled().
Example: helpsystem/tooltip.cpp.
Use mapToIndex() instead.
Translates from logical index l to actual index (index at which the section l is displayed) . Returns -1 if l is outside the legal range.
See also mapToLogical().
Warning: If QTable is used to move header sections as a result of user interaction, the mapping exposed by this function will not reflect the order of the headers in the table; i.e., QTable does not call moveSection() to move sections but handles move operations internally.
See also mapToSection().
Use mapToSection() instead.
Translates from actual index a (index at which the section is displayed) to logical index of the section. Returns -1 if a is outside the legal range.
See also mapToActual().
Warning: If QTable is used to move header sections as a result of user interaction, the mapping exposed by this function will not reflect the order of the headers in the table; i.e., QTable does not call moveSection() to move sections but handles move operations internally.
See also mapToIndex().
Use moveSection() instead.
Moves the section that is currently displayed at index fromIdx to index toIdx.
Use indexChange() instead.
This signal is emitted when the user has moved the section which is displayed at the index fromIndex to the index toIndex.
Returns the header's left-most (or top-most) visible pixel. See the "offset" property for details.
Returns the header's orientation. See the "orientation" property for details.
Calls paintSectionLabel().
Called by paintSection()
This signal is emitted when the user presses section section down.
See also released().
This signal is emitted when section section is released.
See also pressed().
See also offset.
Example: helpsystem/tooltip.cpp.
Use clicked() instead.
This signal is emitted when a part of the header is clicked. index is the index at which the section is displayed.
In a list view this signal would typically be connected to a slot that sorts the specified column (or row).
This signal is emitted when the user doubleclicks on the edge (handle) of section section.
See also offset.
Example: helpsystem/tooltip.cpp.
Use resizeSection() instead.
Sets the size of the section section to s pixels.
Warning: does not repaint or send out signals
If section is -1 (the default) then the enable value is set for all existing sections and will be applied to any new sections that are added.
See also moving and setResizeEnabled().
If the section does not exist, nothing happens.
Examples: chart/setdataform.cpp and table/small-table-demo/main.cpp.
Sets the icon for section section to iconset and the text to s. The section's width is set to size if size >= 0; otherwise it is left unchanged.
If the section does not exist, nothing happens.
Sets whether the header sections can be moved. See the "moving" property for details.
Sets the header's left-most (or top-most) visible pixel to pos. See the "offset" property for details.
Sets the header's orientation. See the "orientation" property for details.
If section is negative (the default) then the enable value is set for all existing sections and will be applied to any new sections that are added. Example:
// Allow resizing of all current and future sections
header->setResizeEnabled(TRUE);
// Disable resizing of section 3, (the fourth section added)
header->setResizeEnabled(FALSE, 3);
If the user resizes a section, a sizeChange() signal is emitted.
See also moving, setClickEnabled(), and tracking.
Sets a sort indicator onto the specified section. The indicator's order is either Ascending or Descending.
Only one section can show a sort indicator at any one time. If you don't want any section to show a sort indicator pass a section number of -1.
See also sortIndicatorSection() and sortIndicatorOrder().
This function is obsolete. It is provided to keep old source working. We strongly advise against using it in new code.
Use the other overload instead.
If section is -1, and if b is TRUE, then all sections will be resized equally when the header is resized so that they take up the full width (or height for vertical headers) of the header; otherwise all the sections will be set to be unstretchable and will not resize when the header is resized.
See also adjustHeaderSize().
Sets whether the header sections always take up the full width (or height) of the header to b. See the "stretching" property for details.
Sets whether the sizeChange() signal is emitted continuously to enable. See the "tracking" property for details.
This signal is emitted when the user has changed the size of a section from oldSize to newSize. This signal is typically connected to a slot that repaints the table or list that contains the header.
See also setSortIndicator() and sortIndicatorSection().
See also setSortIndicator() and sortIndicatorOrder().
Returns TRUE if the sizeChange() signal is emitted continuously; otherwise returns FALSE. See the "tracking" property for details.
This property holds the number of sections in the header.
Get this property's value with count().
This property holds whether the header sections can be moved.
If this property is TRUE (the default) the user can move sections. If the user moves a section the indexChange() signal is emitted.
See also setClickEnabled() and setResizeEnabled().
Set this property's value with setMovingEnabled() and get this property's value with isMovingEnabled().
This property holds the header's left-most (or top-most) visible pixel.
Setting this property will scroll the header so that offset becomes the left-most (or top-most for vertical headers) visible pixel.
Set this property's value with setOffset() and get this property's value with offset().
This property holds the header's orientation.
The orientation is either Vertical or Horizontal (the default).
Call setOrientation() before adding labels if you don't provide a size parameter otherwise the sizes will be incorrect.
Set this property's value with setOrientation() and get this property's value with orientation().
This property holds whether the header sections always take up the full width (or height) of the header.
Set this property's value with setStretchEnabled() and get this property's value with isStretchEnabled().
This property holds whether the sizeChange() signal is emitted continuously.
If tracking is on, the sizeChange() signal is emitted continuously while the mouse is moved (i.e. when the header is resized), otherwise it is only emitted when the mouse button is released at the end of resizing.
Tracking defaults to FALSE.
Set this property's value with setTracking() and get this property's value with tracking().
This file is part of the Qt toolkit. Copyright © 1995-2007 Trolltech. All Rights Reserved.
| Copyright © 2007 Trolltech | Trademarks | Qt 3.3.8
|