src/imports/folderlistmodel/qdeclarativefolderlistmodel.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the examples of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QDECLARATIVEFOLDERLISTMODEL_H
  43 #define QDECLARATIVEFOLDERLISTMODEL_H
  44
  45 #include <qdeclarative.h>
  46 #include <QStringList>
  47 #include <QUrl>
  48 #include <QAbstractListModel>
  49
  50 #ifndef QT_NO_DIRMODEL
  51
  52 QT_BEGIN_HEADER
  53
  54 QT_BEGIN_NAMESPACE
  55
  56
  57 class QDeclarativeContext;
  58 class QModelIndex;
  59
  60 class QDeclarativeFolderListModelPrivate;
  61
  62 //![class begin]
  63 class QDeclarativeFolderListModel : public QAbstractListModel, public QDeclarativeParserStatus
  64 {
  65     Q_OBJECT
  66     Q_INTERFACES(QDeclarativeParserStatus)
  67 //![class begin]
  68
  69 //![class props]
  70     Q_PROPERTY(QUrl folder READ folder WRITE setFolder NOTIFY folderChanged)
  71     Q_PROPERTY(QUrl parentFolder READ parentFolder NOTIFY folderChanged)
  72     Q_PROPERTY(QStringList nameFilters READ nameFilters WRITE setNameFilters)
  73     Q_PROPERTY(SortField sortField READ sortField WRITE setSortField)
  74     Q_PROPERTY(bool sortReversed READ sortReversed WRITE setSortReversed)
  75     Q_PROPERTY(bool showDirs READ showDirs WRITE setShowDirs)
  76     Q_PROPERTY(bool showDotAndDotDot READ showDotAndDotDot WRITE setShowDotAndDotDot)
  77     Q_PROPERTY(bool showOnlyReadable READ showOnlyReadable WRITE setShowOnlyReadable)
  78     Q_PROPERTY(int count READ count)
  79 //![class props]
  80
  81 //![abslistmodel]
  82 public:
  83     QDeclarativeFolderListModel(QObject *parent = 0);
  84     ~QDeclarativeFolderListModel();
  85
  86     enum Roles { FileNameRole = Qt::UserRole+1, FilePathRole = Qt::UserRole+2 };
  87
  88     int rowCount(const QModelIndex &parent) const;
  89     QVariant data(const QModelIndex &index, int role) const;
  90 //![abslistmodel]
  91
  92 //![count]
  93     int count() const { return rowCount(QModelIndex()); }
  94 //![count]
  95
  96 //![prop funcs]
  97     QUrl folder() const;
  98     void setFolder(const QUrl &folder);
  99
 100     QUrl parentFolder() const;
 101
 102     QStringList nameFilters() const;
 103     void setNameFilters(const QStringList &filters);
 104
 105     enum SortField { Unsorted, Name, Time, Size, Type };
 106     SortField sortField() const;
 107     void setSortField(SortField field);
 108     Q_ENUMS(SortField)
 109
 110     bool sortReversed() const;
 111     void setSortReversed(bool rev);
 112
 113     bool showDirs() const;
 114     void  setShowDirs(bool);
 115     bool showDotAndDotDot() const;
 116     void  setShowDotAndDotDot(bool);
 117     bool showOnlyReadable() const;
 118     void  setShowOnlyReadable(bool);
 119 //![prop funcs]
 120
 121 //![isfolder]
 122     Q_INVOKABLE bool isFolder(int index) const;
 123 //![isfolder]
 124
 125 //![parserstatus]
 126     virtual void classBegin();
 127     virtual void componentComplete();
 128 //![parserstatus]
 129
 130 //![notifier]
 131 Q_SIGNALS:
 132     void folderChanged();
 133 //![notifier]
 134
 135 //![class end]
 136 private Q_SLOTS:
 137     void refresh();
 138     void resetFiltering();
 139     void inserted(const QModelIndex &index, int start, int end);
 140     void removed(const QModelIndex &index, int start, int end);
 141     void handleDataChanged(const QModelIndex &start, const QModelIndex &end);
 142
 143 private:
 144     Q_DISABLE_COPY(QDeclarativeFolderListModel)
 145     QDeclarativeFolderListModelPrivate *d;
 146 };
 147 //![class end]
 148
 149 QT_END_NAMESPACE
 150
 151 //![qml decl]
 152 QML_DECLARE_TYPE(QDeclarativeFolderListModel)
 153 //![qml decl]
 154
 155 QT_END_HEADER
 156
 157 #endif // QT_NO_DIRMODEL
 158
 159 #endif // QDECLARATIVEFOLDERLISTMODEL_H