diff options
author | Martin Smith <msmith@trolltech.com> | 2009-05-08 11:49:35 (GMT) |
---|---|---|
committer | Martin Smith <msmith@trolltech.com> | 2009-05-08 11:49:35 (GMT) |
commit | c7b42eb426a27d3f8124f5c37f39a8b91e3e03e8 (patch) | |
tree | 6ae3b6ec1a7e61c0fa02296d7ed65b717d5a6203 /src/declarative/3rdparty | |
parent | 80c80005c74776a930ec4a1a8fb8af5330073a71 (diff) | |
download | Qt-c7b42eb426a27d3f8124f5c37f39a8b91e3e03e8.zip Qt-c7b42eb426a27d3f8124f5c37f39a8b91e3e03e8.tar.gz Qt-c7b42eb426a27d3f8124f5c37f39a8b91e3e03e8.tar.bz2 |
qdoc: Added qlistmodelinterface.cpp to correct some qdoc warnings.
Diffstat (limited to 'src/declarative/3rdparty')
-rw-r--r-- | src/declarative/3rdparty/3rdparty.pri | 3 | ||||
-rw-r--r-- | src/declarative/3rdparty/qlistmodelinterface.cpp | 115 | ||||
-rw-r--r-- | src/declarative/3rdparty/qlistmodelinterface.h | 49 |
3 files changed, 134 insertions, 33 deletions
diff --git a/src/declarative/3rdparty/3rdparty.pri b/src/declarative/3rdparty/3rdparty.pri index 5350fcf..fc78cb2 100644 --- a/src/declarative/3rdparty/3rdparty.pri +++ b/src/declarative/3rdparty/3rdparty.pri @@ -1,2 +1,5 @@ HEADERS += \ 3rdparty/qlistmodelinterface.h\ + +SOURCES += \ + 3rdparty/qlistmodelinterface.cpp \ diff --git a/src/declarative/3rdparty/qlistmodelinterface.cpp b/src/declarative/3rdparty/qlistmodelinterface.cpp new file mode 100644 index 0000000..5e0544e --- /dev/null +++ b/src/declarative/3rdparty/qlistmodelinterface.cpp @@ -0,0 +1,115 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Qt Software Information (qt-info@nokia.com) +** +** This file is part of the QtDeclarative module 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$ +** +****************************************************************************/ + +#include "qlistmodelinterface.h" + +QT_BEGIN_NAMESPACE + +/*! + \class QListModelInterface + \brief The QListModelInterface class can be subclassed to provide C++ models to QFx Views + + This class is comprised primarily of pure virtual functions which + you must implement in a subclass. You can then use the subclass + as a model for a QFx view, such as a QFxListView. +*/ + +/*! \fn QListModelInterface::QListModelInterface(QObject *parent) + Constructs a QListModelInterface with the specified \a parent. + + /*! \fn QListModelInterface::QListModelInterface(QObjectPrivate &dd, QObject *parent) + + \internal + */ + +/*! \fn QListModelInterface::~QListModelInterface() + The destructor is virtual. + */ + +/*! \fn int QListModelInterface::count() const + Returns the number of data entries in the model. +*/ + +/*! \fn QHash_int QListModelInterface::data(int index, const QList_int &roles) const + Returns the data at the given \a index for the specifed \a roles. +*/ + +/*! \fn bool QListModelInterface::setData(int index, const QHash_int &values) + Sets the data at the given \a index. \a values is a mapping of + QVariant values to roles. +*/ + +/*! \fn bool QListModelInterface::setData(int index, const QVariant &value, int role) + This convenience function builds a QHash_int from + the specified \a role and \a value and calls the other setData() + with the QHash and the \a index. +*/ + +/*! \fn QList_int QListModelInterface::roles() const + Returns the list of roles for which the list model interface + provides data. +*/ + +/*! \fn QString QListModelInterface::toString(int role) const + Returns a string description of the specified \a role. +*/ + +/*! \enum QListModelInterface::Roles + + Values for representing roles. + + \value TextRole + + \value IconRole +*/ + +/*! + \typedef QListModelInterface::QHash_int + + Synonym for QHash<int, QVariant>. +*/ + +/*! + \typedef QListModelInterface::QList_int + + Synonym for QList<int>. +*/ +QT_END_NAMESPACE diff --git a/src/declarative/3rdparty/qlistmodelinterface.h b/src/declarative/3rdparty/qlistmodelinterface.h index 446b89b..e1eb21e 100644 --- a/src/declarative/3rdparty/qlistmodelinterface.h +++ b/src/declarative/3rdparty/qlistmodelinterface.h @@ -53,16 +53,10 @@ QT_BEGIN_NAMESPACE QT_MODULE(Declarative) -/*! - \class QListModelInterface - \brief The QListModelInterface class can be subclassed to provide C++ models to QFx Views - - This class is comprised primarily of pure virtual functions which you need to implement in a subclass. You can then use the subclass as a model for a QFx view, such as a QFxListView. -*/ class Q_DECLARATIVE_EXPORT QListModelInterface : public QObject { Q_OBJECT -public: + public: QListModelInterface(QObject *parent = 0) : QObject(parent) {} virtual ~QListModelInterface() {} @@ -72,47 +66,36 @@ public: IconRole = Qt::DecorationRole }; - /*! - Returns the number of data entries in the model. - */ virtual int count() const = 0; - /*! - Returns the data at the given \a index for the specifed \a roles. - */ - virtual QHash<int,QVariant> data(int index, const QList<int> &roles = (QList<int>())) const = 0; - /*! - Sets the data at the given \a index.\a values is a mapping of QVariant values to roles. - */ - virtual bool setData(int index, const QHash<int,QVariant> &values) { Q_UNUSED(index); Q_UNUSED(values); return false; } - /*! - This convinience function can be used to set the data for one specific role. It internally uses the other setData and does not need to be reimplemented. - */ + + typedef QHash<int, QVariant> QHash_int; + typedef QList<int> QList_int; + virtual QHash_int data(int index, const QList_int &roles = QList_int) const = 0; + + virtual bool setData(int index, const QHash_int &values) + { Q_UNUSED(index); Q_UNUSED(values); return false; } + inline bool setData(int index, const QVariant &value, int role) { - QHash<int,QVariant> values; + QHash_int values; values.insert(role, value); return setData(index, values); } - /*! - Returns which roles the list provides data for. - */ - virtual QList<int> roles() const = 0; - /*! - Returns a string description of the specified \a role. - */ + virtual QList_int roles() const = 0; virtual QString toString(int role) const = 0; //void bind(int index, int role, QObject *object, const char *propertyName, bool readOnly = true); -Q_SIGNALS: + Q_SIGNALS: void itemsInserted(int index, int count); void itemsRemoved(int index, int count); void itemsMoved(int from, int to, int count); - void itemsChanged(int index, int count, const QList<int> &roles); + void itemsChanged(int index, int count, const QList_int &roles); -protected: - QListModelInterface(QObjectPrivate &dd, QObject *parent) : QObject(dd, parent) {} + protected: + QListModelInterface(QObjectPrivate &dd, QObject *parent) + : QObject(dd, parent) {} }; |