summaryrefslogtreecommitdiffstats
path: root/src/declarative/qml/qmlcustomparser.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/declarative/qml/qmlcustomparser.cpp')
-rw-r--r--src/declarative/qml/qmlcustomparser.cpp96
1 files changed, 96 insertions, 0 deletions
diff --git a/src/declarative/qml/qmlcustomparser.cpp b/src/declarative/qml/qmlcustomparser.cpp
new file mode 100644
index 0000000..a342ca8
--- /dev/null
+++ b/src/declarative/qml/qmlcustomparser.cpp
@@ -0,0 +1,96 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Qt Software Information (qt-info@nokia.com)
+**
+** This file is part of the QtDeclarative module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the either Technology Preview License Agreement or the
+** Beta Release License Agreement.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain
+** additional rights. These rights are described in the Nokia Qt LGPL
+** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
+** package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at qt-sales@nokia.com.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qmlcustomparser.h"
+
+
+QT_BEGIN_NAMESPACE
+
+/*!
+ \class QmlCustomParser
+ \brief The QmlCustomParser class allows you to add new arbitrary types to QML.
+
+ By subclassing QmlCustomParser, you can add an XML parser for building a
+ particular type.
+
+ The subclass must implement compile() and create(), and define itself in
+ the meta type system with one of the macros:
+
+ \code
+ QML_DEFINE_CUSTOM_PARSER(Name, parserClass)
+ \endcode
+
+ \code
+ QML_DEFINE_CUSTOM_PARSER_NS("XmlNamespaceUri", Name, parserClass)
+ \endcode
+*/
+
+/*!
+ \fn QByteArray QmlCustomParser::compile(QXmlStreamReader& reader, bool *ok)
+
+ Upon entry to this function, \a reader is positioned on a QXmlStreamReader::StartElement
+ with the name specified when the class was defined with the QML_DEFINE_CUSTOM_PARSER macro.
+
+ The custom parser must consume tokens from \a reader until the EndElement matching the
+ initial start element is reached, or until error.
+
+ On return, \c *ok indicates success.
+
+ The returned QByteArray contains data meaningful only to the custom parser; the
+ type engine will pass this same data to create() when making an instance of the data.
+
+ The QByteArray may be cached between executions of the system, so it must contain
+ correctly-serialized data (not, for example, pointers to stack objects).
+*/
+
+/*!
+ \fn QVariant QmlCustomParser::create(const QByteArray &data)
+
+ This function returns a QVariant containing the value represented by \a data, which
+ is a block of data previously returned by a call to compile().
+
+ If the compile is for a type, the variant should be a pointer to the
+ correctly-named QObject subclass (i.e. the one defined by QML_DEFINE_TYPE for
+ the same-named type as this custom parser is defined for).
+*/
+
+
+QT_END_NAMESPACE