removed extra membersections (patch 1702329)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@45543 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -163,11 +163,9 @@ the only restriction is that it must be done before calling
|
|||||||
\helpref{Parse}{wxcmdlineparserparse}.
|
\helpref{Parse}{wxcmdlineparserparse}.
|
||||||
|
|
||||||
To specify the command line to parse you may use either one of constructors
|
To specify the command line to parse you may use either one of constructors
|
||||||
accepting it (\helpref{wxCmdLineParser(argc, argv)}{wxcmdlineparserwxcmdlineparserargc} or
|
accepting it (\tt{wxCmdLineParser(argc, argv)} or \tt{wxCmdLineParser(const wxString&)} usually)
|
||||||
\helpref{wxCmdLineParser}{wxcmdlineparserwxcmdlineparserdescargc} usually) or,
|
or, if you use the default constructor, you can do it later by calling
|
||||||
if you use \helpref{the default constructor}{wxcmdlineparserwxcmdlineparserdef},
|
\helpref{SetCmdLine}{wxcmdlineparsersetcmdline}.
|
||||||
you can do it later by calling
|
|
||||||
\helpref{SetCmdLine}{wxcmdlineparsersetcmdlineargc}.
|
|
||||||
|
|
||||||
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
|
the constructor (\helpref{without command line}{wxcmdlineparserwxcmdlineparserdesc} or
|
||||||
@@ -228,7 +226,7 @@ you may access the results of parsing using one of overloaded {\tt Found()}
|
|||||||
methods.
|
methods.
|
||||||
|
|
||||||
For a simple switch, you will simply call
|
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()}
|
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
|
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
|
{\tt Found()} functions return true if the switch or option were found in the
|
||||||
@@ -242,21 +240,18 @@ command line or false if they were not specified.
|
|||||||
}}
|
}}
|
||||||
|
|
||||||
|
|
||||||
\membersection{wxCmdLineParser::wxCmdLineParser}\label{wxcmdlineparserwxcmdlineparserdef}
|
\membersection{wxCmdLineParser::wxCmdLineParser}\label{wxcmdlineparserwxcmdlineparser}
|
||||||
|
|
||||||
\func{}{wxCmdLineParser}{\void}
|
\func{}{wxCmdLineParser}{\void}
|
||||||
|
|
||||||
Default constructor. You must use
|
Default constructor. You must use
|
||||||
\helpref{SetCmdLine}{wxcmdlineparsersetcmdlineargc} later.
|
\helpref{SetCmdLine}{wxcmdlineparsersetcmdline} later.
|
||||||
|
|
||||||
|
|
||||||
\membersection{wxCmdLineParser::wxCmdLineParser}\label{wxcmdlineparserwxcmdlineparserargc}
|
|
||||||
|
|
||||||
\func{}{wxCmdLineParser}{\param{int }{argc}, \param{char** }{argv}}
|
\func{}{wxCmdLineParser}{\param{int }{argc}, \param{char** }{argv}}
|
||||||
|
|
||||||
\func{}{wxCmdLineParser}{\param{int }{argc}, \param{wchar\_t** }{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
|
(Unix) command line format. The parameters {\it argc} and {\it argv} have the
|
||||||
same meaning as for {\tt main()} function.
|
same meaning as for {\tt main()} function.
|
||||||
|
|
||||||
@@ -265,39 +260,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
|
platforms the command line arguments are passed as ASCII strings even to
|
||||||
Unicode programs.
|
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
|
{\it cmdline} has the same meaning as the corresponding parameter of
|
||||||
{\tt WinMain()}.
|
{\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} but not the
|
||||||
specifies the \helpref{command line description}{wxcmdlineparsersetdesc}.
|
command line. You must use \helpref{SetCmdLine}{wxcmdlineparsersetcmdline} later.
|
||||||
|
|
||||||
|
|
||||||
\membersection{wxCmdLineParser::wxCmdLineParser}\label{wxcmdlineparserwxcmdlineparserdescargc}
|
|
||||||
|
|
||||||
\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 both the command line (in Unix format) and the
|
||||||
specifies the \helpref{command line description}{wxcmdlineparsersetdesc}.
|
\helpref{command line description}{wxcmdlineparsersetdesc}.
|
||||||
|
|
||||||
|
|
||||||
\membersection{wxCmdLineParser::wxCmdLineParser}\label{wxcmdlineparserwxcmdlineparserdescstr}
|
|
||||||
|
|
||||||
\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 both the command line (in Windows format) and the
|
||||||
specifies the \helpref{command line description}{wxcmdlineparsersetdesc}.
|
\helpref{command line description}{wxcmdlineparsersetdesc}.
|
||||||
|
|
||||||
|
|
||||||
\membersection{wxCmdLineParser::ConvertStringToArgs}\label{wxcmdlineparserconvertstringtoargs}
|
\membersection{wxCmdLineParser::ConvertStringToArgs}\label{wxcmdlineparserconvertstringtoargs}
|
||||||
|
|
||||||
@@ -308,7 +290,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 +299,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.
|
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.
|
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}}
|
\func{void}{SetCmdLine}{\param{const wxString\& }{cmdline}}
|
||||||
|
|
||||||
Set command line to parse after using one of the constructors which don't do it.
|
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}
|
||||||
@@ -477,34 +449,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.
|
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}}
|
\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 +483,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}
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user