QListViewItemIterator(3qt)

NAME
QListViewItemIterator - Iterator for collections of QListViewItems

#include <qlistview.h>

  Public Members
QListViewItemIterator ()
QListViewItemIterator ( QListViewItem * item )
QListViewItemIterator ( const QListViewItemIterator & it )
QListViewItemIterator ( QListView * lv )
QListViewItemIterator & operator= ( const QListViewItemIterator & it )
~QListViewItemIterator ()
QListViewItemIterator & operator++ ()
const QListViewItemIterator operator++ ( int )
QListViewItemIterator & operator+= ( int j )
QListViewItemIterator & operator-- ()
const QListViewItemIterator operator-- ( int )
QListViewItemIterator & operator-= ( int j )
QListViewItem * current () const

DESCRIPTION
The QListViewItemIterator class provides an iterator for collections of QListViewItems.

Construct an instance of a QListViewItemIterator, with either a QListView* or a QListViewItem* as argument, to operate on the tree of QListViewItems.

A QListViewItemIterator iterates over all items of a list view. This means that it always makes the first child of the current item the new current item. If there is no child, the next sibling becomes the new current item; and if there is no next sibling, the next sibling of the parent becomes current.

The following example function gets a list of all the items that have been selected by the user, storing pointers to the items in a QPtrList:

  QPtrList<QListViewItem> * getSelectedItems( QListView *lv ) {
    if ( !lv )
      return 0;
    // Create the list
    QPtrList<QListViewItem> *lst = new QPtrList<QListViewItem>;
    lst->setAutoDelete( FALSE );
    // Create an iterator and give the list view as argument
    QListViewItemIterator it( lv );
    // iterate through all items of the list view
    for ( ; it.current(); ++it ) {
      if ( it.current()->isSelected() )
        lst->append( it.current() );
    }
    return lst;
  }

A QListViewItemIterator provides a convenient and easy way to traverse a hierarchical QListView.

Multiple QListViewItemIterators can operate on the tree of QListViewItems. A QListView knows about all iterators operating on its QListViewItems. So when a QListViewItem gets removed all iterators that point to this item are updated and point to the following item.

See also QListView, QListViewItem and Advanced Widgets.

MEMBER FUNCTION DOCUMENTATION

QListViewItemIterator::QListViewItemIterator ()
Constructs an empty iterator.

QListViewItemIterator::QListViewItemIterator ( QListViewItem * item )
Constructs an iterator for the QListView of the item. The current iterator item is set to point to the item.

QListViewItemIterator::QListViewItemIterator ( const QListViewItemIterator & it )
Constructs an iterator for the same QListView as it. The current iterator item is set to point on the current item of it.

QListViewItemIterator::QListViewItemIterator ( QListView * lv )
Constructs an iterator for the QListView lv. The current iterator item is set to point on the first child ( QListViewItem ) of lv.

QListViewItemIterator::~QListViewItemIterator ()
Destroys the iterator.

QListViewItem * QListViewItemIterator::current () const
Returns a pointer to the current item of the iterator.

Examples:

QListViewItemIterator & QListViewItemIterator::operator++ ()
Prefix ++ makes the next item in the QListViewItem tree of the QListView of the iterator the current item and returns it. If the current item was the last item in the QListView or null, null is returned.

const QListViewItemIterator QListViewItemIterator::operator++ ( int )
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Postfix ++ makes the next item in the QListViewItem tree of the QListView of the iterator the current item and returns the item which was previously current.

QListViewItemIterator & QListViewItemIterator::operator+= ( int j )
Sets the current item to the item j positions after the current item in the QListViewItem hierarchy. If this item is beyond the last item, the current item is set to null.

The new current item (or null, if the new current item is null) is returned.

QListViewItemIterator & QListViewItemIterator::operator-- ()
Prefix -- makes the previous item in the QListViewItem tree of the QListView of the iterator the current item and returns it. If the current item was the last first in the QListView or null, null is returned.

const QListViewItemIterator QListViewItemIterator::operator-- ( int )
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Postfix -- makes the previous item in the QListViewItem tree of the QListView of the iterator the current item and returns the item.

QListViewItemIterator & QListViewItemIterator::operator-= ( int j )
Sets the current item to the item j positions before the current item in the QListViewItem hierarchy. If this item is before the first item, the current item is set to null. The new current item (or null, if the new current item is null) is returned.

QListViewItemIterator & QListViewItemIterator::operator= ( const QListViewItemIterator & it )
Assignment. Makes a copy of it and returns a reference to its iterator.

SEE ALSO
http://doc.trolltech.com/qlistviewitemiterator.html http://www.trolltech.com/faq/tech.html

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

AUTHOR
Generated automatically from the source code.

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 (qlistviewitemiterator.3qt) and the Qt version (3.0.0-beta6).