added convenient wxON_BLOCK_EXIT_THISn() macros wrapping wxON_BLOCK_EXIT_OBJn(*this)

[wxWidgets.git] / interface / cmdline.h

diff --git a/interface/cmdline.h b/interface/cmdline.h
index 73754835d84c92e991d21577c47ceb7ae531beed..56cd319a2b9502286e6ce33d37b4148f93fd3c4f 100644 (file)
--- a/interface/cmdline.h
+++ b/interface/cmdline.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        cmdline.h
-// Purpose:     documentation for wxCmdLineParser class
+// Purpose:     interface of wxCmdLineParser
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -14,43 +14,32 @@
 
     It has the following features:
 
-     distinguishes options, switches and parameters; allows option grouping
-     allows both short and long options
-     automatically generates the usage message from the command line description
-     does type checks on the options values (number, date, ...).
+    - distinguishes options, switches and parameters
+    - allows option grouping
+    - allows both short and long options
+    - automatically generates the usage message from the command line description
+    - checks types of the options values (number, date, ...).
 
     To use it you should follow these steps:
 
-     @ref wxCmdLineParser::construction construct an object of this class
+    -# @ref wxCmdLineParser::construction construct an object of this class
     giving it the command line to parse and optionally its description or use
     @c AddXXX() functions later
-     call @c Parse()
-     use @c Found() to retrieve the results
+    -# call @c Parse()
+    -# use @c Found() to retrieve the results
 
     In the documentation below the following terminology is used:
 
-
-
-    switch
-
-
+    - @e switch
     This is a boolean option which can be given or not, but
     which doesn't have any value. We use the word switch to distinguish such boolean
     options from more generic options like those described below. For example,
     @c -v might be a switch meaning "enable verbose mode".
-
-
-    option
-
-
+    - @e option
     Option for us here is something which comes with a value 0
     unlike a switch. For example, @c -o:filename might be an option which allows
     to specify the name of the output file.
-
-
-    parameter
-
-
+    - @e parameter
     This is a required program argument.
 
 
@@ -58,8 +47,7 @@
     @library{wxbase}
     @category{appmanagement}
 
-    @seealso
-    wxApp::argc and wxApp::argv, console sample
+    @see wxApp::argc and wxApp::argv, console sample
 */
 class wxCmdLineParser
 {
@@ -116,10 +104,10 @@ public:
 
     /**
         Returns @true if long options are enabled, otherwise @false.
-        
+
         @see EnableLongOptions()
     */
-    bool AreLongOptionsEnabled();
+    bool AreLongOptionsEnabled() const;
 
     /**
         Before Parse() can be called, the command line
@@ -186,7 +174,7 @@ public:
         Enable or disable support for the long options.
         As long options are not (yet) POSIX-compliant, this option allows to disable
         them.
-        
+
         @see Customization() and AreLongOptionsEnabled()
     */
     void EnableLongOptions(bool enable = true);
@@ -196,22 +184,23 @@ public:
         Returns @true if an option taking a date value was found and stores the
         value in the provided pointer (which should not be @NULL).
     */
-    bool Found(const wxString& name);
-    bool Found(const wxString& name, wxString* value);
-    bool Found(const wxString& name, long* value);
-    bool Found(const wxString& name, wxDateTime* value);
+    bool Found(const wxString& name) const;
+    bool Found(const wxString& name, wxString* value) const;
+    bool Found(const wxString& name, long* value) const;
+    bool Found(const wxString& name, double* value) const;
+    bool Found(const wxString& name, wxDateTime* value) const;
     //@}
 
     /**
         Returns the value of Nth parameter (as string only).
     */
-    wxString GetParam(size_t n = 0u);
+    wxString GetParam(size_t n = 0u) const;
 
     /**
         Returns the number of parameters found. This function makes sense mostly if you
         had used @c wxCMD_LINE_PARAM_MULTIPLE flag.
     */
-    size_t GetParamCount();
+    size_t GetParamCount() const;
 
     /**
         After calling Parse() (and if it returned 0),
@@ -230,7 +219,7 @@ public:
         Parse the command line, return 0 if ok, -1 if @c "-h" or @c "--help"
         option was encountered and the help message was given or a positive value if a
         syntax error occurred.
-        
+
         @param giveUsage
             If @true (default), the usage message is given if a
             syntax error was encountered while parsing the command line or if help was
@@ -284,8 +273,9 @@ public:
         Give the standard usage message describing all program options. It will use the
         options and parameters descriptions specified earlier, so the resulting message
         will not be helpful to the user unless the descriptions were indeed specified.
-        
+
         @see SetLogo()
     */
-    void Usage();
+    void Usage() const;
 };
+