Document wxHTTP::SetPostBuffer().

[wxWidgets.git] / interface / wx / datetime.h

diff --git a/interface/wx/datetime.h b/interface/wx/datetime.h
index f0751079373fb244f24755fc9add289b48a20720..7f01b6483510bed79b3b4cf8ac0a073550459f16 100644 (file)
--- a/interface/wx/datetime.h
+++ b/interface/wx/datetime.h
@@ -59,7 +59,7 @@
     in 'free' format, i.e. allow them to be specified in any of possible ways.
     These functions will usually be used to parse the (interactive) user input
     which is not bound to be in any predefined format. As an example,
-    ParseDateTime() can parse the strings such as "tomorrow", "March first" and
+    ParseDate() can parse the strings such as "tomorrow", "March first" and
     even "next Sunday".
 
     Finally notice that each of the parsing functions is available in several
@@ -812,8 +812,7 @@ public:
 
         @see Format()
     */
-    const char* ParseDate(const wxString& date,
-                          wxString::const_iterator* end = NULL);
+    bool ParseDate(const wxString& date, wxString::const_iterator *end);
 
     /**
         Parses the string @a datetime containing the date and time in free
@@ -822,13 +821,14 @@ public:
         This function tries as hard as it can to interpret the given string as
         date and time. Unlike ParseRfc822Date(), it will accept anything that
         may be accepted and will only reject strings which can not be parsed in
-        any way at all.
+        any way at all. Notice that the function will fail if either date or
+        time part is present but not both, use ParseDate() or ParseTime() to
+        parse strings containing just the date or time component.
 
         See ParseFormat() for the description of function parameters and return
         value.
     */
-    const char* ParseDateTime(const wxString& datetime,
-                              wxString::const_iterator* end = NULL);
+    bool ParseDateTime(const wxString& datetime, wxString::const_iterator *end);
 
     /**
         This function parses the string @a date according to the given
@@ -849,12 +849,7 @@ public:
         @a dateDef. If it is not specified, Today() is used as the default
         date.
 
-        Notice that the return value of this method is not actually a pointer
-        but rather an object of a special proxy class which is convertible to
-        either @c char* or @c wchar_t* pointer. This is needed for
-        compatibility with the existing code but the new code should use @a end
-        parameter instead and just test whether the return value is @NULL or
-        not, e.g.:
+        Example of using this function:
         @code
             wxDateTime dt;
             wxString str = "...";
@@ -875,26 +870,32 @@ public:
             Used to fill in the date components not specified in the @a date
             string.
         @param end
-            If non-@NULL, will be filled with the iterator pointing to the
-            location where the parsing stopped. If the entire string was
-            consumed, it is set to @c date.end().
+            Will be filled with the iterator pointing to the location where the
+            parsing stopped if the function returns @true. If the entire string
+            was consumed, it is set to @c date.end(). Notice that this argument
+            must be non-@NULL.
         @return
-            Pointer-like object indicating the location where the scan stopped
-            if parsing was successful or @NULL-like otherwise.
+            @true if at least part of the string was parsed successfully,
+            @false otherwise.
 
         @see Format()
     */
-    const char* ParseFormat(const wxString& date,
-                            const wxString& format = wxDefaultDateTimeFormat,
-                            const wxDateTime& dateDef = wxDefaultDateTime,
-                            wxString::const_iterator* end = NULL);
+    bool ParseFormat(const wxString& date,
+                     const wxString& format,
+                     const wxDateTime& dateDef,
+                     wxString::const_iterator *end);
 
     /**
         @overload
     */
-    const char* ParseFormat(const wxString& date,
-                            const wxString& format = wxDefaultDateTimeFormat,
-                            wxString::const_iterator* end = NULL);
+    bool ParseFormat(const wxString& date,
+                     const wxString& format,
+                     wxString::const_iterator *end);
+
+    /**
+        @overload
+    */
+    bool ParseFormat(const wxString& date, wxString::const_iterator *end);
 
     /**
         This function parses the string containing the date and time in ISO
@@ -944,8 +945,7 @@ public:
         See ParseFormat() for the description of function parameters and return
         value.
     */
-    const char* ParseRfc822Date(const wxString& date,
-                                wxString::const_iterator* end = NULL);
+    bool ParseRfc822Date(const wxString& date, wxString::const_iterator *end);
 
     /**
         This functions is like ParseDateTime(), but only allows the time to be
@@ -954,8 +954,7 @@ public:
         See ParseFormat() for the description of function parameters and return
         value.
     */
-    const char* ParseTime(const wxString& time,
-                          wxString::const_iterator* end = NULL);
+    bool ParseTime(const wxString& time, wxString::const_iterator *end);
 
     //@}