X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a66abda9d31bd568152769cc7fa594ef168f8aca..ebb396715d5ecd865a225fa3cf7675277ceb3f1b:/docs/latex/wx/cmdlpars.tex diff --git a/docs/latex/wx/cmdlpars.tex b/docs/latex/wx/cmdlpars.tex index 407a0707ac..d2a9373fd6 100644 --- a/docs/latex/wx/cmdlpars.tex +++ b/docs/latex/wx/cmdlpars.tex @@ -281,6 +281,14 @@ specifies the \helpref{command line description}{wxcmdlineparsersetdesc}. Same as \helpref{wxCmdLineParser}{wxcmdlineparserwxcmdlineparserstr}, but also specifies the \helpref{command line description}{wxcmdlineparsersetdesc}. +\membersection{wxCmdLineParser::ConvertStringToArgs}\label{wxcmdlineparserconvertstringtoargs} + +\func{static wxArrayString}{ConvertStringToArgs}{\param{const wxChar }{*cmdline}} + +Breaks down the string containing the full command line in words. The words are +separated by whitespace. The quotes can be used in the input string to quote +the white space and the back slashes can be used to quote the quotes. + \membersection{wxCmdLineParser::SetCmdLine}\label{wxcmdlineparsersetcmdlineargc} \func{void}{SetCmdLine}{\param{int }{argc}, \param{char** }{argv}} @@ -397,12 +405,20 @@ Add a parameter of the given {\it type} to the command line description. \membersection{wxCmdLineParser::Parse}\label{wxcmdlineparserparse} -\func{int}{Parse}{\void} +\func{int}{Parse}{\param{bool }{giveUsage = {\tt TRUE}}} Parse the command line, return $0$ if ok, $-1$ if {\tt "-h"} or {\tt "--help"} option was encountered and the help message was given or a positive value if a syntax error occured. +\wxheading{Parameters} + +\docparam{giveUsage}{If {\tt TRUE} (default), the usage message is given if a +syntax error was encountered while parsing the command line or if help was +requested. If {\tt FALSE}, only error messages about possible syntax errors +are given, use \helpref{Usage}{wxcmdlineparserusage} to show the usage message +from the caller if needed.} + \membersection{wxCmdLineParser::Usage}\label{wxcmdlineparserusage} \func{void}{Usage}{\void}