QGCFileDialog.h 7.39 KB
Newer Older
Don Gagne's avatar
Don Gagne committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
/*=====================================================================
 
 QGroundControl Open Source Ground Control Station
 
 (c) 2009 - 2014 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
 
 This file is part of the QGROUNDCONTROL project
 
 QGROUNDCONTROL is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.
 
 QGROUNDCONTROL is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with QGROUNDCONTROL. If not, see <http://www.gnu.org/licenses/>.
 
 ======================================================================*/

#ifndef QGCFILEDIALOG_H
#define QGCFILEDIALOG_H

27 28 29 30
#ifdef __mobile__
#error Should not be included in mobile builds
#endif

Don Gagne's avatar
Don Gagne committed
31 32 33
#include <QFileDialog>

/// @file
34
///     @brief Subclass of <a href="http://qt-project.org/doc/qt-5/qfiledialog.html">QFileDialog</a>
Don Gagne's avatar
Don Gagne committed
35 36
///     @author Don Gagne <don@thegagnes.com>

37
/*!
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
    Subclass of <a href="http://qt-project.org/doc/qt-5/qfiledialog.html">QFileDialog</a> which re-implements the static public functions. The reason for this
    is that the <a href="http://qt-project.org/doc/qt-5/qfiledialog.html">QFileDialog</a> implementations of these use the native os dialogs. On OSX these
    these can intermittently hang. So instead here we use the native dialogs. It also allows
    use to catch these dialogs for unit testing.
    @remark If you need to know what type of file was returned by these functions, you can use something like:
    @code{.cpp}
    QString filename = QGCFileDialog::getSaveFileName(this, tr("Save File"), "~/", "Foo files (*.foo);;All Files (*.*)", "foo");
    if (!filename.isEmpty()) {
        QFileInfo fi(filename);
        QString fileExtension(fi.suffix());
        if (fileExtension == QString("foo")) {
            // do something
        }
    }
    @endcode
53 54
*/

Don Gagne's avatar
Don Gagne committed
55 56 57
class QGCFileDialog : public QFileDialog {
    
public:
58 59 60

    //! Static helper that will return an existing directory selected by the user.
    /*!
dogmaphobic's avatar
dogmaphobic committed
61 62 63 64 65 66
        @param[in] parent The parent QWidget.
        @param[in] caption The caption displayed at the top of the dialog.
        @param[in] dir The initial directory shown to the user.
        @param[in] options Set the various options that affect the look and feel of the dialog.
        @return The chosen path or \c QString("") if none.
        @sa <a href="http://qt-project.org/doc/qt-5/qfiledialog.html#getExistingDirectory">QFileDialog::getExistingDirectory()</a>
67
    */
68 69 70 71 72
    static QString getExistingDirectory(
        QWidget* parent = 0,
        const QString& caption = QString(),
        const QString& dir = QString(),
        Options options = ShowDirsOnly);
Don Gagne's avatar
Don Gagne committed
73
    
74 75
    //! Static helper that invokes a File Open dialog where the user can select a file to be opened.
    /*!
dogmaphobic's avatar
dogmaphobic committed
76 77 78 79 80 81 82
        @param[in] parent The parent QWidget.
        @param[in] caption The caption displayed at the top of the dialog.
        @param[in] dir The initial directory shown to the user.
        @param[in] filter The filter used for selecting the file type.
        @param[in] options Set the various options that affect the look and feel of the dialog.
        @return The full path and filename to be opened or \c QString("") if none.
        @sa <a href="http://qt-project.org/doc/qt-5/qfiledialog.html#getOpenFileName">QFileDialog::getOpenFileName()</a>
83
    */
84 85 86 87 88 89
    static QString getOpenFileName(
        QWidget* parent = 0,
        const QString& caption = QString(),
        const QString& dir = QString(),
        const QString& filter = QString(),
        Options options = 0);
Don Gagne's avatar
Don Gagne committed
90
    
91 92
    //! Static helper that invokes a File Open dialog where the user can select one or more files to be opened.
    /*!
dogmaphobic's avatar
dogmaphobic committed
93 94 95 96 97 98 99
        @param[in] parent The parent QWidget.
        @param[in] caption The caption displayed at the top of the dialog.
        @param[in] dir The initial directory shown to the user.
        @param[in] filter The filter used for selecting the file type.
        @param[in] options Set the various options that affect the look and feel of the dialog.
        @return A <a href="http://qt-project.org/doc/qt-5/qstringlist.html">QStringList</a> object containing zero or more files to be opened.
        @sa <a href="http://qt-project.org/doc/qt-5/qfiledialog.html#getOpenFileNames">QFileDialog::getOpenFileNames()</a>
100
    */
101 102 103 104 105 106
    static QStringList getOpenFileNames(
        QWidget* parent = 0,
        const QString& caption = QString(),
        const QString& dir = QString(),
        const QString& filter = QString(),
        Options options = 0);
Don Gagne's avatar
Don Gagne committed
107
    
108 109
    //! Static helper that invokes a File Save dialog where the user can select a directory and enter a filename to be saved.
    /*!
dogmaphobic's avatar
dogmaphobic committed
110 111 112 113 114 115 116 117 118 119 120 121 122 123
        @param[in] parent The parent QWidget.
        @param[in] caption The caption displayed at the top of the dialog.
        @param[in] dir The initial directory shown to the user.
        @param[in] filter The filter used for selecting the file type.
        @param[in] defaultSuffix Specifies a string that will be added to the filename if it has no suffix already. The suffix is typically used to indicate the file type (e.g. "txt" indicates a text file).
        @param[in] strict Makes the default suffix mandatory. Only files with those extensions will be allowed.
        @param[in] options Set the various options that affect the look and feel of the dialog.
        @return The full path and filename to be used to save the file or \c QString("") if none.
        @sa <a href="http://qt-project.org/doc/qt-5/qfiledialog.html#getSaveFileName">QFileDialog::getSaveFileName()</a>
        @remark If a default suffix is given, it will be appended to the filename if the user does not enter one themselves. That is, if the user simply enters \e foo and the default suffix is set to \e bar,
        the returned filename will be \e foo.bar. However, if the user specifies a suffix, the \e strict flag will determine what is done. If the user enters \e foo.txt and \e strict is false, the function
        returns \e foo.txt (no suffix enforced). If \e strict is true however, the default suffix is appended no matter what. In the case above, the function will return \e foo.txt.bar (suffix enforced).
        @remark If \e strict is set and the file name given by the user is renamed (the \e foo.txt.bar example above), the function will check and see if the file already exists. If that's the case, it will
        ask the user if they want to overwrite it.
124
    */
125 126 127 128 129
    static QString getSaveFileName(
        QWidget* parent = 0,
        const QString& caption = QString(),
        const QString& dir = QString(),
        const QString& filter = QString(),
130
        const QString& defaultSuffix = QString(),
131
        bool strict = false,
132 133
        Options options = 0);

134
private slots:
dogmaphobic's avatar
dogmaphobic committed
135
    /// @brief The exec slot is private because we only want QGCFileDialog users to use the static methods. Otherwise it will break
136
    ///        unit testing.
Don Gagne's avatar
Don Gagne committed
137
    int exec(void) { return QFileDialog::exec(); }
138 139
    
private:
140
    static void    _validate(Options& options);
141 142
    static bool    _validateExtension(const QString& filter, const QString& extension);
    static QString _getFirstExtensionInFilter(const QString& filter);
Don Gagne's avatar
Don Gagne committed
143 144 145 146
};


#endif