From ea318d1431c89e647598c510c4245c6571aa5f46 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Thu, 26 Jan 2012 23:32:43 -0600 Subject: Update to latest tqt3 automated conversion --- doc/html/ntqintdict.html | 313 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 313 insertions(+) create mode 100644 doc/html/ntqintdict.html (limited to 'doc/html/ntqintdict.html') diff --git a/doc/html/ntqintdict.html b/doc/html/ntqintdict.html new file mode 100644 index 00000000..da3d16f6 --- /dev/null +++ b/doc/html/ntqintdict.html @@ -0,0 +1,313 @@ + + + + + +TQIntDict Class + + + + + + + +

TQIntDict Class Reference

+ +

The TQIntDict class is a template class that provides a dictionary based on long keys. +More... +

#include <ntqintdict.h> +

Inherits TQPtrCollection. +

List of all member functions. +

Public Members

TQIntDict ( int size = 17 )
TQIntDict ( const TQIntDict<type> & dict )
~TQIntDict ()
TQIntDict<type> & operator= ( const TQIntDict<type> & dict )
virtual uint count () const
uint size () const
bool isEmpty () const
void insert ( long key, const type * item )
void replace ( long key, const type * item )
bool remove ( long key )
type * take ( long key )
type * find ( long key ) const
type * operator[] ( long key ) const
virtual void clear ()
void resize ( uint newsize )
void statistics () const

Important Inherited Members

bool autoDelete () const
void setAutoDelete ( bool enable )

Protected Members

virtual TQDataStream & read ( TQDataStream & s, TQPtrCollection::Item & item )
virtual TQDataStream & write ( TQDataStream & s, TQPtrCollection::Item ) const

Detailed Description

+ + +The TQIntDict class is a template class that provides a dictionary based on long keys. +

+ +

TQMap is an STL-compatible alternative to this class. +

TQIntDict is implemented as a template class. Define a template +instance TQIntDict<X> to create a dictionary that operates on +pointers to X (X*). +

A dictionary is a collection of key-value pairs. The key is an long used for insertion, removal and lookup. The value is a +pointer. Dictionaries provide very fast insertion and lookup. +

Example: +

+    TQIntDict<TQLineEdit> fields; // long int keys, TQLineEdit* values
+    for ( int i = 0; i < 3; i++ )
+        fields.insert( i, new TQLineEdit( this ) );
+
+    fields[0]->setText( "Homer" );
+    fields[1]->setText( "Simpson" );
+    fields[2]->setText( "45" );
+
+    TQIntDictIterator<TQLineEdit> it( fields );
+    for ( ; it.current(); ++it )
+        cout << it.currentKey() << ": " << it.current()->text() << endl;
+
+    for ( int i = 0; i < 3; i++ )
+        cout << fields[i]->text() << " "; // Prints "Homer Simpson 45"
+    cout << endl;
+
+    fields.remove( 1 ); // Does not delete the line edit
+    for ( int i = 0; i < 3; i++ )
+        if ( fields[i] )
+            cout << fields[i]->text() << " "; // Prints "Homer 45"
+

+ +

See TQDict for full details, including the choice of dictionary +size, and how deletions are handled. +

Member Function Documentation

TQIntDict::TQIntDict ( int size = 17 ) +

+ +

Constructs a dictionary using an internal hash array of size size. +

Setting size to a suitably large prime number (equal to or +greater than the expected number of entries) makes the hash +distribution better which leads to faster lookup. + +

TQIntDict::TQIntDict ( const TQIntDict<type> & dict ) +

+ +

Constructs a copy of dict. +

Each item in dict is inserted into this dictionary. Only the +pointers are copied (shallow copy). + +

TQIntDict::~TQIntDict () +

+ +

Removes all items from the dictionary and destroys it. +

All iterators that access this dictionary will be reset. +

bool TQPtrCollection::autoDelete () const +

+ +

Returns the setting of the auto-delete option. The default is FALSE. +

