[ 1960295 ] wxWeakRef - Reorganization and comments

[wxWidgets.git] / include / wx / cmdline.h

diff --git a/include/wx/cmdline.h b/include/wx/cmdline.h
index 07c893eb752f8d50a60fb60a760c23840343160f..4539dd61abcbdb2dc11b1d7acb4267239fe4075a 100644 (file)
--- a/include/wx/cmdline.h
+++ b/include/wx/cmdline.h
@@ -17,10 +17,11 @@
 
 #include "wx/string.h"
 #include "wx/arrstr.h"
+#include "wx/cmdargs.h"
 
 #if wxUSE_CMDLINE_PARSER
 
-class WXDLLIMPEXP_BASE wxDateTime;
+class WXDLLIMPEXP_FWD_BASE wxDateTime;
 
 // ----------------------------------------------------------------------------
 // constants
@@ -44,6 +45,7 @@ enum wxCmdLineParamType
     wxCMD_LINE_VAL_STRING,  // should be 0 (default)
     wxCMD_LINE_VAL_NUMBER,
     wxCMD_LINE_VAL_DATE,
+    wxCMD_LINE_VAL_DOUBLE,
     wxCMD_LINE_VAL_NONE
 };
 
@@ -53,6 +55,7 @@ enum wxCmdLineEntryType
     wxCMD_LINE_SWITCH,
     wxCMD_LINE_OPTION,
     wxCMD_LINE_PARAM,
+    wxCMD_LINE_USAGE_TEXT,
     wxCMD_LINE_NONE         // to terminate the list
 };
 
@@ -64,13 +67,17 @@ enum wxCmdLineEntryType
 struct wxCmdLineEntryDesc
 {
     wxCmdLineEntryType kind;
-    const wxChar *shortName;
-    const wxChar *longName;
-    const wxChar *description;
+    const char *shortName;
+    const char *longName;
+    const char *description;
     wxCmdLineParamType type;
     int flags;
 };
 
+// the list of wxCmdLineEntryDesc objects should be terminated with this one
+#define wxCMD_LINE_DESC_END \
+        { wxCMD_LINE_NONE, NULL, NULL, NULL, wxCMD_LINE_VAL_NONE, 0x0 }
+
 // ----------------------------------------------------------------------------
 // wxCmdLineParser is a class for parsing command line.
 //
@@ -100,6 +107,8 @@ public:
     wxCmdLineParser(int argc, char **argv) { Init(); SetCmdLine(argc, argv); }
 #if wxUSE_UNICODE
     wxCmdLineParser(int argc, wxChar **argv) { Init(); SetCmdLine(argc, argv); }
+    wxCmdLineParser(int argc, const wxCmdLineArgsArray& argv)
+        { Init(); SetCmdLine(argc, argv); }
 #endif // wxUSE_UNICODE
     wxCmdLineParser(const wxString& cmdline) { Init(); SetCmdLine(cmdline); }
 
@@ -112,6 +121,10 @@ public:
 #if wxUSE_UNICODE
     wxCmdLineParser(const wxCmdLineEntryDesc *desc, int argc, wxChar **argv)
         { Init(); SetCmdLine(argc, argv); SetDesc(desc); }
+    wxCmdLineParser(const wxCmdLineEntryDesc *desc,
+                    int argc,
+                    const wxCmdLineArgsArray& argv)
+        { Init(); SetCmdLine(argc, argv); SetDesc(desc); }
 #endif // wxUSE_UNICODE
     wxCmdLineParser(const wxCmdLineEntryDesc *desc, const wxString& cmdline)
         { Init(); SetCmdLine(cmdline); SetDesc(desc); }
@@ -120,6 +133,7 @@ public:
     void SetCmdLine(int argc, char **argv);
 #if wxUSE_UNICODE
     void SetCmdLine(int argc, wxChar **argv);
+    void SetCmdLine(int argc, const wxCmdLineArgsArray& argv);
 #endif // wxUSE_UNICODE
     void SetCmdLine(const wxString& cmdline);
 
@@ -138,7 +152,7 @@ public:
     void EnableLongOptions(bool enable = true);
     void DisableLongOptions() { EnableLongOptions(false); }
 
-    bool AreLongOptionsEnabled();
+    bool AreLongOptionsEnabled() const;
 
     // extra text may be shown by Usage() method if set by this function
     void SetLogo(const wxString& logo);
@@ -165,6 +179,9 @@ public:
                   wxCmdLineParamType type = wxCMD_LINE_VAL_STRING,
                   int flags = 0);
 
+    // add an explanatory text to be shown to the user in help
+    void AddUsageText(const wxString& text);
+
     // actions
     // -------
 
@@ -177,7 +194,10 @@ public:
     int Parse(bool showUsage = true);
 
     // give the usage message describing all program options
-    void Usage();
+    void Usage() const;
+
+    // return the usage string, call Usage() to directly show it to the user
+    wxString GetUsageString() const;
 
     // get the command line arguments
     // ------------------------------
@@ -193,6 +213,10 @@ public:
     // the value in the provided pointer
     bool Found(const wxString& name, long *value) const;
 
+    // returns true if an option taking a double value was found and stores
+    // the value in the provided pointer
+    bool Found(const wxString& name, double *value) const;
+
 #if wxUSE_DATETIME
     // returns true if an option taking a date value was found and stores the
     // value in the provided pointer
@@ -212,9 +236,6 @@ public:
     static wxArrayString ConvertStringToArgs(const wxString& cmdline);
 
 private:
-    // get usage string
-    wxString GetUsageString();
-
     // common part of all ctors
     void Init();
 
@@ -236,4 +257,3 @@ public:
 #endif // wxUSE_CMDLINE_PARSER/!wxUSE_CMDLINE_PARSER
 
 #endif // _WX_CMDLINE_H_
-