src/declarative/util/qlistmodelinterface.cpp

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