better document the possible arguments accepted by wxLaunchDefaultBrowser; in particu...

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

diff --git a/interface/wx/utils.h b/interface/wx/utils.h
index 8e615d89acd1cf42e6e304f08a4d2b5d143ebbfd..d1121780e6e196fa2297de8b673d3a8393c29608 100644 (file)
--- a/interface/wx/utils.h
+++ b/interface/wx/utils.h
@@ -366,9 +366,15 @@ bool wxLaunchDefaultApplication(const wxString& document, int flags = 0);
     a busy cursor is shown while the browser is being launched (using
     wxBusyCursor).
 
-    The @a url may also be a local file path (with or without the "file://"
-    prefix), if it doesn't correspond to an existing file and the URL has no
-    scheme "http://" is prepended to it by default.
+    The parameter @a url is interpreted as follows:
+    - if it has a valid scheme (e.g. @c "file:", @c "http:" or @c "mailto:")
+      it is passed to the appropriate browser configured in the user system.
+    - if it has no valid scheme (e.g. it's a local file path without the @c "file:"
+      prefix), then ::wxFileExists and ::wxDirExists are used to test if it's a
+      local file/directory; if it is, then the browser is called with the
+      @a url parameter eventually prefixed by @c "file:".
+    - if it has no valid scheme and it's not a local file/directory, then @c "http:"
+      is prepended and the browser is called.
 
     Returns @true if the application was successfully launched.
 

diff --git a/src/common/utilscmn.cpp b/src/common/utilscmn.cpp
index c3a019d5270f1461f79e764536a8ea4d8c4e59f1..afcfa394ddb4521b5965efc97bd2e170bd8d064e 100644 (file)
--- a/src/common/utilscmn.cpp
+++ b/src/common/utilscmn.cpp
@@ -1010,10 +1010,14 @@ static bool DoLaunchDefaultBrowserHelper(const wxString& urlOrig, int flags)
     //
     // for (int i=0; i<2; i++)
     // {
+    //   // test arguments without a valid URL scheme:
     //   wxLaunchDefaultBrowser("C:\\test.txt", i==0 ? 0 : wxBROWSER_NEW_WINDOW);
     //   wxLaunchDefaultBrowser("wxwidgets.org", i==0 ? 0 : wxBROWSER_NEW_WINDOW);
+    //
+    //   // test arguments with different valid schemes:
     //   wxLaunchDefaultBrowser("file:/C%3A/test.txt", i==0 ? 0 : wxBROWSER_NEW_WINDOW);
     //   wxLaunchDefaultBrowser("http://wxwidgets.org", i==0 ? 0 : wxBROWSER_NEW_WINDOW);
+    //   wxLaunchDefaultBrowser("mailto:user@host.org", i==0 ? 0 : wxBROWSER_NEW_WINDOW);
     // }
     // (assuming you have a C:\test.txt file)
 
@@ -1039,7 +1043,7 @@ static bool DoLaunchDefaultBrowserHelper(const wxString& urlOrig, int flags)
             // TODO: extract URLToFileName() to some always compiled in
             //       function
 #if wxUSE_FILESYSTEM
-            // ShellExecuteEx() doesn't like the "file" scheme when opening local files; 
+            // ShellExecuteEx() doesn't like the "file" scheme when opening local files;
             // remove it
             url = wxFileSystem::URLToFileName(url).GetFullPath();
 #endif // wxUSE_FILESYSTEM