]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/cmdlpars.tex
added null pointer check and assert
[wxWidgets.git] / docs / latex / wx / cmdlpars.tex
index d9c3255d4dd1038f0c67e78d17cca3a68123a763..8dd937c1a9a58179c1eb11f2f6c7ef091236c02f 100644 (file)
@@ -53,6 +53,10 @@ No base class
 
 <wx/cmdline.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{Constants}
 
 The structure wxCmdLineEntryDesc is used to describe the one command
@@ -65,9 +69,9 @@ this structure:
 struct wxCmdLineEntryDesc
 {
     wxCmdLineEntryType kind;
-    const wxChar *shortName;
-    const wxChar *longName;
-    const wxChar *description;
+    wxString shortName;
+    wxString longName;
+    wxString description;
     wxCmdLineParamType type;
     int flags;
 };
@@ -89,7 +93,7 @@ enum wxCmdLineEntryType
 }
 
 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
+{\tt longName} is the corresponding long name or empty if the option has no long
 name. Both of these fields are unused for the parameters. Both the short and
 long option names can contain only letters, digits and the underscores.
 
@@ -163,15 +167,15 @@ 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
-accepting it (\tt{wxCmdLineParser(argc, argv)} or \tt{wxCmdLineParser(const wxString&)} usually) 
+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 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}, 
+the \helpref{constructor}{wxcmdlineparserwxcmdlineparserctor} (with or without
+the command line itself) or constructed later using either
+\helpref{SetDesc}{wxcmdlineparsersetdesc} or combination of 
+\helpref{AddSwitch}{wxcmdlineparseraddswitch}, 
 \helpref{AddOption}{wxcmdlineparseraddoption} and 
 \helpref{AddParam}{wxcmdlineparseraddparam} methods.
 
@@ -240,15 +244,13 @@ command line or false if they were not specified.
 }}
 
 
-\membersection{wxCmdLineParser::wxCmdLineParser}\label{wxcmdlineparserwxcmdlineparser}
+\membersection{wxCmdLineParser::wxCmdLineParser}\label{wxcmdlineparserwxcmdlineparserctor}
 
 \func{}{wxCmdLineParser}{\void}
 
 Default constructor. You must use 
 \helpref{SetCmdLine}{wxcmdlineparsersetcmdline} later.
 
-\membersection{wxCmdLineParser::wxCmdLineParser}\label{wxcmdlineparserwxcmdlineparserdescargc}
-
 \func{}{wxCmdLineParser}{\param{int }{argc}, \param{char** }{argv}}
 
 \func{}{wxCmdLineParser}{\param{int }{argc}, \param{wchar\_t** }{argv}}