X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5b8643eace7dee009bbe864e8da00f380ea479f3..afbe906abdf9aa69a56571b8b20b095351dd8f34:/docs/latex/wx/function.tex?ds=sidebyside diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index 35eeebcb3e..cfaa54463a 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -430,8 +430,16 @@ processes. \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}} +\perlnote{In wxPerl this function only takes the {\tt command} argument, +and returns a 2-element list {\tt ( status, output )}, where {\tt output} is +an array reference.} + \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{wxArrayString\& }{errors}} +\perlnote{In wxPerl this function only takes the {\tt command} argument, +and returns a 3-element list {\tt ( status, output, errors )}, where +{\tt output} and {\tt errors} are array references.} + Executes another program in Unix or Windows. The first form takes a command string, such as {\tt "emacs file.txt"}. @@ -2254,21 +2262,11 @@ Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead. \func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}} -This function posts the event to the specified {\it dest} object. The -difference between sending an event and posting it is that in the first case -the event is processed before the function returns (in wxWindows, event sending -is done with \helpref{ProcessEvent}{wxevthandlerprocessevent} function), but in -the second, the function returns immediately and the event will be processed -sometime later - usually during the next even loop iteration. - -Note that a copy of the {\it event} is made by the function, so the original -copy can be deleted as soon as function returns. This function can also be used -to send events between different threads safely. As this function makes a -copy of the event, the event needs to have a fully implemented Clone() method, -which may not be the case for all event in wxWindows. - -See also \helpref{AddPendingEvent}{wxevthandleraddpendingevent} (which this function -uses internally). +In a GUI application, this function posts {\it event} to the specified {\it dest} +object using \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}. +Otherwise, it dispatches {\it event} immediately using +\helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent}. +See the respective documentation for details (and caveats). \wxheading{Include files} @@ -3370,7 +3368,7 @@ because it will not be executed in release mode at all. \func{}{wxASSERT\_MIN\_BITSIZE}{\param{}{type}, \param{}{size}} This macro results in a -\helpref{compile time assertion failure}{wxCOMPILE\_TIME\_ASSERT} if the size +\helpref{compile time assertion failure}{wxcompiletimeassert} if the size of the given type {\it type} is less than {\it size} bits. You may use it like this, for example: @@ -3399,7 +3397,7 @@ Assert macro with message. An error message will be generated if the condition i \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}} Using {\tt wxCOMPILE\_TIME\_ASSERT} results in a compilation error if the -specified {\it condition| is false. The compiler error message should include +specified {\it condition} is false. The compiler error message should include the {\it msg} identifier - please note that it must be a valid C++ identifier and not a string unlike in the other cases.