QPtrDictIterator(3qt)

📦 version 3.3.8b, in fedora 43, fedora 44

✨ QPtrDictIterator — the 3qt manual, but make it cute ✨

okay bestie, so this is the manual page for QPtrDictIterator, and yes it lives in section 3qt of your man pages (iykyk). It's the little iterator buddy that walks your QPtrDict collections for you. Let's get into it 💅

🌸 NAME 🌸

QPtrDictIterator — Iterator for QPtrDict collections 🦋

✨ SYNOPSIS ✨

#include <qptrdict.h>

🎀 Public Members 🎀

QPtrDictIterator ( const QPtrDict<type> & dict )
~QPtrDictIterator ()
uint count () const
bool isEmpty () const
type * toFirst ()
operator type * () const
type * current () const
void * currentKey () const
type * operator() ()
type * operator++ ()
type * operator+= ( uint jump )

💖 DESCRIPTION 💖

The QPtrDictIterator class provides an iterator for QPtrDict collections. That's the whole job. She's a walker. She walks the dict. 👑

QPtrDictIterator is implemented as a template class. Define a template instance QPtrDictIterator<X> to create a dictionary iterator that operates on QPtrDict<X> (dictionary of X*). Periodt. 🫶

Example time, and honestly it's giving iconic:

QPtrDict<char> fields;
QLineEdit *le1 = new QLineEdit( this );
le1->setText( "Simpson" );
QLineEdit *le2 = new QLineEdit( this );
le2->setText( "Homer" );
QLineEdit *le3 = new QLineEdit( this );
le3->setText( "45" );
fields.insert( le1, "Surname" );
fields.insert( le2, "Forename" );
fields.insert( le3, "Age" );
QPtrDictIterator<char> it( fields );
for( ; it.current(); ++it ) {
    QLineEdit *le = (QLineEdit)it.currentKey();
    cout << it.current() << ": " << le->text() << endl;
}
cout << endl;
// Output (random order):
//  Forename: Homer
//  Age: 45
//  Surname: Simpson

In the example we insert some line edits into a dictionary, associating a string with each. We then iterate over the dictionary printing the associated strings. 🍓

Multiple iterators may independently traverse the same dictionary. A QPtrDict knows about all the iterators that are operating on the dictionary. When an item is removed from the dictionary, QPtrDict updates all iterators that refer the removed item to point to the next item in the traversing order. Bestie, the dict is literally keeping tabs on everybody so nobody's iterator gets left pointing at a ghost 👻

See also QPtrDict, Collection Classes, and Non-GUI Classes.

🧚 MEMBER FUNCTION DOCUMENTATION 🧚

QPtrDictIterator::QPtrDictIterator ( const QPtrDict<type> & dict )

Constructs an iterator for dict. The current iterator item is set to point on the first item in the dict. First day on the job and she's already at the front of the line 💅

QPtrDictIterator::~QPtrDictIterator ()

Destroys the iterator. Bye bestie, thank you for your service 😭

uint QPtrDictIterator::count () const

Returns the number of items in the dictionary this iterator operates on. Counting queen 🔢

See also isEmpty().

type * QPtrDictIterator::current () const

Returns a pointer to the current iterator item's value. That's the vibe check right there.

void * QPtrDictIterator::currentKey () const

Returns the current iterator item's key. 🔑

bool QPtrDictIterator::isEmpty () const

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

See also count().

QPtrDictIterator::operator type * () const

Cast operator. Returns a pointer to the current iterator item. Same as current(). Two names, one function, no drama.

type * QPtrDictIterator::operator() ()

Makes the succeeding item current and returns the original current item. She moves on but she never forgets where she was 🥲

If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned.

type * QPtrDictIterator::operator++ ()

Prefix ++ makes the succeeding item current and returns the new current item.

If the current iterator item was the last item in the dictionary or if it was 0, 0 is returned.

type * QPtrDictIterator::operator+= ( uint jump )

Sets the current item to the item jump positions after the current item and returns a pointer to that item. Skip, skip, skip to my item 🦋

If that item is beyond the last item or if the dictionary is empty, it sets the current item to 0 and returns 0.

type * QPtrDictIterator::toFirst ()

Sets the current iterator item to point to the first item in the dictionary and returns a pointer to the item. If the dictionary is empty, it sets the current item to 0 and returns 0. Rewind, rewind, main character energy ⏪👑

🌈 SEE ALSO 🌈

Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the license file included in the distribution for a complete license statement.

💜 AUTHOR 💜

Generated automatically from the source code. (Yes, she wrote herself. Iconic behaviour, honestly.)

💀 BUGS 💀

If you find a bug in Qt, please report it as described in http://doc.trolltech.com/bughowto.html. Good bug reports help us to help you. Thank you. 🙏

The definitive Qt documentation is provided in HTML format; it is located at $QTDIR/doc/html and can be read using Qt Assistant or with a web browser. This man page is provided as a convenience for those users who prefer man pages, although this format is not officially supported by Trolltech.

If you find errors in this manual page, please report them to qt-bugs@trolltech.com. Please include the name of the manual page (qptrdictiterator.3qt) and the Qt version (3.3.8). Fr fr, include both, the maintainers need the receipts 🧾

okay that's the whole page bestie, no cap 💖 this one came out of Trolltech AS, dated 2 February 2007, and it's running on Qt version 3.3.8 — and the man page file itself is qptrdictiterator.3qt. slay, go iterate something. ✨🎀🫶

📦 where this page comes from