Improve documentation.
[profile/ivi/qtdeclarative.git] / src / qml / qml / qqmlscriptstring.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 QQMLSCRIPTSTRING_H
43 #define QQMLSCRIPTSTRING_H
44
45 #include <QtQml/qtqmlglobal.h>
46 #include <QtCore/qstring.h>
47 #include <QtCore/qshareddata.h>
48 #include <QtCore/qmetatype.h>
49
50 QT_BEGIN_HEADER
51
52 QT_BEGIN_NAMESPACE
53
54
55 class QObject;
56 class QQmlContext;
57 class QQmlScriptStringPrivate;
58 class Q_QML_EXPORT QQmlScriptString 
59 {
60 public:
61     QQmlScriptString();
62     QQmlScriptString(const QQmlScriptString &);
63     ~QQmlScriptString();
64
65     QQmlScriptString &operator=(const QQmlScriptString &);
66
67     bool isEmpty() const;
68
69     bool isUndefinedLiteral() const;
70     bool isNullLiteral() const;
71     QString stringLiteral() const;
72     qreal numberLiteral(bool *ok) const;
73     bool booleanLiteral(bool *ok) const;
74
75 private:
76     QQmlScriptString(const QString &script, QQmlContext *context, QObject *scope);
77     QSharedDataPointer<QQmlScriptStringPrivate> d;
78
79     friend class QQmlScriptStringPrivate;
80     friend class QQmlVME;
81     friend class QQmlExpression;
82     friend class QQmlBinding;
83 };
84
85 QT_END_NAMESPACE
86
87 Q_DECLARE_METATYPE(QQmlScriptString)
88
89 QT_END_HEADER
90
91 #endif // QQMLSCRIPTSTRING_H
92