summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFrederik Gladhorn <frederik.gladhorn@digia.com>2013-06-05 18:09:28 +0200
committerFrederik Gladhorn <frederik.gladhorn@digia.com>2013-06-05 18:09:28 +0200
commitfb60a431c893262dc978e2eb0fc8690f351de1c4 (patch)
treeafa1b07a1f37e24d19980e84eaf60e6be7699cf4 /doc
parent82463b455f71ec450c7ef3efc562a24e3a7155d3 (diff)
downloadqtenginio-fb60a431c893262dc978e2eb0fc8690f351de1c4.tar.gz
More docs.
Diffstat (limited to 'doc')
-rw-r--r--doc/enginio-qt.qdocconf4
-rw-r--r--doc/snippets/simple.qml26
2 files changed, 29 insertions, 1 deletions
diff --git a/doc/enginio-qt.qdocconf b/doc/enginio-qt.qdocconf
index f4ba1a1..4da13bb 100644
--- a/doc/enginio-qt.qdocconf
+++ b/doc/enginio-qt.qdocconf
@@ -14,5 +14,7 @@ imagedirs += images
outputdir = ./html
outputformats = HTML
-exampledirs += ../examples/qml
+exampledirs += \
+ ../examples/qml \
+ snippets
diff --git a/doc/snippets/simple.qml b/doc/snippets/simple.qml
new file mode 100644
index 0000000..8f2b2bf
--- /dev/null
+++ b/doc/snippets/simple.qml
@@ -0,0 +1,26 @@
+
+import QtQuick 2.0
+import Enginio 1.0
+
+Rectangle {
+ //! [client]
+ Enginio {
+ id: client
+ backendId: "YOUR_BACKEND_ID" // from Enginio Dashboard
+ backendSecret: "YOUR_BACKEND_SECRET" // from Enginio Dashboard
+ }
+ //! [client]
+
+ //! [client-signals]
+ Enginio {
+ onFinished: console.log("Engino request finished." + reply.data)
+ onError: console.log("Enginio error " + reply.errorCode + ": " + reply.errorString)
+ }
+ //! [client-signals]
+
+ //! [client-query]
+ Enginio {
+ Component.onCompleted: query({objectType: "objects.image",})
+ }
+ //! [client-query]
+}