diff options
Diffstat (limited to 'doc/html/ntqptrlist.html')
| -rw-r--r-- | doc/html/ntqptrlist.html | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/doc/html/ntqptrlist.html b/doc/html/ntqptrlist.html index 305b49949..8751b3757 100644 --- a/doc/html/ntqptrlist.html +++ b/doc/html/ntqptrlist.html @@ -142,7 +142,7 @@ Example: }; TQPtrList<Employee> list; - list.<a href="ntqptrcollection.html#setAutoDelete">setAutoDelete</a>( TRUE ); // the list owns the objects + list.<a href="ntqptrcollection.html#setAutoDelete">setAutoDelete</a>( true ); // the list owns the objects list.<a href="#append">append</a>( new Employee("John", "Doe", 50000) ); list.<a href="#append">append</a>( new Employee("Jane", "Williams", 80000) ); @@ -176,7 +176,7 @@ Example: using a <a href="qptrlistiterator.html">TQPtrListIterator</a> can be more practical. Multiple list iterators may traverse the same list, independently of each other and of the current list item. -<p> In the example above we make the call <a href="ntqptrcollection.html#setAutoDelete">setAutoDelete</a>(TRUE). +<p> In the example above we make the call <a href="ntqptrcollection.html#setAutoDelete">setAutoDelete</a>(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 @@ -260,7 +260,7 @@ item, last item, or current item, whichever is closest to <em>index</em>. <h3 class=fn>bool <a name="autoDelete"></a>TQPtrCollection::autoDelete () const </h3> -<p> Returns the setting of the auto-delete option. The default is FALSE. +<p> Returns the setting of the auto-delete option. The default is false. <p> <p>See also <a href="ntqptrcollection.html#setAutoDelete">setAutoDelete</a>(). <h3 class=fn>void <a name="clear"></a>TQPtrList::clear ()<tt> [virtual]</tt> @@ -439,8 +439,8 @@ a few additional items. </h3> <p> Inserts the <em>item</em> at position <em>index</em> in the list. -<p> Returns TRUE if successful, i.e. if <em>index</em> is in range; -otherwise returns FALSE. The valid range is 0 to <a href="#count">count</a>() +<p> Returns true if successful, i.e. if <em>index</em> is in range; +otherwise returns false. The valid range is 0 to <a href="#count">count</a>() (inclusively). The item is appended if <em>index</em> == count(). <p> The inserted item becomes the current list item. <p> <em>item</em> must not be 0. @@ -449,7 +449,7 @@ otherwise returns FALSE. The valid range is 0 to <a href="#count">count</a>() <h3 class=fn>bool <a name="isEmpty"></a>TQPtrList::isEmpty () const </h3> -<p> Returns TRUE if the list is empty; otherwise returns FALSE. +<p> Returns true if the list is empty; otherwise returns false. <p> <p>See also <a href="#count">count</a>(). <h3 class=fn>type * <a name="last"></a>TQPtrList::last () @@ -473,8 +473,8 @@ function call was the last item, the current item will be set to <h3 class=fn>bool <a name="operator!-eq"></a>TQPtrList::operator!= ( const <a href="ntqptrlist.html">TQPtrList</a><type> & list ) const </h3> -<p> Compares this list with <em>list</em>. Returns TRUE if the lists contain -different data; otherwise returns FALSE. +<p> Compares this list with <em>list</em>. Returns true if the lists contain +different data; otherwise returns false. <h3 class=fn><a href="ntqptrlist.html">TQPtrList</a><type> & <a name="operator-eq"></a>TQPtrList::operator= ( const <a href="ntqptrlist.html">TQPtrList</a><type> & list ) </h3> @@ -486,8 +486,8 @@ copied (shallow copy) unless <a href="ntqptrcollection.html#newItem">newItem</a> <h3 class=fn>bool <a name="operator-eq-eq"></a>TQPtrList::operator== ( const <a href="ntqptrlist.html">TQPtrList</a><type> & list ) const </h3> -<p> Compares this list with <em>list</em>. Returns TRUE if the lists contain -the same data; otherwise returns FALSE. +<p> Compares this list with <em>list</em>. Returns true if the lists contain +the same data; otherwise returns false. <h3 class=fn>void <a name="prepend"></a>TQPtrList::prepend ( const type * item ) </h3> @@ -520,8 +520,8 @@ the stream. </h3> <p> Removes the item at position <em>index</em> in the list. -<p> Returns TRUE if successful, i.e. if <em>index</em> is in range; -otherwise returns FALSE. The valid range is <tt>0..(count() - 1)</tt> +<p> Returns true if successful, i.e. if <em>index</em> is in range; +otherwise returns false. The valid range is <tt>0..(count() - 1)</tt> inclusive. <p> The removed item is deleted if <a href="ntqptrcollection.html#setAutoDelete">auto-deletion</a> is enabled. <p> The item after the removed item becomes the new current list item @@ -536,8 +536,8 @@ point to the new current item. <p> This is an overloaded member function, provided for convenience. It behaves essentially like the above function. <p> Removes the current list item. -<p> Returns TRUE if successful, i.e. if the current item isn't 0; -otherwise returns FALSE. +<p> Returns true if successful, i.e. if the current item isn't 0; +otherwise returns false. <p> The removed item is deleted if <a href="ntqptrcollection.html#setAutoDelete">auto-deletion</a> is enabled. <p> The item after the removed item becomes the new current list item if the removed item is not the last item in the list. If the last @@ -552,8 +552,8 @@ point to the new current item. <p> This is an overloaded member function, provided for convenience. It behaves essentially like the above function. <p> Removes the first occurrence of <em>item</em> from the list. -<p> Returns TRUE if successful, i.e. if <em>item</em> is in the list; -otherwise returns FALSE. +<p> Returns true if successful, i.e. if <em>item</em> is in the list; +otherwise returns false. <p> The removed item is deleted if <a href="ntqptrcollection.html#setAutoDelete">auto-deletion</a> is enabled. <p> The <a href="#compareItems">compareItems</a>() function is called when searching for the item in the list. If compareItems() is not reimplemented, it is more @@ -570,8 +570,8 @@ point to the new current item. <h3 class=fn>bool <a name="removeFirst"></a>TQPtrList::removeFirst () </h3> -<p> Removes the first item from the list. Returns TRUE if successful, -i.e. if the list isn't empty; otherwise returns FALSE. +<p> Removes the first item from the list. Returns true if successful, +i.e. if the list isn't empty; otherwise returns false. <p> The removed item is deleted if <a href="ntqptrcollection.html#setAutoDelete">auto-deletion</a> is enabled. <p> The first item in the list becomes the new current list item. The current item is set to 0 if the list becomes empty. @@ -582,8 +582,8 @@ point to the new current item. <h3 class=fn>bool <a name="removeLast"></a>TQPtrList::removeLast () </h3> -<p> Removes the last item from the list. Returns TRUE if successful, -i.e. if the list isn't empty; otherwise returns FALSE. +<p> Removes the last item from the list. Returns true if successful, +i.e. if the list isn't empty; otherwise returns false. <p> The removed item is deleted if <a href="ntqptrcollection.html#setAutoDelete">auto-deletion</a> is enabled. <p> The last item in the list becomes the new current list item. The current item is set to 0 if the list becomes empty. @@ -609,8 +609,8 @@ the removed item was the last item. </h3> <p> Removes the first occurrence of <em>item</em> from the list. -<p> Returns TRUE if successful, i.e. if <em>item</em> is in the list; -otherwise returns FALSE. +<p> Returns true if successful, i.e. if <em>item</em> is in the list; +otherwise returns false. <p> The removed item is deleted if <a href="ntqptrcollection.html#setAutoDelete">auto-deletion</a> is enabled. <p> Equivalent to: <pre> @@ -630,7 +630,7 @@ point to the new current item. </h3> <p> Replaces the item at position <em>index</em> with the new <em>item</em>. -<p> Returns TRUE if successful, i.e. <em>index</em> is in the range 0 to +<p> Returns true if successful, i.e. <em>index</em> is in the range 0 to <a href="#count">count</a>()-1. <p> <p>See also <a href="#append">append</a>(), <a href="#current">current</a>(), and <a href="#insert">insert</a>(). @@ -638,11 +638,11 @@ point to the new current item. </h3> <p> Sets the collection to auto-delete its contents if <em>enable</em> is -TRUE and to never delete them if <em>enable</em> is FALSE. +true and to never delete them if <em>enable</em> is false. <p> 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. -<p> The default setting is FALSE, for safety. If you turn it on, be +<p> 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. <p> Note that the auto-delete setting may also affect other functions |