]>
git.saurik.com Git - wxWidgets.git/blob - interface/wx/msgdlg.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxMessageDialog
4 // Author: wxWidgets team
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
10 @class wxMessageDialog
12 This class represents a dialog that shows a single or multi-line message,
13 with a choice of OK, Yes, No and Cancel buttons.
17 Puts an Ok button in the message box. May be combined with @c wxCANCEL.
19 Puts a Cancel button in the message box. Must be combined with
20 either @c wxOK or @c wxYES_NO.
22 Puts Yes and No buttons in the message box. It is recommended to always
23 use @c wxCANCEL with this style as otherwise the message box won't have
24 a close button under wxMSW and the user will be forced to answer it.
26 Puts a Help button to the message box. This button can have special
27 appearance or be specially positioned if its label is not changed from
28 the default one. Notice that using this button is not supported when
29 showing a message box from non-main thread in wxOSX/Cocoa and it is not
30 supported in wxOSX/Carbon at all. @since 2.9.3.
32 Makes the "No" button default, can only be used with @c wxYES_NO.
33 @style{wxCANCEL_DEFAULT}
34 Makes the "Cancel" button default, can only be used with @c wxCANCEL
36 Makes the "Yes" button default, this is the default behaviour and
37 this flag exists solely for symmetry with @c wxNO_DEFAULT.
39 Makes the "OK" button default, this is the default behaviour and
40 this flag exists solely for symmetry with @c wxCANCEL_DEFAULT.
42 Displays no icon in the dialog if possible (an icon might still be
43 displayed if the current platform mandates its use). This style may be
44 used to prevent the dialog from using the default icon based on @c
45 wxYES_NO presence as explained in @c wxICON_QUESTION and @c
46 wxICON_INFORMATION documentation below.
47 @style{wxICON_EXCLAMATION}
48 Displays an exclamation, or warning, icon in the dialog.
50 Displays an error icon in the dialog.
52 Displays an error symbol, this is a MSW-inspired synonym for @c wxICON_ERROR.
53 @style{wxICON_QUESTION}
54 Displays a question mark symbol. This icon is automatically used
55 with @c wxYES_NO so it's usually unnecessary to specify it explicitly.
56 This style is not supported for message dialogs under wxMSW when a task
57 dialog is used to implement them (i.e. when running under Windows Vista
58 or later) because <a href="http://msdn.microsoft.com/en-us/library/aa511273.aspx">Microsoft
59 guidelines</a> indicate that no icon should be used for routine
60 confirmations. If it is specified, no icon will be displayed.
61 @style{wxICON_INFORMATION}
62 Displays an information symbol. This icon is used by default if
63 @c wxYES_NO is not given so it is usually unnecessary to specify it
66 Makes the message box stay on top of all other windows and not only
67 just its parent (currently implemented only under MSW and GTK).
69 Centre the message box on its parent or on the screen if parent is not
71 Setting this style under MSW makes no differences as the dialog is
72 always centered on the parent.
78 @see @ref overview_cmndlg_msg
79 @see wxRichMessageDialog
81 class wxMessageDialog
: public wxDialog
85 Constructor specifying the message box properties.
86 Use ShowModal() to show the dialog.
88 @a style may be a bit list of the identifiers described above.
90 Notice that not all styles are compatible: only one of @c wxOK and
91 @c wxYES_NO may be specified (and one of them must be specified) and at
92 most one default button style can be used and it is only valid if the
93 corresponding button is shown in the message box.
98 Message to show in the dialog.
102 Combination of style flags described above.
104 Dialog position (ignored under MSW).
106 wxMessageDialog(wxWindow
* parent
, const wxString
& message
,
107 const wxString
& caption
= wxMessageBoxCaptionStr
,
108 long style
= wxOK
| wxCENTRE
,
109 const wxPoint
& pos
= wxDefaultPosition
);
112 Sets the extended message for the dialog: this message is usually an
113 extension of the short message specified in the constructor or set with
116 If it is set, the main message appears highlighted -- if supported --
117 and this message appears beneath it in normal font. On the platforms
118 which don't support extended messages, it is simply appended to the
119 normal message with an empty line separating them.
123 virtual void SetExtendedMessage(const wxString
& extendedMessage
);
126 Sets the label for the Help button.
128 Please see the remarks in SetYesNoLabels() documentation.
130 Notice that changing the label of the help button resets its special
131 status (if any, this depends on the platform) and it will be treated
132 just like another button in this case.
136 virtual bool SetHelpLabel(const ButtonLabel
& help
);
139 Sets the message shown by the dialog.
143 virtual void SetMessage(const wxString
& message
);
146 Overrides the default labels of the OK and Cancel buttons.
148 Please see the remarks in SetYesNoLabels() documentation.
152 virtual bool SetOKCancelLabels(const ButtonLabel
& ok
,
153 const ButtonLabel
& cancel
);
156 Overrides the default label of the OK button.
158 Please see the remarks in SetYesNoLabels() documentation.
162 virtual bool SetOKLabel(const ButtonLabel
& ok
);
165 Overrides the default labels of the Yes, No and Cancel buttons.
167 Please see the remarks in SetYesNoLabels() documentation.
171 virtual bool SetYesNoCancelLabels(const ButtonLabel
& yes
,
172 const ButtonLabel
& no
,
173 const ButtonLabel
& cancel
);
176 Overrides the default labels of the Yes and No buttons.
178 The arguments of this function can be either strings or one of the
179 standard identifiers, such as @c wxID_APPLY or @c wxID_OPEN. Notice
180 that even if the label is specified as an identifier, the return value
181 of the dialog ShowModal() method still remains one of @c wxID_OK, @c
182 wxID_CANCEL, @c wxID_YES or @c wxID_NO values, i.e. this identifier
183 changes only the label appearance but not the return code generated by
184 the button. It is possible to mix stock identifiers and string labels
185 in the same function call, for example:
187 wxMessageDialog dlg(...);
188 dlg.SetYesNoLabels(wxID_SAVE, _("&Don't save"));
191 Also notice that this function is not currently available on all
192 platforms (although as of wxWidgets 2.9.0 it is implemented in all
193 major ports), so it may return @false to indicate that the labels
194 couldn't be changed. If it returns @true, the labels were set
197 Typically, if the function was used successfully, the main dialog
198 message may need to be changed, e.g.:
200 wxMessageDialog dlg(...);
201 if ( dlg.SetYesNoLabels(_("&Quit"), _("&Don't quit")) )
202 dlg.SetMessage(_("What do you want to do?"));
203 else // buttons have standard "Yes"/"No" values, so rephrase the question
204 dlg.SetMessage(_("Do you really want to quit?"));
209 virtual bool SetYesNoLabels(const ButtonLabel
& yes
, const ButtonLabel
& no
);
212 Shows the dialog, returning one of wxID_OK, wxID_CANCEL, wxID_YES,
213 wxID_NO or wxID_HELP.
215 Notice that this method returns the identifier of the button which was
216 clicked unlike wxMessageBox() function.
218 virtual int ShowModal();
223 // ============================================================================
224 // Global functions/macros
225 // ============================================================================
227 /** @addtogroup group_funcmacro_dialog */
231 Show a general purpose message dialog.
233 This is a convenient function which is usually used instead of using
234 wxMessageDialog directly. Notice however that some of the features, such as
235 extended text and custom labels for the message box buttons, are not
236 provided by this function but only by wxMessageDialog.
238 The return value is one of: @c wxYES, @c wxNO, @c wxCANCEL, @c wxOK or @c
239 wxHELP (notice that this return value is @b different from the return value
240 of wxMessageDialog::ShowModal()).
244 int answer = wxMessageBox("Quit program?", "Confirm",
245 wxYES_NO | wxCANCEL, main_frame);
250 @a message may contain newline characters, in which case the message will
251 be split into separate lines, to cater for large messages.
254 Message to show in the dialog.
260 Combination of style flags described in wxMessageDialog documentation.
262 Horizontal dialog position (ignored under MSW). Use ::wxDefaultCoord
263 for @a x and @a y to let the system position the window.
265 Vertical dialog position (ignored under MSW).
268 int wxMessageBox(const wxString
& message
,
269 const wxString
& caption
= "Message",
271 wxWindow
* parent
= NULL
,
272 int x
= wxDefaultCoord
,
273 int y
= wxDefaultCoord
);