X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f06832c1b6caae13c0bddf8f3a8aeb1114f4392b..3ad41c280f8d84a34b20e29719fea73481386840:/interface/wx/utils.h diff --git a/interface/wx/utils.h b/interface/wx/utils.h index 2e49aaf7bd..aec4146a67 100644 --- a/interface/wx/utils.h +++ b/interface/wx/utils.h @@ -510,7 +510,7 @@ void wxSetDisplayName(const wxString& displayName); By default, the functions strips both the mnemonics character (@c '&') which is used to indicate a keyboard shortkey, and the accelerators, which are used only in the menu items and are separated from the main text by the - @c \t (TAB) character. By using @a flags of @c wxStrip_Mnemonics or + @c \\t (TAB) character. By using @a flags of @c wxStrip_Mnemonics or @c wxStrip_Accel to strip only the former or the latter part, respectively. Notice that in most cases wxMenuItem::GetLabelFromText() or @@ -959,18 +959,22 @@ bool wxShell(const wxString& command = NULL); This function shuts down or reboots the computer depending on the value of the @a flags. - @note Doing this requires the corresponding access rights (superuser under - Unix, SE_SHUTDOWN privilege under Windows NT) and that this function - is only implemented under Unix and Win32. + @note Note that performing the shutdown requires the corresponding access + rights (superuser under Unix, SE_SHUTDOWN privilege under Windows NT) + and that this function is only implemented under Unix and MSW. @param flags - Either wxSHUTDOWN_POWEROFF or wxSHUTDOWN_REBOOT + One of @c wxSHUTDOWN_POWEROFF, @c wxSHUTDOWN_REBOOT or + @c wxSHUTDOWN_LOGOFF (currently implemented only for MSW) possibly + combined with @c wxSHUTDOWN_FORCE which forces shutdown under MSW by + forcefully terminating all the applications. As doing this can result + in a data loss, this flag shouldn't be used unless really necessary. @return @true on success, @false if an error occurred. @header{wx/utils.h} */ -bool wxShutdown(wxShutdownFlags flags); +bool wxShutdown(int flags = wxSHUTDOWN_POWEROFF); //@}