aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/doc/src/cppextensionpoints.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/quick/doc/src/cppextensionpoints.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/quick/doc/src/cppextensionpoints.qdoc')
-rw-r--r--src/quick/doc/src/cppextensionpoints.qdoc52
1 files changed, 52 insertions, 0 deletions
diff --git a/src/quick/doc/src/cppextensionpoints.qdoc b/src/quick/doc/src/cppextensionpoints.qdoc
new file mode 100644
index 0000000000..953d804b60
--- /dev/null
+++ b/src/quick/doc/src/cppextensionpoints.qdoc
@@ -0,0 +1,52 @@
+/****************************************************************************
+**
+** 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 qtquick-cppextensionpoints.html
+\title C++ Extension Points Provided By Qt Quick
+\brief Description of the C++ extension points provided by the Qt Quick module
+
+// XXX TODO: should this be a topic page? Are each of the sections below big enough to require their own page?
+
+Qt Quick provides several extension and integration points for C++ developers.
+In particular, it allows C++ developers to create and register custom
+QQuickItem-derived types which can be rendered by Qt Quick. It also provides
+several scene graph-related classes which allow developers to define their own
+rendering primitives.
+
+\section1 User-Defined QQuickItem-Derived Types
+
+While the Qt Quick module already provides a rich library of visual item types
+for use in a QML application, some developers may wish to define their own
+item-derived types in C++ and expose them to the QML type system.
+
+\section1 Scene Graph-Related Classes
+
+As an OpenGL-based scene graph, the scene graph in Qt Quick uses nodes which
+may be geometries or textures.
+
+*/