undo the last change as it results in buildbot configuration error

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

diff --git a/interface/wx/dialog.h b/interface/wx/dialog.h
index e057bc30ed6a2cc65f40bdc2d1085f17012efca2..4cf131dd17e159ec0d5f324125a793756a97f7e9 100644 (file)
--- a/interface/wx/dialog.h
+++ b/interface/wx/dialog.h
@@ -126,13 +126,15 @@ enum wxDialogLayoutAdaptationMode
     styles to have an effect.
 
 
     styles to have an effect.
 
 

-    @beginEventTable{wxCloseEvent}
+    @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_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}
     @endEventTable
 
     @library{wxcore}


@@ -581,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()