src/qml/qml/qqmllist.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQMLLIST_H
  43 #define QQMLLIST_H
  44
  45 #include <QtQml/qtqmlglobal.h>
  46 #include <QtCore/qlist.h>
  47 #include <QtCore/qvariant.h>
  48
  49 QT_BEGIN_HEADER
  50
  51 QT_BEGIN_NAMESPACE
  52
  53
  54 class QObject;
  55 struct QMetaObject;
  56
  57 #ifndef QQMLLISTPROPERTY
  58 #define QQMLLISTPROPERTY
  59 template<typename T>
  60 class QQmlListProperty {
  61 public:
  62     typedef void (*AppendFunction)(QQmlListProperty<T> *, T*);
  63     typedef int (*CountFunction)(QQmlListProperty<T> *);
  64     typedef T *(*AtFunction)(QQmlListProperty<T> *, int);
  65     typedef void (*ClearFunction)(QQmlListProperty<T> *);
  66
  67     QQmlListProperty()
  68         : object(0), data(0), append(0), count(0), at(0), clear(0), dummy1(0), dummy2(0) {}
  69     QQmlListProperty(QObject *o, QList<T *> &list)
  70         : object(o), data(&list), append(qlist_append), count(qlist_count), at(qlist_at),
  71           clear(qlist_clear), dummy1(0), dummy2(0) {}
  72     QQmlListProperty(QObject *o, void *d, AppendFunction a, CountFunction c, AtFunction t,
  73                     ClearFunction r )
  74         : object(o), data(d), append(a), count(c), at(t), clear(r), dummy1(0), dummy2(0) {}
  75     QQmlListProperty(QObject *o, void *d, CountFunction c, AtFunction t)
  76         : object(o), data(d), append(0), count(c), at(t), clear(0), dummy1(0), dummy2(0) {}
  77     bool operator==(const QQmlListProperty &o) const {
  78         return object == o.object &&
  79                data == o.data &&
  80                append == o.append &&
  81                count == o.count &&
  82                at == o.at &&
  83                clear == o.clear;
  84     }
  85
  86     QObject *object;
  87     void *data;
  88
  89     AppendFunction append;
  90
  91     CountFunction count;
  92     AtFunction at;
  93
  94     ClearFunction clear;
  95
  96     void *dummy1;
  97     void *dummy2;
  98
  99 private:
 100     static void qlist_append(QQmlListProperty *p, T *v) {
 101         reinterpret_cast<QList<T *> *>(p->data)->append(v);
 102     }
 103     static int qlist_count(QQmlListProperty *p) {
 104         return reinterpret_cast<QList<T *> *>(p->data)->count();
 105     }
 106     static T *qlist_at(QQmlListProperty *p, int idx) {
 107         return reinterpret_cast<QList<T *> *>(p->data)->at(idx);
 108     }
 109     static void qlist_clear(QQmlListProperty *p) {
 110         return reinterpret_cast<QList<T *> *>(p->data)->clear();
 111     }
 112 };
 113 #endif
 114
 115 class QQmlEngine;
 116 class QQmlListReferencePrivate;
 117 class Q_QML_EXPORT QQmlListReference
 118 {
 119 public:
 120     QQmlListReference();
 121     QQmlListReference(QObject *, const char *property, QQmlEngine * = 0);
 122     QQmlListReference(const QQmlListReference &);
 123     QQmlListReference &operator=(const QQmlListReference &);
 124     ~QQmlListReference();
 125
 126     bool isValid() const;
 127
 128     QObject *object() const;
 129     const QMetaObject *listElementType() const;
 130
 131     bool canAppend() const;
 132     bool canAt() const;
 133     bool canClear() const;
 134     bool canCount() const;
 135
 136     bool isManipulable() const;
 137     bool isReadable() const;
 138
 139     bool append(QObject *) const;
 140     QObject *at(int) const;
 141     bool clear() const;
 142     int count() const;
 143
 144 private:
 145     friend class QQmlListReferencePrivate;
 146     QQmlListReferencePrivate* d;
 147 };
 148
 149 QT_END_NAMESPACE
 150
 151 Q_DECLARE_METATYPE(QQmlListReference)
 152
 153 QT_END_HEADER
 154
 155 #endif // QQMLLIST_H