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/qptrdict.html | 316 ------------------------------------------------- 1 file changed, 316 deletions(-) delete mode 100644 doc/html/qptrdict.html (limited to 'doc/html/qptrdict.html') diff --git a/doc/html/qptrdict.html b/doc/html/qptrdict.html deleted file mode 100644 index e8a113830..000000000 --- a/doc/html/qptrdict.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - -TQPtrDict Class - - - - - - - -

TQPtrDict Class Reference

- -

The TQPtrDict class is a template class that provides a dictionary based on void* keys. -More... -

#include <qptrdict.h> -

Inherits TQPtrCollection. -

List of all member functions. -

Public Members

TQPtrDict ( int size = 17 )
TQPtrDict ( const TQPtrDict<type> & dict )
~TQPtrDict ()
TQPtrDict<type> & operator= ( const TQPtrDict<type> & dict )
virtual uint count () const
uint size () const
bool isEmpty () const
void insert ( void * key, const type * item )
void replace ( void * key, const type * item )
bool remove ( void * key )
type * take ( void * key )
type * find ( void * key ) const
type * operator[] ( void * 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 TQPtrDict class is a template class that provides a dictionary based on void* keys. -

- -

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

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

Example: -

-    TQPtrDict<char> fields; // void* keys, char* values
-
-    TQLineEdit *le1 = new TQLineEdit( this );
-    le1->setText( "Simpson" );
-    TQLineEdit *le2 = new TQLineEdit( this );
-    le2->setText( "Homer" );
-    TQLineEdit *le3 = new TQLineEdit( this );
-    le3->setText( "45" );
-
-    fields.insert( le1, "Surname" );
-    fields.insert( le2, "Forename" );
-    fields.insert( le3, "Age" );
-
-    TQPtrDictIterator<char> it( fields );
-    for( ; it.current(); ++it )
-        cout << it.current() << endl;
-    cout << endl;
-
-    if ( fields[le1] ) // Prints "Surname: Simpson"
-        cout << fields[le1] << ": " << le1->text() << endl; 
-    if ( fields[le2] ) // Prints "Forename: Homer"
-        cout << fields[le2] << ": " << le2->text() << endl; 
-
-    fields.remove( le1 ); // Removes le1 from the dictionary
-    cout << le1->text() << endl; // Prints "Simpson"
-

- -In this example we use a dictionary to add an extra property (a -char*) to the line edits we're using. -

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

Member Function Documentation

TQPtrDict::TQPtrDict ( int size = 17 ) -

- -

Constructs a dictionary using an internal hash array with the 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 and improves lookup performance. - -

TQPtrDict::TQPtrDict ( const TQPtrDict<type> & dict ) -

- -

Constructs a copy of dict. -

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

TQPtrDict::~TQPtrDict () -

- -

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 TQPtrDict::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 TQPtrDict::count () const `[virtual]` -

- -

Returns the number of items in the dictionary. -

type * TQPtrDict::find ( void * 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 TQPtrDict::insert ( void * key, const type * item ) -

- -

Inserts the key with the item into the dictionary. -

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 TQPtrDict::isEmpty () const -

- -

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

TQPtrDict<type> & TQPtrDict::operator= ( const TQPtrDict<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 the dictionary. Only the pointers are copied -(shallow copy), unless newItem() has been reimplemented. - -

type * TQPtrDict::operator[] ( void * 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 & TQPtrDict::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 TQPtrDict::remove ( void * key ) -

- -

Removes the item associated with key from the dictionary. -Returns TRUE if successful, i.e. if 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 traversal order. -

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

void TQPtrDict::replace ( void * 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 -

-        TQPtrDict<ItemType> 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 TQPtrDict::resize ( uint newsize ) -

- -

Changes the size of the hash table 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 TQPtrDict::size () const -

- -

Returns the size of the internal hash table (as specified in the -constructor). -

void TQPtrDict::statistics () const -

- -

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

type * TQPtrDict::take ( void * key ) -

- -

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