X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e5a2291ac72235414468467c451607de5ca10ffd..45ef0076bf8dd723ac709a4e30bdacedbb75b5f8:/docs/latex/wx/function.tex?ds=sidebyside diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index 1f153cddef..13e2bbb853 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -36,7 +36,7 @@ void MyThread::Foo(void) // Call GUI here: my_window->DrawSomething(); - + wxMutexGuiLeave(); } \end{verbatim} @@ -88,7 +88,7 @@ a directory. \membersection{::wxFileModificationTime} -\func{time_t}{wxFileModificationTime}{\param{const wxString\& }{filename}} +\func{time\_t}{wxFileModificationTime}{\param{const wxString\& }{filename}} Returns time of last modification of given file. @@ -260,7 +260,7 @@ Under MS Windows, the current drive is also changed if {\it dir} contains a driv \membersection{::wxSplitPath}\label{wxsplitfunction} -\func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{const wxString *}{ path}, \param{const wxString *}{ name}, \param{const wxString *}{ ext}} +\func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}} This function splits a full file name into components: the path (including possible disk/drive specification under Windows), the base name and the extension. Any of the output parameters @@ -569,6 +569,24 @@ if (s) +\membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser} + +\func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}} + +Shows the colour selection dialog and returns the colour selected by user or +invalid colour (use \helpref{wxColour::Ok}{wxcolourok} to test whether a colour +is valid) if the dialog was cancelled. + +\wxheading{Parameters} + +\docparam{parent}{The parent window for the colour selection dialog} + +\docparam{colInit}{If given, this will be the colour initially selected in the dialog.} + +\wxheading{Include files} + + + \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser} \func{long}{wxGetNumberFromUser}{ @@ -1099,7 +1117,7 @@ registered with the dynamic class system using DECLARE... and IMPLEMENT... macro Called when wxWindows exits, to clean up the DDE system. This no longer needs to be called by the application. -See also helpref{wxDDEInitialize}{wxddeinitialize}. +See also \helpref{wxDDEInitialize}{wxddeinitialize}. \wxheading{Include files} @@ -1241,6 +1259,8 @@ wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}. \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}} +\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}} + Executes another program in Unix or Windows. The first form takes a command string, such as {\tt "emacs file.txt"}. @@ -1248,6 +1268,9 @@ The first form takes a command string, such as {\tt "emacs file.txt"}. The second form takes an array of values: a command, any number of arguments, terminated by NULL. +The semantics of the third version is different from the first two and is +described in more details below. + If {\it sync} is FALSE (the default), flow of control immediately returns. If TRUE, the current application waits until the other program has terminated. @@ -1267,6 +1290,10 @@ parameter can not be non NULL for synchronous execution), \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when the process finishes. +Finally, you may use the third overloaded version of this function to execute +a process (always synchronously) and capture its output in the array +{\it output}. + See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}, \helpref{Exec sample}{sampleexec}. @@ -1813,8 +1840,8 @@ See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfig Yields control to pending messages in the windowing system. This can be useful, for example, when a time-consuming process writes to a text window. Without an occasional -yield, the text window will not be updated properly, and (since Windows -multitasking is cooperative) other processes will not respond. +yield, the text window will not be updated properly, and on systems with +cooperative multitasking, such as Windows 3.1 other processes will not respond. Caution should be exercised, however, since yielding may allow the user to perform actions which are not compatible with the current task. @@ -1822,6 +1849,12 @@ Disabling menu items or whole menus during processing can avoid unwanted reentrance of code: see \helpref{::wxSafeYield}{wxsafeyield} for a better function. +Note that wxYield will not flush the message logs. This is intentional as +calling wxYield is usually done to quickly update the screen and popping up a +message box dialog may be undesirable. If you do with to flush the log +messages immediately (otherwise it will be done during the next idle loop +iteration), call \helpref{wxLog::FlushActive}{wxlogflushactive}. + \wxheading{Include files} or @@ -2486,6 +2519,11 @@ as the last system error code ({\it errno} or {\it ::GetLastError()} depending on the platform) and the corresponding error message. The second form of this function takes the error code explitly as the first argument. +\wxheading{See also} + +\helpref{wxSysErrorCode}{wxsyserrorcode}, +\helpref{wxSysErrorMsg}{wxsyserrormsg} + \membersection{::wxLogDebug}\label{wxlogdebug} \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}} @@ -2541,6 +2579,31 @@ trace masks. \item wxTraceOleCalls: trace OLE method calls (Win32 only) \end{itemize} +\membersection{::wxSysErrorCode}\label{wxsyserrorcode} + +\func{unsigned long}{wxSysErrorCode}{\void} + +Returns the error code from the last system call. This function uses +{\tt errno} on Unix platforms and {\tt GetLastError} under Win32. + +\wxheading{See also} + +\helpref{wxSysErrorMsg}{wxsyserrormsg}, +\helpref{wxLogSysError}{wxlogsyserror} + +\membersection{::wxSysErrorMsg}\label{wxsyserrormsg} + +\func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}} + +Returns the error message corresponding to the given system error code. If +{\it errCode} is $0$ (default), the last error code (as returned by +\helpref{wxSysErrorCode}{wxsyserrorcode}) is used. + +\wxheading{See also} + +\helpref{wxSysErrorCode}{wxsyserrorcode}, +\helpref{wxLogSysError}{wxlogsyserror} + \section{Debugging macros and functions}\label{debugmacros} Useful macros and functins for error checking and defensive programming. ASSERTs are only