diff options
Diffstat (limited to 'doc/tqintcache.doc')
| -rw-r--r-- | doc/tqintcache.doc | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/doc/tqintcache.doc b/doc/tqintcache.doc index b8d4fa206..a904e4640 100644 --- a/doc/tqintcache.doc +++ b/doc/tqintcache.doc @@ -65,7 +65,7 @@ recently used item. There are also methods to remove() or take() an object from the - cache. Calling setAutoDelete(TRUE) for a cache tells it to delete + cache. Calling setAutoDelete(true) for a cache tells it to delete items that are removed. The default is to not delete items when they are removed (i.e. remove() and take() are equivalent). @@ -173,15 +173,15 @@ /*! \fn bool TQIntCache::isEmpty() const - Returns TRUE if the cache is empty; otherwise returns FALSE. + Returns true if the cache is empty; otherwise returns false. */ /*! \fn bool TQIntCache::insert( long k, const type *d, int c, int p ) Inserts the item \a d into the cache with key \a k and assigns it - a cost of \a c (default 1). Returns TRUE if it succeeds; otherwise - returns FALSE. + a cost of \a c (default 1). Returns true if it succeeds; otherwise + returns false. The cache's size is limited, and if the total cost is too high, TQIntCache will remove old, least-used items until there is room @@ -190,7 +190,7 @@ The parameter \a p is internal and should be left at the default value (0). - \warning If this function returns FALSE (for example, the cost \c, + \warning If this function returns false (for example, the cost \c, exceeds maxCost()), you must delete \a d yourself. Additionally, be very careful about using \a d after calling this function. Any other insertions into the cache, from anywhere in the application @@ -201,11 +201,11 @@ /*! \fn bool TQIntCache::remove( long k ) - Removes the item associated with \a k, and returns TRUE if the - item was present in the cache; otherwise returns FALSE. + Removes the item associated with \a k, and returns true if the + item was present in the cache; otherwise returns false. The item is deleted if auto-deletion has been enabled, i.e. if you - have called setAutoDelete(TRUE). + have called setAutoDelete(true). If there are two or more items with equal keys, the one that was inserted most recently is removed. @@ -247,7 +247,7 @@ \fn type * TQIntCache::find( long k, bool ref ) const Returns the item associated with \a k, or 0 if the key does not - exist in the cache. If \a ref is TRUE (the default), the item is + exist in the cache. If \a ref is true (the default), the item is moved to the front of the least recently used list. If there are two or more items with equal keys, the one that was @@ -264,7 +264,7 @@ If there are two or more items with equal keys, the one that was inserted most recently is returned. - This is the same as find( k, TRUE ). + This is the same as find( k, true ). \sa find() */ @@ -300,8 +300,8 @@ TQIntCacheIterator provides an operator++(), and an operator+=() to traverse the cache; current() and currentKey() to access the current cache item and its key; atFirst() atLast(), which return - TRUE if the iterator points to the first/last item in the cache; - isEmpty(), which returns TRUE if the cache is empty; and count(), + true if the iterator points to the first/last item in the cache; + isEmpty(), which returns true if the cache is empty; and count(), which returns the number of items in the cache. Note that atFirst() and atLast() refer to the iterator's arbitrary @@ -347,7 +347,7 @@ /*! \fn bool TQIntCacheIterator::isEmpty() const - Returns TRUE if the cache is empty; otherwise returns FALSE. + Returns true if the cache is empty; otherwise returns false. \sa count() */ @@ -355,8 +355,8 @@ /*! \fn bool TQIntCacheIterator::atFirst() const - Returns TRUE if the iterator points to the first item in the - cache; otherwise returns FALSE. Note that this refers to the + Returns true if the iterator points to the first item in the + cache; otherwise returns false. Note that this refers to the iterator's arbitrary ordering, not to the cache's internal least recently used list. @@ -366,8 +366,8 @@ /*! \fn bool TQIntCacheIterator::atLast() const - Returns TRUE if the iterator points to the last item in the cache; - otherwise returns FALSE. Note that this refers to the iterator's + Returns true if the iterator points to the last item in the cache; + otherwise returns false. Note that this refers to the iterator's arbitrary ordering, not to the cache's internal least recently used list. |