Moving .qdoc files under examples/widgets/doc

Updated those .qdoc files to refer to the new relative examples
emplacement. Images and snippets to be moved later.

Also grouped all widgets related examples under widgets.

Change-Id: Ib29696e2d8948524537f53e8dda88f9ee26a597f
Reviewed-by: J-P Nurmi <j-p.nurmi@nokia.com>

6 files changed, 531 insertions, 0 deletions

diff --git a/examples/widgets/statemachine/rogue/main.cpp b/examples/widgets/statemachine/rogue/main.cpp
new file mode 100644
index 0000000000..c909c17cde
--- /dev/null
+++ b/examples/widgets/statemachine/rogue/main.cpp
@@ -0,0 +1,54 @@
+/****************************************************************************
+**
+** 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: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 Nokia Corporation 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 <QtWidgets>
+
+#include "window.h"
+
+int main(int argv, char **args)
+{
+    QApplication app(argv, args);
+
+    Window window;
+    window.show();
+
+    return app.exec();
+}
+
diff --git a/examples/widgets/statemachine/rogue/movementtransition.h b/examples/widgets/statemachine/rogue/movementtransition.h
new file mode 100644
index 0000000000..6f27da93b8
--- /dev/null
+++ b/examples/widgets/statemachine/rogue/movementtransition.h
@@ -0,0 +1,112 @@
+/****************************************************************************
+**
+** 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: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 Nokia Corporation 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$
+**
+****************************************************************************/
+
+#ifndef MOVEMENTTRANSITION_H
+#define MOVEMENTTRANSITION_H
+
+#include <QtWidgets>
+
+#include "window.h"
+
+//![0]
+class MovementTransition : public QEventTransition
+{
+    Q_OBJECT
+
+public:
+    MovementTransition(Window *window) :
+        QEventTransition(window, QEvent::KeyPress) {
+        this->window = window;
+    }
+//![0]
+
+//![1]
+protected:
+    bool eventTest(QEvent *event) {
+        if (event->type() == QEvent::StateMachineWrapped &&
+            static_cast<QStateMachine::WrappedEvent *>(event)->event()->type() == QEvent::KeyPress) {
+            QEvent *wrappedEvent = static_cast<QStateMachine::WrappedEvent *>(event)->event();
+
+            QKeyEvent *keyEvent = static_cast<QKeyEvent *>(wrappedEvent);
+            int key = keyEvent->key();
+
+            return key == Qt::Key_2 || key == Qt::Key_8 || key == Qt::Key_6 ||
+                   key == Qt::Key_4 || key == Qt::Key_Down || key == Qt::Key_Up ||
+                   key == Qt::Key_Right || key == Qt::Key_Left;
+        }
+        return false;
+    }
+//![1]
+
+//![2]
+    void onTransition(QEvent *event) {
+        QKeyEvent *keyEvent = static_cast<QKeyEvent *>(
+            static_cast<QStateMachine::WrappedEvent *>(event)->event());
+
+        int key = keyEvent->key();
+        switch (key) {
+            case Qt::Key_Left:
+            case Qt::Key_4:
+                window->movePlayer(Window::Left);
+                break;
+            case Qt::Key_Up:
+            case Qt::Key_8:
+                window->movePlayer(Window::Up);
+                break;
+            case Qt::Key_Right:
+            case Qt::Key_6:
+                window->movePlayer(Window::Right);
+                break;
+            case Qt::Key_Down:
+            case Qt::Key_2:
+                window->movePlayer(Window::Down);
+                break;
+            default:
+                ;
+        }
+    }
+//![2]
+
+private:
+    Window *window;
+};
+
+#endif
+
diff --git a/examples/widgets/statemachine/rogue/rogue.desktop b/examples/widgets/statemachine/rogue/rogue.desktop
new file mode 100644
index 0000000000..71ca4b6511
--- /dev/null
+++ b/examples/widgets/statemachine/rogue/rogue.desktop
@@ -0,0 +1,11 @@
+[Desktop Entry]
+Encoding=UTF-8
+Version=1.0
+Type=Application
+Terminal=false
+Name=Rogue
+Exec=/opt/usr/bin/rogue
+Icon=rogue
+X-Window-Icon=
+X-HildonDesk-ShowInToolbar=true
+X-Osso-Type=application/x-executable
diff --git a/examples/widgets/statemachine/rogue/rogue.pro b/examples/widgets/statemachine/rogue/rogue.pro
new file mode 100644
index 0000000000..4ed132db06
--- /dev/null
+++ b/examples/widgets/statemachine/rogue/rogue.pro
@@ -0,0 +1,13 @@
+HEADERS       = window.h \
+                movementtransition.h
+SOURCES       = main.cpp \
+                window.cpp
+
+# install
+target.path = $$[QT_INSTALL_EXAMPLES]/qtbase/statemachine/rogue
+sources.files = $$SOURCES $$HEADERS *.pro
+sources.path = $$[QT_INSTALL_EXAMPLES]/qtbase/statemachine/rogue
+INSTALLS += target sources
+
+QT += widgets
+
diff --git a/examples/widgets/statemachine/rogue/window.cpp b/examples/widgets/statemachine/rogue/window.cpp
new file mode 100644
index 0000000000..0c57b2c2d7
--- /dev/null
+++ b/examples/widgets/statemachine/rogue/window.cpp
@@ -0,0 +1,251 @@
+/****************************************************************************
+**
+** 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: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 Nokia Corporation 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 <QtWidgets>
+
+#include "window.h"
+#include "movementtransition.h"
+
+//![0]
+Window::Window()
+{
+    pX = 5;
+    pY = 5;
+//![0]
+
+    QFontDatabase database;
+    QFont font;
+    if (database.families().contains("Monospace")) {
+        font = QFont("Monospace");
+    }
+    else {
+        foreach (QString family, database.families()) {
+            if (database.isFixedPitch(family)) {
+                font = QFont(family);
+                break;
+            }
+        }
+    }
+    font.setPointSize(12);
+    setFont(font);
+
+//![1]
+    setupMap();
+    buildMachine();
+}
+//![1]
+
+void Window::setStatus(const QString &status)
+{
+    myStatus = status;
+    repaint();
+}
+
+QString Window::status() const
+{
+    return myStatus;
+}
+
+void Window::paintEvent(QPaintEvent * /* event */)
+{
+    QFontMetrics metrics(font());
+    QPainter painter(this);
+    int fontHeight = metrics.height();
+    int fontWidth = metrics.width('X');
+    int yPos = fontHeight;
+    int xPos;
+
+    painter.fillRect(rect(), Qt::black);
+    painter.setPen(Qt::white);
+
+    painter.drawText(QPoint(0, yPos), status());
+    
+    for (int y = 0; y < HEIGHT; ++y) {
+        yPos += fontHeight;
+        xPos = 0;
+
+        for (int x = 0; x < WIDTH; ++x) {
+            if (y == pY && x == pX) {
+                xPos += fontWidth;
+                continue;
+            }
+
+            painter.setPen(Qt::white);
+
+            double x1 = static_cast<double>(pX);
+            double y1 = static_cast<double>(pY);
+            double x2 = static_cast<double>(x);
+            double y2 = static_cast<double>(y);
+
+            if (x2<x1) {
+                x2+=0.5;
+            } else if (x2>x1) {
+                 x2-=0.5;
+            }
+
+            if (y2<y1) {
+                 y2+=0.5;
+            } else if (y2>y1) {
+                 y2-=0.5;
+            }
+
+            double dx = x2 - x1;
+            double dy = y2 - y1;
+
+            double length = qSqrt(dx*dx+dy*dy);
+
+            dx /= length;
+            dy /= length;
+
+            double xi = x1;
+            double yi = y1;
+
+            while (length > 0) {
+                int cx = static_cast<int>(xi+0.5);
+                int cy = static_cast<int>(yi+0.5);
+
+                if (x2 == cx && y2 == cy)
+                    break;
+
+                if (!(x1==cx && y1==cy)
+                    && (map[cx][cy] == '#' || (length-10) > 0)) {
+                    painter.setPen(QColor(60,60,60));
+                    break;
+                }
+
+                xi += dx;
+                yi += dy;
+                --length;
+            }
+
+            painter.drawText(QPoint(xPos, yPos), map[x][y]);
+            xPos += fontWidth;
+        }
+    }
+    painter.setPen(Qt::white);
+    painter.drawText(QPoint(pX * fontWidth, (pY + 2) * fontHeight), QChar('@'));
+}
+
+QSize Window::sizeHint() const
+{
+    QFontMetrics metrics(font());
+
+    return QSize(metrics.width('X') * WIDTH, metrics.height() * (HEIGHT + 1));
+}
+
+//![2]
+void Window::buildMachine()
+{
+    machine = new QStateMachine;
+
+    QState *inputState = new QState(machine);
+    inputState->assignProperty(this, "status", "Move the rogue with 2, 4, 6, and 8");
+
+    MovementTransition *transition = new MovementTransition(this);
+    inputState->addTransition(transition);
+//![2]
+
+//![3]
+    QState *quitState = new QState(machine);
+    quitState->assignProperty(this, "status", "Really quit(y/n)?"); 
+
+    QKeyEventTransition *yesTransition = new
+        QKeyEventTransition(this, QEvent::KeyPress, Qt::Key_Y);
+    yesTransition->setTargetState(new QFinalState(machine));
+    quitState->addTransition(yesTransition);
+
+    QKeyEventTransition *noTransition =
+        new QKeyEventTransition(this, QEvent::KeyPress, Qt::Key_N);
+    noTransition->setTargetState(inputState);
+    quitState->addTransition(noTransition);
+//![3]
+
+//![4]
+    QKeyEventTransition *quitTransition =
+        new QKeyEventTransition(this, QEvent::KeyPress, Qt::Key_Q);
+    quitTransition->setTargetState(quitState);
+    inputState->addTransition(quitTransition);
+//![4]
+
+//![5]
+    machine->setInitialState(inputState);
+
+    connect(machine, SIGNAL(finished()), qApp, SLOT(quit()));
+
+    machine->start();
+}
+//![5]
+
+void Window::movePlayer(Direction direction)
+{
+    switch (direction) {
+        case Left:
+            if (map[pX - 1][pY] != '#')
+                --pX;            
+            break;
+        case Right:
+            if (map[pX + 1][pY] != '#')
+                ++pX;
+            break;
+        case Up:
+            if (map[pX][pY - 1] != '#')
+                --pY;
+            break;
+        case Down:
+            if (map[pX][pY + 1] != '#')
+                ++pY;
+            break;        
+    }
+    repaint();
+}
+
+void Window::setupMap()
+{
+    qsrand(QTime(0,0,0).secsTo(QTime::currentTime()));
+
+    for (int x = 0; x < WIDTH; ++x)
+        for (int y = 0; y < HEIGHT; ++y) {
+        if (x == 0 || x == WIDTH - 1 || y == 0 || y == HEIGHT - 1 || qrand() % 40 == 0)
+            map[x][y] = '#';
+        else
+            map[x][y] = '.';
+    }
+}
+
diff --git a/examples/widgets/statemachine/rogue/window.h b/examples/widgets/statemachine/rogue/window.h
new file mode 100644
index 0000000000..8ef3591e96
--- /dev/null
+++ b/examples/widgets/statemachine/rogue/window.h
@@ -0,0 +1,90 @@
+/****************************************************************************
+**
+** 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: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 Nokia Corporation 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$
+**
+****************************************************************************/
+
+#ifndef WINDOW_H
+#define WINDOW_H
+
+#include <QWidget>
+
+QT_BEGIN_NAMESPACE
+class QState;
+class QStateMachine;
+class QTransition;
+QT_END_NAMESPACE
+
+#define WIDTH 35
+#define HEIGHT 20
+
+//![0]
+class Window : public QWidget
+{
+    Q_OBJECT
+    Q_PROPERTY(QString status READ status WRITE setStatus)
+
+public:
+    enum Direction { Up, Down, Left, Right };
+
+    Window();
+
+    void movePlayer(Direction direction);
+    void setStatus(const QString &status);
+    QString status() const;
+
+    QSize sizeHint() const;
+
+protected:
+    void paintEvent(QPaintEvent *event);
+//![0]
+
+//![1]
+private:
+    void buildMachine();
+    void setupMap();
+
+    QChar map[WIDTH][HEIGHT];
+    int pX, pY;
+
+    QStateMachine *machine;
+    QString myStatus;
+};
+//![1]
+
+#endif
+