Doc: Moved QML "plugins" example to "qmlextensionplugins"

The example generates a plugins.html which collides with the
plugins.html from qtbase repository.

Task-number: QTBUG-32580
Change-Id: I47ce9e00378738f7696672e6e47dd3337bb4fafc
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>

12 files changed, 380 insertions, 0 deletions

diff --git a/examples/qml/qmlextensionplugins/doc/images/qml-plugins-example.png b/examples/qml/qmlextensionplugins/doc/images/qml-plugins-example.png
new file mode 100644
index 0000000000..c2d4886ea2
--- /dev/null
+++ b/examples/qml/qmlextensionplugins/doc/images/qml-plugins-example.png
diff --git a/examples/qml/qmlextensionplugins/doc/src/qmlpluginex.qdoc b/examples/qml/qmlextensionplugins/doc/src/qmlpluginex.qdoc
new file mode 100644
index 0000000000..79a48358c8
--- /dev/null
+++ b/examples/qml/qmlextensionplugins/doc/src/qmlpluginex.qdoc
@@ -0,0 +1,42 @@
+/****************************************************************************
+**
+** 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 Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** 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.  Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \title QML Plugin Example
+    \example qmlextensionplugins
+
+    \brief This example creates a C++ plugin extension by subclassing QQmlExtensionPlugin.
+
+    \image qml-plugins-example.png
+
+    To run this example, use the following commands on the prompt:
+    \code
+     > qmake
+     > make
+     > qmlscene -I imports plugins.qml
+    \endcode
+*/
diff --git a/examples/qml/qmlextensionplugins/imports/TimeExample/Clock.qml b/examples/qml/qmlextensionplugins/imports/TimeExample/Clock.qml
new file mode 100644
index 0000000000..fa9cdadd1d
--- /dev/null
+++ b/examples/qml/qmlextensionplugins/imports/TimeExample/Clock.qml
@@ -0,0 +1,88 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the examples of the Qt Toolkit.
+**
+** $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
+
+Rectangle {
+    id: clock
+    width: 200; height: 200; color: "gray"
+
+    property alias city: cityLabel.text
+    property variant hours
+    property variant minutes
+    property variant shift : 0
+
+    Image { id: background; source: "clock.png" }
+
+    Image {
+        x: 92.5; y: 27
+        source: "hour.png"
+        transform: Rotation {
+            id: hourRotation
+            origin.x: 7.5; origin.y: 73;
+            angle: (clock.hours * 30) + (clock.minutes * 0.5)
+            Behavior on angle {
+                SpringAnimation{ spring: 2; damping: 0.2; modulus: 360 }
+            }
+        }
+    }
+
+    Image {
+        x: 93.5; y: 17
+        source: "minute.png"
+        transform: Rotation {
+            id: minuteRotation
+            origin.x: 6.5; origin.y: 83;
+            angle: clock.minutes * 6
+            Behavior on angle {
+                SpringAnimation{ spring: 2; damping: 0.2; modulus: 360 }
+            }
+        }
+    }
+
+    Image {
+        anchors.centerIn: background; source: "center.png"
+    }
+
+    Text {
+        id: cityLabel; font.bold: true; font.pixelSize: 14; y:200; color: "white"
+        anchors.horizontalCenter: parent.horizontalCenter
+    }
+}
diff --git a/examples/qml/qmlextensionplugins/imports/TimeExample/center.png b/examples/qml/qmlextensionplugins/imports/TimeExample/center.png
new file mode 100644
index 0000000000..7fbd802a44
--- /dev/null
+++ b/examples/qml/qmlextensionplugins/imports/TimeExample/center.png
diff --git a/examples/qml/qmlextensionplugins/imports/TimeExample/clock.png b/examples/qml/qmlextensionplugins/imports/TimeExample/clock.png
new file mode 100644
index 0000000000..462edacc0e
--- /dev/null
+++ b/examples/qml/qmlextensionplugins/imports/TimeExample/clock.png
diff --git a/examples/qml/qmlextensionplugins/imports/TimeExample/hour.png b/examples/qml/qmlextensionplugins/imports/TimeExample/hour.png
new file mode 100644
index 0000000000..f8061a1235
--- /dev/null
+++ b/examples/qml/qmlextensionplugins/imports/TimeExample/hour.png
diff --git a/examples/qml/qmlextensionplugins/imports/TimeExample/minute.png b/examples/qml/qmlextensionplugins/imports/TimeExample/minute.png
new file mode 100644
index 0000000000..1297ec7c2b
--- /dev/null
+++ b/examples/qml/qmlextensionplugins/imports/TimeExample/minute.png
diff --git a/examples/qml/qmlextensionplugins/imports/TimeExample/qmldir b/examples/qml/qmlextensionplugins/imports/TimeExample/qmldir
new file mode 100644
index 0000000000..252e662e12
--- /dev/null
+++ b/examples/qml/qmlextensionplugins/imports/TimeExample/qmldir
@@ -0,0 +1,3 @@
+module TimeExample
+Clock 1.0 Clock.qml
+plugin qmlqtimeexampleplugin
diff --git a/examples/qml/qmlextensionplugins/plugin.cpp b/examples/qml/qmlextensionplugins/plugin.cpp
new file mode 100644
index 0000000000..a125138dd0
--- /dev/null
+++ b/examples/qml/qmlextensionplugins/plugin.cpp
@@ -0,0 +1,155 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the examples of the Qt Toolkit.
+**
+** $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$
+**
+****************************************************************************/
+
+#include <QtQml/QQmlExtensionPlugin>
+#include <QtQml/qqml.h>
+#include <qdebug.h>
+#include <qdatetime.h>
+#include <qbasictimer.h>
+#include <qcoreapplication.h>
+
+// Implements a "TimeModel" class with hour and minute properties
+// that change on-the-minute yet efficiently sleep the rest
+// of the time.
+
+class MinuteTimer : public QObject
+{
+    Q_OBJECT
+public:
+    MinuteTimer(QObject *parent) : QObject(parent)
+    {
+    }
+
+    void start()
+    {
+        if (!timer.isActive()) {
+            time = QTime::currentTime();
+            timer.start(60000-time.second()*1000, this);
+        }
+    }
+
+    void stop()
+    {
+        timer.stop();
+    }
+
+    int hour() const { return time.hour(); }
+    int minute() const { return time.minute(); }
+
+signals:
+    void timeChanged();
+
+protected:
+    void timerEvent(QTimerEvent *)
+    {
+        QTime now = QTime::currentTime();
+        if (now.second() == 59 && now.minute() == time.minute() && now.hour() == time.hour()) {
+            // just missed time tick over, force it, wait extra 0.5 seconds
+            time.addSecs(60);
+            timer.start(60500, this);
+        } else {
+            time = now;
+            timer.start(60000-time.second()*1000, this);
+        }
+        emit timeChanged();
+    }
+
+private:
+    QTime time;
+    QBasicTimer timer;
+};
+
+//![0]
+class TimeModel : public QObject
+{
+    Q_OBJECT
+    Q_PROPERTY(int hour READ hour NOTIFY timeChanged)
+    Q_PROPERTY(int minute READ minute NOTIFY timeChanged)
+//![0]
+
+public:
+    TimeModel(QObject *parent=0) : QObject(parent)
+    {
+        if (++instances == 1) {
+            if (!timer)
+                timer = new MinuteTimer(QCoreApplication::instance());
+            connect(timer, SIGNAL(timeChanged()), this, SIGNAL(timeChanged()));
+            timer->start();
+        }
+    }
+
+    ~TimeModel()
+    {
+        if (--instances == 0) {
+            timer->stop();
+        }
+    }
+
+    int minute() const { return timer->minute(); }
+    int hour() const { return timer->hour(); }
+
+signals:
+    void timeChanged();
+
+private:
+    QTime t;
+    static MinuteTimer *timer;
+    static int instances;
+};
+
+int TimeModel::instances=0;
+MinuteTimer *TimeModel::timer=0;
+
+//![plugin]
+class QExampleQmlPlugin : public QQmlExtensionPlugin
+{
+    Q_OBJECT
+    Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QQmlExtensionInterface")
+
+public:
+    void registerTypes(const char *uri)
+    {
+        Q_ASSERT(uri == QLatin1String("TimeExample"));
+        qmlRegisterType<TimeModel>(uri, 1, 0, "Time");
+    }
+};
+//![plugin]
+
+#include "plugin.moc"
diff --git a/examples/qml/qmlextensionplugins/plugins.qml b/examples/qml/qmlextensionplugins/plugins.qml
new file mode 100644
index 0000000000..a82c12b7fd
--- /dev/null
+++ b/examples/qml/qmlextensionplugins/plugins.qml
@@ -0,0 +1,53 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the examples of the Qt Toolkit.
+**
+** $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$
+**
+****************************************************************************/
+//![0]
+import TimeExample 1.0 // import types from the plugin
+
+Clock { // this class is defined in QML (imports/TimeExample/Clock.qml)
+
+    Time { // this class is defined in C++ (plugin.cpp)
+        id: time
+    }
+
+    hours: time.hour
+    minutes: time.minute
+
+}
+//![0]
diff --git a/examples/qml/qmlextensionplugins/plugins.qmlproject b/examples/qml/qmlextensionplugins/plugins.qmlproject
new file mode 100644
index 0000000000..771ab45b66
--- /dev/null
+++ b/examples/qml/qmlextensionplugins/plugins.qmlproject
@@ -0,0 +1,16 @@
+import QmlProject 1.1
+
+Project {
+    mainFile: "plugins.qml"
+
+    /* Include .qml, .js, and image files from current directory and subdirectories */
+    QmlFiles {
+        directory: "."
+    }
+    JavaScriptFiles {
+        directory: "."
+    }
+    ImageFiles {
+        directory: "."
+    }
+}
diff --git a/examples/qml/qmlextensionplugins/qmlextensionplugins.pro b/examples/qml/qmlextensionplugins/qmlextensionplugins.pro
new file mode 100644
index 0000000000..64fd23af8d
--- /dev/null
+++ b/examples/qml/qmlextensionplugins/qmlextensionplugins.pro
@@ -0,0 +1,23 @@
+TEMPLATE = lib
+CONFIG += plugin
+QT += qml
+
+DESTDIR = imports/TimeExample
+TARGET  = qmlqtimeexampleplugin
+
+SOURCES += plugin.cpp
+
+pluginfiles.files += \
+    imports/TimeExample/qmldir \
+    imports/TimeExample/center.png \
+    imports/TimeExample/clock.png \
+    imports/TimeExample/Clock.qml \
+    imports/TimeExample/hour.png \
+    imports/TimeExample/minute.png
+
+qml.files = plugins.qml
+qml.path += $$[QT_INSTALL_EXAMPLES]/qml/qmlextensionplugins
+target.path += $$[QT_INSTALL_EXAMPLES]/qml/qmlextensionplugins/imports/TimeExample
+pluginfiles.path += $$[QT_INSTALL_EXAMPLES]/qml/qmlextensionplugins/imports/TimeExample
+
+INSTALLS += target qml pluginfiles