Document wxDialog::ShowWindowModal().

This function is not yet really implemented under all platforms but provide
the documentation for it hinting at how (and where) it works.

Closes #12873.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@66697 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/dialog.h b/interface/wx/dialog.h
index c530528dd6ec2c4fef8ed4ff9c96268ccb0567f9..093d0c42ec6382eae89ef13dfd4e27b61570ff0d 100644 (file)
--- a/interface/wx/dialog.h
+++ b/interface/wx/dialog.h
@@ -594,7 +594,7 @@ public:
     virtual bool Show(bool show = 1);
 
     /**
-        Shows a modal dialog.
+        Shows an application-modal dialog.
 
         Program flow does not return until the dialog has been dismissed with
         EndModal().
@@ -611,9 +611,26 @@ public:
 
         @return The value set with SetReturnCode().
 
-        @see EndModal(), GetReturnCode(), SetReturnCode()
+        @see ShowWindowModal(), EndModal(), GetReturnCode(), SetReturnCode()
     */
     virtual int ShowModal();
+
+    /**
+        Shows a dialog modal to the parent top level window only.
+
+        Unlike ShowModal(), dialogs shown with this function only prevent the
+        user from interacting with their parent frame only but not with the
+        rest of the application. They also don't block the program execution
+        but instead return immediately, as Show(), and generate a
+        wxEVT_WINDOW_MODAL_DIALOG_CLOSED event later when the dialog is closed.
+
+        Currently this function is only fully implemented in wxOSX ports, under
+        the other platforms it behaves like ShowModal() (but also sends the
+        above mentioned event).
+
+        @since 2.9.0
+     */
+    void ShowWindowModal();
 };