Qt 4.8
qproxymodel.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtGui 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 QPROXYMODEL_H
43 #define QPROXYMODEL_H
44 
45 #include <QtCore/qabstractitemmodel.h>
46 
48 
50 
51 QT_MODULE(Gui)
52 
53 #ifndef QT_NO_PROXYMODEL
54 
55 class QProxyModelPrivate;
56 
58 {
59  Q_OBJECT
60 
61 public:
62  explicit QProxyModel(QObject *parent = 0);
63  ~QProxyModel();
64 
65  virtual void setModel(QAbstractItemModel *model);
66  QAbstractItemModel *model() const;
67 
68  // implementing model interface
69 
70  QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const;
71  QModelIndex parent(const QModelIndex &child) const;
72 
73  int rowCount(const QModelIndex &parent = QModelIndex()) const;
74  int columnCount(const QModelIndex &parent = QModelIndex()) const;
75  bool hasChildren(const QModelIndex &parent = QModelIndex()) const;
76 
77  QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const;
78  bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole);
79 
80  QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const;
81  bool setHeaderData(int section, Qt::Orientation orientation, const QVariant &value,
82  int role = Qt::EditRole);
83 
84  QStringList mimeTypes() const;
85  QMimeData *mimeData(const QModelIndexList &indexes) const;
86  bool dropMimeData(const QMimeData *data, Qt::DropAction action,
87  int row, int column, const QModelIndex &parent);
88  Qt::DropActions supportedDropActions() const;
89 
90  bool insertRows(int row, int count, const QModelIndex &parent = QModelIndex());
91  bool insertColumns(int column, int count, const QModelIndex &parent = QModelIndex());
92 
93  void fetchMore(const QModelIndex &parent);
94  Qt::ItemFlags flags(const QModelIndex &index) const;
95 
96  void sort(int column, Qt::SortOrder order = Qt::AscendingOrder);
97 
98  QModelIndexList match(const QModelIndex &start, int role, const QVariant &value,
99  int hits = 1, Qt::MatchFlags flags =
100  Qt::MatchFlags(Qt::MatchStartsWith|Qt::MatchWrap)) const;
101 
102  QSize span(const QModelIndex &index) const;
103 
104  bool submit();
105  void revert();
106 
107 #ifdef Q_NO_USING_KEYWORD
108  inline QObject *parent() const { return QObject::parent(); }
109 #else
110  using QObject::parent;
111 #endif
112 
113 protected:
114  QProxyModel(QProxyModelPrivate &, QObject *parent = 0);
115 
116  QModelIndex setProxyModel(const QModelIndex &source_index) const;
117  QModelIndex setSourceModel(const QModelIndex &proxy_index) const;
118 
119  void connectToModel(const QAbstractItemModel *model) const;
120  void disconnectFromModel(const QAbstractItemModel *model) const;
121 
122 private:
125 
126  Q_PRIVATE_SLOT(d_func(), void _q_sourceDataChanged(const QModelIndex&,const QModelIndex&))
127  Q_PRIVATE_SLOT(d_func(), void _q_sourceRowsAboutToBeInserted(const QModelIndex&,int,int))
128  Q_PRIVATE_SLOT(d_func(), void _q_sourceRowsInserted(const QModelIndex&,int,int))
129  Q_PRIVATE_SLOT(d_func(), void _q_sourceRowsAboutToBeRemoved(const QModelIndex&,int,int))
130  Q_PRIVATE_SLOT(d_func(), void _q_sourceRowsRemoved(const QModelIndex&,int,int))
131  Q_PRIVATE_SLOT(d_func(), void _q_sourceColumnsAboutToBeInserted(const QModelIndex&,int,int))
132  Q_PRIVATE_SLOT(d_func(), void _q_sourceColumnsInserted(const QModelIndex&,int,int))
133  Q_PRIVATE_SLOT(d_func(), void _q_sourceColumnsAboutToBeRemoved(const QModelIndex&,int,int))
134  Q_PRIVATE_SLOT(d_func(), void _q_sourceColumnsRemoved(const QModelIndex&,int,int))
135 };
136 
137 #endif // QT_NO_PROXYMODEL
138 
140 
142 
143 #endif // QPROXYMODEL_H
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
virtual QModelIndexList match(const QModelIndex &start, int role, const QVariant &value, int hits=1, Qt::MatchFlags flags=Qt::MatchFlags(Qt::MatchStartsWith|Qt::MatchWrap)) const
Returns a list of indexes for the items in the column of the start index where data stored under the ...
virtual int columnCount(const QModelIndex &parent=QModelIndex()) const =0
Returns the number of columns for the children of the given parent.
virtual QSize span(const QModelIndex &index) const
Returns the row and column span of the item represented by index.
virtual bool dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
Handles the data supplied by a drag and drop operation that ended with the given action.
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
#define QT_MODULE(x)
Definition: qglobal.h:2783
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
virtual int rowCount(const QModelIndex &parent=QModelIndex()) const =0
Returns the number of rows under the given parent.
#define Q_GUI_EXPORT
Definition: qglobal.h:1450
virtual bool setData(const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)
Sets the role data for the item at index to value.
virtual QStringList mimeTypes() const
Returns a list of MIME types that can be used to describe a list of model indexes.
#define Q_DISABLE_COPY(Class)
Disables the use of copy constructors and assignment operators for the given Class.
Definition: qglobal.h:2523
#define Q_PRIVATE_SLOT(d, signature)
Definition: qobjectdefs.h:73
virtual Qt::DropActions supportedDropActions() const
Returns the drop actions supported by this model.
The QObject class is the base class of all Qt objects.
Definition: qobject.h:111
virtual bool submit()
Lets the model know that it should submit cached information to permanent storage.
virtual QVariant headerData(int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
Returns the data for the given role and section in the header with the specified orientation.
virtual void sort(int column, Qt::SortOrder order=Qt::AscendingOrder)
Sorts the model by column in the given order.
virtual Qt::ItemFlags flags(const QModelIndex &index) const
Returns the item flags for the given index.
virtual QModelIndex index(int row, int column, const QModelIndex &parent=QModelIndex()) const =0
Returns the index of the item in the model specified by the given row, column and parent index...
SortOrder
Definition: qnamespace.h:189
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
virtual bool hasChildren(const QModelIndex &parent=QModelIndex()) const
Returns true if parent has any children; otherwise returns false.
The QProxyModel class provides support for processing data passed between another model and a view...
Definition: qproxymodel.h:57
The QStringList class provides a list of strings.
Definition: qstringlist.h:66
virtual QVariant data(const QModelIndex &index, int role=Qt::DisplayRole) const =0
Returns the data stored under the given role for the item referred to by the index.
DropAction
Definition: qnamespace.h:1597
The QMimeData class provides a container for data that records information about its MIME type...
Definition: qmimedata.h:57
virtual bool insertRows(int row, int count, const QModelIndex &parent=QModelIndex())
On models that support this, inserts count rows into the model before the given row.
#define Q_OBJECT
Definition: qobjectdefs.h:157
The QAbstractItemModel class provides the abstract interface for item model classes.
virtual bool setHeaderData(int section, Qt::Orientation orientation, const QVariant &value, int role=Qt::EditRole)
Sets the data for the given role and section in the header with the specified orientation to the valu...
virtual void fetchMore(const QModelIndex &parent)
Fetches any available data for the items with the parent specified by the parent index.
QObject * parent() const
Returns a pointer to the parent object.
Definition: qobject.h:273
The QModelIndex class is used to locate data in a data model.
virtual bool insertColumns(int column, int count, const QModelIndex &parent=QModelIndex())
On models that support this, inserts count new columns into the model before the given column...
The QSize class defines the size of a two-dimensional object using integer point precision.
Definition: qsize.h:53
#define Q_DECLARE_PRIVATE(Class)
Definition: qglobal.h:2467
Orientation
Definition: qnamespace.h:174
virtual void revert()
Lets the model know that it should discard cached information.
#define QT_END_HEADER
Definition: qglobal.h:137
virtual QMimeData * mimeData(const QModelIndexList &indexes) const
Returns an object that contains serialized items of data corresponding to the list of indexes specifi...