gfilechooser.h

/*
 * File: gfilechooser.h
 * --------------------
 * This file defines the <code>GFileChooser</code> class which supports
 * popping up graphical dialog boxes to select file names.
 * 
 * @author Marty Stepp
 * @version 2021/04/09
 * - added sgl namespace
 * @version 2018/09/07
 * - added doc comments for new documentation generation
 * - added overloads that accept GWindow* parent
 * @version 2018/08/23
 * - renamed to gfilechooser.h to replace Java version
 * @version 2018/06/28
 * - initial version
 */


#ifndef _gfilechooser_h
#define _gfilechooser_h

#include <string>
#include <QWidget>

#include "gwindow.h"

namespace sgl {

class GFileChooser {
public:
    static string showOpenDialog(const string& title = "Open file", const string& currentDir = "", const string& fileFilter = "");

    static string showOpenDialog(GWindow* parent, const string& title = "Open file", const string& currentDir = "", const string& fileFilter = "");

    static string showOpenDialog(QWidget* parent, const string& title = "Open file", const string& currentDir = "", const string& fileFilter = "");

    static string showSaveDialog(const string& title = "Save file", const string& currentDir = "", const string& fileFilter = "");

    static string showSaveDialog(GWindow* parent, const string& title = "Save file", const string& currentDir = "", const string& fileFilter = "");

    static string showSaveDialog(QWidget* parent, const string& title = "Save file", const string& currentDir = "", const string& fileFilter = "");

private:
    GFileChooser();   // prevent construction

    /*
     * Constants for dialog types, similar to those in Java's JFileChooser
     */
    enum DialogType {
        OPEN_DIALOG = 0,
        SAVE_DIALOG = 1
    };

    /*
     * Converts between our comma-separated file filter format to the one
     * used by Qt that uses ;; as its separator.
     * @param fileFilter a file filter string such as "*.gif,*.jpg,*.png".
     */
    static string normalizeFileFilter(const string& fileFilter);
};

} // namespace sgl

#endif // _gfilechooser_h