@style{wxOK_DEFAULT}
Makes the "OK" button default, this is the default behaviour and
this flag exists solely for symmetry with @c wxCANCEL_DEFAULT.
+ @style{wxICON_NONE}
+ Displays no icon in the dialog if possible (an icon might still be
+ displayed if the current platform mandates its use). This style may be
+ used to prevent the dialog from using the default icon based on @c
+ wxYES_NO presence as explained in @c wxICON_QUESTION and @c
+ wxICON_INFORMATION documentation below.
@style{wxICON_EXCLAMATION}
- Displays an exclamation mark symbol.
+ Displays an exclamation, or warning, icon in the dialog.
@style{wxICON_ERROR}
- Displays an error symbol.
+ Displays an error icon in the dialog.
@style{wxICON_HAND}
Displays an error symbol, this is a MSW-inspired synonym for @c wxICON_ERROR.
@style{wxICON_QUESTION}
@c wxYES_NO is not given so it is usually unnecessary to specify it
explicitly.
@style{wxSTAY_ON_TOP}
- Makes the message box stay on top of all other windows (currently
- implemented only under MSW).
+ Makes the message box stay on top of all other windows and not only
+ just its parent (currently implemented only under MSW and GTK).
@endStyleTable
@library{wxcore}
If it is set, the main message appears highlighted -- if supported --
and this message appears beneath it in normal font. On the platforms
which don't support extended messages, it is simply appended to the
- normal message with a new line separating them.
+ normal message with an empty line separating them.
+
+ @since 2.9.0
*/
virtual void SetExtendedMessage(const wxString& extendedMessage);
/**
Sets the message shown by the dialog.
+
+ @since 2.9.0
*/
virtual void SetMessage(const wxString& message);
Overrides the default labels of the OK and Cancel buttons.
Please see the remarks in SetYesNoLabels() documentation.
+
+ @since 2.9.0
*/
virtual bool SetOKCancelLabels(const ButtonLabel& ok,
const ButtonLabel& cancel);
Overrides the default label of the OK button.
Please see the remarks in SetYesNoLabels() documentation.
+
+ @since 2.9.0
*/
virtual bool SetOKLabel(const ButtonLabel& ok);
Overrides the default labels of the Yes, No and Cancel buttons.
Please see the remarks in SetYesNoLabels() documentation.
+
+ @since 2.9.0
*/
virtual bool SetYesNoCancelLabels(const ButtonLabel& yes,
const ButtonLabel& no,
Also notice that this function is not currently available on all
platforms (although as of wxWidgets 2.9.0 it is implemented in all
major ports), so it may return @false to indicate that the labels
- couldn't be changed. If it returns @true (currently only under wxMac),
- the labels were set successfully. Typically, if the function was used
- successfully, the main dialog message may need to be changed, e.g.:
+ couldn't be changed. If it returns @true, the labels were set
+ successfully.
+
+ Typically, if the function was used successfully, the main dialog
+ message may need to be changed, e.g.:
@code
wxMessageDialog dlg(...);
if ( dlg.SetYesNoLabels(_("&Quit"), _("&Don't quit")) )
else // buttons have standard "Yes"/"No" values, so rephrase the question
dlg.SetMessage(_("Do you really want to quit?"));
@endcode
+
+ @since 2.9.0
*/
virtual bool SetYesNoLabels(const ButtonLabel& yes, const ButtonLabel& no);
// Global functions/macros
// ============================================================================
-/** @ingroup group_funcmacro_dialog */
+/** @addtogroup group_funcmacro_dialog */
//@{
/**
@param style
Combination of style flags described in wxMessageDialog documentation.
@param x
- Horizontal dialog position (ignored under MSW). Use @c wxDefaultCoord
+ Horizontal dialog position (ignored under MSW). Use ::wxDefaultCoord
for @a x and @a y to let the system position the window.
@param y
Vertical dialog position (ignored under MSW).