src/gui/fspathedit.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 <QWidget>
  32
  33 #include "base/path.h"
  34
  35 namespace Private
  36 {
  37     class FileComboEdit;
  38     class FileLineEdit;
  39     class IFileEditorWithCompletion;
  40 }
  41
  42 /*!
  43  * \brief
  44  * Widget for editing strings which are paths in filesystem
  45  */
  46 class FileSystemPathEdit : public QWidget
  47 {
  48     Q_OBJECT
  49     Q_DISABLE_COPY_MOVE(FileSystemPathEdit)
  50
  51     Q_PROPERTY(Mode mode READ mode WRITE setMode)
  52     Q_PROPERTY(Path selectedPath READ selectedPath WRITE setSelectedPath NOTIFY selectedPathChanged)
  53     Q_PROPERTY(QString fileNameFilter READ fileNameFilter WRITE setFileNameFilter)
  54     Q_PROPERTY(QString dialogCaption READ dialogCaption WRITE setDialogCaption)
  55
  56     class FileSystemPathEditPrivate;
  57
  58 public:
  59     ~FileSystemPathEdit() override;
  60
  61     enum class Mode
  62     {
  63         FileOpen,        //!< opening files, shows open file dialog
  64         FileSave,        //!< saving files, shows save file dialog
  65         DirectoryOpen,   //!< selecting existing directories
  66         DirectorySave    //!< selecting directories for saving
  67     };
  68     Q_ENUM(Mode)
  69
  70     Mode mode() const;
  71     void setMode(Mode mode);
  72
  73     Path selectedPath() const;
  74     void setSelectedPath(const Path &val);
  75
  76     QString fileNameFilter() const;
  77     void setFileNameFilter(const QString &val);
  78
  79     Path placeholder() const;
  80     void setPlaceholder(const Path &val);
  81
  82     /// The browse button caption is "..." if true, and "Browse" otherwise
  83     bool briefBrowseButtonCaption() const;
  84     void setBriefBrowseButtonCaption(bool brief);
  85
  86     QString dialogCaption() const;
  87     void setDialogCaption(const QString &caption);
  88
  89     virtual void clear() = 0;
  90
  91 signals:
  92     void selectedPathChanged(const Path &path);
  93
  94 protected:
  95     explicit FileSystemPathEdit(Private::IFileEditorWithCompletion *editor, QWidget *parent);
  96
  97     template <class Widget>
  98     Widget *editWidget() const
  99     {
 100         return static_cast<Widget *>(editWidgetImpl());
 101     }
 102
 103 protected slots:
 104     void onPathEdited();
 105
 106 private:
 107     Q_DECLARE_PRIVATE(FileSystemPathEdit)
 108
 109     virtual QString editWidgetText() const = 0;
 110     virtual void setEditWidgetText(const QString &text) = 0;
 111
 112     QWidget *editWidgetImpl() const;
 113
 114     FileSystemPathEditPrivate *d_ptr = nullptr;
 115 };
 116
 117 /// Widget which uses QLineEdit for path editing
 118 class FileSystemPathLineEdit final : public FileSystemPathEdit
 119 {
 120     using base = FileSystemPathEdit;
 121     using WidgetType = Private::FileLineEdit;
 122
 123 public:
 124     explicit FileSystemPathLineEdit(QWidget *parent = nullptr);
 125
 126     void clear() override;
 127
 128 private:
 129     QString editWidgetText() const override;
 130     void setEditWidgetText(const QString &text) override;
 131 };
 132
 133 /// Widget which uses QComboBox for path editing
 134 class FileSystemPathComboEdit final : public FileSystemPathEdit
 135 {
 136     using base = FileSystemPathEdit;
 137     using WidgetType = Private::FileComboEdit;
 138
 139 public:
 140     explicit FileSystemPathComboEdit(QWidget *parent = nullptr);
 141
 142     void clear() override;
 143
 144     int count() const;
 145     Path item(int index) const;
 146     void addItem(const Path &path);
 147     void insertItem(int index, const Path &path);
 148
 149     int currentIndex() const;
 150     void setCurrentIndex(int index);
 151
 152     int maxVisibleItems() const;
 153     void setMaxVisibleItems(int maxItems);
 154
 155 private:
 156     QString editWidgetText() const override;
 157     void setEditWidgetText(const QString &text) override;
 158 };