src/gui/fspathedit_p.h

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2016 Eugene Shalygin
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  *
  19  * In addition, as a special exception, the copyright holders give permission to
  20  * link this program with the OpenSSL project's "OpenSSL" library (or with
  21  * modified versions of it that use the same license as the "OpenSSL" library),
  22  * and distribute the linked executables. You must obey the GNU General Public
  23  * License in all respects for all of the code used other than "OpenSSL".  If you
  24  * modify file(s), you may extend this exception to your version of the file(s),
  25  * but you are not obligated to do so. If you do not wish to do so, delete this
  26  * exception statement from your version.
  27  */
  28
  29 #pragma once
  30
  31 #include <QComboBox>
  32 #include <QFileIconProvider>
  33 #include <QLineEdit>
  34 #include <QtContainerFwd>
  35 #include <QValidator>
  36
  37 class QAction;
  38 class QCompleter;
  39 class QContextMenuEvent;
  40 class QFileSystemModel;
  41 class QKeyEvent;
  42
  43 namespace Private
  44 {
  45     class FileSystemPathValidator final : public QValidator
  46     {
  47         Q_OBJECT
  48
  49     public:
  50         FileSystemPathValidator(QObject *parent = nullptr);
  51
  52         bool strictMode() const;
  53         void setStrictMode(bool v);
  54
  55         bool existingOnly() const;
  56         void setExistingOnly(bool v);
  57
  58         bool directoriesOnly() const;
  59         void setDirectoriesOnly(bool v);
  60
  61         bool checkReadPermission() const;
  62         void setCheckReadPermission(bool v);
  63
  64         bool checkWritePermission() const;
  65         void setCheckWritePermission(bool v);
  66
  67         QValidator::State validate(QString &input, int &pos) const override;
  68
  69         enum class TestResult
  70         {
  71             OK,
  72             DoesNotExist,
  73             NotADir,
  74             NotAFile,
  75             CantRead,
  76             CantWrite
  77         };
  78
  79         TestResult lastTestResult() const;
  80         QValidator::State lastValidationState() const;
  81         QString lastTestedPath() const;
  82
  83     private:
  84         QValidator::State validate(const QList<QStringView> &pathComponents, bool strict,
  85                                    int firstComponentToTest, int lastComponentToTest) const;
  86
  87         TestResult testPath(QStringView path, bool pathIsComplete) const;
  88
  89         bool m_strictMode;
  90         bool m_existingOnly;
  91         bool m_directoriesOnly;
  92         bool m_checkReadPermission;
  93         bool m_checkWritePermission;
  94
  95         mutable TestResult m_lastTestResult;
  96         mutable QValidator::State m_lastValidationState;
  97         mutable QString m_lastTestedPath;
  98     };
  99
 100     class FileEditorWithCompletion
 101     {
 102     public:
 103         virtual ~FileEditorWithCompletion() = default;
 104         virtual void completeDirectoriesOnly(bool completeDirsOnly) = 0;
 105         virtual void setFilenameFilters(const QStringList &filters) = 0;
 106         virtual void setBrowseAction(QAction *action) = 0;
 107         virtual void setValidator(QValidator *validator) = 0;
 108         virtual QWidget *widget() = 0;
 109     };
 110
 111     class FileLineEdit final : public QLineEdit, public FileEditorWithCompletion
 112     {
 113         Q_OBJECT
 114         Q_DISABLE_COPY_MOVE(FileLineEdit)
 115
 116     public:
 117         FileLineEdit(QWidget *parent = nullptr);
 118         ~FileLineEdit();
 119
 120         void completeDirectoriesOnly(bool completeDirsOnly) override;
 121         void setFilenameFilters(const QStringList &filters) override;
 122         void setBrowseAction(QAction *action) override;
 123         void setValidator(QValidator *validator) override;
 124         QWidget *widget() override;
 125
 126     protected:
 127         void keyPressEvent(QKeyEvent *event) override;
 128         void contextMenuEvent(QContextMenuEvent *event) override;
 129
 130     private:
 131         static QString warningText(FileSystemPathValidator::TestResult r);
 132         void showCompletionPopup();
 133
 134         QFileSystemModel *m_completerModel;
 135         QCompleter *m_completer;
 136         QAction *m_browseAction;
 137         QFileIconProvider m_iconProvider;
 138         QAction *m_warningAction;
 139     };
 140
 141     class FileComboEdit final : public QComboBox, public FileEditorWithCompletion
 142     {
 143         Q_OBJECT
 144
 145     public:
 146         FileComboEdit(QWidget *parent = nullptr);
 147
 148         void completeDirectoriesOnly(bool completeDirsOnly) override;
 149         void setFilenameFilters(const QStringList &filters) override;
 150         void setBrowseAction(QAction *action) override;
 151         void setValidator(QValidator *validator) override;
 152         QWidget *widget() override;
 153
 154     protected:
 155         QString text() const;
 156     };
 157 }