Documented new menu label functions

[wxWidgets.git] / docs / latex / wx / cmdlpars.tex

diff --git a/docs/latex/wx/cmdlpars.tex b/docs/latex/wx/cmdlpars.tex
index f3a2c4eca8856fd1b2794a508929e934b89647ae..e7ab669a5174c8f1cddd35504ac536729bf76765 100644 (file)
--- a/docs/latex/wx/cmdlpars.tex
+++ b/docs/latex/wx/cmdlpars.tex
@@ -6,12 +6,12 @@
 %% Created:     27.03.00
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin
 %% Created:     27.03.00
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin

-%% License:     wxWidgets license
+%% License:     wxWindows license

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxCmdLineParser}}\label{wxcmdlineparser}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxCmdLineParser}}\label{wxcmdlineparser}
 

-wxCmdLineParser is a class for parsing command line.
+wxCmdLineParser is a class for parsing the command line.

 
 It has the following features:
 
 
 It has the following features:
 


@@ -53,6 +53,10 @@ No base class
 
 <wx/cmdline.h>
 
 
 <wx/cmdline.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \wxheading{Constants}
 
 The structure wxCmdLineEntryDesc is used to describe the one command
 \wxheading{Constants}
 
 The structure wxCmdLineEntryDesc is used to describe the one command


@@ -163,15 +167,13 @@ the only restriction is that it must be done before calling
 \helpref{Parse}{wxcmdlineparserparse}.
 
 To specify the command line to parse you may use either one of constructors
 \helpref{Parse}{wxcmdlineparserparse}.
 
 To specify the command line to parse you may use either one of constructors

-accepting it (\helpref{wxCmdLineParser(argc, argv)}{wxcmdlineparserwxcmdlineparserargc} or 
-\helpref{wxCmdLineParser}{wxcmdlineparserwxcmdlineparserdescargc} usually) or,
-if you use \helpref{the default constructor}{wxcmdlineparserwxcmdlineparserdef},
-you can do it later by calling 
-\helpref{SetCmdLine}{wxcmdlineparsersetcmdlineargc}.
+accepting it (\tt{wxCmdLineParser(argc, argv)} or \tt{wxCmdLineParser(const wxString&)} usually) 
+or, if you use the default constructor, you can do it later by calling 
+\helpref{SetCmdLine}{wxcmdlineparsersetcmdline}.

 
 The same holds for command line description: it can be specified either in
 
 The same holds for command line description: it can be specified either in

-the constructor (\helpref{without command line}{wxcmdlineparserwxcmdlineparserdesc} or 
-\helpref{together with it}{wxcmdlineparserwxcmdlineparserdescargc}) or
+the constructor (\helpref{without\ command\ line}{wxcmdlineparserwxcmdlineparser} or 
+\helpref{together\ with\ it}{wxcmdlineparserwxcmdlineparserdescargc}) or

 constructed later using either \helpref{SetDesc}{wxcmdlineparsersetdesc} or
 combination of \helpref{AddSwitch}{wxcmdlineparseraddswitch}, 
 \helpref{AddOption}{wxcmdlineparseraddoption} and 
 constructed later using either \helpref{SetDesc}{wxcmdlineparsersetdesc} or
 combination of \helpref{AddSwitch}{wxcmdlineparseraddswitch}, 
 \helpref{AddOption}{wxcmdlineparseraddoption} and 


@@ -228,7 +230,7 @@ you may access the results of parsing using one of overloaded {\tt Found()}
 methods.
 
 For a simple switch, you will simply call 
 methods.
 
 For a simple switch, you will simply call 

-\helpref{Found}{wxcmdlineparserfoundswitch} to determine if the switch was given
+\helpref{Found}{wxcmdlineparserfound} 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
 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


@@ -242,21 +244,20 @@ command line or false if they were not specified.
 }}
 
 
 }}
 
 

-\membersection{wxCmdLineParser::wxCmdLineParser}\label{wxcmdlineparserwxcmdlineparserdef}
+\membersection{wxCmdLineParser::wxCmdLineParser}\label{wxcmdlineparserwxcmdlineparser}

 
 \func{}{wxCmdLineParser}{\void}
 
 Default constructor. You must use 
 
 \func{}{wxCmdLineParser}{\void}
 
 Default constructor. You must use 

