goptionpane.h

/*
 * File: goptionpane.h
 * -------------------
 *
 * @author Marty Stepp
 * @version 2021/04/09
 * - added sgl namespace
 * @version 2021/04/03
 * - removed dependency on custom collections
 * @version 2018/09/23
 * - renamed enum constants to avoid name collisions (may break some client code)
 * @version 2018/09/08
 * - added doc comments for new documentation generation
 * @version 2018/08/23
 * - renamed to goptionpane.h to replace Java version
 * @version 2018/06/28
 * - initial version
 */


#ifndef _goptionpane_h
#define _goptionpane_h

#include <string>
#include <vector>

#include "ginteractor.h"

namespace sgl {

// forward declaration
class GWindow;

class GOptionPane {
public:
    enum ConfirmType {
        CONFIRM_YES_NO = 0,
        CONFIRM_YES_NO_CANCEL = 1,
        CONFIRM_OK_CANCEL = 2
    };

    enum ConfirmResult {
        CONFIRM_CANCEL = -1,   // for yes/no/cancel dialogs
        CONFIRM_NO = 0,        // 0 so that 'no' is 'falsey'
        CONFIRM_YES = 1,       // 1 so that 'yes' is 'truthy'
        CONFIRM_OK = 2         // for ok/cancel dialogs
    };

    enum MessageType {
        MESSAGE_ERROR = 0,
        MESSAGE_INFORMATION = 1,
        MESSAGE_PLAIN = -1,
        MESSAGE_WARNING = 2,
        MESSAGE_QUESTION = 3,
        MESSAGE_ABOUT = 4
    };

    static ConfirmResult showConfirmDialog(const string& message,
                                           const string& title = "",
                                           ConfirmType type = CONFIRM_YES_NO);

    static ConfirmResult showConfirmDialog(GWindow* parent,
                                           const string& message,
                                           const string& title = "",
                                           ConfirmType type = CONFIRM_YES_NO);

    static ConfirmResult showConfirmDialog(QWidget* parent,
                                           const string& message,
                                           const string& title = "",
                                           ConfirmType type = CONFIRM_YES_NO);

    static string showInputDialog(const string& message,
                                       const string& title = "",
                                       const string& initialValue = "");

    static string showInputDialog(GWindow* parent,
                                       const string& message,
                                       const string& title = "",
                                       const string& initialValue = "");

    static string showInputDialog(QWidget* parent,
                                       const string& message,
                                       const string& title = "",
                                       const string& initialValue = "");

    static void showMessageDialog(const string& message,
                                  const string& title = "",
                                  MessageType type = MESSAGE_PLAIN);

    static void showMessageDialog(GWindow* parent,
                                  const string& message,
                                  const string& title = "",
                                  MessageType type = MESSAGE_PLAIN);

    static void showMessageDialog(QWidget* parent,
                                  const string& message,
                                  const string& title = "",
                                  MessageType type = MESSAGE_PLAIN);

    static string showOptionDialog(const string& message,
                                        const std::vector<string>& options,
                                        const string& title = "",
                                        const string& initiallySelected = "");

    static string showOptionDialog(GWindow* parent,
                                        const string& message,
                                        const std::vector<string>& options,
                                        const string& title = "",
                                        const string& initiallySelected = "");

    static string showOptionDialog(QWidget* parent,
                                        const string& message,
                                        const std::vector<string>& options,
                                        const string& title = "",
                                        const string& initiallySelected = "");

    static void showTextFileDialog(const string& fileText,
                                   const string& title = "",
                                   int rows = -1, int cols = -1);

    static void showTextFileDialog(GWindow* parent,
                                   const string& fileText,
                                   const string& title = "",
                                   int rows = -1, int cols = -1);

    static void showTextFileDialog(QWidget* parent,
                                   const string& fileText,
                                   const string& title = "",
                                   int rows = -1, int cols = -1);

private:
    GOptionPane();

    enum InternalResult {
        INTERNAL_CANCEL_OPTION = 2,
        INTERNAL_CLOSED_OPTION = -1,
        INTERNAL_NO_OPTION = 1,
        INTERNAL_OK_OPTION = 0,
        INTERNAL_YES_OPTION = 0
    };
};

} // namespace sgl

#endif // _goptionpane_h