]> git.saurik.com Git - wxWidgets.git/blame - include/wx/msgdlg.h
Fix text text changed events sending in OS X combo box and text control.
[wxWidgets.git] / include / wx / msgdlg.h
CommitLineData
e5b50758
WS
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/msgdlgg.h
3// Purpose: common header and base class for wxMessageDialog
99d80019 4// Author: Julian Smart
e5b50758
WS
5// Modified by:
6// Created:
7// RCS-ID: $Id$
99d80019 8// Copyright: (c) Julian Smart
e5b50758
WS
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
34138703
JS
12#ifndef _WX_MSGDLG_H_BASE_
13#define _WX_MSGDLG_H_BASE_
c801d85f 14
2ecf902b 15#include "wx/defs.h"
13a7abf9 16
e421922f
VZ
17#if wxUSE_MSGDLG
18
2afb9e16 19#include "wx/dialog.h"
e08931c0 20#include "wx/stockitem.h"
2afb9e16 21
53a2db12 22WXDLLIMPEXP_DATA_CORE(extern const char) wxMessageBoxCaptionStr[];
2afb9e16 23
e08931c0
VZ
24// ----------------------------------------------------------------------------
25// wxMessageDialogBase: base class defining wxMessageDialog interface
26// ----------------------------------------------------------------------------
27
53a2db12 28class WXDLLIMPEXP_CORE wxMessageDialogBase : public wxDialog
e5b50758 29{
2afb9e16 30public:
e08931c0
VZ
31 // helper class for SetXXXLabels() methods: it makes it possible to pass
32 // either a stock id (wxID_CLOSE) or a string ("&Close") to them
33 class ButtonLabel
34 {
35 public:
36 // ctors are not explicit, objects of this class can be implicitly
37 // constructed from either stock ids or strings
38 ButtonLabel(int stockId)
39 : m_stockId(stockId)
40 {
41 wxASSERT_MSG( wxIsStockID(stockId), "invalid stock id" );
42 }
43
44 ButtonLabel(const wxString& label)
45 : m_label(label), m_stockId(wxID_NONE)
46 {
47 }
48
298c25c3
VZ
49 ButtonLabel(const char *label)
50 : m_label(label), m_stockId(wxID_NONE)
51 {
52 }
53
54 ButtonLabel(const wchar_t *label)
55 : m_label(label), m_stockId(wxID_NONE)
56 {
57 }
58
59 ButtonLabel(const wxCStrData& label)
60 : m_label(label), m_stockId(wxID_NONE)
61 {
62 }
63
e08931c0
VZ
64 // default copy ctor and dtor are ok
65
66 // get the string label, whether it was originally specified directly
67 // or as a stock id -- this is only useful for platforms without native
68 // stock items id support
69 wxString GetAsString() const
70 {
3b5137c4
VZ
71 return m_stockId == wxID_NONE
72 ? m_label
73 : wxGetStockLabel(m_stockId, wxSTOCK_FOR_BUTTON);
e08931c0
VZ
74 }
75
76 // return the stock id or wxID_NONE if this is not a stock label
77 int GetStockId() const { return m_stockId; }
78
79 private:
80 // the label if explicitly given or empty if this is a stock item
81 const wxString m_label;
82
83 // the stock item id or wxID_NONE if m_label should be used
84 const int m_stockId;
85 };
86
87
2afb9e16
VZ
88 // ctors
89 wxMessageDialogBase() { m_dialogStyle = 0; }
90 wxMessageDialogBase(wxWindow *parent,
91 const wxString& message,
92 const wxString& caption,
93 long style)
94 : m_message(message),
95 m_caption(caption)
96 {
97 m_parent = parent;
98 SetMessageDialogStyle(style);
99 }
100
101 // virtual dtor for the base class
102 virtual ~wxMessageDialogBase() { }
103
104
105 // methods for setting up more custom message dialogs -- all functions
106 // return false if they're not implemented
e08931c0
VZ
107 virtual bool SetYesNoLabels(const ButtonLabel& WXUNUSED(yes),
108 const ButtonLabel& WXUNUSED(no))
2afb9e16
VZ
109 {
110 return false;
111 }
112
e08931c0
VZ
113 virtual bool SetYesNoCancelLabels(const ButtonLabel& WXUNUSED(yes),
114 const ButtonLabel& WXUNUSED(no),
115 const ButtonLabel& WXUNUSED(cancel))
2afb9e16
VZ
116 {
117 return false;
118 }
119
e08931c0 120 virtual bool SetOKLabel(const ButtonLabel& WXUNUSED(ok))
2afb9e16
VZ
121 {
122 return false;
123 }
124
e08931c0
VZ
125 virtual bool SetOKCancelLabels(const ButtonLabel& WXUNUSED(ok),
126 const ButtonLabel& WXUNUSED(cancel))
2afb9e16
VZ
127 {
128 return false;
129 }
130
131 virtual void SetMessage(const wxString& message)
132 {
133 m_message = message;
134 }
135
136 virtual void SetExtendedMessage(const wxString& extendedMessage)
137 {
138 m_extendedMessage = extendedMessage;
139 }
140
298c25c3 141 // change the dialog style flag
e5b50758
WS
142 void SetMessageDialogStyle(long style)
143 {
e08931c0
VZ
144 wxASSERT_MSG( ((style & wxYES_NO) == wxYES_NO) || !(style & wxYES_NO),
145 "wxYES and wxNO may only be used together" );
e5b50758 146
f45d6ade
VZ
147 wxASSERT_MSG( !(style & wxYES) || !(style & wxOK),
148 "wxOK and wxYES/wxNO can't be used together" );
149
150 wxASSERT_MSG( (style & wxYES) || (style & wxOK),
151 "one of wxOK and wxYES/wxNO must be used" );
152
e5b50758 153 wxASSERT_MSG( (style & wxID_OK) != wxID_OK,
e08931c0 154 "wxMessageBox: Did you mean wxOK (and not wxID_OK)?" );
e5b50758 155
9053c7b9
VZ
156 wxASSERT_MSG( !(style & wxNO_DEFAULT) || (style & wxNO),
157 "wxNO_DEFAULT is invalid without wxNO" );
41285bc8 158
9053c7b9
VZ
159 wxASSERT_MSG( !(style & wxCANCEL_DEFAULT) || (style & wxCANCEL),
160 "wxCANCEL_DEFAULT is invalid without wxCANCEL" );
41285bc8 161
3c9a70dd 162 wxASSERT_MSG( !(style & wxCANCEL_DEFAULT) || !(style & wxNO_DEFAULT),
9053c7b9 163 "only one default button can be specified" );
f45d6ade 164
e5b50758
WS
165 m_dialogStyle = style;
166 }
2afb9e16 167
298c25c3 168protected:
2afb9e16
VZ
169 long GetMessageDialogStyle() const { return m_dialogStyle; }
170
a4578b0c
VZ
171 // based on message dialog style, returns exactly one of: wxICON_NONE,
172 // wxICON_ERROR, wxICON_WARNING, wxICON_QUESTION, wxICON_INFORMATION
173 long GetEffectiveIcon() const
174 {
175 if ( m_dialogStyle & wxICON_NONE )
176 return wxICON_NONE;
177 else if ( m_dialogStyle & wxICON_ERROR )
178 return wxICON_ERROR;
179 else if ( m_dialogStyle & wxICON_WARNING )
180 return wxICON_WARNING;
181 else if ( m_dialogStyle & wxICON_QUESTION )
182 return wxICON_QUESTION;
183 else if ( m_dialogStyle & wxICON_INFORMATION )
184 return wxICON_INFORMATION;
185 else if ( m_dialogStyle & wxYES )
186 return wxICON_QUESTION;
187 else
188 return wxICON_INFORMATION;
189 }
190
2afb9e16
VZ
191
192 // for the platforms not supporting separate main and extended messages
193 // this function should be used to combine both of them in a single string
194 wxString GetFullMessage() const
e5b50758 195 {
2afb9e16
VZ
196 wxString msg = m_message;
197 if ( !m_extendedMessage.empty() )
198 msg << "\n\n" << m_extendedMessage;
199
200 return msg;
e5b50758
WS
201 }
202
2afb9e16
VZ
203 wxString m_message,
204 m_extendedMessage,
205 m_caption;
e5b50758 206 long m_dialogStyle;
23e00c55 207
c0c133e1 208 wxDECLARE_NO_COPY_CLASS(wxMessageDialogBase);
e5b50758
WS
209};
210
23e00c55
VZ
211// this is a helper class for native wxMessageDialog implementations which need
212// to store the custom button labels as member variables and then use them in
213// ShowModal() (there could conceivably be a port which would have some native
214// functions for setting these labels immediately and we also don't need to
215// store them at all if custom labels are not supported, which is why we do
216// this in a separate class and not wxMessageDialogBase itself)
92763588
VZ
217#if defined(__WXCOCOA__) || \
218 defined(__WXGTK20__) || \
219 defined(__WXMAC__) || \
220 defined(__WXMSW__)
23e00c55
VZ
221
222class WXDLLIMPEXP_CORE wxMessageDialogWithCustomLabels
223 : public wxMessageDialogBase
224{
225public:
226 // ctors
227 wxMessageDialogWithCustomLabels() { }
228 wxMessageDialogWithCustomLabels(wxWindow *parent,
229 const wxString& message,
230 const wxString& caption,
231 long style)
232 : wxMessageDialogBase(parent, message, caption, style)
233 {
234 }
235
236 // customization of the message box buttons
e08931c0 237 virtual bool SetYesNoLabels(const ButtonLabel& yes,const ButtonLabel& no)
23e00c55
VZ
238 {
239 DoSetCustomLabel(m_yes, yes);
240 DoSetCustomLabel(m_no, no);
241 return true;
242 }
243
e08931c0
VZ
244 virtual bool SetYesNoCancelLabels(const ButtonLabel& yes,
245 const ButtonLabel& no,
246 const ButtonLabel& cancel)
23e00c55
VZ
247 {
248 DoSetCustomLabel(m_yes, yes);
249 DoSetCustomLabel(m_no, no);
250 DoSetCustomLabel(m_cancel, cancel);
251 return true;
252 }
253
e08931c0 254 virtual bool SetOKLabel(const ButtonLabel& ok)
23e00c55
VZ
255 {
256 DoSetCustomLabel(m_ok, ok);
257 return true;
258 }
259
e08931c0
VZ
260 virtual bool SetOKCancelLabels(const ButtonLabel& ok,
261 const ButtonLabel& cancel)
23e00c55
VZ
262 {
263 DoSetCustomLabel(m_ok, ok);
264 DoSetCustomLabel(m_cancel, cancel);
265 return true;
266 }
267
268protected:
269 // test if any custom labels were set
270 bool HasCustomLabels() const
271 {
272 return !(m_ok.empty() && m_cancel.empty() &&
273 m_yes.empty() && m_no.empty());
274 }
275
276 // these functions return the label to be used for the button which is
277 // either a custom label explicitly set by the user or the default label,
278 // i.e. they always return a valid string
92763588
VZ
279 wxString GetYesLabel() const
280 { return m_yes.empty() ? GetDefaultYesLabel() : m_yes; }
281 wxString GetNoLabel() const
282 { return m_no.empty() ? GetDefaultNoLabel() : m_no; }
283 wxString GetOKLabel() const
284 { return m_ok.empty() ? GetDefaultOKLabel() : m_ok; }
23e00c55 285 wxString GetCancelLabel() const
92763588 286 { return m_cancel.empty() ? GetDefaultCancelLabel() : m_cancel; }
23e00c55 287
23e00c55
VZ
288 // this function is called by our public SetXXXLabels() and should assign
289 // the value to var with possibly some transformation (e.g. Cocoa version
e08931c0
VZ
290 // currently uses this to remove any accelerators from the button strings
291 // while GTK+ one handles stock items specifically here)
292 virtual void DoSetCustomLabel(wxString& var, const ButtonLabel& label)
23e00c55 293 {
e08931c0 294 var = label.GetAsString();
23e00c55
VZ
295 }
296
e08931c0 297private:
92763588
VZ
298 // these functions may be overridden to provide different defaults for the
299 // default button labels (this is used by wxGTK)
b91d65b1
MB
300 virtual wxString GetDefaultYesLabel() const { return wxGetTranslation("Yes"); }
301 virtual wxString GetDefaultNoLabel() const { return wxGetTranslation("No"); }
302 virtual wxString GetDefaultOKLabel() const { return wxGetTranslation("OK"); }
303 virtual wxString GetDefaultCancelLabel() const { return wxGetTranslation("Cancel"); }
92763588 304
23e00c55
VZ
305 // labels for the buttons, initially empty meaning that the defaults should
306 // be used, use GetYes/No/OK/CancelLabel() to access them
307 wxString m_yes,
308 m_no,
309 m_ok,
310 m_cancel;
311
c0c133e1 312 wxDECLARE_NO_COPY_CLASS(wxMessageDialogWithCustomLabels);
23e00c55
VZ
313};
314
315#endif // ports needing wxMessageDialogWithCustomLabels
316
2afb9e16
VZ
317#if defined(__WX_COMPILING_MSGDLGG_CPP__) || \
318 defined(__WXUNIVERSAL__) || defined(__WXGPE__) || \
2afb9e16
VZ
319 (defined(__WXGTK__) && !defined(__WXGTK20__))
320 #include "wx/generic/msgdlgg.h"
321
322 #define wxMessageDialog wxGenericMessageDialog
e9871aaf 323#elif defined(__WXCOCOA__)
2c6dbc21 324 #include "wx/cocoa/msgdlg.h"
4055ed82 325#elif defined(__WXPALMOS__)
2afb9e16 326 #include "wx/palmos/msgdlg.h"
21709999 327#elif defined(__WXMSW__)
2afb9e16 328 #include "wx/msw/msgdlg.h"
2049ba38 329#elif defined(__WXMOTIF__)
2afb9e16 330 #include "wx/motif/msgdlg.h"
1be7a35c 331#elif defined(__WXGTK20__)
2afb9e16 332 #include "wx/gtk/msgdlg.h"
34138703 333#elif defined(__WXMAC__)
ef0e9220 334 #include "wx/osx/msgdlg.h"
1777b9bb 335#elif defined(__WXPM__)
2afb9e16 336 #include "wx/os2/msgdlg.h"
c801d85f
KB
337#endif
338
e421922f
VZ
339// ----------------------------------------------------------------------------
340// wxMessageBox: the simplest way to use wxMessageDialog
341// ----------------------------------------------------------------------------
342
53a2db12 343int WXDLLIMPEXP_CORE wxMessageBox(const wxString& message,
e5b50758
WS
344 const wxString& caption = wxMessageBoxCaptionStr,
345 long style = wxOK | wxCENTRE,
346 wxWindow *parent = NULL,
347 int x = wxDefaultCoord, int y = wxDefaultCoord);
e421922f
VZ
348
349#endif // wxUSE_MSGDLG
350
2afb9e16 351#endif // _WX_MSGDLG_H_BASE_