Qt 4.8
qdirmodel.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 QDIRMODEL_H
43 #define QDIRMODEL_H
44 
45 #include <QtCore/qabstractitemmodel.h>
46 #include <QtCore/qdir.h>
47 #include <QtGui/qfileiconprovider.h>
48 
50 
52 
53 QT_MODULE(Gui)
54 
55 #ifndef QT_NO_DIRMODEL
56 
57 class QDirModelPrivate;
58 
60 {
61  Q_OBJECT
63  bool readOnly;
65 
66 public:
67  enum Roles {
68  FileIconRole = Qt::DecorationRole,
69  FilePathRole = Qt::UserRole + 1,
70  FileNameRole
71  };
72 
73  QDirModel(const QStringList &nameFilters, QDir::Filters filters,
74  QDir::SortFlags sort, QObject *parent = 0);
75  explicit QDirModel(QObject *parent = 0);
76  ~QDirModel();
77 
78  QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const;
79  QModelIndex parent(const QModelIndex &child) const;
80 
81  int rowCount(const QModelIndex &parent = QModelIndex()) const;
82  int columnCount(const QModelIndex &parent = QModelIndex()) const;
83 
84  QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const;
85  bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole);
86 
87  QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const;
88 
89  bool hasChildren(const QModelIndex &index = QModelIndex()) const;
90  Qt::ItemFlags flags(const QModelIndex &index) const;
91 
92  void sort(int column, Qt::SortOrder order = Qt::AscendingOrder);
93 
94  QStringList mimeTypes() const;
95  QMimeData *mimeData(const QModelIndexList &indexes) const;
96  bool dropMimeData(const QMimeData *data, Qt::DropAction action,
97  int row, int column, const QModelIndex &parent);
98  Qt::DropActions supportedDropActions() const;
99 
100  // QDirModel specific API
101 
102  void setIconProvider(QFileIconProvider *provider);
103  QFileIconProvider *iconProvider() const;
104 
105  void setNameFilters(const QStringList &filters);
106  QStringList nameFilters() const;
107 
108  void setFilter(QDir::Filters filters);
109  QDir::Filters filter() const;
110 
111  void setSorting(QDir::SortFlags sort);
112  QDir::SortFlags sorting() const;
113 
114  void setResolveSymlinks(bool enable);
115  bool resolveSymlinks() const;
116 
117  void setReadOnly(bool enable);
118  bool isReadOnly() const;
119 
120  void setLazyChildCount(bool enable);
121  bool lazyChildCount() const;
122 
123  QModelIndex index(const QString &path, int column = 0) const;
124 
125  bool isDir(const QModelIndex &index) const;
126  QModelIndex mkdir(const QModelIndex &parent, const QString &name);
127  bool rmdir(const QModelIndex &index);
128  bool remove(const QModelIndex &index);
129 
130  QString filePath(const QModelIndex &index) const;
131  QString fileName(const QModelIndex &index) const;
132  QIcon fileIcon(const QModelIndex &index) const;
133  QFileInfo fileInfo(const QModelIndex &index) const;
134 
135 #ifdef Q_NO_USING_KEYWORD
136  inline QObject *parent() const { return QObject::parent(); }
137 #else
138  using QObject::parent;
139 #endif
140 
141 public Q_SLOTS:
142  void refresh(const QModelIndex &parent = QModelIndex());
143 
144 protected:
145  QDirModel(QDirModelPrivate &, QObject *parent = 0);
146  friend class QFileDialogPrivate;
147 
148 private:
151  Q_PRIVATE_SLOT(d_func(), void _q_refresh())
152 };
153 
154 #endif // QT_NO_DIRMODEL
155 
157 
159 
160 #endif // QDIRMODEL_H
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
virtual int columnCount(const QModelIndex &parent=QModelIndex()) const =0
Returns the number of columns for the children of the given parent.
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
bool resolveSymlinks
Whether the directory model should resolve symbolic links.
Definition: qdirmodel.h:62
#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.
#define Q_SLOTS
Definition: qobjectdefs.h:71
The QString class provides a Unicode character string.
Definition: qstring.h:83
bool readOnly
Whether the directory model allows writing to the file system.
Definition: qdirmodel.h:63
The QObject class is the base class of all Qt objects.
Definition: qobject.h:111
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
static void sort(T *array, int count, LessThan lessThan)
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
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.
bool lazyChildCount
Whether the directory model optimizes the hasChildren function to only check if the item is a directo...
Definition: qdirmodel.h:64
static const char *const filters[3]
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)
quint16 index
#define Q_DECLARE_PRIVATE(Class)
Definition: qglobal.h:2467
The QFileInfo class provides system-independent file information.
Definition: qfileinfo.h:60
Orientation
Definition: qnamespace.h:174
#define QT_END_HEADER
Definition: qglobal.h:137
static QString fileName(const QString &fileUrl)
The QDirModel class provides a data model for the local filesystem.
Definition: qdirmodel.h:59
virtual QMimeData * mimeData(const QModelIndexList &indexes) const
Returns an object that contains serialized items of data corresponding to the list of indexes specifi...
The QIcon class provides scalable icons in different modes and states.
Definition: qicon.h:60