Docs - add missing images and code, clean up sections
[profile/ivi/qtdeclarative.git] / src / qml / qml / qqmlcleanup_p.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 QtQml module 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 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