X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/eaa69588615bad177910f1dac8ee22142ce1dcb1..f2959820a5286e4b1595bb9c89de30fa69d6fc6a:/interface/wx/preferences.h?ds=sidebyside

diff --git a/interface/wx/preferences.h b/interface/wx/preferences.h
index 656ce907c1..8ce835c319 100644
--- a/interface/wx/preferences.h
+++ b/interface/wx/preferences.h
@@ -3,7 +3,6 @@
 // Purpose:     wxPreferencesEditor class documentation.
 // Author:      Vaclav Slavik
 // Created:     2013-02-26
-// RCS-ID:      $Id$
 // Copyright:   (c) 2013 Vaclav Slavik <vslavik@fastmail.fm>
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
@@ -82,9 +81,8 @@ public:
     /**
         Hide the currently shown dialog, if any.
 
-        This doesn't do anything on the platforms using modal preferences
-        dialogs (e.g. Windows) but should be called to dismiss the dialog if
-        the object whose preferences it is editing was closed.
+        This is typically called to dismiss the dialog if the object whose
+        preferences it is editing was closed.
      */
     void Dismiss();
 
@@ -98,6 +96,23 @@ public:
         in this case as well.
      */
     static bool ShouldApplyChangesImmediately()
+
+    /**
+        Returns whether the preferences dialog is shown modally.
+
+        If this method returns false, as it currently does in wxGTK and wxOSX,
+        Show() simply makes the dialog visible and returns immediately. If it
+        returns true, as it does in wxMSW and under the other platforms, then
+        the dialog is shown modally, i.e. Show() blocks until the user
+        dismisses it.
+
+        Notice that it isn't necessary to test the return value of this method
+        to use this class normally, its interface is designed to work in both
+        cases. However it can sometimes be necessary to call it if the program
+        needs to handle modal dialogs specially, e.g. perhaps to block some
+        periodic background update operation while a modal dialog is shown.
+     */
+    static bool ShownModally();
 };