diff options
author | Shawn Rutledge <shawn.rutledge@nokia.com> | 2012-08-15 17:48:16 +0200 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-08-21 11:05:20 +0200 |
commit | 5a07e87fd29baf794d3033df1ba70d181753df43 (patch) | |
tree | 7d2163cb367b51b4db7d978945c0ca74d5bb4255 /src/widgets/doc/snippets/common-table-model | |
parent | 3a7b6a74a8b36d98d57f4ec73b7e57f14911a775 (diff) |
Reuse the same QAbstractTableModel implementation for 4 snippets
They were really the same anyway. This makes the source distro a bit
more compact and eliminates some qdoc errors of the form
../doc/snippets/reading-selections/model.cpp:51: Overrides a previous doc
../doc/snippets/itemselection/model.cpp:51: (The previous doc is here)
Change-Id: I7956f457422e9078c32de65cd421685f589c8a6c
Reviewed-by: Jens Bache-Wiig <jens.bache-wiig@nokia.com>
Diffstat (limited to 'src/widgets/doc/snippets/common-table-model')
-rw-r--r-- | src/widgets/doc/snippets/common-table-model/README | 2 | ||||
-rw-r--r-- | src/widgets/doc/snippets/common-table-model/model.cpp | 238 | ||||
-rw-r--r-- | src/widgets/doc/snippets/common-table-model/model.h | 74 |
3 files changed, 314 insertions, 0 deletions
diff --git a/src/widgets/doc/snippets/common-table-model/README b/src/widgets/doc/snippets/common-table-model/README new file mode 100644 index 0000000000..eaebd3efc8 --- /dev/null +++ b/src/widgets/doc/snippets/common-table-model/README @@ -0,0 +1,2 @@ +This is a QAbstractTableModel implementation used for several other snippets. +There is no .pro file in this directory because it is not a standalone project. diff --git a/src/widgets/doc/snippets/common-table-model/model.cpp b/src/widgets/doc/snippets/common-table-model/model.cpp new file mode 100644 index 0000000000..6c9c5bad82 --- /dev/null +++ b/src/widgets/doc/snippets/common-table-model/model.cpp @@ -0,0 +1,238 @@ +/**************************************************************************** +** +** 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$ +** +****************************************************************************/ + +/* + model.cpp + + Provides a table model for use in various examples. +*/ + +#include <QtGui> + +#include "model.h" + +/*! + Constructs a table model with at least one row and one column. +*/ + +TableModel::TableModel(int rows, int columns, QObject *parent) + : QAbstractTableModel(parent) +{ + QStringList newList; + + for (int column = 0; column < qMax(1, columns); ++column) { + newList.append(""); + } + + for (int row = 0; row < qMax(1, rows); ++row) { + rowList.append(newList); + } +} + + +/*! + Returns the number of items in the row list as the number of rows + in the model. +*/ + +int TableModel::rowCount(const QModelIndex &/*parent*/) const +{ + return rowList.size(); +} + +/*! + Returns the number of items in the first list item as the number of + columns in the model. All rows should have the same number of columns. +*/ + +int TableModel::columnCount(const QModelIndex &/*parent*/) const +{ + return rowList[0].size(); +} + +/*! + Returns an appropriate value for the requested data. + If the view requests an invalid index, an invalid variant is returned. + Any valid index that corresponds to a string in the list causes that + string to be returned for the display role; otherwise an invalid variant + is returned. +*/ + +QVariant TableModel::data(const QModelIndex &index, int role) const +{ + if (!index.isValid()) + return QVariant(); + + if (role == Qt::DisplayRole) + return rowList[index.row()][index.column()]; + 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 TableModel::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 TableModel::flags(const QModelIndex &index) const +{ + if (!index.isValid()) + return Qt::ItemIsEnabled; + + return Qt::ItemIsEnabled | Qt::ItemIsSelectable | Qt::ItemIsEditable; +} + +/*! + Changes an item in the model, but only if the following conditions + are met: + + * The index supplied is valid. + * The role associated with editing text is specified. + + The dataChanged() signal is emitted if the item is changed. +*/ + +bool TableModel::setData(const QModelIndex &index, + const QVariant &value, int role) +{ + if (!index.isValid() || role != Qt::EditRole) + return false; + + rowList[index.row()][index.column()] = value.toString(); + emit dataChanged(index, index); + return true; +} + +/*! + Inserts a number of rows into the model at the specified position. +*/ + +bool TableModel::insertRows(int position, int rows, const QModelIndex &parent) +{ + int columns = columnCount(); + beginInsertRows(parent, position, position + rows - 1); + + for (int row = 0; row < rows; ++row) { + QStringList items; + for (int column = 0; column < columns; ++column) + items.append(""); + rowList.insert(position, items); + } + + endInsertRows(); + return true; +} + +/*! + Inserts a number of columns into the model at the specified position. + Each entry in the list is extended in turn with the required number of + empty strings. +*/ + +bool TableModel::insertColumns(int position, int columns, + const QModelIndex &parent) +{ + int rows = rowCount(); + beginInsertColumns(parent, position, position + columns - 1); + + for (int row = 0; row < rows; ++row) { + for (int column = position; column < columns; ++column) { + rowList[row].insert(position, ""); + } + } + + endInsertColumns(); + return true; +} + +/*! + Removes a number of rows from the model at the specified position. +*/ + +bool TableModel::removeRows(int position, int rows, const QModelIndex &parent) +{ + beginRemoveRows(parent, position, position + rows - 1); + + for (int row = 0; row < rows; ++row) { + rowList.removeAt(position); + } + + endRemoveRows(); + return true; +} + +/*! + Removes a number of columns from the model at the specified position. + Each row is shortened by the number of columns specified. +*/ + +bool TableModel::removeColumns(int position, int columns, + const QModelIndex &parent) +{ + int rows = rowCount(); + beginRemoveColumns(parent, position, position + columns - 1); + + for (int row = 0; row < rows; ++row) { + for (int column = 0; column < columns; ++column) { + rowList[row].removeAt(position); + } + } + + endRemoveColumns(); + return true; +} diff --git a/src/widgets/doc/snippets/common-table-model/model.h b/src/widgets/doc/snippets/common-table-model/model.h new file mode 100644 index 0000000000..ef63e45ce0 --- /dev/null +++ b/src/widgets/doc/snippets/common-table-model/model.h @@ -0,0 +1,74 @@ +/**************************************************************************** +** +** 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 MODEL_H +#define MODEL_H + +#include <QAbstractTableModel> +#include <QStringList> +#include <QVariant> + +class TableModel : public QAbstractTableModel +{ + Q_OBJECT + +public: + TableModel(int rows = 1, int columns = 1, QObject *parent = 0); + + int rowCount(const QModelIndex &parent = QModelIndex()) const; + int columnCount(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 &parent = QModelIndex()); + bool insertColumns(int position, int columns, const QModelIndex &parent = QModelIndex()); + bool removeRows(int position, int rows, const QModelIndex &parent = QModelIndex()); + bool removeColumns(int position, int columns, const QModelIndex &parent = QModelIndex()); + +private: + QList<QStringList> rowList; +}; + +#endif |