don't remove docs for wxThreadHelper::Create; list it in deprecated methods changelog...

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

diff --git a/interface/wx/utils.h b/interface/wx/utils.h
index e15454fc62f5b8081c04c14cf1a096df2739978e..85154729a09e39aa8d563ebcd3fcf71f379bf293 100644 (file)
--- a/interface/wx/utils.h
+++ b/interface/wx/utils.h
@@ -78,7 +78,7 @@ public:
     /**
         Constructs a busy cursor object, calling wxBeginBusyCursor().
     */
     /**
         Constructs a busy cursor object, calling wxBeginBusyCursor().
     */

-    wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR);
+    wxBusyCursor(const wxCursor* cursor = wxHOURGLASS_CURSOR);

 
     /**
         Destroys the busy cursor object, calling wxEndBusyCursor().
 
     /**
         Destroys the busy cursor object, calling wxEndBusyCursor().


@@ -349,9 +349,11 @@ void wxRegisterId(long id);
 
     Returns @true if the application was successfully launched.
 
 
     Returns @true if the application was successfully launched.
 

+    @see wxLaunchDefaultBrowser(), wxExecute()
+

     @header{wx/utils.h}
 */
     @header{wx/utils.h}
 */

-bool wxLaunchDefaultApplication(const wxString& document, int flags = 0)
+bool wxLaunchDefaultApplication(const wxString& document, int flags = 0);

 
 /**
     Opens the @a url in user's default browser.
 
 /**
     Opens the @a url in user's default browser.


@@ -375,6 +377,8 @@ bool wxLaunchDefaultApplication(const wxString& document, int flags = 0)
           may be used for local URLs while another one may be used for remote
           URLs).
 
           may be used for local URLs while another one may be used for remote
           URLs).
 

+    @see wxLaunchDefaultApplication(), wxExecute()
+

     @header{wx/utils.h}
 */
 bool wxLaunchDefaultBrowser(const wxString& url, int flags = 0);
     @header{wx/utils.h}
 */
 bool wxLaunchDefaultBrowser(const wxString& url, int flags = 0);


@@ -710,7 +714,8 @@ bool wxIsPlatformLittleEndian();
     @param callback
         An optional pointer to wxProcess.
 
     @param callback
         An optional pointer to wxProcess.
 

-    @see wxShell(), wxProcess, @ref page_samples_exec
+    @see wxShell(), wxProcess, @ref page_samples_exec,
+         wxLaunchDefaultApplication(), wxLaunchDefaultBrowser()

 
     @header{wx/utils.h}
 
 
     @header{wx/utils.h}
 


@@ -746,6 +751,9 @@ long wxExecute(const wxString& command, int flags = wxEXEC_ASYNC,
     @param callback
         An optional pointer to wxProcess.
 
     @param callback
         An optional pointer to wxProcess.
 

+    @see wxShell(), wxProcess, @ref page_samples_exec,
+         wxLaunchDefaultApplication(), wxLaunchDefaultBrowser()
+

     @header{wx/utils.h}
 */
 long wxExecute(char** argv, int flags = wxEXEC_ASYNC,
     @header{wx/utils.h}
 */
 long wxExecute(char** argv, int flags = wxEXEC_ASYNC,


@@ -768,16 +776,20 @@ long wxExecute(wchar_t** argv, int flags = wxEXEC_ASYNC,
     @param command
         The command to execute and any parameters to pass to it as a single
         string.
     @param command
         The command to execute and any parameters to pass to it as a single
         string.

+    @param output
+        The string array where the stdout of the executed process is saved.

     @param flags
         Must include either wxEXEC_ASYNC or wxEXEC_SYNC and can also include
         wxEXEC_NOHIDE, wxEXEC_MAKE_GROUP_LEADER (in either case) or
         wxEXEC_NODISABLE and wxEXEC_NOEVENTS or wxEXEC_BLOCK, which is equal to
         their combination, in wxEXEC_SYNC case.
 
     @param flags
         Must include either wxEXEC_ASYNC or wxEXEC_SYNC and can also include
         wxEXEC_NOHIDE, wxEXEC_MAKE_GROUP_LEADER (in either case) or
         wxEXEC_NODISABLE and wxEXEC_NOEVENTS or wxEXEC_BLOCK, which is equal to
         their combination, in wxEXEC_SYNC case.
 

+    @see wxShell(), wxProcess, @ref page_samples_exec,
+         wxLaunchDefaultApplication(), wxLaunchDefaultBrowser()
+

     @header{wx/utils.h}
 */
     @header{wx/utils.h}
 */

-long wxExecute(const wxString& command, wxArrayString& output,
-                int flags = 0);
+long wxExecute(const wxString& command, wxArrayString& output, int flags = 0);

 
 /**
     This is an overloaded version of wxExecute(const wxString&,int,wxProcess*),
 
 /**
     This is an overloaded version of wxExecute(const wxString&,int,wxProcess*),


@@ -789,12 +801,19 @@ long wxExecute(const wxString& command, wxArrayString& output,
     @param command
         The command to execute and any parameters to pass to it as a single
         string.
     @param command
         The command to execute and any parameters to pass to it as a single
         string.

+    @param output
+        The string array where the stdout of the executed process is saved.
+    @param errors
+        The string array where the stderr of the executed process is saved.

     @param flags
         Must include either wxEXEC_ASYNC or wxEXEC_SYNC and can also include
         wxEXEC_NOHIDE, wxEXEC_MAKE_GROUP_LEADER (in either case) or
         wxEXEC_NODISABLE and wxEXEC_NOEVENTS or wxEXEC_BLOCK, which is equal to
         their combination, in wxEXEC_SYNC case.
 
     @param flags
         Must include either wxEXEC_ASYNC or wxEXEC_SYNC and can also include
         wxEXEC_NOHIDE, wxEXEC_MAKE_GROUP_LEADER (in either case) or
         wxEXEC_NODISABLE and wxEXEC_NOEVENTS or wxEXEC_BLOCK, which is equal to
         their combination, in wxEXEC_SYNC case.
 

+    @see wxShell(), wxProcess, @ref page_samples_exec,
+         wxLaunchDefaultApplication(), wxLaunchDefaultBrowser()
+

     @header{wx/utils.h}
 */
 long wxExecute(const wxString& command, wxArrayString& output,
     @header{wx/utils.h}
 */
 long wxExecute(const wxString& command, wxArrayString& output,