X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/11dd61cb3d1641b347a89e30f76480e159ab1b9e..b72ed64277a2b16c6c8681995e5f3f304a8fe38d:/interface/wx/msgdlg.h?ds=sidebyside diff --git a/interface/wx/msgdlg.h b/interface/wx/msgdlg.h index 6541cbce30..0448b04366 100644 --- a/interface/wx/msgdlg.h +++ b/interface/wx/msgdlg.h @@ -3,7 +3,7 @@ // Purpose: interface of wxMessageDialog // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -19,8 +19,9 @@ Puts a Cancel button in the message box. Must be combined with either @c wxOK or @c wxYES_NO. @style{wxYES_NO} - Puts Yes and No buttons in the message box. May be combined with - @c wxCANCEL. + Puts Yes and No buttons in the message box. It is recommended to always + use @c wxCANCEL with this style as otherwise the message box won't have + a close button under wxMSW and the user will be forced to answer it. @style{wxNO_DEFAULT} Makes the "No" button default, can only be used with @c wxYES_NO. @style{wxCANCEL_DEFAULT} @@ -31,28 +32,45 @@ @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} Displays a question mark symbol. This icon is automatically used with @c wxYES_NO so it's usually unnecessary to specify it explicitly. + This style is not supported for message dialogs under wxMSW when a task + dialog is used to implement them (i.e. when running under Windows Vista + or later) because Microsoft + guidelines indicate that no icon should be used for routine + confirmations. If it is specified, no icon will be displayed. @style{wxICON_INFORMATION} Displays an information symbol. This icon is used by default if @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). + @style{wxCENTRE} + Centre the message box on its parent or on the screen if parent is not + specified. + Setting this style under MSW makes no differences as the dialog is + always centered on the parent. @endStyleTable @library{wxcore} @category{cmndlg} @see @ref overview_cmndlg_msg + @see wxRichMessageDialog */ class wxMessageDialog : public wxDialog { @@ -92,12 +110,16 @@ public: 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); @@ -105,6 +127,8 @@ public: 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); @@ -113,6 +137,8 @@ public: 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); @@ -120,6 +146,8 @@ public: 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, @@ -144,9 +172,11 @@ public: 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")) ) @@ -154,6 +184,8 @@ public: 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); @@ -172,7 +204,7 @@ public: // Global functions/macros // ============================================================================ -/** @ingroup group_funcmacro_dialog */ +/** @addtogroup group_funcmacro_dialog */ //@{ /** @@ -207,7 +239,7 @@ public: @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).