]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/msgdlg.h
few other fixes for wxChar => wxString
[wxWidgets.git] / interface / wx / msgdlg.h
index 87f91584518ee008baab4a6071e4b8bd81d0e7f1..781ec79cf9ef3ede8a33dde296139f64b58b3566 100644 (file)
     @library{wxcore}
     @category{cmndlg}
 
-    @see @ref overview_wxmessagedialogoverview "wxMessageDialog overview"
+    @see @ref overview_cmndlg_msg
 */
 class wxMessageDialog : public wxDialog
 {
 public:
     /**
         Constructor specifying the message box properties.
-
         Use ShowModal() to show the dialog.
 
         @a style may be a bit list of the following identifiers:
@@ -39,9 +38,14 @@ public:
             @c wxCANCEL.
         @style{wxNO_DEFAULT}
             Makes the "No" button default, can only be used with @c wxYES_NO.
+        @style{wxCANCEL_DEFAULT}
+            Makes the "Cancel" button default, can only be used with @c wxCANCEL
         @style{wxYES_DEFAULT}
             Makes the "Yes" button default, this is the default behaviour and
             this flag exists solely for symmetry with @c wxNO_DEFAULT.
+        @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_EXCLAMATION}
             Displays an exclamation mark symbol.
         @style{wxICON_ERROR}
@@ -51,8 +55,7 @@ public:
             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.
+            with @c wxYES_NO so it's usually unnecessary to specify it explicitly.
         @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
@@ -62,6 +65,11 @@ public:
             implemented only under MSW).
         @endStyleTable
 
+        Notice that not all styles are compatible: only one of @c wxOK and
+        @c wxYES_NO may be specified (and one of them must be specified) and at
+        most one default button style can be used and it is only valid if the
+        corresponding button is shown in the message box.
+
         @param parent
             Parent window.
         @param message
@@ -74,8 +82,8 @@ public:
             Dialog position (ignored under MSW).
     */
     wxMessageDialog(wxWindow* parent, const wxString& message,
-                    const wxString& caption = "Message box",
-                    long style = wxOK | wxCANCEL,
+                    const wxString& caption = wxMessageBoxCaptionStr,
+                    long style = wxOK | wxCENTRE,
                     const wxPoint& pos = wxDefaultPosition);
 
     /**
@@ -88,34 +96,36 @@ public:
         which don't support extended messages, it is simply appended to the
         normal message with a new line separating them.
     */
-    void SetExtendedMessage(const wxString extendedMessage);
+    virtual void SetExtendedMessage(const wxString& extendedMessage);
 
     /**
         Sets the message shown by the dialog.
     */
-    void SetMessage(const wxString msg);
+    virtual void SetMessage(const wxString& message);
 
     /**
         Overrides the default labels of the OK and Cancel buttons.
 
         Please see the remarks in SetYesNoLabels() documentation.
     */
-    bool SetOKCancelLabels(const ButtonLabel& ok, const ButtonLabel& cancel);
+    virtual bool SetOKCancelLabels(const ButtonLabel& ok,
+                                   const ButtonLabel& cancel);
 
     /**
         Overrides the default label of the OK button.
 
         Please see the remarks in SetYesNoLabels() documentation.
     */
-    bool SetOKLabel(const ButtonLabel& ok);
+    virtual bool SetOKLabel(const ButtonLabel& ok);
 
     /**
         Overrides the default labels of the Yes, No and Cancel buttons.
 
         Please see the remarks in SetYesNoLabels() documentation.
     */
-    bool SetYesNoCancelLabels(const ButtonLabel& yes, const ButtonLabel& no,
-                              const ButtonLabel& cancel);
+    virtual bool SetYesNoCancelLabels(const ButtonLabel& yes,
+                                      const ButtonLabel& no,
+                                      const ButtonLabel& cancel);
 
     /**
         Overrides the default labels of the Yes and No buttons.
@@ -147,16 +157,15 @@ public:
             dlg.SetMessage(_("Do you really want to quit?"));
         @endcode
     */
-    bool SetYesNoLabels(const ButtonLabel& yes, const ButtonLabel& no);
+    virtual bool SetYesNoLabels(const ButtonLabel& yes, const ButtonLabel& no);
 
     /**
-        Shows the dialog, returning one of wxID_OK, wxID_CANCEL, wxID_YES,
-        wxID_NO.
+        Shows the dialog, returning one of wxID_OK, wxID_CANCEL, wxID_YES, wxID_NO.
 
         Notice that this method returns the identifier of the button which was
         clicked unlike wxMessageBox() function.
     */
-    int ShowModal();
+    virtual int ShowModal();
 };