Improve documentation.
[profile/ivi/qtdeclarative.git] / src / qml / qml / qqmlnullablevalue_p_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 QQMLNULLABLEVALUE_P_H
43 #define QQMLNULLABLEVALUE_P_H
44
45 //
46 //  W A R N I N G
47 //  -------------
48 //
49 // This file is not part of the Qt API.  It exists purely as an
50 // implementation detail.  This header file may change from version to
51 // version without notice, or even be removed.
52 //
53 // We mean it.
54 //
55
56 QT_BEGIN_NAMESPACE
57
58 template<typename T>
59 struct QQmlNullableValue 
60 {
61     QQmlNullableValue()
62     : isNull(true), value(T()) {}
63     QQmlNullableValue(const QQmlNullableValue<T> &o)
64     : isNull(o.isNull), value(o.value) {}
65     QQmlNullableValue(const T &t)
66     : isNull(false), value(t) {}
67     QQmlNullableValue<T> &operator=(const T &t)
68     { isNull = false; value = t; return *this; }
69     QQmlNullableValue<T> &operator=(const QQmlNullableValue<T> &o)
70     { isNull = o.isNull; value = o.value; return *this; }
71     operator T() const { return value; }
72
73     void invalidate() { isNull = true; }
74     bool isValid() const { return !isNull; }
75     bool isNull;
76     T value;
77 };
78
79 QT_END_NAMESPACE
80
81 #endif // QQMLNULLABLEVALUE_P_H