tests/auto/xmlpatternssdk/TreeItem.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the test suite of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef PatternistSDK_TreeItem_H
  43 #define PatternistSDK_TreeItem_H
  44
  45 #include <QObject>
  46
  47 #include "Global.h"
  48
  49 QT_BEGIN_HEADER
  50
  51 QT_BEGIN_NAMESPACE
  52
  53 class QVariant;
  54 template<typename T> class QList;
  55 template<typename T> class QPointer;
  56
  57 namespace QPatternistSDK
  58 {
  59     /**
  60      * @short TreeItem is a node in a hierachial structure and is used together
  61      * with TreeModel.
  62      *
  63      * TreeItem is abstract base class. Instances of sub-classes of TreeItem
  64      * can be used with TreeModel in order to use hierarchial data in Qt's
  65      * model/view framework.
  66      *
  67      * TreeItem is a QObject in order to be able to be used with QPointer.
  68      *
  69      * @author Frans Englich <frans.englich@nokia.com>
  70      * @see TreeModel
  71      * @ingroup PatternistSDK
  72      */
  73     class Q_PATTERNISTSDK_EXPORT TreeItem : public QObject
  74     {
  75         Q_OBJECT
  76     public:
  77         typedef QList<QPointer<TreeItem> > List;
  78
  79         virtual ~TreeItem() {}
  80         virtual void appendChild(TreeItem *item) = 0;
  81         virtual TreeItem *child(const unsigned int row) const = 0;
  82         virtual unsigned int childCount() const = 0;
  83         virtual TreeItem *parent() const = 0;
  84
  85         virtual TreeItem::List children() const = 0;
  86         virtual int columnCount() const = 0;
  87
  88         /**
  89          * Determines the position among the children of
  90          * this TreeItem's parent. This is done by introspecting the result
  91          * of children().
  92          */
  93         int row() const;
  94
  95         virtual QVariant data(const Qt::ItemDataRole role, int column) const = 0;
  96
  97     Q_SIGNALS:
  98         /**
  99          * Emitted whenever this item changed. This is used for keeping
 100          * views in synchronization with the item model which houses
 101          * this item.
 102          *
 103          * @param item the item which changed. That is, this TreeItem.
 104          */
 105         void changed(TreeItem *item);
 106     };
 107 }
 108
 109 QT_END_NAMESPACE
 110
 111 QT_END_HEADER
 112
 113 #endif
 114 // vim: et:ts=4:sw=4:sts=4