diff options
Diffstat (limited to 'doc/man/man3/tqheader.3qt')
| -rw-r--r-- | doc/man/man3/tqheader.3qt | 44 |
1 files changed, 22 insertions, 22 deletions
diff --git a/doc/man/man3/tqheader.3qt b/doc/man/man3/tqheader.3qt index 3c9a7d65b..69b0b0198 100644 --- a/doc/man/man3/tqheader.3qt +++ b/doc/man/man3/tqheader.3qt @@ -142,7 +142,7 @@ Inherits TQWidget. .BI "virtual void moveCell ( int fromIdx, int toIdx ) \fI(obsolete)\fR" .br .ti -1c -.BI "void setSortIndicator ( int section, bool ascending = TRUE ) \fI(obsolete)\fR" +.BI "void setSortIndicator ( int section, bool ascending = true ) \fI(obsolete)\fR" .br .ti -1c .BI "void \fBsetSortIndicator\fR ( int section, SortOrder order )" @@ -232,9 +232,9 @@ A header is composed of one or more \fIsections\fR, each of which can display a .PP 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. .PP -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). +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). .PP -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 TQHeader API works in terms of section numbers, so it doesn't matter where a particular section has been moved to. +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 TQHeader API works in terms of section numbers, so it doesn't matter where a particular section has been moved to. .PP 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. .PP @@ -280,7 +280,7 @@ This is an overloaded member function, provided for convenience. It behaves esse .PP Adds a new section with iconset \fIiconset\fR and label text \fIs\fR. 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 \fIsize\fR, unless size is negative in which case the size is calculated taking account of the size of the text. .SH "void TQHeader::adjustHeaderSize ()" -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. +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. .SH "int TQHeader::cellAt ( int pos ) const" \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. .PP @@ -300,7 +300,7 @@ Use sectionSize() instead. .PP Returns the size in pixels of the section that is displayed at the index \fIi\fR. .SH "void TQHeader::clicked ( int section )\fC [signal]\fR" -If isClickEnabled() is TRUE, this signal is emitted when the user clicks section \fIsection\fR. +If isClickEnabled() is true, this signal is emitted when the user clicks section \fIsection\fR. .PP See also pressed() and released(). .SH "int TQHeader::count () const" @@ -312,25 +312,25 @@ Returns the icon set for section \fIsection\fR. If the section does not exist, 0 .SH "void TQHeader::indexChange ( int section, int fromIndex, int toIndex )\fC [signal]\fR" This signal is emitted when the user moves section \fIsection\fR from index position \fIfromIndex\fR, to index position \fItoIndex\fR. .SH "bool TQHeader::isClickEnabled ( int section = -1 ) const" -Returns TRUE if section \fIsection\fR is clickable; otherwise returns FALSE. +Returns true if section \fIsection\fR is clickable; otherwise returns false. .PP -If \fIsection\fR is out of range (negative or larger than count() - 1): returns TRUE if all sections are clickable; otherwise returns FALSE. +If \fIsection\fR is out of range (negative or larger than count() - 1): returns true if all sections are clickable; otherwise returns false. .PP See also setClickEnabled(). .SH "bool TQHeader::isMovingEnabled () const" -Returns TRUE if the header sections can be moved; otherwise returns FALSE. See the "moving" property for details. +Returns true if the header sections can be moved; otherwise returns false. See the "moving" property for details. .SH "bool TQHeader::isResizeEnabled ( int section = -1 ) const" -Returns TRUE if section \fIsection\fR is resizeable; otherwise returns FALSE. +Returns true if section \fIsection\fR is resizeable; otherwise returns false. .PP -If \fIsection\fR is -1 then this function applies to all sections, i.e. returns TRUE if all sections are resizeable; otherwise returns FALSE. +If \fIsection\fR is -1 then this function applies to all sections, i.e. returns true if all sections are resizeable; otherwise returns false. .PP See also setResizeEnabled(). .SH "bool TQHeader::isStretchEnabled () const" -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 the header sections always take up the full width (or height) of the header; otherwise returns false. See the "stretching" property for details. .SH "bool TQHeader::isStretchEnabled ( int section ) const" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP -Returns TRUE if section \fIsection\fR 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. +Returns true if section \fIsection\fR 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. .PP See also setStretchEnabled(). .SH "TQString TQHeader::label ( int section ) const" @@ -440,7 +440,7 @@ Sets the size of the section \fIsection\fR to \fIs\fR pixels. .PP \fBWarning:\fR does not repaint or send out signals .SH "void TQHeader::setClickEnabled ( bool enable, int section = -1 )\fC [virtual]\fR" -If \fIenable\fR is TRUE, any clicks on section \fIsection\fR will result in clicked() signals being emitted; otherwise the section will ignore clicks. +If \fIenable\fR is true, any clicks on section \fIsection\fR will result in clicked() signals being emitted; otherwise the section will ignore clicks. .PP If \fIsection\fR is -1 (the default) then the \fIenable\fR value is set for all existing sections and will be applied to any new sections that are added. .PP @@ -465,7 +465,7 @@ Sets the header's left-most (or top-most) visible pixel to \fIpos\fR. See the "o .SH "void TQHeader::setOrientation ( Orientation )\fC [virtual]\fR" Sets the header's orientation. See the "orientation" property for details. .SH "void TQHeader::setResizeEnabled ( bool enable, int section = -1 )\fC [virtual]\fR" -If \fIenable\fR is TRUE the user may resize section \fIsection\fR; otherwise the section may not be manually resized. +If \fIenable\fR is true the user may resize section \fIsection\fR; otherwise the section may not be manually resized. .PP If \fIsection\fR is negative (the default) then the \fIenable\fR value is set for all existing sections and will be applied to any new sections that are added. Example: .PP @@ -473,11 +473,11 @@ If \fIsection\fR is negative (the default) then the \fIenable\fR value is set fo .br // Allow resizing of all current and future sections .br - header->setResizeEnabled(TRUE); + header->setResizeEnabled(true); .br // Disable resizing of section 3, (the fourth section added) .br - header->setResizeEnabled(FALSE, 3); + header->setResizeEnabled(false, 3); .br .fi .PP @@ -490,16 +490,16 @@ Sets a sort indicator onto the specified \fIsection\fR. The indicator's \fIorder 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 \fIsection\fR number of -1. .PP See also sortIndicatorSection() and sortIndicatorOrder(). -.SH "void TQHeader::setSortIndicator ( int section, bool ascending = TRUE )" +.SH "void TQHeader::setSortIndicator ( int section, bool ascending = true )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. .PP Use the other overload instead. .SH "void TQHeader::setStretchEnabled ( bool b, int section )\fC [virtual]\fR" -If \fIb\fR is TRUE, section \fIsection\fR will be resized when the header is resized, so that the sections take up the full width (or height for vertical headers) of the header; otherwise section \fIsection\fR will be set to be unstretchable and will not resize when the header is resized. +If \fIb\fR is true, section \fIsection\fR will be resized when the header is resized, so that the sections take up the full width (or height for vertical headers) of the header; otherwise section \fIsection\fR will be set to be unstretchable and will not resize when the header is resized. .PP -If \fIsection\fR is -1, and if \fIb\fR 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. +If \fIsection\fR is -1, and if \fIb\fR 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. .PP See also adjustHeaderSize(). .SH "void TQHeader::setStretchEnabled ( bool b )" @@ -517,7 +517,7 @@ Returns the section showing the sort indicator or -1 if there is no sort indicat .PP See also setSortIndicator() and sortIndicatorOrder(). .SH "bool TQHeader::tracking () const" -Returns TRUE if the sizeChange() signal is emitted continuously; otherwise returns FALSE. See the "tracking" property for details. +Returns true if the sizeChange() signal is emitted continuously; otherwise returns false. See the "tracking" property for details. .SS "Property Documentation" .SH "int count" This property holds the number of sections in the header. @@ -526,7 +526,7 @@ Get this property's value with count(). .SH "bool moving" This property holds whether the header sections can be moved. .PP -If this property is TRUE (the default) the user can move sections. If the user moves a section the indexChange() signal is emitted. +If this property is true (the default) the user can move sections. If the user moves a section the indexChange() signal is emitted. .PP See also setClickEnabled() and setResizeEnabled(). .PP @@ -554,7 +554,7 @@ This property holds whether the sizeChange() signal is emitted continuously. .PP 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. .PP -Tracking defaults to FALSE. +Tracking defaults to false. .PP Set this property's value with setTracking() and get this property's value with tracking(). |