QList< T >::const_iterator Class Reference

#include <qlist.h>

Collaboration diagram for QList< T >::const_iterator:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<typename T>
class QList< T >::const_iterator

The QList::const_iterator class provides an STL-style const iterator for QList and QQueue.

QList provides both {STL-style iterators} and {Java-style iterators}. The STL-style iterators are more low-level and more cumbersome to use; on the other hand, they are slightly faster and, for developers who already know STL, have the advantage of familiarity.

QList<T>const_iterator allows you to iterate over a QList<T> (or a QQueue<T>). If you want to modify the QList as you iterate over it, use QList::iterator instead. It is generally good practice to use QList::const_iterator on a non-const QList as well, unless you need to change the QList through the iterator. Const iterators are slightly faster, and can improve code readability.

The default QList::const_iterator constructor creates an uninitialized iterator. You must initialize it using a QList function like QList::constBegin(), QList::constEnd(), or QList::insert() before you can start iterating. Here's a typical loop that prints all the items stored in a list:

        QList<QString> list;
        list.append("January");
        list.append("February");
        ...
        list.append("December");

        QList<QString>::const_iterator i;
        for (i = list.constBegin(); i != list.constEnd(); ++i)
            cout << *i << endl;

Most QList functions accept an integer index rather than an iterator. For that reason, iterators are rarely useful in connection with QList. One place where STL-style iterators do make sense is as arguments to {generic algorithms}.

For example, here's how to delete all the widgets stored in a QList<QWidget *>:

        QList<QWidget *> list;
        ...
        qDeleteAll(list.constBegin(), list.constEnd());

Multiple iterators can be used on the same list. However, be aware that any non-const function call performed on the QList will render all existing iterators undefined. If you need to keep iterators over a long period of time, we recommend that you use QLinkedList rather than QList.

See also:
QList::iterator, QListIterator

Definition at line 175 of file qlist.h.

Public Types

typedef std::random_access_iterator_tag iterator_category
typedef ptrdiff_t difference_type
typedef T value_type
typedef const T * pointer
typedef const T & reference

Public Member Functions

 const_iterator ()
 const_iterator (Node *n)
 const_iterator (const const_iterator &o)
 const_iterator (const iterator &o)
const T & operator * () const
const T * operator-> () const
const T & operator[] (int j) const
bool operator== (const const_iterator &o) const
bool operator!= (const const_iterator &o) const
bool operator< (const const_iterator &other) const
bool operator<= (const const_iterator &other) const
bool operator> (const const_iterator &other) const
bool operator>= (const const_iterator &other) const
const_iteratoroperator++ ()
const_iterator operator++ (int)
const_iteratoroperator-- ()
const_iterator operator-- (int)
const_iteratoroperator+= (int j)
const_iteratoroperator-= (int j)
const_iterator operator+ (int j) const
const_iterator operator- (int j) const
int operator- (const_iterator j) const

Public Attributes

Nodei


Member Typedef Documentation

template<typename T>
QList< T >::const_iterator::iterator_category

Definition at line 178 of file qlist.h.

template<typename T>
QList< T >::const_iterator::difference_type

Definition at line 179 of file qlist.h.

template<typename T>
QList< T >::const_iterator::value_type

Definition at line 180 of file qlist.h.

template<typename T>
QList< T >::const_iterator::pointer

Definition at line 181 of file qlist.h.

template<typename T>
QList< T >::const_iterator::reference

Definition at line 182 of file qlist.h.


Constructor & Destructor Documentation

template<typename T>
QList< T >::const_iterator::const_iterator (  )  [inline]

Constructs an uninitialized iterator.

Functions like operator*() and operator++() should not be called on an uninitialized iterartor. Use operator=() to assign a value to it before using it.

See also:
QList::constBegin() QList::constEnd()

Definition at line 184 of file qlist.h.

Referenced by QList< T >::const_iterator::operator+(), and QList< T >::const_iterator::operator-().

00184 : i(0) {}

