Qt 4.8
qfilesystemmodel.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 QFILESYSTEMMODEL_H
43 #define QFILESYSTEMMODEL_H
44 
45 #include <QtCore/qabstractitemmodel.h>
46 #include <QtCore/qpair.h>
47 #include <QtCore/qdir.h>
48 #include <QtGui/qicon.h>
49 #include <QtCore/qdiriterator.h>
50 
52 
54 
55 QT_MODULE(Gui)
56 
57 #ifndef QT_NO_FILESYSTEMMODEL
58 
59 class ExtendedInformation;
61 class QFileIconProvider;
62 
64 {
65  Q_OBJECT
67  bool readOnly;
69 
70 Q_SIGNALS:
71  void rootPathChanged(const QString &newPath);
72  void fileRenamed(const QString &path, const QString &oldName, const QString &newName);
73  void directoryLoaded(const QString &path);
74 
75 public:
76  enum Roles {
77  FileIconRole = Qt::DecorationRole,
78  FilePathRole = Qt::UserRole + 1,
79  FileNameRole = Qt::UserRole + 2,
80  FilePermissions = Qt::UserRole + 3
81  };
82 
83  explicit QFileSystemModel(QObject *parent = 0);
85 
86  QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const;
87  QModelIndex index(const QString &path, int column = 0) const;
88  QModelIndex parent(const QModelIndex &child) const;
89  bool hasChildren(const QModelIndex &parent = QModelIndex()) const;
90  bool canFetchMore(const QModelIndex &parent) const;
91  void fetchMore(const QModelIndex &parent);
92 
93  int rowCount(const QModelIndex &parent = QModelIndex()) const;
94  int columnCount(const QModelIndex &parent = QModelIndex()) const;
95 
96  QVariant myComputer(int role = Qt::DisplayRole) const;
97  QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const;
98  bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole);
99 
100  QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const;
101 
102  Qt::ItemFlags flags(const QModelIndex &index) const;
103 
104  void sort(int column, Qt::SortOrder order = Qt::AscendingOrder);
105 
106  QStringList mimeTypes() const;
107  QMimeData *mimeData(const QModelIndexList &indexes) const;
108  bool dropMimeData(const QMimeData *data, Qt::DropAction action,
109  int row, int column, const QModelIndex &parent);
110  Qt::DropActions supportedDropActions() const;
111 
112  // QFileSystemModel specific API
113  QModelIndex setRootPath(const QString &path);
114  QString rootPath() const;
115  QDir rootDirectory() const;
116 
117  void setIconProvider(QFileIconProvider *provider);
118  QFileIconProvider *iconProvider() const;
119 
120  void setFilter(QDir::Filters filters);
121  QDir::Filters filter() const;
122 
123  void setResolveSymlinks(bool enable);
124  bool resolveSymlinks() const;
125 
126  void setReadOnly(bool enable);
127  bool isReadOnly() const;
128 
129  void setNameFilterDisables(bool enable);
130  bool nameFilterDisables() const;
131 
132  void setNameFilters(const QStringList &filters);
133  QStringList nameFilters() const;
134 
135  QString filePath(const QModelIndex &index) const;
136  bool isDir(const QModelIndex &index) const;
137  qint64 size(const QModelIndex &index) const;
138  QString type(const QModelIndex &index) const;
139  QDateTime lastModified(const QModelIndex &index) const;
140 
141  QModelIndex mkdir(const QModelIndex &parent, const QString &name);
142  bool rmdir(const QModelIndex &index) const; // ### Qt5: should not be const
143  inline QString fileName(const QModelIndex &index) const;
144  inline QIcon fileIcon(const QModelIndex &index) const;
145  QFile::Permissions permissions(const QModelIndex &index) const;
146  inline QFileInfo fileInfo(const QModelIndex &index) const;
147  bool remove(const QModelIndex &index) const;
148 
149 protected:
152  bool event(QEvent *event);
153 
154 private:
157 
158  Q_PRIVATE_SLOT(d_func(), void _q_directoryChanged(const QString &directory, const QStringList &list))
159  Q_PRIVATE_SLOT(d_func(), void _q_performDelayedSort())
160  Q_PRIVATE_SLOT(d_func(), void _q_fileSystemChanged(const QString &path, const QList<QPair<QString, QFileInfo> > &))
161  Q_PRIVATE_SLOT(d_func(), void _q_resolvedName(const QString &fileName, const QString &resolvedName))
162 
164 };
165 
166 inline QString QFileSystemModel::fileName(const QModelIndex &aindex) const
167 { return aindex.data(Qt::DisplayRole).toString(); }
168 inline QIcon QFileSystemModel::fileIcon(const QModelIndex &aindex) const
169 { return qvariant_cast<QIcon>(aindex.data(Qt::DecorationRole)); }
171 { return QFileInfo(filePath(aindex)); }
172 
173 #endif // QT_NO_FILESYSTEMMODEL
174 
176 
178 
179 #endif // QFILESYSTEMMODEL_H
180 
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
The QDir class provides access to directory structures and their contents.
Definition: qdir.h:58
virtual int columnCount(const QModelIndex &parent=QModelIndex()) const =0
Returns the number of columns for the children of the given parent.
The QFileSystemModel class provides a data model for the local filesystem.
int type
Definition: qmetatype.cpp:239
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
EventRef event
#define QT_MODULE(x)
Definition: qglobal.h:2783
QVariant data(int role=Qt::DisplayRole) const
Returns the data for the given role for the item referred to by the index.
#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 void timerEvent(QTimerEvent *)
This event handler can be reimplemented in a subclass to receive timer events for the object...
Definition: qobject.cpp:1294
QString toString() const
Returns the variant as a QString if the variant has type() String , Bool , ByteArray ...
Definition: qvariant.cpp:2270
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 QString class provides a Unicode character string.
Definition: qstring.h:83
The QObject class is the base class of all Qt objects.
Definition: qobject.h:111
virtual bool event(QEvent *)
This virtual function receives events to an object and should return true if the event e was recogniz...
Definition: qobject.cpp:1200
#define Q_SIGNALS
Definition: qobjectdefs.h:72
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.
QIcon fileIcon(const QModelIndex &index) const
Returns the icon for the item stored in the model under the given index.
virtual void sort(int column, Qt::SortOrder order=Qt::AscendingOrder)
Sorts the model by column in the given order.
bool resolveSymlinks
Whether the directory model should resolve symbolic links.
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...
bool nameFilterDisables
Whether files that don&#39;t pass the name filter are hidden or disabled.
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.
const char * name
The QStringList class provides a list of strings.
Definition: qstringlist.h:66
The QFileIconProvider class provides file icons for the QDirModel and the QFileSystemModel classes...
static const char * data(const QByteArray &arr)
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
virtual bool canFetchMore(const QModelIndex &parent) const
Returns true if there is more data available for parent; otherwise returns false. ...
__int64 qint64
Definition: qglobal.h:942
QFileInfo fileInfo(const QModelIndex &index) const
Returns the QFileInfo for the item stored in the model under the given index.
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.
virtual void fetchMore(const QModelIndex &parent)
Fetches any available data for the items with the parent specified by the parent index.
static const char *const filters[3]
The QDateTime class provides date and time functions.
Definition: qdatetime.h:216
The QTimerEvent class contains parameters that describe a timer event.
Definition: qcoreevent.h:341
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.
QFuture< void > filter(Sequence &sequence, FilterFunction filterFunction)
T qvariant_cast(const QVariant &)
Definition: qvariant.h:571
quint16 index
#define Q_DECLARE_PRIVATE(Class)
Definition: qglobal.h:2467
bool readOnly
Whether the directory model allows writing to the file system.
The QFileInfo class provides system-independent file information.
Definition: qfileinfo.h:60
#define class
Orientation
Definition: qnamespace.h:174
The QEvent class is the base class of all event classes.
Definition: qcoreevent.h:56
#define QT_END_HEADER
Definition: qglobal.h:137
static QString fileName(const QString &fileUrl)
virtual QMimeData * mimeData(const QModelIndexList &indexes) const
Returns an object that contains serialized items of data corresponding to the list of indexes specifi...
QVariant data(const QModelIndex &index, int role=Qt::DisplayRole) const
Reimplemented Function
The QIcon class provides scalable icons in different modes and states.
Definition: qicon.h:60