-\helpref{SetCmdLine}{wxcmdlineparsersetcmdlineargc} later.
+\helpref{SetCmdLine}{wxcmdlineparsersetcmdline} later.

 
 

-
-\membersection{wxCmdLineParser::wxCmdLineParser}\label{wxcmdlineparserwxcmdlineparserargc}
+\membersection{wxCmdLineParser::wxCmdLineParser}\label{wxcmdlineparserwxcmdlineparserdescargc}

 
 \func{}{wxCmdLineParser}{\param{int }{argc}, \param{char** }{argv}}
 
 \func{}{wxCmdLineParser}{\param{int }{argc}, \param{wchar\_t** }{argv}}
 
 
 \func{}{wxCmdLineParser}{\param{int }{argc}, \param{char** }{argv}}
 
 \func{}{wxCmdLineParser}{\param{int }{argc}, \param{wchar\_t** }{argv}}
 

-Constructor specifies the command line to parse. This is the traditional
+Constructors which specify the command line to parse. This is the traditional

 (Unix) command line format. The parameters {\it argc} and {\it argv} have the
 same meaning as for {\tt main()} function.
 
 (Unix) command line format. The parameters {\it argc} and {\it argv} have the
 same meaning as for {\tt main()} function.
 


@@ -265,39 +266,26 @@ first one is available in both ANSI and Unicode modes because under some
 platforms the command line arguments are passed as ASCII strings even to
 Unicode programs.
 
 platforms the command line arguments are passed as ASCII strings even to
 Unicode programs.
 

-
-\membersection{wxCmdLineParser::wxCmdLineParser}\label{wxcmdlineparserwxcmdlineparserstr}
-

 \func{}{wxCmdLineParser}{\param{const wxString\& }{cmdline}}
 
 \func{}{wxCmdLineParser}{\param{const wxString\& }{cmdline}}
 

-Constructor specifies the command line to parse in Windows format. The parameter 
+Constructor which specify the command line to parse in Windows format. The parameter 

 {\it cmdline} has the same meaning as the corresponding parameter of 
 {\tt WinMain()}.
 
 {\it cmdline} has the same meaning as the corresponding parameter of 
 {\tt WinMain()}.
 

-
-\membersection{wxCmdLineParser::wxCmdLineParser}\label{wxcmdlineparserwxcmdlineparserdesc}
-

 \func{}{wxCmdLineParser}{\param{const wxCmdLineEntryDesc* }{desc}}
 
 \func{}{wxCmdLineParser}{\param{const wxCmdLineEntryDesc* }{desc}}
 

-Same as \helpref{wxCmdLineParser}{wxcmdlineparserwxcmdlineparserdef}, but also
-specifies the \helpref{command line description}{wxcmdlineparsersetdesc}.
-
-
-\membersection{wxCmdLineParser::wxCmdLineParser}\label{wxcmdlineparserwxcmdlineparserdescargc}
+Specifies the \helpref{command line description}{wxcmdlineparsersetdesc} but not the
+command line. You must use \helpref{SetCmdLine}{wxcmdlineparsersetcmdline} later.

 
 \func{}{wxCmdLineParser}{\param{const wxCmdLineEntryDesc* }{desc}, \param{int }{argc}, \param{char** }{argv}}
 
 
 \func{}{wxCmdLineParser}{\param{const wxCmdLineEntryDesc* }{desc}, \param{int }{argc}, \param{char** }{argv}}
 

-Same as \helpref{wxCmdLineParser}{wxcmdlineparserwxcmdlineparserargc}, but also
-specifies the \helpref{command line description}{wxcmdlineparsersetdesc}.
-
-
-\membersection{wxCmdLineParser::wxCmdLineParser}\label{wxcmdlineparserwxcmdlineparserdescstr}
+Specifies both the command line (in Unix format) and the 
+\helpref{command line description}{wxcmdlineparsersetdesc}.

 
 \func{}{wxCmdLineParser}{\param{const wxCmdLineEntryDesc* }{desc}, \param{const wxString\& }{cmdline}}
 
 
 \func{}{wxCmdLineParser}{\param{const wxCmdLineEntryDesc* }{desc}, \param{const wxString\& }{cmdline}}
 

