diff options
Diffstat (limited to 'doc/html/tqcache.html')
| -rw-r--r-- | doc/html/tqcache.html | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/doc/html/tqcache.html b/doc/html/tqcache.html index c7f046f0d..fd4baf5be 100644 --- a/doc/html/tqcache.html +++ b/doc/html/tqcache.html @@ -37,7 +37,7 @@ body { background: #ffffff; color: black; } <p><a href="tqcache-members.html">List of all member functions.</a> <h2>Public Members</h2> <ul> -<li class=fn><a href="#TQCache-2"><b>TQCache</b></a> ( int maxCost = 100, int size = 17, bool caseSensitive = TRUE )</li> +<li class=fn><a href="#TQCache-2"><b>TQCache</b></a> ( int maxCost = 100, int size = 17, bool caseSensitive = true )</li> <li class=fn><a href="#~TQCache"><b>~TQCache</b></a> ()</li> <li class=fn>int <a href="#maxCost"><b>maxCost</b></a> () const</li> <li class=fn>int <a href="#totalCost"><b>totalCost</b></a> () const</li> @@ -49,7 +49,7 @@ body { background: #ffffff; color: black; } <li class=fn>bool <a href="#insert"><b>insert</b></a> ( const TQString & k, const type * d, int c = 1, int p = 0 )</li> <li class=fn>bool <a href="#remove"><b>remove</b></a> ( const TQString & k )</li> <li class=fn>type * <a href="#take"><b>take</b></a> ( const TQString & k )</li> -<li class=fn>type * <a href="#find"><b>find</b></a> ( const TQString & k, bool ref = TRUE ) const</li> +<li class=fn>type * <a href="#find"><b>find</b></a> ( const TQString & k, bool ref = true ) const</li> <li class=fn>type * <a href="#operator[]"><b>operator[]</b></a> ( const TQString & k ) const</li> <li class=fn>void <a href="#statistics"><b>statistics</b></a> () const</li> </ul> @@ -78,7 +78,7 @@ operates on pointers to X, or X*. item, returns it, and by default marks it as being the most recently used item. <p> There are also methods to <a href="#remove">remove</a>() or <a href="#take">take</a>() an object from the -cache. Calling <a href="tqptrcollection.html#setAutoDelete">setAutoDelete</a>(TRUE) for a cache tells it to delete +cache. Calling <a href="tqptrcollection.html#setAutoDelete">setAutoDelete</a>(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). <p> When inserting an item into the cache, only the pointer is copied, @@ -99,7 +99,7 @@ same performance as a TQAsciiCache. <p> <p>See also <a href="tqcacheiterator.html">TQCacheIterator</a>, <a href="tqasciicache.html">TQAsciiCache</a>, <a href="tqintcache.html">TQIntCache</a>, <a href="collection.html">Collection Classes</a>, and <a href="tools.html">Non-GUI Classes</a>. <hr><h2>Member Function Documentation</h2> -<h3 class=fn><a name="TQCache-2"></a>TQCache::TQCache ( int maxCost = 100, int size = 17, bool caseSensitive = TRUE ) +<h3 class=fn><a name="TQCache-2"></a>TQCache::TQCache ( int maxCost = 100, int size = 17, bool caseSensitive = true ) </h3> <p> Constructs a cache whose contents will never have a total cost @@ -112,8 +112,8 @@ than the largest expected number of items in the cache. item, if the total cost of all items in the cache will exceed <em>maxCost</em>, the cache will start throwing out the older (least recently used) items until there is enough room for the new item to be inserted. -<p> If <em>caseSensitive</em> is TRUE (the default), the cache keys are case -sensitive; if it is FALSE, they are case-insensitive. +<p> If <em>caseSensitive</em> is true (the default), the cache keys are case +sensitive; if it is false, they are case-insensitive. Case-insensitive comparison considers all Unicode letters. <h3 class=fn><a name="~TQCache"></a>TQCache::~TQCache () @@ -125,7 +125,7 @@ that access this cache will be reset. <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="tqptrcollection.html#setAutoDelete">setAutoDelete</a>(). <h3 class=fn>void <a name="clear"></a>TQCache::clear ()<tt> [virtual]</tt> @@ -144,11 +144,11 @@ has been enabled. <p> <p>See also <a href="#totalCost">totalCost</a>(). <p>Reimplemented from <a href="tqptrcollection.html#count">TQPtrCollection</a>. -<h3 class=fn>type * <a name="find"></a>TQCache::find ( const <a href="tqstring.html">TQString</a> & k, bool ref = TRUE ) const +<h3 class=fn>type * <a name="find"></a>TQCache::find ( const <a href="tqstring.html">TQString</a> & k, bool ref = true ) const </h3> <p> Returns the item associated with key <em>k</em>, or 0 if the key does -not exist in the cache. If <em>ref</em> is TRUE (the default), the item +not exist in the cache. If <em>ref</em> is true (the default), the item is moved to the front of the least recently used list. <p> If there are two or more items with equal keys, the one that was inserted last is returned. @@ -157,14 +157,14 @@ inserted last is returned. </h3> <p> Inserts the item <em>d</em> into the cache with key <em>k</em> and associated -cost, <em>c</em>. Returns TRUE if it is successfully inserted; otherwise -returns FALSE. +cost, <em>c</em>. Returns true if it is successfully inserted; otherwise +returns false. <p> The cache's size is limited, and if the total cost is too high, TQCache will remove old, least recently used items until there is room for this new item. <p> The parameter <em>p</em> is internal and should be left at the default value (0). -<p> <b>Warning:</b> If this function returns FALSE (which could happen, e.g. +<p> <b>Warning:</b> If this function returns false (which could happen, e.g. if the cost of this item alone exceeds <a href="#maxCost">maxCost</a>()) you must delete <em>d</em> yourself. Additionally, be very careful about using <em>d</em> after calling this function because any other insertions into the @@ -175,7 +175,7 @@ become invalid. <h3 class=fn>bool <a name="isEmpty"></a>TQCache::isEmpty () const </h3> -<p> Returns TRUE if the cache is empty; otherwise returns FALSE. +<p> Returns true if the cache is empty; otherwise returns false. <h3 class=fn>int <a name="maxCost"></a>TQCache::maxCost () const </h3> @@ -191,16 +191,16 @@ exist in the cache, and moves the item to the front of the least recently used list. <p> If there are two or more items with equal keys, the one that was inserted last is returned. -<p> This is the same as <a href="#find">find</a>( k, TRUE ). +<p> This is the same as <a href="#find">find</a>( k, true ). <p> <p>See also <a href="#find">find</a>(). <h3 class=fn>bool <a name="remove"></a>TQCache::remove ( const <a href="tqstring.html">TQString</a> & k ) </h3> -<p> Removes the item associated with <em>k</em>, and returns TRUE if the -item was present in the cache; otherwise returns FALSE. +<p> Removes the item associated with <em>k</em>, and returns true if the +item was present in the cache; otherwise returns false. <p> The item is deleted if auto-deletion has been enabled, i.e., if -you have called <a href="tqptrcollection.html#setAutoDelete">setAutoDelete</a>(TRUE). +you have called <a href="tqptrcollection.html#setAutoDelete">setAutoDelete</a>(true). <p> If there are two or more items with equal keys, the one that was inserted last is removed. <p> All iterators that refer to the removed item are set to point to @@ -211,11 +211,11 @@ the next item in the cache's traversal order. </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 |