diff options
Diffstat (limited to 'doc/html/tqiconview.html')
| -rw-r--r-- | doc/html/tqiconview.html | 92 |
1 files changed, 46 insertions, 46 deletions
diff --git a/doc/html/tqiconview.html b/doc/html/tqiconview.html index d88419e5c..d20c38a1b 100644 --- a/doc/html/tqiconview.html +++ b/doc/html/tqiconview.html @@ -50,7 +50,7 @@ body { background: #ffffff; color: black; } <li class=fn>TQIconViewItem * <a href="#lastItem"><b>lastItem</b></a> () const</li> <li class=fn>TQIconViewItem * <a href="#currentItem"><b>currentItem</b></a> () const</li> <li class=fn>virtual void <a href="#setCurrentItem"><b>setCurrentItem</b></a> ( TQIconViewItem * item )</li> -<li class=fn>virtual void <a href="#setSelected"><b>setSelected</b></a> ( TQIconViewItem * item, bool s, bool cb = FALSE )</li> +<li class=fn>virtual void <a href="#setSelected"><b>setSelected</b></a> ( TQIconViewItem * item, bool s, bool cb = false )</li> <li class=fn>uint <a href="#count"><b>count</b></a> () const</li> <li class=fn>virtual void <a href="#setSelectionMode"><b>setSelectionMode</b></a> ( SelectionMode m )</li> <li class=fn>SelectionMode <a href="#selectionMode"><b>selectionMode</b></a> () const</li> @@ -87,20 +87,20 @@ body { background: #ffffff; color: black; } <li class=fn>bool <a href="#autoArrange"><b>autoArrange</b></a> () const</li> <li class=fn>virtual void <a href="#setShowToolTips"><b>setShowToolTips</b></a> ( bool b )</li> <li class=fn>bool <a href="#showToolTips"><b>showToolTips</b></a> () const</li> -<li class=fn>void <a href="#setSorting"><b>setSorting</b></a> ( bool sort, bool ascending = TRUE )</li> +<li class=fn>void <a href="#setSorting"><b>setSorting</b></a> ( bool sort, bool ascending = true )</li> <li class=fn>bool <a href="#sorting"><b>sorting</b></a> () const</li> <li class=fn>bool <a href="#sortDirection"><b>sortDirection</b></a> () const</li> <li class=fn>virtual void <a href="#setItemsMovable"><b>setItemsMovable</b></a> ( bool b )</li> <li class=fn>bool <a href="#itemsMovable"><b>itemsMovable</b></a> () const</li> <li class=fn>virtual void <a href="#setWordWrapIconText"><b>setWordWrapIconText</b></a> ( bool b )</li> <li class=fn>bool <a href="#wordWrapIconText"><b>wordWrapIconText</b></a> () const</li> -<li class=fn>virtual void <a href="#sort"><b>sort</b></a> ( bool ascending = TRUE )</li> +<li class=fn>virtual void <a href="#sort"><b>sort</b></a> ( bool ascending = true )</li> <li class=fn>bool <a href="#isRenaming"><b>isRenaming</b></a> () const</li> </ul> <h2>Public Slots</h2> <ul> -<li class=fn>virtual void <a href="#arrangeItemsInGrid"><b>arrangeItemsInGrid</b></a> ( const TQSize & grid, bool update = TRUE )</li> -<li class=fn>virtual void <a href="#arrangeItemsInGrid-2"><b>arrangeItemsInGrid</b></a> ( bool update = TRUE )</li> +<li class=fn>virtual void <a href="#arrangeItemsInGrid"><b>arrangeItemsInGrid</b></a> ( const TQSize & grid, bool update = true )</li> +<li class=fn>virtual void <a href="#arrangeItemsInGrid-2"><b>arrangeItemsInGrid</b></a> ( bool update = true )</li> </ul> <h2>Signals</h2> <ul> @@ -195,7 +195,7 @@ For example: <p> The <a href="tqiconviewitem.html">TQIconViewItem</a> call passes a pointer to the TQIconView we wish to populate, along with the label text and a <a href="tqpixmap.html">TQPixmap</a>. <p> When an item is inserted the TQIconView allocates a position for it. -Existing items are rearranged if <a href="#autoArrange">autoArrange</a>() is TRUE. The +Existing items are rearranged if <a href="#autoArrange">autoArrange</a>() is true. The default arrangement is <a href="#Arrangement-enum">LeftToRight</a> -- the TQIconView fills up the <em>left-most</em> column from top to bottom, then moves one column <em>right</em> and fills that from top to bottom and so on. The @@ -286,8 +286,8 @@ reimplement <a href="tqiconviewitem.html#acceptDrop">TQIconViewItem::acceptDrop< bool MyIconViewItem::acceptDrop( const <a href="tqmimesource.html">TQMimeSource</a> *mime ) const { if ( mime-><a href="tqmimesource.html#provides">provides</a>( "text/plain" ) ) - return TRUE; - return FALSE; + return true; + return false; } void MyIconViewItem::dropped( <a href="tqdropevent.html">TQDropEvent</a> *evt, const <a href="tqvaluelist.html">TQValueList</a><TQIconDragItem>& ) @@ -396,21 +396,21 @@ Destroys the icon view and deletes all items. Adjusts the positions of the items to the geometry of the icon view. -<h3 class=fn>void <a name="arrangeItemsInGrid"></a>TQIconView::arrangeItemsInGrid ( const <a href="tqsize.html">TQSize</a> & grid, bool update = TRUE )<tt> [virtual slot]</tt> +<h3 class=fn>void <a name="arrangeItemsInGrid"></a>TQIconView::arrangeItemsInGrid ( const <a href="tqsize.html">TQSize</a> & grid, bool update = true )<tt> [virtual slot]</tt> </h3> This variant uses <em>grid</em> instead of (<a href="#gridX">gridX</a>(), <a href="#gridY">gridY</a>()). If <em>grid</em> is invalid (see <a href="tqsize.html#isValid">TQSize::isValid</a>()), <a href="#arrangeItemsInGrid">arrangeItemsInGrid</a>() calculates a valid grid itself and uses that. -<p> If <em>update</em> is TRUE (the default) the viewport is repainted. +<p> If <em>update</em> is true (the default) the viewport is repainted. <p>Example: <a href="fileiconview-example.html#x807">fileiconview/tqfileiconview.h</a>. -<h3 class=fn>void <a name="arrangeItemsInGrid-2"></a>TQIconView::arrangeItemsInGrid ( bool update = TRUE )<tt> [virtual slot]</tt> +<h3 class=fn>void <a name="arrangeItemsInGrid-2"></a>TQIconView::arrangeItemsInGrid ( bool update = true )<tt> [virtual slot]</tt> </h3> This is an overloaded member function, provided for convenience. It behaves essentially like the above function. <p> Arranges all the items in the grid given by <a href="#gridX">gridX</a>() and <a href="#gridY">gridY</a>(). <p> Even if <a href="#sorting">sorting</a>() is enabled, the items are not sorted by this function. If you want to sort or rearrange the items, use iconview->sort(iconview->sortDirection()). -<p> If <em>update</em> is TRUE (the default), the viewport is repainted as +<p> If <em>update</em> is true (the default), the viewport is repainted as well. <p> <p>See also <a href="#gridX-prop">TQIconView::gridX</a>, <a href="#gridY-prop">TQIconView::gridY</a>, and <a href="#sort">TQIconView::sort</a>(). @@ -418,7 +418,7 @@ well. </h3><p>Returns the arrangement mode of the icon view. See the <a href="tqiconview.html#arrangement-prop">"arrangement"</a> property for details. <h3 class=fn>bool <a name="autoArrange"></a>TQIconView::autoArrange () const -</h3><p>Returns TRUE if the icon view rearranges its items when a new item is inserted; otherwise returns FALSE. +</h3><p>Returns true if the icon view rearranges its items when a new item is inserted; otherwise returns false. See the <a href="tqiconview.html#autoArrange-prop">"autoArrange"</a> property for details. <h3 class=fn>void <a name="clear"></a>TQIconView::clear ()<tt> [virtual]</tt> </h3> @@ -602,8 +602,8 @@ mode. <h3 class=fn>bool <a name="isRenaming"></a>TQIconView::isRenaming () const </h3> -Returns TRUE if an iconview item is being renamed; otherwise -returns FALSE. +Returns true if an iconview item is being renamed; otherwise +returns false. <h3 class=fn>void <a name="itemRenamed"></a>TQIconView::itemRenamed ( <a href="tqiconviewitem.html">TQIconViewItem</a> * item, const <a href="tqstring.html">TQString</a> & name )<tt> [signal]</tt> </h3> @@ -626,7 +626,7 @@ See the <a href="tqiconview.html#itemTextBackground-prop">"itemTextBackground"</ </h3><p>Returns the position where the text of each item is drawn. See the <a href="tqiconview.html#itemTextPos-prop">"itemTextPos"</a> property for details. <h3 class=fn>bool <a name="itemsMovable"></a>TQIconView::itemsMovable () const -</h3><p>Returns TRUE if the user is allowed to move items around in the icon view; otherwise returns FALSE. +</h3><p>Returns true if the user is allowed to move items around in the icon view; otherwise returns false. See the <a href="tqiconview.html#itemsMovable-prop">"itemsMovable"</a> property for details. <h3 class=fn><a href="tqiconviewitem.html">TQIconViewItem</a> * <a name="lastItem"></a>TQIconView::lastItem () const </h3> @@ -748,8 +748,8 @@ coordinate system (<a href="tqmouseevent.html#globalPos">TQMouseEvent::globalPos <h3 class=fn>void <a name="selectAll"></a>TQIconView::selectAll ( bool select )<tt> [virtual]</tt> </h3> In Multi and Extended modes, this function sets all items to be -selected if <em>select</em> is TRUE, and to be unselected if <em>select</em> -is FALSE. +selected if <em>select</em> is true, and to be unselected if <em>select</em> +is false. <p> In Single and NoSelection modes, this function only changes the selection status of <a href="#currentItem">currentItem</a>(). @@ -803,19 +803,19 @@ See the <a href="tqiconview.html#maxItemWidth-prop">"maxItemWidth"</a> property <h3 class=fn>void <a name="setResizeMode"></a>TQIconView::setResizeMode ( <a href="tqiconview.html#ResizeMode-enum">ResizeMode</a> am )<tt> [virtual]</tt> </h3><p>Sets the resize mode of the icon view to <em>am</em>. See the <a href="tqiconview.html#resizeMode-prop">"resizeMode"</a> property for details. -<h3 class=fn>void <a name="setSelected"></a>TQIconView::setSelected ( <a href="tqiconviewitem.html">TQIconViewItem</a> * item, bool s, bool cb = FALSE )<tt> [virtual]</tt> +<h3 class=fn>void <a name="setSelected"></a>TQIconView::setSelected ( <a href="tqiconviewitem.html">TQIconViewItem</a> * item, bool s, bool cb = false )<tt> [virtual]</tt> </h3> Selects or unselects <em>item</em> depending on <em>s</em>, and may also unselect other items, depending on <a href="#selectionMode">TQIconView::selectionMode</a>() and <em>cb</em>. -<p> If <em>s</em> is FALSE, <em>item</em> is unselected. -<p> If <em>s</em> is TRUE and TQIconView::selectionMode() is <a href="#SelectionMode-enum">Single</a>, <em>item</em> is selected, and the item which was selected is unselected. -<p> If <em>s</em> is TRUE and TQIconView::selectionMode() is <a href="#SelectionMode-enum">Extended</a>, <em>item</em> is selected. If <em>cb</em> is TRUE, the selection state of the -icon view's other items is left unchanged. If <em>cb</em> is FALSE (the +<p> If <em>s</em> is false, <em>item</em> is unselected. +<p> If <em>s</em> is true and TQIconView::selectionMode() is <a href="#SelectionMode-enum">Single</a>, <em>item</em> is selected, and the item which was selected is unselected. +<p> If <em>s</em> is true and TQIconView::selectionMode() is <a href="#SelectionMode-enum">Extended</a>, <em>item</em> is selected. If <em>cb</em> is true, the selection state of the +icon view's other items is left unchanged. If <em>cb</em> is false (the default) all other items are unselected. -<p> If <em>s</em> is TRUE and TQIconView::selectionMode() is <a href="#SelectionMode-enum">Multi</a> <em>item</em> +<p> If <em>s</em> is true and TQIconView::selectionMode() is <a href="#SelectionMode-enum">Multi</a> <em>item</em> is selected. -<p> Note that <em>cb</em> is used only if TQIconView::selectionMode() is <a href="#SelectionMode-enum">Extended</a>. <em>cb</em> defaults to FALSE. +<p> Note that <em>cb</em> is used only if TQIconView::selectionMode() is <a href="#SelectionMode-enum">Extended</a>. <em>cb</em> defaults to false. <p> All items whose selection status is changed repaint themselves. <h3 class=fn>void <a name="setSelectionMode"></a>TQIconView::setSelectionMode ( <a href="tqiconview.html#SelectionMode-enum">SelectionMode</a> m )<tt> [virtual]</tt> @@ -824,14 +824,14 @@ See the <a href="tqiconview.html#selectionMode-prop">"selectionMode"</a> propert <h3 class=fn>void <a name="setShowToolTips"></a>TQIconView::setShowToolTips ( bool b )<tt> [virtual]</tt> </h3><p>Sets whether the icon view will display a tool tip with the complete text for any truncated item text to <em>b</em>. See the <a href="tqiconview.html#showToolTips-prop">"showToolTips"</a> property for details. -<h3 class=fn>void <a name="setSorting"></a>TQIconView::setSorting ( bool sort, bool ascending = TRUE ) +<h3 class=fn>void <a name="setSorting"></a>TQIconView::setSorting ( bool sort, bool ascending = true ) </h3> -If <em>sort</em> is TRUE, this function sets the icon view to sort items -when a new item is inserted. If <em>sort</em> is FALSE, the icon view +If <em>sort</em> is true, this function sets the icon view to sort items +when a new item is inserted. If <em>sort</em> is false, the icon view will not be sorted. -<p> Note that <a href="#autoArrange">autoArrange</a>() must be TRUE for sorting to take place. -<p> If <em>ascending</em> is TRUE (the default), items are sorted in -ascending order. If <em>ascending</em> is FALSE, items are sorted in +<p> Note that <a href="#autoArrange">autoArrange</a>() must be true for sorting to take place. +<p> If <em>ascending</em> is true (the default), items are sorted in +ascending order. If <em>ascending</em> is false, items are sorted in descending order. <p> <a href="tqiconviewitem.html#compare">TQIconViewItem::compare</a>() is used to compare pairs of items. The sorting is based on the items' keys; these default to the items' @@ -845,7 +845,7 @@ See the <a href="tqiconview.html#spacing-prop">"spacing"</a> property for detail </h3><p>Sets whether the item text will be word-wrapped if it is too long to <em>b</em>. See the <a href="tqiconview.html#wordWrapIconText-prop">"wordWrapIconText"</a> property for details. <h3 class=fn>bool <a name="showToolTips"></a>TQIconView::showToolTips () const -</h3><p>Returns TRUE if the icon view will display a tool tip with the complete text for any truncated item text; otherwise returns FALSE. +</h3><p>Returns true if the icon view will display a tool tip with the complete text for any truncated item text; otherwise returns false. See the <a href="tqiconview.html#showToolTips-prop">"showToolTips"</a> property for details. <h3 class=fn>void <a name="slotUpdate"></a>TQIconView::slotUpdate ()<tt> [virtual protected slot]</tt> </h3> @@ -856,9 +856,9 @@ many items are inserted in a loop the icon view is probably redrawn only once at the end of the loop. This makes the insertions both flicker-free and faster. -<h3 class=fn>void <a name="sort"></a>TQIconView::sort ( bool ascending = TRUE )<tt> [virtual]</tt> +<h3 class=fn>void <a name="sort"></a>TQIconView::sort ( bool ascending = true )<tt> [virtual]</tt> </h3> -Sorts and rearranges all the items in the icon view. If <em>ascending</em> is TRUE, the items are sorted in increasing order, +Sorts and rearranges all the items in the icon view. If <em>ascending</em> is true, the items are sorted in increasing order, otherwise they are sorted in decreasing order. <p> <a href="tqiconviewitem.html#compare">TQIconViewItem::compare</a>() is used to compare pairs of items. The sorting is based on the items' keys; these default to the items' @@ -867,10 +867,10 @@ text unless specifically set to something else. <p> <p>See also <a href="tqiconviewitem.html#key">TQIconViewItem::key</a>(), <a href="tqiconviewitem.html#setKey">TQIconViewItem::setKey</a>(), <a href="tqiconviewitem.html#compare">TQIconViewItem::compare</a>(), <a href="#setSorting">TQIconView::setSorting</a>(), and <a href="#sortDirection-prop">TQIconView::sortDirection</a>. <h3 class=fn>bool <a name="sortDirection"></a>TQIconView::sortDirection () const -</h3><p>Returns TRUE if the sort direction for inserting new items is ascending;; otherwise returns FALSE. +</h3><p>Returns true if the sort direction for inserting new items is ascending;; otherwise returns false. See the <a href="tqiconview.html#sortDirection-prop">"sortDirection"</a> property for details. <h3 class=fn>bool <a name="sorting"></a>TQIconView::sorting () const -</h3><p>Returns TRUE if the icon view sorts on insertion; otherwise returns FALSE. +</h3><p>Returns true if the icon view sorts on insertion; otherwise returns false. See the <a href="tqiconview.html#sorting-prop">"sorting"</a> property for details. <h3 class=fn>int <a name="spacing"></a>TQIconView::spacing () const </h3><p>Returns the space in pixels between icon view items. @@ -888,7 +888,7 @@ should normally not need to call this function because an item is to delete it. <h3 class=fn>bool <a name="wordWrapIconText"></a>TQIconView::wordWrapIconText () const -</h3><p>Returns TRUE if the item text will be word-wrapped if it is too long; otherwise returns FALSE. +</h3><p>Returns true if the item text will be word-wrapped if it is too long; otherwise returns false. See the <a href="tqiconview.html#wordWrapIconText-prop">"wordWrapIconText"</a> property for details. <hr><h2>Property Documentation</h2> <h3 class=fn><a href="tqiconview.html#Arrangement-enum">Arrangement</a> <a name="arrangement-prop"></a>arrangement</h3> @@ -898,7 +898,7 @@ See the <a href="tqiconview.html#wordWrapIconText-prop">"wordWrapIconText"</a> p <p>Set this property's value with <a href="#setArrangement">setArrangement</a>() and get this property's value with <a href="#arrangement">arrangement</a>(). <h3 class=fn>bool <a name="autoArrange-prop"></a>autoArrange</h3> <p>This property holds whether the icon view rearranges its items when a new item is inserted. -<p>The default is TRUE. +<p>The default is true. <p> Note that if the icon view is not visible at the time of insertion, TQIconView defers all position-related work until it is shown and then calls <a href="#arrangeItemsInGrid">arrangeItemsInGrid</a>(). @@ -934,7 +934,7 @@ normal icon view background is used. <p>Set this property's value with <a href="#setItemTextPos">setItemTextPos</a>() and get this property's value with <a href="#itemTextPos">itemTextPos</a>(). <h3 class=fn>bool <a name="itemsMovable-prop"></a>itemsMovable</h3> <p>This property holds whether the user is allowed to move items around in the icon view. -<p>The default is TRUE. +<p>The default is true. <p>Set this property's value with <a href="#setItemsMovable">setItemsMovable</a>() and get this property's value with <a href="#itemsMovable">itemsMovable</a>(). <h3 class=fn>int <a name="maxItemTextLength-prop"></a>maxItemTextLength</h3> @@ -962,20 +962,20 @@ See <a href="#ResizeMode-enum">ResizeMode</a>. <p>Set this property's value with <a href="#setSelectionMode">setSelectionMode</a>() and get this property's value with <a href="#selectionMode">selectionMode</a>(). <h3 class=fn>bool <a name="showToolTips-prop"></a>showToolTips</h3> <p>This property holds whether the icon view will display a tool tip with the complete text for any truncated item text. -<p>The default is TRUE. Note that this has no effect if -<a href="#setWordWrapIconText">setWordWrapIconText</a>() is TRUE, as it is by default. +<p>The default is true. Note that this has no effect if +<a href="#setWordWrapIconText">setWordWrapIconText</a>() is true, as it is by default. <p>Set this property's value with <a href="#setShowToolTips">setShowToolTips</a>() and get this property's value with <a href="#showToolTips">showToolTips</a>(). <h3 class=fn>bool <a name="sortDirection-prop"></a>sortDirection</h3> <p>This property holds whether the sort direction for inserting new items is ascending;. -<p>The default is TRUE (i.e. ascending). This sort direction is only -meaningful if both <a href="#sorting">sorting</a>() and <a href="#autoArrange">autoArrange</a>() are TRUE. +<p>The default is true (i.e. ascending). This sort direction is only +meaningful if both <a href="#sorting">sorting</a>() and <a href="#autoArrange">autoArrange</a>() are true. <p> To set the sort direction, use <a href="#setSorting">setSorting</a>() <p>Get this property's value with <a href="#sortDirection">sortDirection</a>(). <h3 class=fn>bool <a name="sorting-prop"></a>sorting</h3> <p>This property holds whether the icon view sorts on insertion. -<p>The default is FALSE, i.e. no sorting on insertion. +<p>The default is false, i.e. no sorting on insertion. <p> To set the sorting, use <a href="#setSorting">setSorting</a>(). <p>Get this property's value with <a href="#sorting">sorting</a>(). @@ -987,8 +987,8 @@ meaningful if both <a href="#sorting">sorting</a>() and <a href="#autoArrange">a <p>Set this property's value with <a href="#setSpacing">setSpacing</a>() and get this property's value with <a href="#spacing">spacing</a>(). <h3 class=fn>bool <a name="wordWrapIconText-prop"></a>wordWrapIconText</h3> <p>This property holds whether the item text will be word-wrapped if it is too long. -<p>The default is TRUE. -<p> If this property is FALSE, icon text that is too long is +<p>The default is true. +<p> If this property is false, icon text that is too long is truncated, and an ellipsis (...) appended to indicate that truncation has occurred. The full text can still be seen by the user if they hover the mouse because the full text is shown in a |