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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
#pragma once
#include "imodule.h"
#include <memory>
class wxWindow;
namespace ui
{
class IDialog
{
public:
virtual ~IDialog() {}
enum Result
{
RESULT_CANCELLED = 0,
RESULT_OK,
RESULT_NO,
RESULT_YES,
};
/// Possible message types (used for IDialogManager::createMessageBox())
enum MessageType
{
/// Just a plain message with an OK button
MESSAGE_CONFIRM,
// Queries Yes//No from the user
MESSAGE_ASK,
/// Displays a warning message
MESSAGE_WARNING,
/// Displays an error message
MESSAGE_ERROR,
/// Has three options: Yes, No or Cancel
MESSAGE_YESNOCANCEL,
/// Save confirmation as per HIG 2.32/3.4.6.1
MESSAGE_SAVECONFIRMATION
};
// Sets the dialog title
virtual void setTitle(const std::string& title) = 0;
// A handle to access dialog elements after addition
typedef std::size_t Handle;
typedef std::vector<std::string> ComboBoxOptions;
// ------------------- Elements -----------------------
/**
* Adds a simple label at the current position in the dialog.
* A unique handle is returned to allow for later value retrieval.
* The elements are inserted in the order of calls, top to bottom.
* In case of errors an invalid handle (==0) is returned.
*/
virtual Handle addLabel(const std::string& text) = 0;
virtual Handle addComboBox(const std::string& label, const ComboBoxOptions& options) = 0;
virtual Handle addEntryBox(const std::string& label) = 0;
virtual Handle addPathEntry(const std::string& label, bool foldersOnly = false) = 0;
virtual Handle addSpinButton(const std::string& label, double min, double max, double step, unsigned int digits) = 0;
virtual Handle addCheckbox(const std::string& label) = 0;
// ----------------- Element Value --------------------
// Retrieve or set an element's value by string
virtual void setElementValue(const Handle& handle, const std::string& value) = 0;
virtual std::string getElementValue(const Handle& handle) = 0;
// ----------------------------------------------------
/**
* Run the dialog an enter the main loop (block the application).
* Returns the Dialog::Result, corresponding to the user's action.
*/
virtual Result run() = 0;
};
typedef std::shared_ptr<IDialog> IDialogPtr;
const IDialog::Handle INVALID_HANDLE = 0;
class IFileChooser;
typedef std::shared_ptr<IFileChooser> IFileChooserPtr;
class IDirChooser;
typedef std::shared_ptr<IDirChooser> IDirChooserPtr;
class IResourceChooser; // defined in iresourcechooser.h
class IAnimationChooser; // defined in ianimationchooser.h
class IDialogManager :
public RegisterableModule
{
public:
// Virtual destructor
virtual ~IDialogManager() {}
/**
* Create a new dialog. Note that the DialogManager will hold a reference
* to this dialog internally to allow scripts to reference the Dialog class
* without holding the shared_ptr on their own or using wrapper classes doing so.
*
* Every dialog features an OK and a Cancel button by default.
*
* @title: The string displayed on the dialog's window bar.
* @type: the dialog type to create, determines e.g. which buttons are shown.
* @parent: optional top-level widget this dialog should be parented to, defaults to
* GlobalMainFrame's toplevel window if left at NULL.
*/
virtual IDialogPtr createDialog(const std::string& title,
wxWindow* parent = nullptr) = 0;
/**
* Create a simple message box, which can either notify the user about something,
* queries "Yes"/"No" or displays an error message. It usually features
* an icon according to the the MessageType passed (exclamation mark, error sign).
*
* @title: The string displayed on the message box window bar.
* @text: The text/question to be displayed.
* @type: the message type this dialog represents.
* @parent: optional top-level widget this dialog should be parented to, defaults to
* GlobalMainFrame().getMainWindow().
*/
virtual IDialogPtr createMessageBox(const std::string& title,
const std::string& text,
IDialog::MessageType type,
wxWindow* parent = nullptr) = 0;
/**
* Acquire a new filechooser instance with the given parameters.
*
* @title: The dialog title.
* @open: if TRUE this is asking for "Open" files, FALSE generates a "Save" dialog.
* @pattern: the type "map", "prefab", this determines the file extensions.
* @defaultExt: The default extension appended when the user enters
* filenames without extension.
*/
virtual IFileChooserPtr createFileChooser(const std::string& title,
bool open,
const std::string& pattern = "",
const std::string& defaultExt = "") = 0;
/**
* Acquire a new folder chooser instance with the given parameters.
*
* @title: The dialog title.
*/
virtual IDirChooserPtr createDirChooser(const std::string& title) = 0;
// Creates and returns a new Dialog class for selecting a sound shader.
// It's the responsibility of the client code to call destroyDialog() on the returned object.
// Optionally specify a parent window the dialog should be a child of.
virtual IResourceChooser* createSoundShaderChooser(wxWindow* parent = nullptr) = 0;
// Creates and returns a new Dialog class for selecting an MD5 anim.
// It's the responsibility of the client code to call destroyDialog() on the returned object.
// Optionally specify a parent window the dialog should be a child of.
virtual IAnimationChooser* createAnimationChooser(wxWindow* parent = nullptr) = 0;
};
} // namespace ui
constexpr const char* const MODULE_DIALOGMANAGER = "DialogManager";
inline ui::IDialogManager& GlobalDialogManager()
{
static module::InstanceReference<ui::IDialogManager> _reference(MODULE_DIALOGMANAGER);
return _reference;
}
|