void TQIntDict::clear () `[virtual]` +

+ +

Removes all items from the dictionary. +

The removed items are deleted if auto-deletion is enabled. +

All dictionary iterators that access this dictionary will be reset. +

See also remove(), take(), and setAutoDelete(). + +

Reimplemented from TQPtrCollection. +

uint TQIntDict::count () const `[virtual]` +

+ +

Returns the number of items in the dictionary. +

type * TQIntDict::find ( long key ) const +

+ +

Returns the item associated with key, or 0 if the key does not +exist in the dictionary. +

If there are two or more items with equal keys, then the most +recently inserted item will be found. +

Equivalent to operator[]. +

void TQIntDict::insert ( long key, const type * item ) +

+ +

Insert item item into the dictionary using key key. +

Multiple items can have the same key, in which case only the last +item will be accessible using operator[](). +

item may not be 0. +

bool TQIntDict::isEmpty () const +

+ +

Returns TRUE if the dictionary is empty; otherwise returns FALSE. +

TQIntDict<type> & TQIntDict::operator= ( const TQIntDict<type> & dict ) +

+ +

Assigns dict to this dictionary and returns a reference to this +dictionary. +

This dictionary is first cleared and then each item in dict is +inserted into this dictionary. Only the pointers are copied +(shallow copy), unless newItem() has been reimplemented. + +

type * TQIntDict::operator[] ( long key ) const +

+ +

Returns the item associated with key, or 0 if the key does not +exist in the dictionary. +

If there are two or more items with equal keys, then the most +recently inserted item will be found. +

Equivalent to the find() function. +

TQDataStream & TQIntDict::read ( TQDataStream & s, TQPtrCollection::Item & item ) `[virtual protected]` +

+ +

Reads a dictionary item from the stream s and returns a +reference to the stream. +

The default implementation sets item to 0. +

bool TQIntDict::remove ( long key ) +

+ +

Removes the item associated with key from the dictionary. +Returns TRUE if successful, i.e. if the key is in the +dictionary; otherwise returns FALSE. +

If there are two or more items with equal keys, then the most +recently inserted item will be removed. +

The removed item is deleted if auto-deletion is enabled. +

All dictionary iterators that refer to the removed item will be +set to point to the next item in the dictionary's traversal +order. +

See also take(), clear(), and setAutoDelete(). + +

Example: table/bigtable/main.cpp. +

void TQIntDict::replace ( long key, const type * item ) +

+ +

If the dictionary has key key, this key's item is replaced with +item. If the dictionary doesn't contain key key, item is +inserted into the dictionary using key key. +

item may not be 0. +

Equivalent to: +

+        TQIntDict<char> dict;
+        //      ...
+        if ( dict.find(key) )
+            dict.remove( key );
+        dict.insert( key, item );
+

+ +

If there are two or more items with equal keys, then the most +recently inserted item will be replaced. +

void TQIntDict::resize ( uint newsize ) +

+ +

Changes the size of the hashtable to newsize. The contents of +the dictionary are preserved, but all iterators on the dictionary +become invalid. + +

void TQPtrCollection::setAutoDelete ( bool enable ) +

+ +

Sets the collection to auto-delete its contents if enable is +TRUE and to never delete them if enable is FALSE. +

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. +

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. +

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. +

uint TQIntDict::size () const +

+ +

Returns the size of the internal hash array (as specified in the +constructor). +

void TQIntDict::statistics () const +

+ +

Debugging-only function that prints out the dictionary +distribution using qDebug(). + +

type * TQIntDict::take ( long key ) +

+ +

Takes the item associated with key out of the dictionary +without deleting it (even if auto-deletion is enabled). +

If there are two or more items with equal keys, then the most +recently inserted item will be taken. +

Returns a pointer to the item taken out, or 0 if the key does not +exist in the dictionary. +

All dictionary iterators that refer to the taken item will be set +to point to the next item in the dictionary's traversing order. +

See also remove(), clear(), and setAutoDelete(). + +