Better document wxAutomationObject::GetDispatchPtr() return value.

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

diff --git a/interface/wx/datetime.h b/interface/wx/datetime.h
index 9e11fed428b47fd21fb620905e2b359d07ab72af..ab0adf6e5910e38bc5a8a2077f839e36f4d7f68d 100644 (file)
--- a/interface/wx/datetime.h
+++ b/interface/wx/datetime.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxDateTime
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxDateTime
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -244,6 +244,42 @@ public:
     };
 
 
     };
 
 

+    /**
+        Contains broken down date-time representation.
+
+        This struct is analogous to standard C <code>struct tm</code> and uses
+        the same, not always immediately obvious, conventions for its members:
+        notably its mon and mday fields count from 0 while yday counts from 1.
+     */
+    struct Tm
+    {
+        wxDateTime_t msec,  ///< Number of milliseconds.
+                     sec,   ///< Seconds in 0..59 (60 with leap seconds) range.
+                     min,   ///< Minutes in 0..59 range.
+                     hour,  ///< Hours since midnight in 0..23 range.
+                     mday,  ///< Day of the month in 1..31 range.
+                     yday;  ///< Day of the year in 0..365 range.
+        Month mon;          ///< Month, as an enumerated constant.
+        int year;           ///< Year.
+
+        /**
+            Check if the given date/time is valid (in Gregorian calendar).
+
+            Return @false if the components don't correspond to a correct date.
+         */
+        bool IsValid() const;
+
+        /**
+            Return the week day corresponding to this date.
+
+            Unlike the other fields, the week day is not always available and
+            so must be accessed using this method as it is computed on demand
+            when it is called.
+         */
+        WeekDay GetWeekDay();
+    };
+
+

     /**
         @name Constructors, Assignment Operators and Setters
 
     /**
         @name Constructors, Assignment Operators and Setters
 


@@ -881,15 +917,15 @@ public:
         @see Format()
     */
     bool ParseFormat(const wxString& date,
         @see Format()
     */
     bool ParseFormat(const wxString& date,

-                     const wxString& format = wxDefaultDateTimeFormat,
-                     const wxDateTime& dateDef = wxDefaultDateTime,
+                     const wxString& format,
+                     const wxDateTime& dateDef,

                      wxString::const_iterator *end);
 
     /**
         @overload
     */
     bool ParseFormat(const wxString& date,
                      wxString::const_iterator *end);
 
     /**
         @overload
     */
     bool ParseFormat(const wxString& date,

-                     const wxString& format = wxDefaultDateTimeFormat,
+                     const wxString& format,

                      wxString::const_iterator *end);
 
     /**
                      wxString::const_iterator *end);
 
     /**


@@ -1463,6 +1499,10 @@ public:
 */
 const wxDateTime wxDefaultDateTime;
 
 */
 const wxDateTime wxDefaultDateTime;
 

+/*
+    wxInvalidDateTime is an alias for wxDefaultDateTime.
+*/
+#define wxInvalidDateTime wxDefaultDateTime

 
 
 /**
 
 
 /**