diff options
Diffstat (limited to 'doc/man/man3/tqiconview.3qt')
| -rw-r--r-- | doc/man/man3/tqiconview.3qt | 78 |
1 files changed, 39 insertions, 39 deletions
diff --git a/doc/man/man3/tqiconview.3qt b/doc/man/man3/tqiconview.3qt index acde42dc0..d435a9321 100644 --- a/doc/man/man3/tqiconview.3qt +++ b/doc/man/man3/tqiconview.3qt @@ -55,7 +55,7 @@ Inherits QScrollView. .BI "virtual void \fBsetCurrentItem\fR ( QIconViewItem * item )" .br .ti -1c -.BI "virtual void \fBsetSelected\fR ( QIconViewItem * item, bool s, bool cb = FALSE )" +.BI "virtual void \fBsetSelected\fR ( QIconViewItem * item, bool s, bool cb = false )" .br .ti -1c .BI "uint \fBcount\fR () const" @@ -166,7 +166,7 @@ Inherits QScrollView. .BI "bool \fBshowToolTips\fR () const" .br .ti -1c -.BI "void \fBsetSorting\fR ( bool sort, bool ascending = TRUE )" +.BI "void \fBsetSorting\fR ( bool sort, bool ascending = true )" .br .ti -1c .BI "bool \fBsorting\fR () const" @@ -187,7 +187,7 @@ Inherits QScrollView. .BI "bool \fBwordWrapIconText\fR () const" .br .ti -1c -.BI "virtual void \fBsort\fR ( bool ascending = TRUE )" +.BI "virtual void \fBsort\fR ( bool ascending = true )" .br .ti -1c .BI "bool \fBisRenaming\fR () const" @@ -196,10 +196,10 @@ Inherits QScrollView. .SS "Public Slots" .in +1c .ti -1c -.BI "virtual void \fBarrangeItemsInGrid\fR ( const QSize & grid, bool update = TRUE )" +.BI "virtual void \fBarrangeItemsInGrid\fR ( const QSize & grid, bool update = true )" .br .ti -1c -.BI "virtual void \fBarrangeItemsInGrid\fR ( bool update = TRUE )" +.BI "virtual void \fBarrangeItemsInGrid\fR ( bool update = true )" .br .in -1c .SS "Signals" @@ -384,7 +384,7 @@ The simplest way to create a QIconView is to create a QIconView object and creat .PP The QIconViewItem call passes a pointer to the QIconView we wish to populate, along with the label text and a QPixmap. .PP -When an item is inserted the QIconView allocates a position for it. Existing items are rearranged if autoArrange() is TRUE. The default arrangement is LeftToRight -- the QIconView fills up the \fIleft-most\fR column from top to bottom, then moves one column \fIright\fR and fills that from top to bottom and so on. The arrangement can be modified with any of the following approaches: +When an item is inserted the QIconView allocates a position for it. Existing items are rearranged if autoArrange() is true. The default arrangement is LeftToRight -- the QIconView fills up the \fIleft-most\fR column from top to bottom, then moves one column \fIright\fR and fills that from top to bottom and so on. The arrangement can be modified with any of the following approaches: .TP Call setArrangement(), e.g. with TopToBottom which will fill the \fItop-most\fR row from left to right, then moves one row \fIdown\fR and fills that row from left to right and so on. .TP @@ -441,9 +441,9 @@ QIconViews and their QIconViewItems can also be the targets of drag and drops. T .br if ( mime->provides( "text/plain" ) ) .br - return TRUE; + return true; .br - return FALSE; + return false; .br } .br @@ -519,26 +519,26 @@ Constructs an empty icon view called \fIname\fR, with parent \fIparent\fR and us Destroys the icon view and deletes all items. .SH "void QIconView::adjustItems ()\fC [virtual protected slot]\fR" Adjusts the positions of the items to the geometry of the icon view. -.SH "void QIconView::arrangeItemsInGrid ( const QSize & grid, bool update = TRUE )\fC [virtual slot]\fR" +.SH "void QIconView::arrangeItemsInGrid ( const QSize & grid, bool update = true )\fC [virtual slot]\fR" This variant uses \fIgrid\fR instead of (gridX(), gridY()). If \fIgrid\fR is invalid (see QSize::isValid()), arrangeItemsInGrid() calculates a valid grid itself and uses that. .PP -If \fIupdate\fR is TRUE (the default) the viewport is repainted. +If \fIupdate\fR is true (the default) the viewport is repainted. .PP Example: fileiconview/qfileiconview.h. -.SH "void QIconView::arrangeItemsInGrid ( bool update = TRUE )\fC [virtual slot]\fR" +.SH "void QIconView::arrangeItemsInGrid ( bool update = true )\fC [virtual slot]\fR" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Arranges all the items in the grid given by gridX() and gridY(). .PP Even if sorting() is enabled, the items are not sorted by this function. If you want to sort or rearrange the items, use iconview->sort(iconview->sortDirection()). .PP -If \fIupdate\fR is TRUE (the default), the viewport is repainted as well. +If \fIupdate\fR is true (the default), the viewport is repainted as well. .PP See also QIconView::gridX, QIconView::gridY, and QIconView::sort(). .SH "Arrangement QIconView::arrangement () const" Returns the arrangement mode of the icon view. See the "arrangement" property for details. .SH "bool QIconView::autoArrange () const" -Returns TRUE if the icon view rearranges its items when a new item is inserted; otherwise returns FALSE. See the "autoArrange" property for details. +Returns true if the icon view rearranges its items when a new item is inserted; otherwise returns false. See the "autoArrange" property for details. .SH "void QIconView::clear ()\fC [virtual]\fR" Clears the icon view. All items are deleted. .SH "void QIconView::clearSelection ()\fC [virtual]\fR" @@ -646,7 +646,7 @@ Inserts the icon view item \fIitem\fR after \fIafter\fR. If \fIafter\fR is 0, \f .SH "void QIconView::invertSelection ()\fC [virtual]\fR" Inverts the selection. Works only in Multi and Extended selection mode. .SH "bool QIconView::isRenaming () const" -Returns TRUE if an iconview item is being renamed; otherwise returns FALSE. +Returns true if an iconview item is being renamed; otherwise returns false. .SH "void QIconView::itemRenamed ( QIconViewItem * item, const TQString & name )\fC [signal]\fR" This signal is emitted when \fIitem\fR has been renamed to \fIname\fR, usually by in-place renaming. .PP @@ -662,7 +662,7 @@ Returns the brush to use when drawing the background of an item's text. See the .SH "ItemTextPos QIconView::itemTextPos () const" Returns the position where the text of each item is drawn. See the "itemTextPos" property for details. .SH "bool QIconView::itemsMovable () const" -Returns TRUE if the user is allowed to move items around in the icon view; otherwise returns FALSE. See the "itemsMovable" property for details. +Returns true if the user is allowed to move items around in the icon view; otherwise returns false. See the "itemsMovable" property for details. .SH "QIconViewItem * QIconView::lastItem () const" Returns a pointer to the last item of the icon view, or 0 if there are no items in the icon view. .PP @@ -728,7 +728,7 @@ This signal is emitted when the user presses the right mouse button. If \fIitem\ .PP \fIpos\fR is the position of the mouse cursor in the global coordinate system (QMouseEvent::globalPos()). .SH "void QIconView::selectAll ( bool select )\fC [virtual]\fR" -In Multi and Extended modes, this function sets all items to be selected if \fIselect\fR is TRUE, and to be unselected if \fIselect\fR is FALSE. +In Multi and Extended modes, this function sets all items to be selected if \fIselect\fR is true, and to be unselected if \fIselect\fR is false. .PP In Single and NoSelection modes, this function only changes the selection status of currentItem(). .SH "void QIconView::selectionChanged ()\fC [signal]\fR" @@ -761,30 +761,30 @@ Sets the maximum length (in characters) that an item's text may have to \fIw\fR. Sets the maximum width that an item may have to \fIw\fR. See the "maxItemWidth" property for details. .SH "void QIconView::setResizeMode ( ResizeMode am )\fC [virtual]\fR" Sets the resize mode of the icon view to \fIam\fR. See the "resizeMode" property for details. -.SH "void QIconView::setSelected ( QIconViewItem * item, bool s, bool cb = FALSE )\fC [virtual]\fR" +.SH "void QIconView::setSelected ( QIconViewItem * item, bool s, bool cb = false )\fC [virtual]\fR" Selects or unselects \fIitem\fR depending on \fIs\fR, and may also unselect other items, depending on QIconView::selectionMode() and \fIcb\fR. .PP -If \fIs\fR is FALSE, \fIitem\fR is unselected. +If \fIs\fR is false, \fIitem\fR is unselected. .PP -If \fIs\fR is TRUE and QIconView::selectionMode() is Single, \fIitem\fR is selected, and the item which was selected is unselected. +If \fIs\fR is true and QIconView::selectionMode() is Single, \fIitem\fR is selected, and the item which was selected is unselected. .PP -If \fIs\fR is TRUE and QIconView::selectionMode() is Extended, \fIitem\fR is selected. If \fIcb\fR is TRUE, the selection state of the icon view's other items is left unchanged. If \fIcb\fR is FALSE (the default) all other items are unselected. +If \fIs\fR is true and QIconView::selectionMode() is Extended, \fIitem\fR is selected. If \fIcb\fR is true, the selection state of the icon view's other items is left unchanged. If \fIcb\fR is false (the default) all other items are unselected. .PP -If \fIs\fR is TRUE and QIconView::selectionMode() is Multi \fIitem\fR is selected. +If \fIs\fR is true and QIconView::selectionMode() is Multi \fIitem\fR is selected. .PP -Note that \fIcb\fR is used only if QIconView::selectionMode() is Extended. \fIcb\fR defaults to FALSE. +Note that \fIcb\fR is used only if QIconView::selectionMode() is Extended. \fIcb\fR defaults to false. .PP All items whose selection status is changed repaint themselves. .SH "void QIconView::setSelectionMode ( SelectionMode m )\fC [virtual]\fR" Sets the selection mode of the icon view to \fIm\fR. See the "selectionMode" property for details. .SH "void QIconView::setShowToolTips ( bool b )\fC [virtual]\fR" Sets whether the icon view will display a tool tip with the complete text for any truncated item text to \fIb\fR. See the "showToolTips" property for details. -.SH "void QIconView::setSorting ( bool sort, bool ascending = TRUE )" -If \fIsort\fR is TRUE, this function sets the icon view to sort items when a new item is inserted. If \fIsort\fR is FALSE, the icon view will not be sorted. +.SH "void QIconView::setSorting ( bool sort, bool ascending = true )" +If \fIsort\fR is true, this function sets the icon view to sort items when a new item is inserted. If \fIsort\fR is false, the icon view will not be sorted. .PP -Note that autoArrange() must be TRUE for sorting to take place. +Note that autoArrange() must be true for sorting to take place. .PP -If \fIascending\fR is TRUE (the default), items are sorted in ascending order. If \fIascending\fR is FALSE, items are sorted in descending order. +If \fIascending\fR is true (the default), items are sorted in ascending order. If \fIascending\fR is false, items are sorted in descending order. .PP QIconViewItem::compare() is used to compare pairs of items. The sorting is based on the items' keys; these default to the items' text unless specifically set to something else. .PP @@ -794,13 +794,13 @@ Sets the space in pixels between icon view items to \fIsp\fR. See the "spacing" .SH "void QIconView::setWordWrapIconText ( bool b )\fC [virtual]\fR" Sets whether the item text will be word-wrapped if it is too long to \fIb\fR. See the "wordWrapIconText" property for details. .SH "bool QIconView::showToolTips () const" -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 "showToolTips" property for details. +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 "showToolTips" property for details. .SH "void QIconView::slotUpdate ()\fC [virtual protected slot]\fR" This slot is used for a slightly-delayed update. .PP The icon view is not redrawn immediately after inserting a new item but after a very small delay using a QTimer. This means that when 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. -.SH "void QIconView::sort ( bool ascending = TRUE )\fC [virtual]\fR" -Sorts and rearranges all the items in the icon view. If \fIascending\fR is TRUE, the items are sorted in increasing order, otherwise they are sorted in decreasing order. +.SH "void QIconView::sort ( bool ascending = true )\fC [virtual]\fR" +Sorts and rearranges all the items in the icon view. If \fIascending\fR is true, the items are sorted in increasing order, otherwise they are sorted in decreasing order. .PP QIconViewItem::compare() is used to compare pairs of items. The sorting is based on the items' keys; these default to the items' text unless specifically set to something else. .PP @@ -808,9 +808,9 @@ Note that this function sets the sort order to \fIascending\fR. .PP See also QIconViewItem::key(), QIconViewItem::setKey(), QIconViewItem::compare(), QIconView::setSorting(), and QIconView::sortDirection. .SH "bool QIconView::sortDirection () const" -Returns TRUE if the sort direction for inserting new items is ascending;; otherwise returns FALSE. See the "sortDirection" property for details. +Returns true if the sort direction for inserting new items is ascending;; otherwise returns false. See the "sortDirection" property for details. .SH "bool QIconView::sorting () const" -Returns TRUE if the icon view sorts on insertion; otherwise returns FALSE. See the "sorting" property for details. +Returns true if the icon view sorts on insertion; otherwise returns false. See the "sorting" property for details. .SH "int QIconView::spacing () const" Returns the space in pixels between icon view items. See the "spacing" property for details. .SH "void QIconView::startDrag ()\fC [virtual protected]\fR" @@ -818,7 +818,7 @@ Starts a drag. .SH "void QIconView::takeItem ( QIconViewItem * item )\fC [virtual]\fR" Takes the icon view item \fIitem\fR out of the icon view and causes an update of the screen display. The item is not deleted. You should normally not need to call this function because QIconViewItem::~QIconViewItem() calls it. The normal way to delete an item is to delete it. .SH "bool QIconView::wordWrapIconText () const" -Returns TRUE if the item text will be word-wrapped if it is too long; otherwise returns FALSE. See the "wordWrapIconText" property for details. +Returns true if the item text will be word-wrapped if it is too long; otherwise returns false. See the "wordWrapIconText" property for details. .SS "Property Documentation" .SH "Arrangement arrangement" This property holds the arrangement mode of the icon view. @@ -829,7 +829,7 @@ Set this property's value with setArrangement() and get this property's value wi .SH "bool autoArrange" This property holds whether the icon view rearranges its items when a new item is inserted. .PP -The default is TRUE. +The default is true. .PP Note that if the icon view is not visible at the time of insertion, QIconView defers all position-related work until it is shown and then calls arrangeItemsInGrid(). .PP @@ -867,7 +867,7 @@ Set this property's value with setItemTextPos() and get this property's value wi .SH "bool itemsMovable" This property holds whether the user is allowed to move items around in the icon view. .PP -The default is TRUE. +The default is true. .PP Set this property's value with setItemsMovable() and get this property's value with itemsMovable(). .SH "int maxItemTextLength" @@ -899,13 +899,13 @@ Set this property's value with setSelectionMode() and get this property's value .SH "bool showToolTips" This property holds whether the icon view will display a tool tip with the complete text for any truncated item text. .PP -The default is TRUE. Note that this has no effect if setWordWrapIconText() is TRUE, as it is by default. +The default is true. Note that this has no effect if setWordWrapIconText() is true, as it is by default. .PP Set this property's value with setShowToolTips() and get this property's value with showToolTips(). .SH "bool sortDirection" This property holds whether the sort direction for inserting new items is ascending;. .PP -The default is TRUE (i.e. ascending). This sort direction is only meaningful if both sorting() and autoArrange() are TRUE. +The default is true (i.e. ascending). This sort direction is only meaningful if both sorting() and autoArrange() are true. .PP To set the sort direction, use setSorting() .PP @@ -913,7 +913,7 @@ Get this property's value with sortDirection(). .SH "bool sorting" This property holds whether the icon view sorts on insertion. .PP -The default is FALSE, i.e. no sorting on insertion. +The default is false, i.e. no sorting on insertion. .PP To set the sorting, use setSorting(). .PP @@ -929,9 +929,9 @@ Set this property's value with setSpacing() and get this property's value with s .SH "bool wordWrapIconText" This property holds whether the item text will be word-wrapped if it is too long. .PP -The default is TRUE. +The default is true. .PP -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 tooltip; see setShowToolTips(). +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 tooltip; see setShowToolTips(). .PP Set this property's value with setWordWrapIconText() and get this property's value with wordWrapIconText(). |