diff options
Diffstat (limited to 'doc/man/man3/tqptrlist.3qt')
| -rw-r--r-- | doc/man/man3/tqptrlist.3qt | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/doc/man/man3/tqptrlist.3qt b/doc/man/man3/tqptrlist.3qt index 9531a08dc..2c8b5e191 100644 --- a/doc/man/man3/tqptrlist.3qt +++ b/doc/man/man3/tqptrlist.3qt @@ -218,7 +218,7 @@ Example: .br TQPtrList<Employee> list; .br - list.setAutoDelete( TRUE ); // the list owns the objects + list.setAutoDelete( true ); // the list owns the objects .br .br list.append( new Employee("John", "Doe", 50000) ); @@ -272,7 +272,7 @@ The output is .PP TQPtrList has several member functions for traversing the list, but using a TQPtrListIterator can be more practical. Multiple list iterators may traverse the same list, independently of each other and of the current list item. .PP -In the example above we make the call setAutoDelete(TRUE). Enabling auto-deletion tells the list to delete items that are removed. The default is to not delete items when they are removed but this would cause a memory leak in the example because there are no other references to the list items. +In the example above we make the call setAutoDelete(true). Enabling auto-deletion tells the list to delete items that are removed. The default is to not delete items when they are removed but this would cause a memory leak in the example because there are no other references to the list items. .PP When inserting an item into a list only the pointer is copied, not the item itself, i.e. a shallow copy. It is possible to make the list copy all of the item's data (deep copy) when an item is inserted. insert(), inSort() and append() call the virtual function TQPtrCollection::newItem() for the item to be inserted. Inherit a list and reimplement newItem() to have deep copies. .PP @@ -327,7 +327,7 @@ Returns the index of the current list item. The returned value is -1 if the curr .PP See also current(). .SH "bool TQPtrCollection::autoDelete () const" -Returns the setting of the auto-delete option. The default is FALSE. +Returns the setting of the auto-delete option. The default is false. .PP See also setAutoDelete(). .SH "void TQPtrList::clear ()\fC [virtual]\fR" @@ -465,7 +465,7 @@ See also insert(), compareItems(), current(), and sort(). .SH "bool TQPtrList::insert ( uint index, const type * item )" Inserts the \fIitem\fR at position \fIindex\fR in the list. .PP -Returns TRUE if successful, i.e. if \fIindex\fR is in range; otherwise returns FALSE. The valid range is 0 to count() (inclusively). The item is appended if \fIindex\fR == count(). +Returns true if successful, i.e. if \fIindex\fR is in range; otherwise returns false. The valid range is 0 to count() (inclusively). The item is appended if \fIindex\fR == count(). .PP The inserted item becomes the current list item. .PP @@ -473,7 +473,7 @@ The inserted item becomes the current list item. .PP See also append(), current(), and replace(). .SH "bool TQPtrList::isEmpty () const" -Returns TRUE if the list is empty; otherwise returns FALSE. +Returns true if the list is empty; otherwise returns false. .PP See also count(). .SH "type * TQPtrList::last ()" @@ -490,13 +490,13 @@ See also first(), last(), prev(), and current(). Examples: .)l listviews/listviews.h and showimg/showimg.cpp. .SH "bool TQPtrList::operator!= ( const TQPtrList<type> & list ) const" -Compares this list with \fIlist\fR. Returns TRUE if the lists contain different data; otherwise returns FALSE. +Compares this list with \fIlist\fR. Returns true if the lists contain different data; otherwise returns false. .SH "TQPtrList<type> & TQPtrList::operator= ( const TQPtrList<type> & list )" Assigns \fIlist\fR to this list and returns a reference to this list. .PP This list is first cleared and then each item in \fIlist\fR is appended to this list. Only the pointers are copied (shallow copy) unless newItem() has been reimplemented. .SH "bool TQPtrList::operator== ( const TQPtrList<type> & list ) const" -Compares this list with \fIlist\fR. Returns TRUE if the lists contain the same data; otherwise returns FALSE. +Compares this list with \fIlist\fR. Returns true if the lists contain the same data; otherwise returns false. .SH "void TQPtrList::prepend ( const type * item )" Inserts the \fIitem\fR at the start of the list. .PP @@ -520,7 +520,7 @@ See also write(). .SH "bool TQPtrList::remove ( uint index )" Removes the item at position \fIindex\fR in the list. .PP -Returns TRUE if successful, i.e. if \fIindex\fR is in range; otherwise returns FALSE. The valid range is \fC0..(count() - 1)\fR inclusive. +Returns true if successful, i.e. if \fIindex\fR is in range; otherwise returns false. The valid range is \fC0..(count() - 1)\fR inclusive. .PP The removed item is deleted if auto-deletion is enabled. .PP @@ -534,7 +534,7 @@ This is an overloaded member function, provided for convenience. It behaves esse .PP Removes the current list item. .PP -Returns TRUE if successful, i.e. if the current item isn't 0; otherwise returns FALSE. +Returns true if successful, i.e. if the current item isn't 0; otherwise returns false. .PP The removed item is deleted if auto-deletion is enabled. .PP @@ -548,7 +548,7 @@ This is an overloaded member function, provided for convenience. It behaves esse .PP Removes the first occurrence of \fIitem\fR from the list. .PP -Returns TRUE if successful, i.e. if \fIitem\fR is in the list; otherwise returns FALSE. +Returns true if successful, i.e. if \fIitem\fR is in the list; otherwise returns false. .PP The removed item is deleted if auto-deletion is enabled. .PP @@ -562,7 +562,7 @@ All list iterators that refer to the removed item will be set to point to the ne .PP See also removeRef(), take(), clear(), setAutoDelete(), compareItems(), and current(). .SH "bool TQPtrList::removeFirst ()" -Removes the first item from the list. Returns TRUE if successful, i.e. if the list isn't empty; otherwise returns FALSE. +Removes the first item from the list. Returns true if successful, i.e. if the list isn't empty; otherwise returns false. .PP The removed item is deleted if auto-deletion is enabled. .PP @@ -572,7 +572,7 @@ All list iterators that refer to the removed item will be set to point to the ne .PP See also removeLast(), setAutoDelete(), current(), and remove(). .SH "bool TQPtrList::removeLast ()" -Removes the last item from the list. Returns TRUE if successful, i.e. if the list isn't empty; otherwise returns FALSE. +Removes the last item from the list. Returns true if successful, i.e. if the list isn't empty; otherwise returns false. .PP The removed item is deleted if auto-deletion is enabled. .PP @@ -598,7 +598,7 @@ See also takeNode(), currentNode(), remove(), and removeRef(). .SH "bool TQPtrList::removeRef ( const type * item )" Removes the first occurrence of \fIitem\fR from the list. .PP -Returns TRUE if successful, i.e. if \fIitem\fR is in the list; otherwise returns FALSE. +Returns true if successful, i.e. if \fIitem\fR is in the list; otherwise returns false. .PP The removed item is deleted if auto-deletion is enabled. .PP @@ -620,15 +620,15 @@ See also remove(), clear(), setAutoDelete(), and current(). .SH "bool TQPtrList::replace ( uint index, const type * item )" Replaces the item at position \fIindex\fR with the new \fIitem\fR. .PP -Returns TRUE if successful, i.e. \fIindex\fR is in the range 0 to count()-1. +Returns true if successful, i.e. \fIindex\fR is in the range 0 to count()-1. .PP See also append(), current(), and insert(). .SH "void TQPtrCollection::setAutoDelete ( bool enable )" -Sets the collection to auto-delete its contents if \fIenable\fR is TRUE and to never delete them if \fIenable\fR is FALSE. +Sets the collection to auto-delete its contents if \fIenable\fR is true and to never delete them if \fIenable\fR is false. .PP If auto-deleting is turned on, all the items in a collection are deleted when the collection itself is deleted. This is convenient if the collection has the only pointer to the items. .PP -The default setting is FALSE, for safety. If you turn it on, be careful about copying the collection - you might find yourself with two collections deleting the same items. +The default setting is false, for safety. If you turn it on, be careful about copying the collection - you might find yourself with two collections deleting the same items. .PP Note that the auto-delete setting may also affect other functions in subclasses. For example, a subclass that has a remove() function will remove the item from its data structure, and if auto-delete is enabled, will also delete the item. .PP |