Qt 4.8
qabstractproxymodel.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 QABSTRACTPROXYMODEL_H
43 #define QABSTRACTPROXYMODEL_H
44 
45 #include <QtCore/qabstractitemmodel.h>
46 
48 
50 
51 QT_MODULE(Gui)
52 
53 #ifndef QT_NO_PROXYMODEL
54 
56 class QItemSelection;
57 
59 {
60  Q_OBJECT
61 
62 public:
63  QAbstractProxyModel(QObject *parent = 0);
65 
66  virtual void setSourceModel(QAbstractItemModel *sourceModel);
67  QAbstractItemModel *sourceModel() const;
68 
69  virtual QModelIndex mapToSource(const QModelIndex &proxyIndex) const = 0;
70  virtual QModelIndex mapFromSource(const QModelIndex &sourceIndex) const = 0;
71 
72  virtual QItemSelection mapSelectionToSource(const QItemSelection &selection) const;
73  virtual QItemSelection mapSelectionFromSource(const QItemSelection &selection) const;
74 
75  bool submit();
76  void revert();
77 
78  QVariant data(const QModelIndex &proxyIndex, int role = Qt::DisplayRole) const;
79  QVariant headerData(int section, Qt::Orientation orientation, int role) const;
81  Qt::ItemFlags flags(const QModelIndex &index) const;
82 
83  bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole);
84  bool setItemData(const QModelIndex& index, const QMap<int, QVariant> &roles);
85  bool setHeaderData(int section, Qt::Orientation orientation, const QVariant &value, int role = Qt::EditRole);
86 
87  QModelIndex buddy(const QModelIndex &index) const;
88  bool canFetchMore(const QModelIndex &parent) const;
89  void fetchMore(const QModelIndex &parent);
90  void sort(int column, Qt::SortOrder order = Qt::AscendingOrder);
91  QSize span(const QModelIndex &index) const;
92  bool hasChildren(const QModelIndex &parent = QModelIndex()) const;
93 
94  QMimeData* mimeData(const QModelIndexList &indexes) const;
95  QStringList mimeTypes() const;
96  Qt::DropActions supportedDropActions() const;
97 
98 protected:
100 
101 private:
104  Q_PRIVATE_SLOT(d_func(), void _q_sourceModelDestroyed())
105 };
106 
107 #endif // QT_NO_PROXYMODEL
108 
110 
112 
113 #endif // QABSTRACTPROXYMODEL_H
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
virtual QSize span(const QModelIndex &index) const
Returns the row and column span of the item represented by index.
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
virtual QMap< int, QVariant > itemData(const QModelIndex &index) const
Returns a map with values for all predefined roles in the model for the item at the given index...
#define QT_MODULE(x)
Definition: qglobal.h:2783
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
#define Q_GUI_EXPORT
Definition: qglobal.h:1450
virtual bool setItemData(const QModelIndex &index, const QMap< int, QVariant > &roles)
Sets the role data for the item at index to the associated value in roles, for every Qt::ItemDataRole...
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.
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 QStringList class provides a list of strings.
Definition: qstringlist.h:66
virtual QModelIndex buddy(const QModelIndex &index) const
Returns a model index for the buddy of the item represented by index.
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.
virtual bool canFetchMore(const QModelIndex &parent) const
Returns true if there is more data available for parent; otherwise returns false. ...
The QMimeData class provides a container for data that records information about its MIME type...
Definition: qmimedata.h:57
#define Q_OBJECT
Definition: qobjectdefs.h:157
The QAbstractItemModel class provides the abstract interface for item model classes.
The QAbstractProxyModel class provides a base class for proxy item models that can do sorting...
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.
The QItemSelection class manages information about selected items in a model.
The QModelIndex class is used to locate data in a data model.
quint16 index
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
The QMap class is a template class that provides a skip-list-based dictionary.
Definition: qdatastream.h:67
virtual QMimeData * mimeData(const QModelIndexList &indexes) const
Returns an object that contains serialized items of data corresponding to the list of indexes specifi...