aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc/src/cppclasses/topic.qdoc
diff options
context:
space:
mode:
authorChris Adams <christopher.adams@nokia.com>2012-05-28 17:12:56 +1000
committerQt by Nokia <qt-info@nokia.com>2012-06-21 09:58:56 +0200
commit5e33b0f580d2b20f1a2989bf2ee8dde4525a2e39 (patch)
tree780d25ce7d8955e56ea985a35dd84609df12fbf0 /src/qml/doc/src/cppclasses/topic.qdoc
parent03342a435a88656d64d1445991a4421d244fcb45 (diff)
Create new documentation structure
The documentation currently has no clear separation between Qt QML and Qt Quick. With recent commits like: 6c8378eaf1edbbefe6aaa3672b0127816a004fd7 and ab1e510121c8a679fdaca12ccd30e0f7ac12a26b the separation between the language definition and implementation, provided by Qt QML, and the standard library for the QML language, provided by Qt Quick, is clear. This commit creates a new documentation structure that is more navigable and separates concepts into logical categories, with clear separation between QtQML and QtQuick. It also provides a more generic QML Application Developer Resources page which contains links to information for QML application developers. Change-Id: Ia807ccfbfd24ffa0e1c7f0a51ed9d2ed3aa6a733 Reviewed-by: Martin Jones <martin.jones@nokia.com>
Diffstat (limited to 'src/qml/doc/src/cppclasses/topic.qdoc')
-rw-r--r--src/qml/doc/src/cppclasses/topic.qdoc68
1 files changed, 68 insertions, 0 deletions
diff --git a/src/qml/doc/src/cppclasses/topic.qdoc b/src/qml/doc/src/cppclasses/topic.qdoc
new file mode 100644
index 0000000000..24d0674f2b
--- /dev/null
+++ b/src/qml/doc/src/cppclasses/topic.qdoc
@@ -0,0 +1,68 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+/*!
+\page qtqml-cppclasses-topic.html
+\title C++ Classes Provided By The Qt QML Module
+\brief Overview of the C++ classes provided by the Qt QML module
+
+The Qt QML module provides C++ classes which implement the QML framework.
+Clients can use these classes to interact with the QML run-time (for example,
+by injecting data or invoking methods on objects), and to instantiate a
+hierarchy of objects from a QML document.
+
+\section1 The QQmlEngine Class
+
+The QQmlEngine class provides an engine which can manage a hierarchy of objects
+which is defined in a QML document. It provides a root QML context within
+which expressions are evaluated, and ensures that properties of objects are
+updated correctly when required.
+
+See \l{qtqml-cppclasses-engine.html}{Qt QML Module C++ Classes - QQmlEngine}
+for in-depth information about QQmlEngine.
+
+\section1 The QQmlComponent Class
+
+The QQmlComponent class is used to load a QML document. It requires a
+QQmlEngine in order to instantiate the hierarchy of objects defined in the QML
+document.
+
+See
+\l{qtqml-cppclasses-component.html}{Qt QML Module C++ Classes - QQmlComponent}
+for in-depth information about QQmlComponent.
+
+\section1 The QQmlContext Class
+
+The QQmlContext class provides a context for object instantiation and
+expression evaluation. All objects are instantiated in a particular context,
+and all of the expressions which are evaluated while an application is running
+are evaluated within a particular context. This context defines how symbols
+are resolved, and thus which values the expression operates on.
+
+See \l{qtqml-cppclasses-context.html}{Qt QML Module C++ Classes - QQmlContext}
+for in-depth information about QQmlContext.
+
+*/