fixing wrong version commit

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

diff --git a/interface/wx/dialog.h b/interface/wx/dialog.h
index 0c4140b2b9dfea7b0aabb9ec3036803bd258c9c0..4cf131dd17e159ec0d5f324125a793756a97f7e9 100644 (file)
--- a/interface/wx/dialog.h
+++ b/interface/wx/dialog.h
@@ -125,6 +125,18 @@ enum wxDialogLayoutAdaptationMode
     managers recognizing the MHM hints should be running for any of these
     styles to have an effect.
 
     managers recognizing the MHM hints should be running for any of these
     styles to have an effect.
 

+
+    @beginEventEmissionTable{wxCloseEvent}
+    @event{EVT_CLOSE(func)}
+        The dialog is being closed by the user or programmatically (see wxWindow::Close).
+        The user may generate this event clicking the close button
+        (typically the 'X' on the top-right of the title bar) if it's present
+        (see the @c wxCLOSE_BOX style) or by clicking a button with the
+        @c wxID_CANCEL or @c wxID_OK ids.
+    @event{EVT_INIT_DIALOG(func)}
+        Process a @c wxEVT_INIT_DIALOG event. See wxInitDialogEvent.
+    @endEventTable
+

     @library{wxcore}
     @category{cmndlg}
 
     @library{wxcore}
     @category{cmndlg}
 


@@ -167,11 +179,14 @@ public:
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = wxDEFAULT_DIALOG_STYLE,
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = wxDEFAULT_DIALOG_STYLE,

-             const wxString& name = "dialogBox");
+             const wxString& name = wxDialogNameStr);

 
     /**
 
     /**

-        Destructor. Deletes any child windows before deleting the physical
-        window.
+        Destructor.
+
+        Deletes any child windows before deleting the physical window.
+
+        See @ref overview_windowdeletion for more info.

     */
     virtual ~wxDialog();
 
     */
     virtual ~wxDialog();
 


@@ -190,7 +205,7 @@ public:
 
         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
     */
 
         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
     */

-    bool CanDoLayoutAdapation();
+    virtual bool CanDoLayoutAdaptation();

 
     /**
         Centres the dialog box on the display.
 
     /**
         Centres the dialog box on the display.


@@ -207,7 +222,8 @@ public:
     */
     bool Create(wxWindow* parent, wxWindowID id, const wxString& title,
                 const wxPoint& pos = wxDefaultPosition,
     */
     bool Create(wxWindow* parent, wxWindowID id, const wxString& title,
                 const wxPoint& pos = wxDefaultPosition,

-                const wxSize& size = wxDefaultSize, long style = 536877056,
+                const wxSize& size = wxDefaultSize,
+                long style = wxDEFAULT_DIALOG_STYLE,

                 const wxString& name = wxDialogNameStr);
 
     /**
                 const wxString& name = wxDialogNameStr);
 
     /**


@@ -250,7 +266,7 @@ public:
 
         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
     */
 
         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
     */

-    bool DoLayoutAdapation();
+    virtual bool DoLayoutAdaptation();

 
     /**
         This function is called when the titlebar OK button is pressed
 
     /**
         This function is called when the titlebar OK button is pressed


@@ -258,6 +274,8 @@ public:
         GetAffirmativeId() is sent by default. You can override this function.
         If the function returns @false, wxWidgets will call Close() for the
         dialog.
         GetAffirmativeId() is sent by default. You can override this function.
         If the function returns @false, wxWidgets will call Close() for the
         dialog.

+
+        @onlyfor{wxmsw}

     */
     virtual bool DoOK();
 
     */
     virtual bool DoOK();
 


@@ -361,6 +379,8 @@ public:
         supported.
 
         This function is not available on any other platform.
         supported.
 
         This function is not available on any other platform.

+
+        @onlyfor{wxmsw}

     */
     wxToolBar* GetToolBar() const;
 
     */
     wxToolBar* GetToolBar() const;
 


@@ -399,9 +419,11 @@ public:
         Returns @true if @a id is in the array of identifiers to be regarded as
         the main buttons for the non-scrolling area of a dialog.
 
         Returns @true if @a id is in the array of identifiers to be regarded as
         the main buttons for the non-scrolling area of a dialog.
 

+        @onlyfor{wxmsw}
+

         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
     */
         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
     */

-    bool IsMainButton(wxWindowID& id) const;
+    bool IsMainButtonId(wxWindowID id) const;

 
     /**
         Returns @true if the dialog box is modal, @false otherwise.
 
     /**
         Returns @true if the dialog box is modal, @false otherwise.


@@ -561,6 +583,11 @@ public:
         modeless dialog modal. However ShowModal() can't be called twice
         without intervening EndModal() calls.
 
         modeless dialog modal. However ShowModal() can't be called twice
         without intervening EndModal() calls.
 

+        Note that this function creates a temporary event loop which takes
+        precedence over the application's main event loop (see wxEventLoopBase)
+        and which is destroyed when the dialog is dismissed.
+        This also results in a call to wxApp::ProcessPendingEvents().
+

         @return The value set with SetReturnCode().
 
         @see EndModal(), GetReturnCode(), SetReturnCode()
         @return The value set with SetReturnCode().
 
         @see EndModal(), GetReturnCode(), SetReturnCode()