tests/auto/xmlpatternssdk/TestContainer.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the test suite of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef PatternistSDK_TestContainer_H
  43 #define PatternistSDK_TestContainer_H
  44
  45 #include "Global.h"
  46 #include "TestItem.h"
  47
  48 QT_BEGIN_HEADER
  49
  50 QT_BEGIN_NAMESPACE
  51
  52 namespace QPatternistSDK
  53 {
  54     /**
  55      * @short an abstract base class, containing
  56      * an appropriate implementation of TestItem for sub-classes
  57      * which can contain other TestItem instances.
  58      *
  59      * @ingroup PatternistSDK
  60      * @author Frans Englich <frans.englich@nokia.com>
  61      */
  62     class Q_PATTERNISTSDK_EXPORT TestContainer : public TestItem
  63     {
  64     public:
  65         virtual ~TestContainer();
  66         virtual void appendChild(TreeItem *item);
  67         virtual TreeItem *child(const unsigned int row) const;
  68         virtual unsigned int childCount() const;
  69
  70         /**
  71          * @returns the TestResults of this TestContainer's children.
  72          */
  73         virtual TestResult::List execute(const ExecutionStage stage,
  74                                          TestSuite *ts);
  75
  76         QString title() const;
  77         void setTitle(const QString &title);
  78
  79         virtual TreeItem::List children() const;
  80
  81         /**
  82          * @return always 2
  83          */
  84         virtual int columnCount() const;
  85
  86         virtual bool isFinalNode() const;
  87
  88         virtual ResultSummary resultSummary() const;
  89         virtual QString description() const;
  90         virtual void setDescription(const QString &desc);
  91
  92         /**
  93          * Determines whether TestContainer will delete its children upon
  94          * destruction. By default, it will.
  95          */
  96         void setDeleteChildren(const bool val);
  97
  98         /**
  99          * Removes the last appended child.
 100          */
 101         void removeLast();
 102
 103     protected:
 104         /**
 105          * Constructor, protected. TestContainer is an abstract class,
 106          * and is not ment to be instantiated, but sub classed.
 107          */
 108         TestContainer();
 109
 110     private:
 111         TreeItem::List  m_children;
 112         QString         m_title;
 113         QString         m_description;
 114         bool            m_deleteChildren;
 115     };
 116 }
 117
 118 QT_END_NAMESPACE
 119
 120 QT_END_HEADER
 121
 122 #endif
 123 // vim: et:ts=4:sw=4:sts=4