-Same as \helpref{wxCmdLineParser}{wxcmdlineparserwxcmdlineparserstr}, but also
-specifies the \helpref{command line description}{wxcmdlineparsersetdesc}.
-
+Specifies both the command line (in Windows format) and the 
+\helpref{command line description}{wxcmdlineparsersetdesc}.

 
 \membersection{wxCmdLineParser::ConvertStringToArgs}\label{wxcmdlineparserconvertstringtoargs}
 
 
 \membersection{wxCmdLineParser::ConvertStringToArgs}\label{wxcmdlineparserconvertstringtoargs}
 


@@ -308,7 +296,7 @@ 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.
 
 
 the white space and the back slashes can be used to quote the quotes.
 
 

-\membersection{wxCmdLineParser::SetCmdLine}\label{wxcmdlineparsersetcmdlineargc}
+\membersection{wxCmdLineParser::SetCmdLine}\label{wxcmdlineparsersetcmdline}

 
 \func{void}{SetCmdLine}{\param{int }{argc}, \param{char** }{argv}}
 
 
 \func{void}{SetCmdLine}{\param{int }{argc}, \param{char** }{argv}}
 


@@ -317,20 +305,10 @@ the white space and the back slashes can be used to quote the quotes.
 Set command line to parse after using one of the constructors which don't do it.
 The second overload of this function is only available in Unicode build.
 
 Set command line to parse after using one of the constructors which don't do it.
 The second overload of this function is only available in Unicode build.
 

-\wxheading{See also}
-
-\helpref{wxCmdLineParser}{wxcmdlineparserwxcmdlineparserargc}
-
-
-\membersection{wxCmdLineParser::SetCmdLine}\label{wxcmdlineparsersetcmdlinestr}
-

 \func{void}{SetCmdLine}{\param{const wxString\& }{cmdline}}
 
 Set command line to parse after using one of the constructors which don't do it.
 
 \func{void}{SetCmdLine}{\param{const wxString\& }{cmdline}}
 
 Set command line to parse after using one of the constructors which don't do it.
 

-\wxheading{See also}
-
-\helpref{wxCmdLineParser}{wxcmdlineparserwxcmdlineparserstr}

 
 
 \membersection{wxCmdLineParser::\destruct{wxCmdLineParser}}\label{wxcmdlineparserdtor}
 
 
 \membersection{wxCmdLineParser::\destruct{wxCmdLineParser}}\label{wxcmdlineparserdtor}


@@ -453,7 +431,7 @@ Add a parameter of the given {\it type} to the command line description.
 
 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
 
 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.
+syntax error occurred.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -477,34 +455,25 @@ will not be helpful to the user unless the descriptions were indeed specified.
 \helpref{SetLogo}{wxcmdlineparsersetlogo}
 
 
 \helpref{SetLogo}{wxcmdlineparsersetlogo}
 
 

-\membersection{wxCmdLineParser::Found}\label{wxcmdlineparserfoundswitch}
+\membersection{wxCmdLineParser::Found}\label{wxcmdlineparserfound}

 
 \constfunc{bool}{Found}{\param{const wxString\& }{name}}
 
 
 \constfunc{bool}{Found}{\param{const wxString\& }{name}}
 

-Returns true if the given switch was found, false otherwise.
-
-
-\membersection{wxCmdLineParser::Found}\label{wxcmdlineparserfoundstringoption}
+Returns \true if the given switch was found, false otherwise.

 
 \constfunc{bool}{Found}{\param{const wxString\& }{name}, \param{wxString* }{value}}
 
 
 \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).
 
 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}}
 
 \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).
 
 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}}
 
 \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).
 
 
 value in the provided pointer (which should not be NULL).
 
 


@@ -520,7 +489,7 @@ had used {\tt wxCMD\_LINE\_PARAM\_MULTIPLE} flag.
 
 \constfunc{wxString}{GetParam}{\param{size\_t }{n = 0u}}
 
 
 \constfunc{wxString}{GetParam}{\param{size\_t }{n = 0u}}
 

-Returns the value of Nth parameter (as string only for now).
+Returns the value of Nth parameter (as string only).

 
 \wxheading{See also}
 
 
 \wxheading{See also}