/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtGui module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QTREEWIDGETITEMITERATOR_H

#define QTREEWIDGETITEMITERATOR_H

#include <QtCore/qglobal.h>

#include <QtCore/qscopedpointer.h>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(Gui)

#ifndef QT_NO_TREEWIDGET

class QTreeWidget;

class QTreeWidgetItem;

class QTreeModel;

class QTreeWidgetItemIteratorPrivate;

class Q_GUI_EXPORT QTreeWidgetItemIterator

{

    friend class QTreeModel;

public:

    enum IteratorFlag {

        All           = 0x00000000,

        Hidden        = 0x00000001,

        NotHidden     = 0x00000002,

        Selected      = 0x00000004,

        Unselected    = 0x00000008,

        Selectable    = 0x00000010,

        NotSelectable = 0x00000020,

        DragEnabled   = 0x00000040,

        DragDisabled  = 0x00000080,

        DropEnabled   = 0x00000100,

        DropDisabled  = 0x00000200,

        HasChildren   = 0x00000400,

        NoChildren    = 0x00000800,

        Checked       = 0x00001000,

        NotChecked    = 0x00002000,

        Enabled       = 0x00004000,

        Disabled      = 0x00008000,

        Editable      = 0x00010000,

        NotEditable   = 0x00020000,

        UserFlag      = 0x01000000 // The first flag that can be used by the user.

    };

    Q_DECLARE_FLAGS(IteratorFlags, IteratorFlag)

    QTreeWidgetItemIterator(const QTreeWidgetItemIterator &it);

    explicit QTreeWidgetItemIterator(QTreeWidget *widget, IteratorFlags flags = All);

    explicit QTreeWidgetItemIterator(QTreeWidgetItem *item, IteratorFlags flags = All);

    ~QTreeWidgetItemIterator();

    QTreeWidgetItemIterator &operator=(const QTreeWidgetItemIterator &it);

    QTreeWidgetItemIterator &operator++();

    inline const QTreeWidgetItemIterator operator++(int);

    inline QTreeWidgetItemIterator &operator+=(int n);

    QTreeWidgetItemIterator &operator--();

    inline const QTreeWidgetItemIterator operator--(int);

    inline QTreeWidgetItemIterator &operator-=(int n);

    inline QTreeWidgetItem *operator*() const;

private:

    bool matchesFlags(const QTreeWidgetItem *item) const;

    QScopedPointer<QTreeWidgetItemIteratorPrivate> d_ptr;

    QTreeWidgetItem *current;

    IteratorFlags flags;

    Q_DECLARE_PRIVATE(QTreeWidgetItemIterator)

};

inline const QTreeWidgetItemIterator QTreeWidgetItemIterator::operator++(int)

{

    QTreeWidgetItemIterator it = *this;

    ++(*this);

    return it;

}

inline const QTreeWidgetItemIterator QTreeWidgetItemIterator::operator--(int)

{

    QTreeWidgetItemIterator it = *this;

    --(*this);

    return it;

}

inline QTreeWidgetItemIterator &QTreeWidgetItemIterator::operator+=(int n)

{

    if (n < 0)

        return (*this) -= (-n);

    while (current && n--)

        ++(*this);

    return *this;

}

inline QTreeWidgetItemIterator &QTreeWidgetItemIterator::operator-=(int n)

{

    if (n < 0)

        return (*this) += (-n);

    while (current && n--)

        --(*this);

    return *this;

}

inline QTreeWidgetItem *QTreeWidgetItemIterator::operator*() const

{

    return current;

}

Q_DECLARE_OPERATORS_FOR_FLAGS(QTreeWidgetItemIterator::IteratorFlags)

QT_END_NAMESPACE

#endif // QT_NO_TREEWIDGET

QT_END_HEADER

#endif // QTREEWIDGETITEMITERATOR_H