aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorFrederik Gladhorn <frederik.gladhorn@digia.com>2013-12-06 15:06:03 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-12-06 20:27:07 +0100
commite27f9d232f38e13307ac99284fdd954932f9554a (patch)
tree1f89746890f1f147621888565d1c7d7e11fe3f0b /doc
parentef22abaf91de79b9b47f20e71305a1cdea177da0 (diff)
Split documentation into C++ and QML
Change-Id: I8737e6cbfd2fccf78d77de52353e98478fd5eecc Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/images/object_browser_first_city_object.pngbin84088 -> 0 bytes
-rw-r--r--doc/qtenginio.qdocconf52
-rw-r--r--doc/snippets/models.qml100
-rw-r--r--doc/snippets/simple.qml68
4 files changed, 0 insertions, 220 deletions
diff --git a/doc/images/object_browser_first_city_object.png b/doc/images/object_browser_first_city_object.png
deleted file mode 100644
index 6024be3..0000000
--- a/doc/images/object_browser_first_city_object.png
+++ /dev/null
Binary files differ
diff --git a/doc/qtenginio.qdocconf b/doc/qtenginio.qdocconf
deleted file mode 100644
index 7284de6..0000000
--- a/doc/qtenginio.qdocconf
+++ /dev/null
@@ -1,52 +0,0 @@
-include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
-
-project = qtenginio
-description = Client library for accessing Enginio service from Qt and QML code
-url = http://engin.io
-
-sourcedirs += ../src/enginio_client
-sourcedirs += ../src/enginio_plugin
-headerdirs += ../src/enginio_client
-headerdirs += ../src/enginio_plugin
-
-imagedirs += images
-
-outputdir = ./html
-outputformats = HTML
-
-exampledirs += \
- ../examples/quick \
- ../examples/widgets \
- snippets \
- ../tests/auto \
-
-depends += qtcore qtgui qtwidgets qtnetwork qtdoc qtqml qtquick qtquickcontrols
-
-qhp.projects = Enginio
-
-qhp.Enginio.file = qtenginio.qhp
-qhp.Enginio.namespace = io.engin.100
-qhp.Enginio.virtualFolder = enginio
-qhp.Enginio.indexTitle = Enginio Overview
-qhp.Enginio.indexRoot =
-
-qhp.Enginio.filterAttributes = enginio 1.0.0
-qhp.Enginio.customFilters.Qt.name = Enginio 1.0.0
-qhp.Enginio.customFilters.Qt.filterAttributes = enginio 1.0.0
-
-qhp.Enginio.subprojects = classes qmltypes examples
-
-qhp.Enginio.subprojects.classes.title = C++ Classes
-qhp.Enginio.subprojects.classes.indexTitle = Enginio C++ Classes
-qhp.Enginio.subprojects.classes.selectors = class
-qhp.Enginio.subprojects.classes.sortPages = true
-
-qhp.Enginio.subprojects.qmltypes.title = QML Types
-qhp.Enginio.subprojects.qmltypes.indexTitle = Enginio QML Types
-qhp.Enginio.subprojects.qmltypes.selectors = fake:qmlclass
-qhp.Enginio.subprojects.qmltypes.sortPages = true
-
-qhp.Enginio.subprojects.examples.title = Examples
-qhp.Enginio.subprojects.examples.indexTitle = Enginio Examples
-qhp.Enginio.subprojects.examples.selectors = fake:example
-qhp.Enginio.subprojects.examples.sortPages = true
diff --git a/doc/snippets/models.qml b/doc/snippets/models.qml
deleted file mode 100644
index 5e5dcfb..0000000
--- a/doc/snippets/models.qml
+++ /dev/null
@@ -1,100 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
-** Contact: http://www.qt-project.org/legal
-**
-** This file is part of the documentation of the QtEnginio library.
-**
-** $QT_BEGIN_LICENSE:BSD$
-** You may use this file under the terms of the BSD license as follows:
-**
-** "Redistribution and use in source and binary forms, with or without
-** modification, are permitted provided that the following conditions are
-** met:
-** * Redistributions of source code must retain the above copyright
-** notice, this list of conditions and the following disclaimer.
-** * Redistributions in binary form must reproduce the above copyright
-** notice, this list of conditions and the following disclaimer in
-** the documentation and/or other materials provided with the
-** distribution.
-** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
-** of its contributors may be used to endorse or promote products derived
-** from this software without specific prior written permission.
-**
-**
-** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
-**
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-import QtQuick 2.0
-import Enginio 1.0
-import "../../examples/qml/config.js" as Config
-
-Rectangle {
- width: 400
- height: 400
-
- EnginioClient {
- id: client
- backendId: Config.id
- onFinished: console.log("Engino request finished." + reply.data)
- onError: console.log("Enginio error " + reply.errorCode + ": " + reply.errorString)
- }
-
- //! [model]
- EnginioModel {
- id: enginioModel
- client: client
- query: { "objectType": "objects.city" }
- }
- //! [model]
-
- //! [view]
- ListView {
- anchors.fill: parent
- model: enginioModel
- delegate: Text {
- text: name + ": " + population
- }
- }
- //! [view]
-
- Rectangle {
- color: "lightsteelblue"
- width: parent.width
- height: 30
- anchors.bottom: parent.bottom
- Text {
- anchors.centerIn: parent
- text: "Add Berlin"
- }
- MouseArea {
- anchors.fill: parent
- onClicked: addCity()
- }
- }
-
- //! [append]
- function addCity() {
- var berlin = {
- "objectType": "objects.city",
- "name": "Berlin",
- "population": 3300000
- }
- enginioModel.append(berlin)
- }
- //! [append]
-
-}
diff --git a/doc/snippets/simple.qml b/doc/snippets/simple.qml
deleted file mode 100644
index 58dac5f..0000000
--- a/doc/snippets/simple.qml
+++ /dev/null
@@ -1,68 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
-** Contact: http://www.qt-project.org/legal
-**
-** This file is part of the documentation of the QtEnginio library.
-**
-** $QT_BEGIN_LICENSE:BSD$
-** You may use this file under the terms of the BSD license as follows:
-**
-** "Redistribution and use in source and binary forms, with or without
-** modification, are permitted provided that the following conditions are
-** met:
-** * Redistributions of source code must retain the above copyright
-** notice, this list of conditions and the following disclaimer.
-** * Redistributions in binary form must reproduce the above copyright
-** notice, this list of conditions and the following disclaimer in
-** the documentation and/or other materials provided with the
-** distribution.
-** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
-** of its contributors may be used to endorse or promote products derived
-** from this software without specific prior written permission.
-**
-**
-** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
-**
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-import QtQuick 2.0
-//! [import]
-import Enginio 1.0
-//! [import]
-
-Rectangle {
- //! [client]
- EnginioClient {
- id: client
- backendId: "YOUR_BACKEND_ID" // from Enginio Dashboard
- }
- //! [client]
-
- //! [client-signals]
- EnginioClient {
- ...
- onFinished: console.log("Engino request finished." + reply.data)
- onError: console.log("Enginio error " + reply.errorCode + ": " + reply.errorString)
- }
- //! [client-signals]
-
- //! [client-query]
- EnginioClient {
- ...
- Component.onCompleted: query({"objectType": "objects.image"})
- }
- //! [client-query]
-}