1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of Qt Creator.
7 **
8 ** Commercial License Usage
9 ** Licensees holding valid commercial Qt licenses may use this file in
10 ** accordance with the commercial license agreement provided with the
11 ** Software or, alternatively, in accordance with the terms contained in
12 ** a written agreement between you and The Qt Company. For licensing terms
13 ** and conditions see https://www.qt.io/terms-conditions. For further
14 ** information use the contact form at https://www.qt.io/contact-us.
15 **
16 ** GNU General Public License Usage
17 ** Alternatively, this file may be used under the terms of the GNU
18 ** General Public License version 3 as published by the Free Software
19 ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
20 ** included in the packaging of this file. Please review the following
21 ** information to ensure the GNU General Public License requirements will
22 ** be met: https://www.gnu.org/licenses/gpl-3.0.html.
23 **
24 ****************************************************************************/
25 
26 #pragma once
27 
28 #include "basefilefilter.h"
29 
30 #include <coreplugin/core_global.h>
31 
32 #include <QString>
33 #include <QByteArray>
34 #include <QFutureInterface>
35 #include <QMutex>
36 
37 namespace Core {
38 namespace Internal {
39 namespace Ui {
40 class DirectoryFilterOptions;
41 } // namespace Ui
42 } // namespace Internal
43 
44 class CORE_EXPORT DirectoryFilter : public BaseFileFilter
45 {
46     Q_OBJECT
47 
48 public:
49     DirectoryFilter(Utils::Id id);
50     void restoreState(const QByteArray &state) override;
51     bool openConfigDialog(QWidget *parent, bool &needsRefresh) override;
52     void refresh(QFutureInterface<void> &future) override;
53 
54     void setIsCustomFilter(bool value);
55     void setDirectories(const QStringList &directories);
56     void addDirectory(const QString &directory);
57     void removeDirectory(const QString &directory);
58     QStringList directories() const;
59     void setFilters(const QStringList &filters);
60     void setExclusionFilters(const QStringList &exclusionFilters);
61 
62 protected:
63     void saveState(QJsonObject &object) const final;
64     void restoreState(const QJsonObject &object) final;
65 
66 private:
67     void handleAddDirectory();
68     void handleEditDirectory();
69     void handleRemoveDirectory();
70     void updateOptionButtons();
71     void updateFileIterator();
72 
73     QStringList m_directories;
74     QStringList m_filters;
75     QStringList m_exclusionFilters;
76     // Our config dialog, uses in addDirectory and editDirectory
77     // to give their dialogs the right parent
78     QDialog *m_dialog = nullptr;
79     Internal::Ui::DirectoryFilterOptions *m_ui = nullptr;
80     mutable QMutex m_lock;
81     Utils::FilePaths m_files;
82     bool m_isCustomFilter = true;
83 };
84 
85 } // namespace Core
86