X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5e0e6ceb8fbcce0cbce97e1e383c1acf99cce033..52c14774b3309c1f6baddbcf92df1eb86a322d92:/docs/latex/wx/cmdlpars.tex diff --git a/docs/latex/wx/cmdlpars.tex b/docs/latex/wx/cmdlpars.tex index a3b45cb5b9..8cbd7ccd89 100644 --- a/docs/latex/wx/cmdlpars.tex +++ b/docs/latex/wx/cmdlpars.tex @@ -80,12 +80,13 @@ the following constants: \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 @@ -102,12 +103,13 @@ by an option or parameter are: \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: @@ -115,13 +117,14 @@ Finally, the {\tt flags} field is a combination of the following bit masks: \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 @@ -175,7 +178,7 @@ combination of \helpref{AddSwitch}{wxcmdlineparseraddswitch}, Using constructors or \helpref{SetDesc}{wxcmdlineparsersetdesc} uses a (usually {\tt const static}) table containing the command line description. If you want -to decide which options to acccept during the run-time, using one of the +to decide which options to accept during the run-time, using one of the {\tt AddXXX()} functions above might be preferable. \membersection{Customization}\label{wxcmdlineparsercustomization} @@ -224,8 +227,8 @@ For a simple switch, you will simply call \helpref{Found}{wxcmdlineparserfoundswitch} to determine if the switch was given or not, for an option or a parameter, you will call a version of {\tt Found()} which also returns the associated value in the provided variable. All -{\tt Found()} functions return TRUE if the switch or option were found in the -command line or FALSE if they were not specified. +{\tt Found()} functions return true if the switch or option were found in the +command line or false if they were not specified. %%%%%%%%%%%%% Methods in alphabetic order %%%%%%%%%%%%% \helponly{\insertatlevel{2}{ @@ -278,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}} @@ -315,7 +326,7 @@ start. Default is {\tt "-"} for Unix, {\tt "-/"} for Windows. \membersection{wxCmdLineParser::EnableLongOptions}\label{wxcmdlineparserenablelongoptions} -\func{void}{EnableLongOptions}{\param{bool }{enable = TRUE}} +\func{void}{EnableLongOptions}{\param{bool }{enable = true}} Enable or disable support for the long options. @@ -324,13 +335,23 @@ them. \wxheading{See also} -\helpref{Customization}{wxcmdlineparsercustomization} +\helpref{Customization}{wxcmdlineparsercustomization} and \helpref{AreLongOptionsEnabled}{wxcmdlineparserarelongoptionsenabled} \membersection{wxCmdLineParser::DisableLongOptions}\label{wxcmdlineparserdisablelongoptions} \func{void}{DisableLongOptions}{\void} -Ientical to \helpref{EnableLongOptions(FALSE)}{wxcmdlineparserenablelongoptions}. +Identical to \helpref{EnableLongOptions(false)}{wxcmdlineparserenablelongoptions}. + +\membersection{wxCmdLineParser::AreLongOptionsEnabled}\label{wxcmdlineparserarelongoptionsenabled} + +\func{bool}{AreLongOptionsEnabled}{\void} + +Returns true if long options are enabled, otherwise false. + +\wxheading{See also} + +\helpref{EnableLongOptions}{wxcmdlineparserenablelongoptions} \membersection{wxCmdLineParser::SetLogo}\label{wxcmdlineparsersetlogo} @@ -394,12 +415,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} @@ -416,27 +445,27 @@ will not be helpful to the user unless the descriptions were indeed specified. \constfunc{bool}{Found}{\param{const wxString\& }{name}} -Returns TRUE if the given switch was found, FALSE otherwise. +Returns true if the given switch was found, false otherwise. \membersection{wxCmdLineParser::Found}\label{wxcmdlineparserfoundstringoption} \constfunc{bool}{Found}{\param{const wxString\& }{name}, \param{wxString* }{value}} -Returns TRUE if an option taking a string value was found and stores the +Returns true if an option taking a string value was found and stores the value in the provided pointer (which should not be NULL). \membersection{wxCmdLineParser::Found}\label{wxcmdlineparserfoundintoption} \constfunc{bool}{Found}{\param{const wxString\& }{name}, \param{long* }{value}} -Returns TRUE if an option taking an integer value was found and stores +Returns true if an option taking an integer value was found and stores the value in the provided pointer (which should not be NULL). \membersection{wxCmdLineParser::Found}\label{wxcmdlineparserfounddateoption} \constfunc{bool}{Found}{\param{const wxString\& }{name}, \param{wxDateTime* }{value}} -Returns TRUE if an option taking a date value was found and stores the +Returns true if an option taking a date value was found and stores the value in the provided pointer (which should not be NULL). \membersection{wxCmdLineParser::GetParamCount}\label{wxcmdlineparsergetparamcount}