template<typename T>
QList< T >::const_iterator::const_iterator ( Node n  )  [inline]

Definition at line 185 of file qlist.h.

00185 : i(n) {}

template<typename T>
QList< T >::const_iterator::const_iterator ( const const_iterator other  )  [inline]

Constructs a copy of other.

Definition at line 186 of file qlist.h.

00186 : i(o.i) {}

template<typename T>
QList< T >::const_iterator::const_iterator ( const iterator other  )  [inline]

Constructs a copy of other.

Definition at line 190 of file qlist.h.

00190 : i(o.i) {}


Member Function Documentation

template<typename T>
const T & QList< T >::const_iterator::operator * (  )  const [inline]

Returns the current item.

See also:
operator->()

Definition at line 192 of file qlist.h.

References QList< T >::const_iterator::i, and QList< T >::Node::t().

00192 { return i->t(); }

Here is the call graph for this function:

template<typename T>
const T * QList< T >::const_iterator::operator-> (  )  const [inline]

Returns a pointer to the current item.

See also:
operator*()

Definition at line 193 of file qlist.h.

References QList< T >::const_iterator::i, and QList< T >::Node::t().

00193 { return &i->t(); }

Here is the call graph for this function:

template<typename T>
const T & QList< T >::const_iterator::operator[] ( int  j  )  const [inline]

Returns the item at position *this + {j}.

This function is provided to make QList iterators behave like C++ pointers.

See also:
operator+()

Definition at line 194 of file qlist.h.

References QList< T >::const_iterator::i, and QList< T >::Node::t().

00194 { return i[j].t(); }

Here is the call graph for this function:

template<typename T>
bool QList< T >::const_iterator::operator== ( const const_iterator other  )  const [inline]

Returns true if other points to the same item as this iterator; otherwise returns false.

See also:
operator!=()

Definition at line 195 of file qlist.h.

References QList< T >::const_iterator::i, and o.

00195 { return i == o.i; }

template<typename T>
bool QList< T >::const_iterator::operator!= ( const const_iterator other  )  const [inline]

Returns true if other points to a different item than this iterator; otherwise returns false.

See also:
operator==()

Definition at line 196 of file qlist.h.

References QList< T >::const_iterator::i, and o.

00196 { return i != o.i; }

template<typename T>
bool QList< T >::const_iterator::operator< ( const const_iterator other  )  const [inline]

Returns true if the item pointed to by this iterator is less than the item pointed to by the other iterator.

Definition at line 197 of file qlist.h.

References QList< T >::const_iterator::i.

00197 { return i < other.i; }

template<typename T>
bool QList< T >::const_iterator::operator<= ( const const_iterator other  )  const [inline]

Returns true if the item pointed to by this iterator is less than or equal to the item pointed to by the other iterator.

Definition at line 198 of file qlist.h.

References QList< T >::const_iterator::i.

00198 { return i <= other.i; }

template<typename T>
bool QList< T >::const_iterator::operator> ( const const_iterator other  )  const [inline]

Returns true if the item pointed to by this iterator is greater than the item pointed to by the other iterator.

Definition at line 199 of file qlist.h.

References QList< T >::const_iterator::i.

00199 { return i > other.i; }

template<typename T>
bool QList< T >::const_iterator::operator>= ( const const_iterator other  )  const [inline]

Returns true if the item pointed to by this iterator is greater than or equal to the item pointed to by the other iterator.

Definition at line 200 of file qlist.h.

References QList< T >::const_iterator::i.

00200 { return i >= other.i; }

template<typename T>
QList::const_iterator & QList< T >::const_iterator::operator++ (  )  [inline]

The prefix ++ operator ({++it}) advances the iterator to the next item in the list and returns an iterator to the new current item.

Calling this function on QList::end() leads to undefined results.

See also:
operator--()

Definition at line 201 of file qlist.h.

References QList< T >::const_iterator::i.

00201 { ++i; return *this; }

