]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/cmdlpars.tex
applied patch 410892 (wxCopyFile uses ::CopyFile under Win32, has overwrite parameter)
[wxWidgets.git] / docs / latex / wx / cmdlpars.tex
index 5fe7725f159cc74db6e710769e84502db81a4071..443c1bd4cb338bfdb2bdb73d5d59c6d5db07af7a 100644 (file)
@@ -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,7 +75,9 @@ 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,
@@ -81,7 +85,8 @@ enum wxCmdLineEntryType
     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,7 +98,9 @@ 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
@@ -101,10 +108,13 @@ enum wxCmdLineParamType
     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
@@ -113,7 +123,8 @@ enum
     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
@@ -196,7 +207,7 @@ application-specific text before the explanation given by
 
 \membersection{Parsing command line}\label{wxcmdlineparserparsing}
 
-After the command line description was constructed and the desiredoptions were
+After the command line description was constructed and the desired options were
 set, you can finally call \helpref{Parse}{wxcmdlineparserparse} method.
 It returns $0$ if the command line was correct and was parsed, $-1$ if the help
 option was specified (this is a separate case as, normally, the program will
@@ -231,8 +242,7 @@ command line or FALSE if they were not specified.
 \func{}{wxCmdLineParser}{\void}
 
 Default constructor. You must use 
-\helpref{SetCmdLine}{wxcmdlineparsersetcmdlineargc} or 
-\helpref{SetCmdLinelater.}{wxcmdlineparsersetcmdlinestr} later.
+\helpref{SetCmdLine}{wxcmdlineparsersetcmdlineargc} later.
 
 \membersection{wxCmdLineParser::wxCmdLineParser}\label{wxcmdlineparserwxcmdlineparserargc}