Doc

1 files changed, 123 insertions, 0 deletions

diff --git a/doc/src/declarative/qtbinding.qdoc b/doc/src/declarative/qtbinding.qdoc
new file mode 100644
index 0000000..94465a1
--- /dev/null
+++ b/doc/src/declarative/qtbinding.qdoc
@@ -0,0 +1,123 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Qt Software Information (qt-info@nokia.com)
+**
+** This file is part of the documentation 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$
+**
+****************************************************************************/
+
+/*!
+\page qtbinding.html
+\target qtbinding
+\title QML/C++ Data Binding
+
+The QML mechanisms of data binding can also be used to bind Qt C++ objects.
+
+The data binding framework is based on Qt's property system (see the Qt documentation for more details on this system). If a binding is meant to be dynamic (where changes in one object are reflected in another object), \c NOTIFY must be specified for the property being tracked. If \c NOTIFY is not specified, any binding to that property will be an 'intialization' binding (the tracking object will be updated only once with the initial value of the tracked object).
+
+Relevant items can also be bound to the contents of a Qt model.
+For example, ListView can make use of data from a QAbstractItemModel-derived model.
+
+
+\section1 Passing Data Between C++ and QML
+
+Data binding provides one method of data transfer between C++ and QML.
+
+For example, lets say you want to implement a slider in QML that changes the screen brightness of the device it is running on. You would start by declaring a brightness property on your QObject-derived class:
+\code
+class MyScreen : public QObject
+{
+    Q_OBJECT
+public:
+    MyScreen(QObject *parent=0);
+
+    Q_PROPERTY(int brightness READ brightness WRITE setBrightness NOTIFY brightnessChanged);
+    int brightness() const;
+    void setBrightness(int b);
+    ...
+
+signals:
+    void brightnessChanged();
+
+private:
+    int m_brightness;
+};
+
+int brightness() const
+{
+    return m_brightness;
+}
+
+void setBrightness(int b)
+{
+    if (b != m_brightness) {
+        m_brightness = b;
+        emit brightnessChanged();
+
+        //set device brightness
+        ...
+    }
+}
+\endcode
+
+\note One important thing to keep in mind is that the changed signal should only be emitted when there is a real change ( \c b \c != \c m_brightness ), or you may get an infinite loop.
+
+Next, make an instance of this class visible to the QML bind engine:
+\code
+QmlView *view = new QmlView;
+view->setUrl("MyUI.qml");
+
+MyScreen *screen = new MyScreen;
+QmlContext *ctxt = view->rootContext();
+ctxt->setContextProperty("screen", screen);
+
+view->execute();
+\endcode
+
+\note Bindings must be made after setUrl() but before execute().
+
+Finally, in QML you can make the appropriate bindings, so in \c "MyUI.qml":
+
+\code
+Slider { value: screen.brightness }
+Binding { target: screen; property: "brightness"; value: slider.value }
+\endcode
+
+The \l QBindableMap class provides a convenient way to make data visible to the bind engine.
+
+C++ \l {qmlmodels}{Data Models} may also be provided to QML.
+
+*/