]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/msgdlg.h
update for bakefile 0.2.6
[wxWidgets.git] / interface / wx / msgdlg.h
index a8687771340f81944d31cdfe478a8c016283e2c3..4477d22675551a434c6c5fff97398c37ce6a931c 100644 (file)
     This class represents a dialog that shows a single or multi-line message,
     with a choice of OK, Yes, No and Cancel buttons.
 
     This class represents a dialog that shows a single or multi-line message,
     with a choice of OK, Yes, No and Cancel buttons.
 
+    @beginStyleTable
+    @style{wxOK}
+        Puts an Ok button in the message box. May be combined with @c wxCANCEL.
+    @style{wxCANCEL}
+        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.
+    @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}
+        Displays an error symbol.
+    @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.
+    @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).
+    @endStyleTable
+
     @library{wxcore}
     @category{cmndlg}
 
     @library{wxcore}
     @category{cmndlg}
 
@@ -24,46 +61,7 @@ public:
         Constructor specifying the message box properties.
         Use ShowModal() to show the dialog.
 
         Constructor specifying the message box properties.
         Use ShowModal() to show the dialog.
 
-        @a style may be a bit list of the following identifiers:
-
-        @beginStyleTable
-        @style{wxOK}
-            Puts an Ok button in the message box. May be combined with @c
-            wxCANCEL.
-        @style{wxCANCEL}
-            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.
-        @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}
-            Displays an error symbol.
-        @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.
-        @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).
-        @endStyleTable
+        @a style may be a bit list of the identifiers described above.
 
         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
 
         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
@@ -82,7 +80,7 @@ public:
             Dialog position (ignored under MSW).
     */
     wxMessageDialog(wxWindow* parent, const wxString& message,
             Dialog position (ignored under MSW).
     */
     wxMessageDialog(wxWindow* parent, const wxString& message,
-                    const wxString& caption = "Message box",
+                    const wxString& caption = wxMessageBoxCaptionStr,
                     long style = wxOK | wxCENTRE,
                     const wxPoint& pos = wxDefaultPosition);
 
                     long style = wxOK | wxCENTRE,
                     const wxPoint& pos = wxDefaultPosition);
 
@@ -96,12 +94,12 @@ public:
         which don't support extended messages, it is simply appended to the
         normal message with a new line separating them.
     */
         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.
     */
 
     /**
         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.
 
     /**
         Overrides the default labels of the OK and Cancel buttons.
@@ -123,8 +121,9 @@ public:
 
         Please see the remarks in SetYesNoLabels() documentation.
     */
 
         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.
 
     /**
         Overrides the default labels of the Yes and No buttons.
@@ -173,7 +172,7 @@ public:
 // Global functions/macros
 // ============================================================================
 
 // Global functions/macros
 // ============================================================================
 
-/** @ingroup group_funcmacro_dialog */
+/** @addtogroup group_funcmacro_dialog */
 //@{
 
 /**
 //@{
 
 /**
@@ -208,7 +207,7 @@ public:
     @param style
         Combination of style flags described in wxMessageDialog documentation.
     @param x
     @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).
         for @a x and @a y to let the system position the window.
     @param y
         Vertical dialog position (ignored under MSW).