1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2010 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   \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 QHash<int,QVariant> QListModelInterface::data(int index, const QList<int>& roles) const

    74   Returns the data at the given \a index for the specifed \a roles.

    75 */

    76 

    77 /*! \fn bool QListModelInterface::setData(int index, const QHash<int,QVariant>& values)

    78   Sets the data at the given \a index. \a values is a mapping of

    79   QVariant values to roles. Returns false.

    80 */

    81 

    82 /*! \fn QList<int> QListModelInterface::roles() const

    83   Returns the list of roles for which the list model interface

    84   provides data.

    85 */

    86 

    87 /*! \fn QString QListModelInterface::toString(int role) const

    88   Returns a string description of the specified \a role.

    89 */

    90 

    91 /*! \fn void QListModelInterface::itemsInserted(int index, int count)

    92   Emit this signal when \a count items are inserted at \a index.

    93  */

    94 

    95 /*! \fn void QListModelInterface::itemsRemoved(int index, int count)

    96   Emit this signal when \a count items are removed at \a index.

    97  */

    98 

    99 /*! \fn void QListModelInterface::itemsMoved(int from, int to, int count)

   100   Emit this signal when \a count items are moved from index \a from

   101   to index \a to.

   102  */

   103 

   104 /*! \fn void QListModelInterface::itemsChanged(int index, int count, const QList<int> &roles)

   105   Emit this signal when \a count items at \a index have had their

   106   \a roles changed.

   107  */

   108 

   109 QT_END_NAMESPACE