src/declarative/qml/qlistmodelinterface.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the QtDeclaractive module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include "qlistmodelinterface_p.h"
  43
  44 QT_BEGIN_NAMESPACE
  45
  46 /*!
  47   \internal
  48   \class QListModelInterface
  49   \brief The QListModelInterface class can be subclassed to provide C++ models to QDeclarativeGraphics Views
  50
  51   This class is comprised primarily of pure virtual functions which
  52   you must implement in a subclass. You can then use the subclass
  53   as a model for a QDeclarativeGraphics view, such as a QDeclarativeListView.
  54 */
  55
  56 /*! \fn QListModelInterface::QListModelInterface(QObject *parent)
  57   Constructs a QListModelInterface with the specified \a parent.
  58 */
  59
  60   /*! \fn QListModelInterface::QListModelInterface(QObjectPrivate &dd, QObject *parent)
  61
  62   \internal
  63  */
  64
  65 /*! \fn QListModelInterface::~QListModelInterface()
  66   The destructor is virtual.
  67  */
  68
  69 /*! \fn int QListModelInterface::count() const
  70   Returns the number of data entries in the model.
  71 */
  72
  73 /*! \fn QVariant QListModelInterface::data(int index, int role) const
  74   Returns the data at the given \a index for the specified \a roles.
  75 */
  76
  77 /*! \fn QList<int> QListModelInterface::roles() const
  78   Returns the list of roles for which the list model interface
  79   provides data.
  80 */
  81
  82 /*! \fn QString QListModelInterface::toString(int role) const
  83   Returns a string description of the specified \a role.
  84 */
  85
  86 /*! \fn void QListModelInterface::itemsInserted(int index, int count)
  87   Emit this signal when \a count items are inserted at \a index.
  88  */
  89
  90 /*! \fn void QListModelInterface::itemsRemoved(int index, int count)
  91   Emit this signal when \a count items are removed at \a index.
  92  */
  93
  94 /*! \fn void QListModelInterface::itemsMoved(int from, int to, int count)
  95   Emit this signal when \a count items are moved from index \a from
  96   to index \a to.
  97  */
  98
  99 /*! \fn void QListModelInterface::itemsChanged(int index, int count, const QList<int> &roles)
 100   Emit this signal when \a count items at \a index have had their
 101   \a roles changed.
 102  */
 103
 104 QT_END_NAMESPACE