qdictiterator.3qt

Qt/Embedded是一个多平台的C++图形用户界面应用程序框架

.TH QDictIterator 3qt "10 November 2000" "Trolltech AS" \" -*- nroff -*-
.\" Copyright 1992-2000 Trolltech AS.  All rights reserved.  See the
.\" license file included in the distribution for a complete license
.\" statement.
.\"
.ad l
.nh
.SH NAME
QDictIterator \- Iterator for QDict collections
.SH SYNOPSIS
.br
.PP
\fC#include <qdict.h>\fR
.PP
Inherits QGDictIterator.
.PP
.SS "Public Members"
.in +1c
.ti -1c
.BI "\fBQDictIterator\fR ( const QDict<type> & dict ) "
.br
.ti -1c
.BI "\fB~QDictIterator\fR () "
.br
.ti -1c
.BI "uint \fBcount\fR () const"
.br
.ti -1c
.BI "bool \fBisEmpty\fR () const"
.br
.ti -1c
.BI "type* \fBtoFirst\fR () "
.br
.ti -1c
.BI "operator \fBtype*\fR ()const"
.br
.ti -1c
.BI "type* \fBcurrent\fR () const"
.br
.ti -1c
.BI "QString \fBcurrentKey\fR () const"
.br
.ti -1c
.BI "type* \fBoperator\fR () "
.br
.ti -1c
.BI "type* \fBoperator++\fR () "
.br
.ti -1c
.BI "type* \fBoperator+=\fR ( uint jump ) "
.br
.in -1c
.SH DESCRIPTION
The QDictIterator class provides an iterator for QDict collections.
.PP
QDictIterator is implemented as a template class. Define a template instance QDictIterator<X> to create a dictionary iterator that operates on QDict<X> (dictionary of X*).
.PP
Example:
.PP
.nf
.br
    #include <qdict.h>
.br
    #include <stdio.h>
.br
.br
    void main()
.br
    {
.br
      // Creates a dictionary that maps QString ==> char* (case insensitive)
.br
        QDict<char> dict( 17, FALSE );
.br
.br
        dict.insert( "France", "Paris" );
.br
        dict.insert( "Russia", "Moscow" );
.br
        dict.insert( "Norway", "Oslo" );
.br
.br
        QDictIterator<char> it( dict ); // iterator for dict
.br
.br
        while ( it.current() ) {
.br
            printf( "%s -> %s\\n", it.currentKey().latin1(), it.current() );
.br
            ++it;
.br
        }
.br
    }
.fi
.PP
Program output:
.PP
.nf
.br
        Russia -> Moscow
.br
        Norway -> Oslo
.br
        France -> Paris
.fi
.PP
Note that the traversal order is arbitrary, you are not guaranteed the order above.
.PP
Multiple iterators may independently traverse the same dictionary. A QDict knows about all iterators that are operating on the dictionary. When an item is removed from the dictionary, QDict update all iterators that are referring the removed item to point to the next item in the traversing order.
.PP
See also QDict and Collection Classes
.SH MEMBER FUNCTION DOCUMENTATION
.SH "QDictIterator::QDictIterator ( const QDict<type> & dict )"
Constructs an iterator for \fIdict.\fR The current iterator item is set to point on the first item in the \fIdict.\fR
.SH "QDictIterator::~QDictIterator ()"
Destroys the iterator.
.SH "QDictIterator::operator type * () const"
Cast operator. Returns a pointer to the current iterator item. Same as current().
.SH "uint QDictIterator::count () const"
Returns the number of items in the dictionary this iterator operates on.
.PP
See also isEmpty().
.SH "type * QDictIterator::current () const"
Returns a pointer to the current iterator item.
.SH "QString QDictIterator::currentKey () const"
Returns a pointer to the key for the current iterator item.
.SH "bool QDictIterator::isEmpty () const"
Returns TRUE if the dictionary is empty, i.e. count() == 0, otherwise FALSE.
.PP
See also count().
.SH "type * QDictIterator::operator() ()"
Makes the succeeding item current and returns the original current item.
.PP
If the current iterator item was the last item in the dictionary or if it was null, null is returned.
.SH "type * QDictIterator::operator++ ()"
Prefix ++ makes the succeeding item current and returns the new current item.
.PP
If the current iterator item was the last item in the dictionary or if it was null, null is returned.
.SH "type * QDictIterator::operator+= ( uint jump )"
Sets the current item to the item \fIjump\fR positions after the current item, and returns a pointer to that item.
.PP
If that item is beyond the last item or if the dictionary is empty, it sets the current item to null and returns null.
.SH "type * QDictIterator::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 null and 
returns null.
.SH "SEE ALSO"
.BR http://doc.trolltech.com/qdictiterator.html
.SH COPYRIGHT
Copyright 1992-2000 Trolltech AS, http://www.trolltech.com/.  See the
license file included in the distribution for a complete license
statement.
.SH AUTHOR
Generated automatically from the source code.