Adding ./doc from boost

Reviewer: Lauro Moura <lauro.neto@openbossa.org>
          Luciano Wolf <luciano.wolf@openbossa.org>

6 files changed, 490 insertions, 0 deletions

diff --git a/doc/codesnippets/doc/src/snippets/persistentindexes/main.cpp b/doc/codesnippets/doc/src/snippets/persistentindexes/main.cpp
new file mode 100644
index 000000000..8c6b8b54a
--- /dev/null
+++ b/doc/codesnippets/doc/src/snippets/persistentindexes/main.cpp
@@ -0,0 +1,52 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial Usage
+** Licensees holding valid Qt Commercial licenses may use this file in
+** accordance with the Qt Commercial License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Nokia.
+**
+** 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 http://www.qtsoftware.com/contact.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QApplication>
+
+#include "mainwindow.h"
+
+int main(int argc, char *argv[])
+{
+    QApplication app(argc, argv);
+    MainWindow *window = new MainWindow;
+    window->show();
+    return app.exec();
+}
diff --git a/doc/codesnippets/doc/src/snippets/persistentindexes/mainwindow.cpp b/doc/codesnippets/doc/src/snippets/persistentindexes/mainwindow.cpp
new file mode 100644
index 000000000..338ea887d
--- /dev/null
+++ b/doc/codesnippets/doc/src/snippets/persistentindexes/mainwindow.cpp
@@ -0,0 +1,121 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial Usage
+** Licensees holding valid Qt Commercial licenses may use this file in
+** accordance with the Qt Commercial License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Nokia.
+**
+** 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 http://www.qtsoftware.com/contact.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QtGui>
+
+#include "mainwindow.h"
+#include "model.h"
+
+/*!
+    The main window constructor creates and populates a model with values
+    from a string list then displays the contents of the model using a
+    QListView widget.
+*/
+
+MainWindow::MainWindow(QWidget *parent)
+    : QMainWindow(parent)
+{
+    QMenu *fileMenu = new QMenu(tr("&File"));
+
+    QAction *quitAction = fileMenu->addAction(tr("E&xit"));
+    quitAction->setShortcut(tr("Ctrl+Q"));
+
+    QMenu *itemsMenu = new QMenu(tr("&Items"));
+
+    insertAction = itemsMenu->addAction(tr("&Insert Item"));
+    removeAction = itemsMenu->addAction(tr("&Remove Item"));
+
+    menuBar()->addMenu(fileMenu);
+    menuBar()->addMenu(itemsMenu);
+
+    QStringList numbers;
+    numbers << tr("One") << tr("Two") << tr("Three") << tr("Four") << tr("Five")
+            << tr("Six") << tr("Seven") << tr("Eight") << tr("Nine") << tr("Ten");
+
+    model = new StringListModel(numbers);
+    QListView *view = new QListView(this);
+    view->setModel(model);
+
+    selectionModel = view->selectionModel();
+
+    connect(quitAction, SIGNAL(triggered()), qApp, SLOT(quit()));
+    connect(insertAction, SIGNAL(triggered()), this, SLOT(insertItem()));
+    connect(removeAction, SIGNAL(triggered()), this, SLOT(removeItem()));
+    connect(selectionModel,
+            SIGNAL(currentChanged(const QModelIndex &, const QModelIndex &)),
+            this, SLOT(updateMenus(const QModelIndex &)));
+    
+    setCentralWidget(view);
+    setWindowTitle("View onto a string list model");
+}
+
+void MainWindow::insertItem()
+{
+    if (!selectionModel->currentIndex().isValid())
+        return;
+
+    QString itemText = QInputDialog::getText(this, tr("Insert Item"),
+        tr("Input text for the new item:"));
+
+    if (itemText.isNull())
+        return;
+
+    int row = selectionModel->currentIndex().row();
+
+    if (model->insertRows(row, 1))
+        model->setData(model->index(row, 0), itemText, Qt::EditRole);
+}
+
+void MainWindow::removeItem()
+{
+    if (!selectionModel->currentIndex().isValid())
+        return;
+
+    int row = selectionModel->currentIndex().row();
+
+    model->removeRows(row, 1);
+}
+
+void MainWindow::updateMenus(const QModelIndex &currentIndex)
+{
+    insertAction->setEnabled(currentIndex.isValid());
+    removeAction->setEnabled(currentIndex.isValid());
+}
diff --git a/doc/codesnippets/doc/src/snippets/persistentindexes/mainwindow.h b/doc/codesnippets/doc/src/snippets/persistentindexes/mainwindow.h
new file mode 100644
index 000000000..dbeef1419
--- /dev/null
+++ b/doc/codesnippets/doc/src/snippets/persistentindexes/mainwindow.h
@@ -0,0 +1,71 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial Usage
+** Licensees holding valid Qt Commercial licenses may use this file in
+** accordance with the Qt Commercial License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Nokia.
+**
+** 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 http://www.qtsoftware.com/contact.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef MAINWINDOW_H
+#define MAINWINDOW_H
+
+#include <QMainWindow>
+#include <QModelIndex>
+
+class QAbstractItemModel;
+class QAction;
+class QItemSelectionModel;
+
+class MainWindow : public QMainWindow
+{
+    Q_OBJECT
+
+public:
+    MainWindow(QWidget *parent = 0);
+
+private slots:
+    void insertItem();
+    void removeItem();
+    void updateMenus(const QModelIndex &currentIndex);
+
+private:
+    QAbstractItemModel *model;
+    QAction *insertAction;
+    QAction *removeAction;
+    QItemSelectionModel *selectionModel;
+};
+
+#endif
diff --git a/doc/codesnippets/doc/src/snippets/persistentindexes/model.cpp b/doc/codesnippets/doc/src/snippets/persistentindexes/model.cpp
new file mode 100644
index 000000000..a60c095a4
--- /dev/null
+++ b/doc/codesnippets/doc/src/snippets/persistentindexes/model.cpp
@@ -0,0 +1,169 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial Usage
+** Licensees holding valid Qt Commercial licenses may use this file in
+** accordance with the Qt Commercial License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Nokia.
+**
+** 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 http://www.qtsoftware.com/contact.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*
+  model.cpp
+
+  A simple model that uses a QStringList as its data source.
+*/
+
+#include <qdebug.h>
+
+#include "model.h"
+
+/*!
+    Returns the number of items in the string list as the number of rows
+    in the model.
+*/
+
+int StringListModel::rowCount(const QModelIndex &parent) const
+{
+    return stringList.count();
+}
+
+/*!
+    Returns an appropriate value for the requested data.
+    If the view requests an invalid index, an invalid variant is returned.
+    If a header is requested then we just return the column or row number,
+    depending on the orientation of the header.
+    Any valid index that corresponds to a string in the list causes that
+    string to be returned.
+*/
+
+QVariant StringListModel::data(const QModelIndex &index, int role) const
+{
+    if (!index.isValid())
+        return QVariant();
+
+    if (index.row() < 0 || index.row() >= stringList.size())
+        return QVariant();
+
+    if (role == Qt::DisplayRole)
+        return stringList.at(index.row());
+    else
+        return QVariant();
+}
+
+/*!
+    Returns the appropriate header string depending on the orientation of
+    the header and the section. If anything other than the display role is
+    requested, we return an invalid variant.
+*/
+
+QVariant StringListModel::headerData(int section, Qt::Orientation orientation,
+                                     int role) const
+{
+    if (role != Qt::DisplayRole)
+        return QVariant();
+
+    if (orientation == Qt::Horizontal)
+        return QString("Column %1").arg(section);
+    else
+        return QString("Row %1").arg(section);
+}
+
+/*!
+    Returns an appropriate value for the item's flags. Valid items are
+    enabled, selectable, and editable.
+*/
+
+Qt::ItemFlags StringListModel::flags(const QModelIndex &index) const
+{
+    if (!index.isValid())
+        return Qt::ItemIsEnabled;
+
+    return QAbstractItemModel::flags(index) | Qt::ItemIsEditable;
+}
+
+/*!
+    Changes an item in the string list, but only if the following conditions
+    are met:
+
+    * The index supplied is valid.
+    * The index corresponds to an item to be shown in a view.
+    * The role associated with editing text is specified.
+
+    The dataChanged() signal is emitted if the item is changed.
+*/
+
+bool StringListModel::setData(const QModelIndex &index,
+                              const QVariant &value, int role)
+{
+    if (index.isValid() && role == Qt::EditRole) {
+
+        stringList.replace(index.row(), value.toString());
+        emit dataChanged(index, index);
+        return true;
+    }
+    return false;
+}
+
+/*!
+    Inserts a number of rows into the model at the specified position.
+*/
+
+bool StringListModel::insertRows(int position, int rows, const QModelIndex &parent)
+{
+    beginInsertRows(parent, position, position + rows - 1);
+
+    for (int row = 0; row < rows; ++row) {
+        stringList.insert(position, "");
+    }
+
+    endInsertRows();
+    return true;
+}
+
+/*!
+    Removes a number of rows from the model at the specified position.
+*/
+
+bool StringListModel::removeRows(int position, int rows, const QModelIndex &parent)
+{
+    beginRemoveRows(parent, position, position + rows - 1);
+
+    for (int row = 0; row < rows; ++row) {
+        stringList.removeAt(position);
+    }
+
+    endRemoveRows();
+    return true;
+}
diff --git a/doc/codesnippets/doc/src/snippets/persistentindexes/model.h b/doc/codesnippets/doc/src/snippets/persistentindexes/model.h
new file mode 100644
index 000000000..3c3ca69fa
--- /dev/null
+++ b/doc/codesnippets/doc/src/snippets/persistentindexes/model.h
@@ -0,0 +1,72 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial Usage
+** Licensees holding valid Qt Commercial licenses may use this file in
+** accordance with the Qt Commercial License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Nokia.
+**
+** 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 http://www.qtsoftware.com/contact.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef MODEL_H
+#define MODEL_H
+
+#include <QAbstractListModel>
+#include <QObject>
+#include <QStringList>
+
+class StringListModel : public QAbstractListModel
+{
+    Q_OBJECT
+public:
+    StringListModel(const QStringList &strings, QObject *parent = 0)
+        : QAbstractListModel(parent), stringList(strings) {}
+
+    int rowCount(const QModelIndex &parent = QModelIndex()) const;
+    QVariant data(const QModelIndex &index, int role) const;
+    QVariant headerData(int section, Qt::Orientation orientation,
+                        int role = Qt::DisplayRole) const;
+
+    Qt::ItemFlags flags(const QModelIndex &index) const;
+    bool setData(const QModelIndex &index, const QVariant &value,
+                 int role = Qt::EditRole);
+
+    bool insertRows(int position, int rows, const QModelIndex &index = QModelIndex());
+    bool removeRows(int position, int rows, const QModelIndex &index = QModelIndex());
+
+private:
+    QStringList stringList;
+};
+
+#endif
diff --git a/doc/codesnippets/doc/src/snippets/persistentindexes/persistentindexes.pro b/doc/codesnippets/doc/src/snippets/persistentindexes/persistentindexes.pro
new file mode 100644
index 000000000..aaf41bd1c
--- /dev/null
+++ b/doc/codesnippets/doc/src/snippets/persistentindexes/persistentindexes.pro
@@ -0,0 +1,5 @@
+HEADERS     = mainwindow.h \
+              model.h
+SOURCES     = main.cpp \
+              mainwindow.cpp \
+              model.cpp