Q3Dict Class Reference

Member Function Documentation

Q3Dict::Q3Dict ( int size = 17, bool caseSensitive = true )

Constructs a dictionary optimized for less than size entries.

We recommend setting size to a suitably large prime number (e.g. a prime that's slightly larger than the expected number of entries). This makes the hash distribution better which will lead to faster lookup.

If caseSensitive is TRUE (the default), keys which differ only by case are considered different.

Q3Dict::Q3Dict ( const Q3Dict<type> & dict )

Constructs a copy of dict.

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

Q3Dict::~Q3Dict ()

Removes all items from the dictionary and destroys it. If setAutoDelete() is TRUE, each value is deleted. All iterators that access this dictionary will be reset.

See also setAutoDelete().

void Q3Dict::clear () [virtual]

Reimplemented from Q3PtrCollection::clear().

Removes all items from the dictionary.

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

All dictionary iterators that operate on the dictionary are reset.

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

uint Q3Dict::count () const [virtual]

Reimplemented from Q3PtrCollection::count().

Returns the number of items in the dictionary.

See also isEmpty().

type * Q3Dict::find ( const QString & key ) const

Returns the item with key 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 [] operator.

See also operator[]().

void Q3Dict::insert ( const QString & key, const type * item )

Inserts the key key with value 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.

See also replace().

bool Q3Dict::isEmpty () const

Returns TRUE if the dictionary is empty, i.e. count() == 0; otherwise returns FALSE.

See also count().

QDataStream & Q3Dict::read ( QDataStream & s, Q3PtrCollection::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.

See also write().

bool Q3Dict::remove ( const QString & key )

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

If there are two or more items with equal keys, then the last item that was inserted 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().

void Q3Dict::replace ( const QString & key, const type * item )

Replaces the value of the key, key with item.

If the item does not already exist, it will be inserted.

item may not be 0.

Equivalent to:

 Q3Dict<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 last item that was inserted will be replaced.

See also insert().

void Q3Dict::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.

uint Q3Dict::size () const

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

See also count().

void Q3Dict::statistics () const

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

type * Q3Dict::take ( const QString & key )

Takes the item 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 last item that was inserted 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 traversal order.

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

QDataStream & Q3Dict::write ( QDataStream & s, Q3PtrCollection::Item item ) const [virtual protected]

Writes a dictionary item to the stream s and returns a reference to the stream.

See also read().

Q3Dict<type> & Q3Dict::operator= ( const Q3Dict<type> & dict )

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

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

type * Q3Dict::operator[] ( const QString & key ) const

Returns the item with key 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.

See also find().