src/qml/qml/qqmlcleanup_p.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 QtQml module 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 QQMLCLEANUP_P_H
  43 #define QQMLCLEANUP_P_H
  44
  45 #include <private/qtqmlglobal_p.h>
  46
  47 //
  48 //  W A R N I N G
  49 //  -------------
  50 //
  51 // This file is not part of the Qt API.  It exists purely as an
  52 // implementation detail.  This header file may change from version to
  53 // version without notice, or even be removed.
  54 //
  55 // We mean it.
  56 //
  57
  58 QT_BEGIN_NAMESPACE
  59
  60 class QQmlEngine;
  61
  62 class Q_QML_PRIVATE_EXPORT QQmlCleanup
  63 {
  64 public:
  65     QQmlCleanup();
  66     QQmlCleanup(QQmlEngine *);
  67     virtual ~QQmlCleanup();
  68
  69     bool hasEngine() const { return prev != 0; }
  70     void addToEngine(QQmlEngine *);
  71 protected:
  72     virtual void clear() = 0;
  73
  74 private:
  75     friend class QQmlEnginePrivate;
  76     QQmlCleanup **prev;
  77     QQmlCleanup  *next;
  78
  79     // Only used for asserts
  80     QQmlEngine *engine;
  81 };
  82
  83 QT_END_NAMESPACE
  84
  85 #endif // QQMLCLEANUP_P_H
  86