Doc and comment cleanup, fixes, tweaks

[wxWidgets.git] / interface / wx / msgdlg.h

diff --git a/interface/wx/msgdlg.h b/interface/wx/msgdlg.h
index 87f91584518ee008baab4a6071e4b8bd81d0e7f1..e2693fe9112be56112133549b45d4a5fce714ab2 100644 (file)
--- a/interface/wx/msgdlg.h
+++ b/interface/wx/msgdlg.h
@@ -39,9 +39,14 @@ public:
             @c wxCANCEL.
         @style{wxNO_DEFAULT}
             Makes the "No" button default, can only be used with @c wxYES_NO.
             @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{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}
         @style{wxICON_EXCLAMATION}
             Displays an exclamation mark symbol.
         @style{wxICON_ERROR}


@@ -62,6 +67,11 @@ public:
             implemented only under MSW).
         @endStyleTable
 
             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
         @param parent
             Parent window.
         @param message


@@ -75,7 +85,7 @@ public:
     */
     wxMessageDialog(wxWindow* parent, const wxString& message,
                     const wxString& caption = "Message box",
     */
     wxMessageDialog(wxWindow* parent, const wxString& message,
                     const wxString& caption = "Message box",

-                    long style = wxOK | wxCANCEL,
+                    long style = wxOK | wxCENTRE,

                     const wxPoint& pos = wxDefaultPosition);
 
     /**
                     const wxPoint& pos = wxDefaultPosition);
 
     /**


@@ -100,14 +110,15 @@ public:
 
         Please see the remarks in SetYesNoLabels() documentation.
     */
 
         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.
     */
 
     /**
         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.
 
     /**
         Overrides the default labels of the Yes, No and Cancel buttons.


@@ -147,7 +158,7 @@ public:
             dlg.SetMessage(_("Do you really want to quit?"));
         @endcode
     */
             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,
 
     /**
         Shows the dialog, returning one of wxID_OK, wxID_CANCEL, wxID_YES,


@@ -156,7 +167,7 @@ public:
         Notice that this method returns the identifier of the button which was
         clicked unlike wxMessageBox() function.
     */
         Notice that this method returns the identifier of the button which was
         clicked unlike wxMessageBox() function.
     */

-    int ShowModal();
+    virtual int ShowModal();

 };
 
 
 };