QValueListIterator Class

Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# QValueListIterator Class Reference

The QValueListIterator class provides an iterator for QValueList. More...

`#include <qvaluelist.h>`

List of all member functions.

## Public Members

- typedef T value_type
- typedef T * pointer
- typedef T & reference
- QValueListIterator ()
- QValueListIterator ( const QValueListIterator<T> & it )
- bool operator== ( const QValueListIterator<T> & it ) const
- bool operator!= ( const QValueListIterator<T> & it ) const
- const T & operator* () const
- T & operator* ()
- QValueListIterator<T> & operator++ ()
- QValueListIterator<T> operator++ ( int )
- QValueListIterator<T> & operator-- ()
- QValueListIterator<T> operator-- ( int )

## Detailed Description

The QValueListIterator class provides an iterator for QValueList.

An iterator is a class for accessing the elements of a container classes - a generalization of the index in an array. A pointer into a "const char *" and an index into an "int[]" are both iterators, and the general idea is to provide that functionality for any data structure.

The QValueListIterator class is an iterator for QValueList instantiations. You can create the appropriate iterator type by using the `iterator` typedef provided by QValueList.

The only way to access the elements in a QValueList is to use an iterator.

Example (see QValueList for the complete code):

        EmployeeList::iterator it;
        for ( it = list.begin(); it != list.end(); ++it )
            cout << (*it).surname().latin1() << ", " <<
                    (*it).forename().latin1() << " earns " <<
                    (*it).salary() << endl;

        // Output:
        // Doe, John earns 50000
        // Williams, Jane earns 80000
        // Hawthorne, Mary earns 90000
        // Jones, Tom earns 60000

QValueList is highly optimized for performance and memory usage. This means that you must be careful: QValueList does not know about all its iterators and the iterators don't know to which list they belong. This makes things very fast, but if you're not careful, you can get spectacular bugs. Always make sure iterators are valid before dereferencing them or using them as parameters to generic algorithms in the STL or the QTL.

Using an invalid iterator is undefined (your application will probably crash).

For every Iterator there is a ConstIterator. When accessing a QValueList in a const environment or if the reference or pointer to the list is itself const, then you must use the ConstIterator. Its semantics are the same as the Iterator, but it returns only const references.

See also QValueList, QValueListConstIterator, Qt Template Library Classes and Non-GUI Classes.

## Member Type Documentation

### QValueListIterator::pointer

Pointer to value_type.

### QValueListIterator::reference

Reference to value_type.

### QValueListIterator::value_type

The type of value, T.

## Member Function Documentation

### QValueListIterator::QValueListIterator ()

Creates un uninitialized iterator.

### QValueListIterator::QValueListIterator ( const QValueListIterator<T> & it )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Constructs a copy of the iterator it.

### bool QValueListIterator::operator!= ( const QValueListIterator<T> & it ) const

Compares this iterator and it and returns TRUE if they point to different items; otherwise returns FALSE.

### T & QValueListIterator::operator* ()

Asterisk operator. Returns a reference to the current iterator item.

### const T & QValueListIterator::operator* () const

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Asterisk operator. Returns a reference to the current iterator item.

### QValueListIterator<T> & QValueListIterator::operator++ ()

Prefix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the list. Incrementing the iterator as returned by end() causes undefined results.

### QValueListIterator<T> QValueListIterator::operator++ ( int )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Postfix ++ makes the succeeding item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the end of the list. Incrementing the iterator as returned by end() causes undefined results.

### QValueListIterator<T> & QValueListIterator::operator-- ()

Prefix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the list. Decrementing the iterator as returned by begin() causes undefined results.

### QValueListIterator<T> QValueListIterator::operator-- ( int )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Postfix -- makes the previous item current and returns an iterator pointing to the new current item. The iterator cannot check whether it reached the beginning of the list. Decrementing the iterator as returned by begin() causes undefined results.

### bool QValueListIterator::operator== ( const QValueListIterator<T> & it ) const

Compares this iterator and it and returns TRUE if they point to the same item; otherwise returns FALSE.

This file is part of the Qt toolkit, copyright © 1995-2001 Trolltech, all rights reserved.