template<typename T>
QList::const_iterator QList< T >::const_iterator::operator++ ( int   )  [inline]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. The postfix ++ operator ({it++}) advances the iterator to the next item in the list and returns an iterator to the previously current item.

Definition at line 202 of file qlist.h.

References QList< T >::const_iterator::i, and n.

00202 { Node *n = i; ++i; return n; }

template<typename T>
QList::const_iterator & QList< T >::const_iterator::operator-- (  )  [inline]

The prefix -- operator ({--it}) makes the preceding item current and returns an iterator to the new current item.

Calling this function on QList::begin() leads to undefined results.

See also:
operator++()

Definition at line 203 of file qlist.h.

References QList< T >::const_iterator::i.

00203 { i--; return *this; }

template<typename T>
QList::const_iterator QList< T >::const_iterator::operator-- ( int   )  [inline]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. The postfix -- operator ({it--}) makes the preceding item current and returns an iterator to the previously current item.

Definition at line 204 of file qlist.h.

References QList< T >::const_iterator::i, and n.

00204 { Node *n = i; i--; return n; }

template<typename T>
QList::const_iterator & QList< T >::const_iterator::operator+= ( int  j  )  [inline]

Advances the iterator by j items. (If j is negative, the iterator goes backward.)

See also:
operator-=(), operator+()

Definition at line 205 of file qlist.h.

References QList< T >::const_iterator::i.

00205 { i+=j; return *this; }

template<typename T>
QList::const_iterator & QList< T >::const_iterator::operator-= ( int  j  )  [inline]

Makes the iterator go back by j items. (If j is negative, the iterator goes forward.)

See also:
operator+=(), operator-()

Definition at line 206 of file qlist.h.

References QList< T >::const_iterator::i.

00206 { i-=j; return *this; }

template<typename T>
QList::const_iterator QList< T >::const_iterator::operator+ ( int  j  )  const [inline]

Returns an iterator to the item at j positions forward from this iterator. (If j is negative, the iterator goes backward.)

See also:
operator-(), operator+=()

Definition at line 207 of file qlist.h.

References QList< T >::const_iterator::const_iterator(), and QList< T >::const_iterator::i.

00207 { return const_iterator(i+j); }

Here is the call graph for this function:

template<typename T>
QList::const_iterator QList< T >::const_iterator::operator- ( int  j  )  const [inline]

Returns an iterator to the item at j positions backward from this iterator. (If j is negative, the iterator goes forward.)

See also:
operator+(), operator-=()

Definition at line 208 of file qlist.h.

References QList< T >::const_iterator::const_iterator(), and QList< T >::const_iterator::i.

00208 { return const_iterator(i-j); }

Here is the call graph for this function:

template<typename T>
int QList< T >::const_iterator::operator- ( const_iterator  other  )  const [inline]

Returns the number of items between the item pointed to by other and the item pointed to by this iterator.

Definition at line 209 of file qlist.h.

References QList< T >::const_iterator::i, and j.

00209 { return i - j.i; }


Member Data Documentation

template<typename T>
Node* QList< T >::const_iterator::i

Definition at line 177 of file qlist.h.

Referenced by QList< T >::const_iterator::operator *(), QList< T >::const_iterator::operator!=(), QList< T >::const_iterator::operator+(), QList< T >::const_iterator::operator++(), QList< T >::const_iterator::operator+=(), QList< T >::const_iterator::operator-(), QList< T >::const_iterator::operator--(), QList< T >::const_iterator::operator-=(), QList< T >::const_iterator::operator->(), QList< T >::const_iterator::operator<(), QList< T >::const_iterator::operator<=(), QList< T >::const_iterator::operator==(), QList< T >::const_iterator::operator>(), QList< T >::const_iterator::operator>=(), and QList< T >::const_iterator::operator[]().


The documentation for this class was generated from the following files:
Generated on Thu Mar 15 18:16:25 2007 for Qt 4.2 User's Guide by  doxygen 1.5.1