diff options
Diffstat (limited to 'doc/html/tqheader.html')
| -rw-r--r-- | doc/html/tqheader.html | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/doc/html/tqheader.html b/doc/html/tqheader.html index 59ff7f6e4..d7ea9920a 100644 --- a/doc/html/tqheader.html +++ b/doc/html/tqheader.html @@ -80,7 +80,7 @@ tables and listviews. <li class=fn>int mapToActual ( int l ) const <em>(obsolete)</em></li> <li class=fn>void <a href="#moveSection"><b>moveSection</b></a> ( int section, int toIndex )</li> <li class=fn>virtual void moveCell ( int fromIdx, int toIdx ) <em>(obsolete)</em></li> -<li class=fn>void setSortIndicator ( int section, bool ascending = TRUE ) <em>(obsolete)</em></li> +<li class=fn>void setSortIndicator ( int section, bool ascending = true ) <em>(obsolete)</em></li> <li class=fn>void <a href="#setSortIndicator"><b>setSortIndicator</b></a> ( int section, SortOrder order )</li> <li class=fn>int <a href="#sortIndicatorSection"><b>sortIndicatorSection</b></a> () const</li> <li class=fn>SortOrder <a href="#sortIndicatorOrder"><b>sortIndicatorOrder</b></a> () const</li> @@ -134,13 +134,13 @@ The label and iconset are set in addLabel() and can be changed later with <a href="#setLabel">setLabel</a>(). Use <a href="#count">count</a>() to retrieve the number of sections in the header. <p> The orientation of the header is set with <a href="#setOrientation">setOrientation</a>(). If -<a href="#setStretchEnabled">setStretchEnabled</a>() is TRUE, the sections will expand to take up +<a href="#setStretchEnabled">setStretchEnabled</a>() 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 <a href="#setResizeEnabled">setResizeEnabled</a>() is -TRUE. Call <a href="#adjustHeaderSize">adjustHeaderSize</a>() to have the sections resize to +true. Call <a href="#adjustHeaderSize">adjustHeaderSize</a>() to have the sections resize to occupy the full width (or height). <p> A section can be moved with <a href="#moveSection">moveSection</a>(). If <a href="#setMovingEnabled">setMovingEnabled</a>() -is TRUE (the default)the user may drag a section from one position +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 <a href="#addLabel">addLabel</a>()), may not be the same after the move. You don't have to worry about this in practice because the @@ -218,7 +218,7 @@ the text. <p> Adjusts the size of the sections to fit the size of the header as completely as possible. Only sections for which <a href="#isStretchEnabled">isStretchEnabled</a>() -is TRUE will be resized. +is true will be resized. <h3 class=fn>int <a name="cellAt"></a>TQHeader::cellAt ( int pos ) const </h3> @@ -245,7 +245,7 @@ the index <em>i</em>. <h3 class=fn>void <a name="clicked"></a>TQHeader::clicked ( int section )<tt> [signal]</tt> </h3> -<p> If <a href="#isClickEnabled">isClickEnabled</a>() is TRUE, this signal is emitted when the user +<p> If <a href="#isClickEnabled">isClickEnabled</a>() is true, this signal is emitted when the user clicks section <em>section</em>. <p> <p>See also <a href="#pressed">pressed</a>() and <a href="#released">released</a>(). @@ -269,33 +269,33 @@ index position <em>fromIndex</em>, to index position <em>toIndex</em>. <h3 class=fn>bool <a name="isClickEnabled"></a>TQHeader::isClickEnabled ( int section = -1 ) const </h3> -Returns TRUE if section <em>section</em> is clickable; otherwise returns -FALSE. +Returns true if section <em>section</em> is clickable; otherwise returns +false. <p> If <em>section</em> is out of range (negative or larger than <a href="#count">count</a>() - -1): returns TRUE if all sections are clickable; otherwise returns -FALSE. +1): returns true if all sections are clickable; otherwise returns +false. <p> <p>See also <a href="#setClickEnabled">setClickEnabled</a>(). <h3 class=fn>bool <a name="isMovingEnabled"></a>TQHeader::isMovingEnabled () const -</h3><p>Returns TRUE if the header sections can be moved; otherwise returns FALSE. +</h3><p>Returns true if the header sections can be moved; otherwise returns false. See the <a href="tqheader.html#moving-prop">"moving"</a> property for details. <h3 class=fn>bool <a name="isResizeEnabled"></a>TQHeader::isResizeEnabled ( int section = -1 ) const </h3> -Returns TRUE if section <em>section</em> is resizeable; otherwise -returns FALSE. +Returns true if section <em>section</em> is resizeable; otherwise +returns false. <p> If <em>section</em> is -1 then this function applies to all sections, -i.e. returns TRUE if all sections are resizeable; otherwise -returns FALSE. +i.e. returns true if all sections are resizeable; otherwise +returns false. <p> <p>See also <a href="#setResizeEnabled">setResizeEnabled</a>(). <h3 class=fn>bool <a name="isStretchEnabled"></a>TQHeader::isStretchEnabled () const -</h3><p>Returns TRUE if the header sections always take up the full width (or height) of the header; otherwise returns FALSE. +</h3><p>Returns true if the header sections always take up the full width (or height) of the header; otherwise returns false. See the <a href="tqheader.html#stretching-prop">"stretching"</a> property for details. <h3 class=fn>bool <a name="isStretchEnabled-2"></a>TQHeader::isStretchEnabled ( int section ) const </h3> This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -<p> Returns TRUE if section <em>section</em> will resize to take up the full -width (or height) of the header; otherwise returns FALSE. If at +<p> Returns true if section <em>section</em> 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. <p> <p>See also <a href="#setStretchEnabled">setStretchEnabled</a>(). @@ -447,7 +447,7 @@ Returns the width (or height) of the <em>section</em> in pixels. <h3 class=fn>void <a name="setClickEnabled"></a>TQHeader::setClickEnabled ( bool enable, int section = -1 )<tt> [virtual]</tt> </h3> -If <em>enable</em> is TRUE, any clicks on section <em>section</em> will result +If <em>enable</em> is true, any clicks on section <em>section</em> will result in <a href="#clicked">clicked</a>() signals being emitted; otherwise the section will ignore clicks. <p> If <em>section</em> is -1 (the default) then the <em>enable</em> value is set @@ -483,7 +483,7 @@ See the <a href="tqheader.html#offset-prop">"offset"</a> property for details. See the <a href="tqheader.html#orientation-prop">"orientation"</a> property for details. <h3 class=fn>void <a name="setResizeEnabled"></a>TQHeader::setResizeEnabled ( bool enable, int section = -1 )<tt> [virtual]</tt> </h3> -If <em>enable</em> is TRUE the user may resize section <em>section</em>; +If <em>enable</em> is true the user may resize section <em>section</em>; otherwise the section may not be manually resized. <p> If <em>section</em> is negative (the default) then the <em>enable</em> value is set for all existing sections and will be applied to any new @@ -491,9 +491,9 @@ sections that are added. Example: <pre> // Allow resizing of all current and future sections - header->setResizeEnabled(TRUE); + header->setResizeEnabled(true); // Disable resizing of section 3, (the fourth section added) - header->setResizeEnabled(FALSE, 3); + header->setResizeEnabled(false, 3); </pre> <p> If the user resizes a section, a <a href="#sizeChange">sizeChange</a>() signal is emitted. @@ -509,18 +509,18 @@ don't want any section to show a sort indicator pass a <em>section</em> number of -1. <p> <p>See also <a href="#sortIndicatorSection">sortIndicatorSection</a>() and <a href="#sortIndicatorOrder">sortIndicatorOrder</a>(). -<h3 class=fn>void <a name="setSortIndicator-2"></a>TQHeader::setSortIndicator ( int section, bool ascending = TRUE ) +<h3 class=fn>void <a name="setSortIndicator-2"></a>TQHeader::setSortIndicator ( int section, bool ascending = true ) </h3> This is an overloaded member function, provided for convenience. It behaves essentially like the above function. <p> <b>This function is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code. <p> Use the other overload instead. <h3 class=fn>void <a name="setStretchEnabled"></a>TQHeader::setStretchEnabled ( bool b, int section )<tt> [virtual]</tt> </h3> -If <em>b</em> is TRUE, section <em>section</em> will be resized when the +If <em>b</em> is true, section <em>section</em> 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 <em>section</em> will be set to be unstretchable and will not resize when the header is resized. -<p> If <em>section</em> is -1, and if <em>b</em> is TRUE, then all sections will +<p> If <em>section</em> is -1, and if <em>b</em> 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 @@ -551,7 +551,7 @@ Returns the section showing the sort indicator or -1 if there is no sort indicat <p> <p>See also <a href="#setSortIndicator">setSortIndicator</a>() and <a href="#sortIndicatorOrder">sortIndicatorOrder</a>(). <h3 class=fn>bool <a name="tracking"></a>TQHeader::tracking () const -</h3><p>Returns TRUE if the <a href="#sizeChange">sizeChange</a>() signal is emitted continuously; otherwise returns FALSE. +</h3><p>Returns true if the <a href="#sizeChange">sizeChange</a>() signal is emitted continuously; otherwise returns false. See the <a href="tqheader.html#tracking-prop">"tracking"</a> property for details. <hr><h2>Property Documentation</h2> <h3 class=fn>int <a name="count-prop"></a>count</h3> @@ -560,7 +560,7 @@ See the <a href="tqheader.html#tracking-prop">"tracking"</a> property for detail <p>Get this property's value with <a href="#count">count</a>(). <h3 class=fn>bool <a name="moving-prop"></a>moving</h3> <p>This property holds whether the header sections can be moved. -<p>If this property is TRUE (the default) the user can move sections. +<p>If this property is true (the default) the user can move sections. If the user moves a section the <a href="#indexChange">indexChange</a>() signal is emitted. <p> <p>See also <a href="#setClickEnabled">setClickEnabled</a>() and <a href="#setResizeEnabled">setResizeEnabled</a>(). @@ -590,7 +590,7 @@ size parameter otherwise the sizes will be incorrect. 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. -<p> Tracking defaults to FALSE. +<p> Tracking defaults to false. <p>Set this property's value with <a href="#setTracking">setTracking</a>() and get this property's value with <a href="#tracking">tracking</a>(). <!-- eof --> |