X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/98ccd5452290db2280d7b23698d66584c3e66732..9d33840bab4e10d701dd36f9b8660f6a13f05afe:/interface/wx/utils.h?ds=sidebyside diff --git a/interface/wx/utils.h b/interface/wx/utils.h index 1254434a7b..8e615d89ac 100644 --- a/interface/wx/utils.h +++ b/interface/wx/utils.h @@ -93,7 +93,7 @@ public: // ============================================================================ -/** @ingroup group_funcmacro_dialog */ +/** @addtogroup group_funcmacro_dialog */ //@{ /** @@ -154,7 +154,7 @@ void wxInfoMessageBox(wxWindow parent = NULL); -/** @ingroup group_funcmacro_env */ +/** @addtogroup group_funcmacro_env */ //@{ /** @@ -205,7 +205,7 @@ bool wxUnsetEnv(const wxString& var); -/** @ingroup group_funcmacro_misc */ +/** @addtogroup group_funcmacro_misc */ //@{ /** @@ -349,9 +349,11 @@ void wxRegisterId(long id); Returns @true if the application was successfully launched. + @see wxLaunchDefaultBrowser(), wxExecute() + @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. @@ -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). + @see wxLaunchDefaultApplication(), wxExecute() + @header{wx/utils.h} */ bool wxLaunchDefaultBrowser(const wxString& url, int flags = 0); @@ -444,7 +448,7 @@ wxString wxStripMenuCodes(const wxString& str, int flags = wxStrip_All); -/** @ingroup group_funcmacro_networkuseros */ +/** @addtogroup group_funcmacro_networkuseros */ //@{ /** @@ -534,7 +538,7 @@ wxString wxGetFullHostName(); @header{wx/utils.h} */ -wxString wxGetUserHome(const wxString& user = ""); +wxString wxGetUserHome(const wxString& user = wxEmptyString); /** This function returns the "user id" also known as "login name" under Unix @@ -641,7 +645,7 @@ bool wxIsPlatformLittleEndian(); -/** @ingroup group_funcmacro_procctrl */ +/** @addtogroup group_funcmacro_procctrl */ //@{ /** @@ -710,7 +714,8 @@ bool wxIsPlatformLittleEndian(); @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} @@ -725,7 +730,7 @@ long wxExecute(const wxString& command, int flags = wxEXEC_ASYNC, //@} -/** @ingroup group_funcmacro_procctrl */ +/** @addtogroup group_funcmacro_procctrl */ //@{ /** This is an overloaded version of wxExecute(const wxString&,int,wxProcess*), @@ -746,6 +751,9 @@ long wxExecute(const wxString& command, int flags = wxEXEC_ASYNC, @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, @@ -754,7 +762,7 @@ long wxExecute(wchar_t** argv, int flags = wxEXEC_ASYNC, wxProcess* callback = NULL); //@} -/** @ingroup group_funcmacro_procctrl */ +/** @addtogroup group_funcmacro_procctrl */ //@{ /** @@ -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 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. + @see wxShell(), wxProcess, @ref page_samples_exec, + wxLaunchDefaultApplication(), wxLaunchDefaultBrowser() + @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*), @@ -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 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. + @see wxShell(), wxProcess, @ref page_samples_exec, + wxLaunchDefaultApplication(), wxLaunchDefaultBrowser() + @header{wx/utils.h} */ long wxExecute(const wxString& command, wxArrayString& output, @@ -900,7 +919,7 @@ bool wxShutdown(int flags = wxSHUTDOWN_POWEROFF); -/** @ingroup group_funcmacro_time */ +/** @addtogroup group_funcmacro_time */ //@{ /**