disable UI updating during GetPopupMenuSelectionFromUser() execution to avoid unexpec...

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

diff --git a/interface/wx/app.h b/interface/wx/app.h
index 4fea75c14b9555bcf9245d79e0ace7be1fcac068..3a5e6a0858b97cfeb6ee1a2971d7027103174c32 100644 (file)
--- a/interface/wx/app.h
+++ b/interface/wx/app.h
@@ -531,9 +531,10 @@ public:
     /**
         Returns a pointer to the top window.
 
-        @remarks If the top window hasn't been set using SetTopWindow(),
-                 this function will find the first top-level window
-                 (frame or dialog) and return that.
+        @remarks
+            If the top window hasn't been set using SetTopWindow(), this function
+            will find the first top-level window (frame or dialog or instance of
+            wxTopLevelWindow) from the internal top level window list and return that.
 
         @see SetTopWindow()
     */
@@ -624,9 +625,13 @@ public:
         Sets the 'top' window. You can call this from within OnInit() to let wxWidgets
         know which is the main window. You don't have to set the top window;
         it is only a convenience so that (for example) certain dialogs without parents
-        can use a specific window as the top window. If no top window is specified by the
-        application, wxWidgets just uses the first frame or dialog in its top-level window
-        list, when it needs to use the top window.
+        can use a specific window as the top window.
+
+        If no top window is specified by the application, wxWidgets just uses the
+        first frame or dialog (or better, any wxTopLevelWindow) in its top-level
+        window list, when it needs to use the top window.
+        If you previously called SetTopWindow() and now you need to restore this
+        automatic behaviour you can call @code wxApp::SetTopWindow(NULL) @endcode.
 
         @param window
             The new top window.
@@ -795,9 +800,9 @@ void wxWakeUpIdle();
 bool wxYield();
 
 /**
-    This function is similar to wxYield, except that it disables the user input to
-    all program windows before calling wxYield and re-enables it again
-    afterwards. If @a win is not @NULL, this window will remain enabled,
+    This function is similar to wxYield(), except that it disables the user
+    input to all program windows before calling wxYield() and re-enables it
+    again afterwards. If @a win is not @NULL, this window will remain enabled,
     allowing the implementation of some limited user interaction.
     Returns the result of the call to ::wxYield.