X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/97d590469d4aaa67459aa4f041ea9bfa409dbecb..bf7945cef10c0844a32e95695c544d829da9293a:/docs/latex/wx/cmdlpars.tex diff --git a/docs/latex/wx/cmdlpars.tex b/docs/latex/wx/cmdlpars.tex index c7164c0163..407a0707ac 100644 --- a/docs/latex/wx/cmdlpars.tex +++ b/docs/latex/wx/cmdlpars.tex @@ -14,7 +14,8 @@ wxCmdLineParser is a class for parsing command line. It has the following features: -\begin{enumerate} + +\begin{enumerate}\itemsep=0pt \item distinguishes options, switches and parameters; allows option grouping \item allows both short and long options \item automatically generates the usage message from the command line description @@ -22,7 +23,8 @@ It has the following features: \end{enumerate} To use it you should follow these steps: -\begin{enumerate} + +\begin{enumerate}\itemsep=0pt \item \helpref{construct}{wxcmdlineparserconstruction} an object of this class giving it the command line to parse and optionally its description or use {\tt AddXXX()} functions later @@ -73,15 +75,18 @@ struct wxCmdLineEntryDesc The type of a command line entity is in the {\tt kind} field and may be one of the following constants: -{\small \begin{verbatim} + +{\small% +\begin{verbatim} enum wxCmdLineEntryType { - wxCMD\_LINE\_SWITCH, - wxCMD\_LINE\_OPTION, - wxCMD\_LINE\_PARAM, - wxCMD\_LINE\_NONE // use this to terminate the list + wxCMD_LINE_SWITCH, + wxCMD_LINE_OPTION, + wxCMD_LINE_PARAM, + wxCMD_LINE_NONE // use this to terminate the list +} +\end{verbatim} } -\end{verbatim}} The field {\tt shortName} is the usual, short, name of the switch or the option. {\tt longName} is the corresponding long name or NULL if the option has no long @@ -93,27 +98,33 @@ to construct a help message explaining the syntax of the program. The possible values of {\tt type} which specifies the type of the value accepted by an option or parameter are: -{\small \begin{verbatim} + +{\small% +\begin{verbatim} enum wxCmdLineParamType { - wxCMD\_LINE\_VAL\_STRING, // default - wxCMD\_LINE\_VAL\_NUMBER, - wxCMD\_LINE\_VAL\_DATE, - wxCMD\_LINE\_VAL\_NONE + wxCMD_LINE_VAL_STRING, // default + wxCMD_LINE_VAL_NUMBER, + wxCMD_LINE_VAL_DATE, + wxCMD_LINE_VAL_NONE +} +\end{verbatim} } -\end{verbatim}} Finally, the {\tt flags} field is a combination of the following bit masks: -{\small \begin{verbatim} + +{\small% +\begin{verbatim} enum { - wxCMD\_LINE\_OPTION\_MANDATORY = 0x01, // this option must be given - wxCMD\_LINE\_PARAM\_OPTIONAL = 0x02, // the parameter may be omitted - wxCMD\_LINE\_PARAM\_MULTIPLE = 0x04, // the parameter may be repeated - wxCMD\_LINE\_OPTION\_HELP = 0x08, // this option is a help request - wxCMD\_LINE\_NEEDS\_SEPARATOR = 0x10, // must have sep before the value + wxCMD_LINE_OPTION_MANDATORY = 0x01, // this option must be given + wxCMD_LINE_PARAM_OPTIONAL = 0x02, // the parameter may be omitted + wxCMD_LINE_PARAM_MULTIPLE = 0x04, // the parameter may be repeated + wxCMD_LINE_OPTION_HELP = 0x08, // this option is a help request + wxCMD_LINE_NEEDS_SEPARATOR = 0x10, // must have sep before the value +} +\end{verbatim} } -\end{verbatim}} Notice that by default (i.e. if flags are just $0$), options are optional (sic) and each call to \helpref{AddParam()}{wxcmdlineparseraddparam} allows one more