non-pch build fix

[wxWidgets.git] / interface / msgdlg.h

diff --git a/interface/msgdlg.h b/interface/msgdlg.h
index 1c063cd142d56d2dc4db2b82e48597074c2a3183..2ce39cc91bd5a384d9c21b7e21730858c35a1743 100644 (file)
--- a/interface/msgdlg.h
+++ b/interface/msgdlg.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        msgdlg.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        msgdlg.h

-// Purpose:     documentation for wxMessageDialog class
+// Purpose:     interface of wxMessageDialog

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -16,91 +16,74 @@
     @library{wxcore}
     @category{cmndlg}
 
     @library{wxcore}
     @category{cmndlg}
 

-    @seealso
-    @ref overview_wxmessagedialogoverview "wxMessageDialog overview"
+    @see @ref overview_wxmessagedialogoverview "wxMessageDialog overview"

 */
 class wxMessageDialog : public wxDialog
 {
 public:
     /**
         Constructor. Use ShowModal() to show the dialog.
 */
 class wxMessageDialog : public wxDialog
 {
 public:
     /**
         Constructor. Use ShowModal() to show the dialog.

-        
+

         @param parent
         @param parent

-        Parent window.
-        
+            Parent window.

         @param message
         @param message

-        Message to show on the dialog.
-        
+            Message to show on the dialog.

         @param caption
         @param caption

-        The dialog caption.
-        
+            The dialog caption.

         @param style
         @param style

-        A dialog style (bitlist) containing flags chosen from the following:
-        
-        
-        wxOK
-        
-        
-        Show an OK button.
-        
-        wxCANCEL
-        
-        
-        Show a Cancel button.
-        
-        wxYES_NO
-        
-        
-        Show Yes and No buttons.
-        
-        wxYES_DEFAULT
-        
-        
-        Used with wxYES_NO, makes Yes button the default - which is the default
+            A dialog style (bitlist) containing flags chosen from the following:
+
+            wxOK
+
+            Show an OK button.
+
+            wxCANCEL
+
+            Show a Cancel button.
+
+            wxYES_NO
+
+            Show Yes and No buttons.
+
+            wxYES_DEFAULT
+
+            Used with wxYES_NO, makes Yes button the default - which is the default

         behaviour.
         behaviour.

-        
-        wxNO_DEFAULT
-        
-        
-        Used with wxYES_NO, makes No button the default.
-        
-        wxICON_EXCLAMATION
-        
-        
-        Shows an exclamation mark icon.
-        
-        wxICON_HAND
-        
-        
-        Shows an error icon.
-        
-        wxICON_ERROR
-        
-        
-        Shows an error icon - the same as wxICON_HAND.
-        
-        wxICON_QUESTION
-        
-        
-        Shows a question mark icon.
-        
-        wxICON_INFORMATION
-        
-        
-        Shows an information (i) icon.
-        
-        wxSTAY_ON_TOP
-        
-        
-        The message box stays on top of all other window, even those of the other
+
+            wxNO_DEFAULT
+
+            Used with wxYES_NO, makes No button the default.
+
+            wxICON_EXCLAMATION
+
+            Shows an exclamation mark icon.
+
+            wxICON_HAND
+
+            Shows an error icon.
+
+            wxICON_ERROR
+
+            Shows an error icon - the same as wxICON_HAND.
+
+            wxICON_QUESTION
+
+            Shows a question mark icon.
+
+            wxICON_INFORMATION
+
+            Shows an information (i) icon.
+
+            wxSTAY_ON_TOP
+
+            The message box stays on top of all other window, even those of the other

         applications (Windows only).
         applications (Windows only).

-        

         @param pos
         @param pos

-        Dialog position. Not Windows.
+            Dialog position. Not Windows.

     */
     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 | wxCANCEL,

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


@@ -125,7 +108,6 @@ public:
 
     /**
         Overrides the default labels of the OK and Cancel buttons.
 
     /**
         Overrides the default labels of the OK and Cancel buttons.

-        

         Please see the remarks in
         SetYesNoLabels() documentation.
     */
         Please see the remarks in
         SetYesNoLabels() documentation.
     */


@@ -133,7 +115,6 @@ public:
 
     /**
         Overrides the default label of the OK button.
 
     /**
         Overrides the default label of the OK button.

-        

         Please see the remarks in
         SetYesNoLabels() documentation.
     */
         Please see the remarks in
         SetYesNoLabels() documentation.
     */


@@ -141,7 +122,6 @@ public:
 
     /**
         Overrides the default labels of the Yes, No and Cancel buttons.
 
     /**
         Overrides the default labels of the Yes, No and Cancel buttons.

-        

         Please see the remarks in
         SetYesNoLabels() documentation.
     */
         Please see the remarks in
         SetYesNoLabels() documentation.
     */


@@ -150,7 +130,6 @@ public:
 
     /**
         Overrides the default labels of the Yes and No buttons.
 
     /**
         Overrides the default labels of the Yes and No buttons.

-        

         Notice that this function is not currently available on all platforms, 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.
         Notice that this function is not currently available on all platforms, 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.


@@ -166,74 +145,57 @@ public:
 };
 
 
 };
 
 

+

 // ============================================================================
 // Global functions/macros
 // ============================================================================
 
 // ============================================================================
 // Global functions/macros
 // ============================================================================
 

+/** @ingroup group_funcmacro_dialog */
+//@{
+

 /**
 /**

-    General purpose message dialog.  @e style may be a bit list of the
+    General purpose message dialog. @c style may be a bit list of the

     following identifiers:
 
     following identifiers:
 

-    wxYES_NO
-
+    @beginStyleTable
+    @style{wxYES_NO}:
+        Puts Yes and No buttons on the message box. May be combined with
+        wxCANCEL.
+    @style{wxCANCEL}:
+        Puts a Cancel button on the message box. May only be combined with
+        wxYES_NO or wxOK.
+    @style{wxOK}:
+        Puts an Ok button on the message box. May be combined with wxCANCEL.
+    @style{wxICON_EXCLAMATION}:
+        Displays an exclamation mark symbol.
+    @style{wxICON_HAND}:
+        Displays an error symbol.
+    @style{wxICON_ERROR}:
+        Displays an error symbol - the same as wxICON_HAND.
+    @style{wxICON_QUESTION}:
+        Displays a question mark symbol.
+    @style{wxICON_INFORMATION}:
+        Displays an information symbol.
+
+    The return value is one of: wxYES, wxNO, wxCANCEL, wxOK. For example:

 
 

-    Puts Yes and No buttons on the message box. May be combined with
-    wxCANCEL.
-
-    wxCANCEL
-
-
-    Puts a Cancel button on the message box. May only be combined with
-    wxYES_NO or wxOK.
-
-    wxOK
-
-
-    Puts an Ok button on the message box. May be combined with wxCANCEL.
-
-    wxICON_EXCLAMATION
-
-
-    Displays an exclamation mark symbol.
-
-    wxICON_HAND
-
-
-    Displays an error symbol.
-
-    wxICON_ERROR
-
-
-    Displays an error symbol - the same as wxICON_HAND.
-
-    wxICON_QUESTION
-
-
-    Displays a question mark symbol.
-
-    wxICON_INFORMATION
-
-
-    Displays an information symbol.
-
-    The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
-
-    For example:

     @code
     @code

-    ...
-      int answer = wxMessageBox("Quit program?", "Confirm",
-                                wxYES_NO | wxCANCEL, main_frame);
-      if (answer == wxYES)
-        main_frame-Close();
-      ...
+    int answer = wxMessageBox("Quit program?", "Confirm",
+                              wxYES_NO | wxCANCEL, main_frame);
+    if (answer == wxYES)
+        main_frame->Close();

     @endcode
 
     @endcode
 

-    @e message may contain newline characters, in which case the
-    message will be split into separate lines, to cater for large messages.
+    @a message may contain newline characters, in which case the message will
+    be split into separate lines, to cater for large messages.
+
+    @header{wx/msgdlg.h}

 */
 int wxMessageBox(const wxString& message,
                  const wxString& caption = "Message",
                  int style = wxOK,
 */
 int wxMessageBox(const wxString& message,
                  const wxString& caption = "Message",
                  int style = wxOK,

-                 wxWindow * parent = @NULL,
+                 wxWindow* parent = NULL,

                  int x = -1, int y = -1);
 
                  int x = -1, int y = -1);
 

+//@}
+