1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: common header and base class for wxMessageDialog
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_MSGDLG_H_BASE_
13 #define _WX_MSGDLG_H_BASE_
19 #include "wx/dialog.h"
20 #include "wx/stockitem.h"
22 WXDLLIMPEXP_DATA_CORE(extern const char) wxMessageBoxCaptionStr
[];
24 // ----------------------------------------------------------------------------
25 // wxMessageDialogBase: base class defining wxMessageDialog interface
26 // ----------------------------------------------------------------------------
28 class WXDLLIMPEXP_CORE wxMessageDialogBase
: public wxDialog
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
36 // ctors are not explicit, objects of this class can be implicitly
37 // constructed from either stock ids or strings
38 ButtonLabel(int stockId
)
41 wxASSERT_MSG( wxIsStockID(stockId
), "invalid stock id" );
44 ButtonLabel(const wxString
& label
)
45 : m_label(label
), m_stockId(wxID_NONE
)
49 ButtonLabel(const char *label
)
50 : m_label(label
), m_stockId(wxID_NONE
)
54 ButtonLabel(const wchar_t *label
)
55 : m_label(label
), m_stockId(wxID_NONE
)
59 ButtonLabel(const wxCStrData
& label
)
60 : m_label(label
), m_stockId(wxID_NONE
)
64 // default copy ctor and dtor are ok
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
71 return m_stockId
== wxID_NONE
73 : wxGetStockLabel(m_stockId
, wxSTOCK_FOR_BUTTON
);
76 // return the stock id or wxID_NONE if this is not a stock label
77 int GetStockId() const { return m_stockId
; }
80 // the label if explicitly given or empty if this is a stock item
81 const wxString m_label
;
83 // the stock item id or wxID_NONE if m_label should be used
88 wxMessageDialogBase() { m_dialogStyle
= 0; }
89 wxMessageDialogBase(wxWindow
*parent
,
90 const wxString
& message
,
91 const wxString
& caption
,
97 SetMessageDialogStyle(style
);
100 // virtual dtor for the base class
101 virtual ~wxMessageDialogBase() { }
103 wxString
GetCaption() const { return m_caption
; }
105 virtual void SetMessage(const wxString
& message
)
110 wxString
GetMessage() const { return m_message
; }
112 void SetExtendedMessage(const wxString
& extendedMessage
)
114 m_extendedMessage
= extendedMessage
;
117 wxString
GetExtendedMessage() const { return m_extendedMessage
; }
119 // change the dialog style flag
120 void SetMessageDialogStyle(long style
)
122 wxASSERT_MSG( ((style
& wxYES_NO
) == wxYES_NO
) || !(style
& wxYES_NO
),
123 "wxYES and wxNO may only be used together" );
125 wxASSERT_MSG( !(style
& wxYES
) || !(style
& wxOK
),
126 "wxOK and wxYES/wxNO can't be used together" );
128 wxASSERT_MSG( (style
& wxYES
) || (style
& wxOK
),
129 "one of wxOK and wxYES/wxNO must be used" );
131 wxASSERT_MSG( (style
& wxID_OK
) != wxID_OK
,
132 "wxMessageBox: Did you mean wxOK (and not wxID_OK)?" );
134 wxASSERT_MSG( !(style
& wxNO_DEFAULT
) || (style
& wxNO
),
135 "wxNO_DEFAULT is invalid without wxNO" );
137 wxASSERT_MSG( !(style
& wxCANCEL_DEFAULT
) || (style
& wxCANCEL
),
138 "wxCANCEL_DEFAULT is invalid without wxCANCEL" );
140 wxASSERT_MSG( !(style
& wxCANCEL_DEFAULT
) || !(style
& wxNO_DEFAULT
),
141 "only one default button can be specified" );
143 m_dialogStyle
= style
;
146 long GetMessageDialogStyle() const { return m_dialogStyle
; }
148 // customization of the message box buttons
149 virtual bool SetYesNoLabels(const ButtonLabel
& yes
,const ButtonLabel
& no
)
151 DoSetCustomLabel(m_yes
, yes
);
152 DoSetCustomLabel(m_no
, no
);
156 virtual bool SetYesNoCancelLabels(const ButtonLabel
& yes
,
157 const ButtonLabel
& no
,
158 const ButtonLabel
& cancel
)
160 DoSetCustomLabel(m_yes
, yes
);
161 DoSetCustomLabel(m_no
, no
);
162 DoSetCustomLabel(m_cancel
, cancel
);
166 virtual bool SetOKLabel(const ButtonLabel
& ok
)
168 DoSetCustomLabel(m_ok
, ok
);
172 virtual bool SetOKCancelLabels(const ButtonLabel
& ok
,
173 const ButtonLabel
& cancel
)
175 DoSetCustomLabel(m_ok
, ok
);
176 DoSetCustomLabel(m_cancel
, cancel
);
180 // test if any custom labels were set
181 bool HasCustomLabels() const
183 return !(m_ok
.empty() && m_cancel
.empty() &&
184 m_yes
.empty() && m_no
.empty());
187 // these functions return the label to be used for the button which is
188 // either a custom label explicitly set by the user or the default label,
189 // i.e. they always return a valid string
190 wxString
GetYesLabel() const
191 { return m_yes
.empty() ? GetDefaultYesLabel() : m_yes
; }
192 wxString
GetNoLabel() const
193 { return m_no
.empty() ? GetDefaultNoLabel() : m_no
; }
194 wxString
GetOKLabel() const
195 { return m_ok
.empty() ? GetDefaultOKLabel() : m_ok
; }
196 wxString
GetCancelLabel() const
197 { return m_cancel
.empty() ? GetDefaultCancelLabel() : m_cancel
; }
199 // based on message dialog style, returns exactly one of: wxICON_NONE,
200 // wxICON_ERROR, wxICON_WARNING, wxICON_QUESTION, wxICON_INFORMATION
201 long GetEffectiveIcon() const
203 if ( m_dialogStyle
& wxICON_NONE
)
205 else if ( m_dialogStyle
& wxICON_ERROR
)
207 else if ( m_dialogStyle
& wxICON_WARNING
)
208 return wxICON_WARNING
;
209 else if ( m_dialogStyle
& wxICON_QUESTION
)
210 return wxICON_QUESTION
;
211 else if ( m_dialogStyle
& wxICON_INFORMATION
)
212 return wxICON_INFORMATION
;
213 else if ( m_dialogStyle
& wxYES
)
214 return wxICON_QUESTION
;
216 return wxICON_INFORMATION
;
220 // for the platforms not supporting separate main and extended messages
221 // this function should be used to combine both of them in a single string
222 wxString
GetFullMessage() const
224 wxString msg
= m_message
;
225 if ( !m_extendedMessage
.empty() )
226 msg
<< "\n\n" << m_extendedMessage
;
236 // this function is called by our public SetXXXLabels() and should assign
237 // the value to var with possibly some transformation (e.g. Cocoa version
238 // currently uses this to remove any accelerators from the button strings
239 // while GTK+ one handles stock items specifically here)
240 virtual void DoSetCustomLabel(wxString
& var
, const ButtonLabel
& label
)
242 var
= label
.GetAsString();
246 // these functions may be overridden to provide different defaults for the
247 // default button labels (this is used by wxGTK)
248 virtual wxString
GetDefaultYesLabel() const { return wxGetTranslation("Yes"); }
249 virtual wxString
GetDefaultNoLabel() const { return wxGetTranslation("No"); }
250 virtual wxString
GetDefaultOKLabel() const { return wxGetTranslation("OK"); }
251 virtual wxString
GetDefaultCancelLabel() const { return wxGetTranslation("Cancel"); }
253 // labels for the buttons, initially empty meaning that the defaults should
254 // be used, use GetYes/No/OK/CancelLabel() to access them
260 wxDECLARE_NO_COPY_CLASS(wxMessageDialogBase
);
263 #include "wx/generic/msgdlgg.h"
265 #if defined(__WX_COMPILING_MSGDLGG_CPP__) || \
266 defined(__WXUNIVERSAL__) || defined(__WXGPE__) || \
267 (defined(__WXGTK__) && !defined(__WXGTK20__))
269 #define wxMessageDialog wxGenericMessageDialog
270 #elif defined(__WXCOCOA__)
271 #include "wx/cocoa/msgdlg.h"
272 #elif defined(__WXPALMOS__)
273 #include "wx/palmos/msgdlg.h"
274 #elif defined(__WXMSW__)
275 #include "wx/msw/msgdlg.h"
276 #elif defined(__WXMOTIF__)
277 #include "wx/motif/msgdlg.h"
278 #elif defined(__WXGTK20__)
279 #include "wx/gtk/msgdlg.h"
280 #elif defined(__WXMAC__)
281 #include "wx/osx/msgdlg.h"
282 #elif defined(__WXPM__)
283 #include "wx/os2/msgdlg.h"
286 // ----------------------------------------------------------------------------
287 // wxMessageBox: the simplest way to use wxMessageDialog
288 // ----------------------------------------------------------------------------
290 int WXDLLIMPEXP_CORE
wxMessageBox(const wxString
& message
,
291 const wxString
& caption
= wxMessageBoxCaptionStr
,
292 long style
= wxOK
| wxCENTRE
,
293 wxWindow
*parent
= NULL
,
294 int x
= wxDefaultCoord
, int y
= wxDefaultCoord
);
296 #endif // wxUSE_MSGDLG
298 #endif // _WX_MSGDLG_H_BASE_