Use the wx.ART_NORMAL_FILE icon

[wxWidgets.git] / wxPython / src / _datetime.i

diff --git a/wxPython/src/_datetime.i b/wxPython/src/_datetime.i
index 6a2dfbd7423e2894960ee3e4b59a568060771914..f0284ce688763161d28a33be8f8e9f3d146bba06 100644 (file)
--- a/wxPython/src/_datetime.i
+++ b/wxPython/src/_datetime.i
@@ -18,18 +18,17 @@
 
 %{
 #include <wx/datetime.h>
 
 %{
 #include <wx/datetime.h>

+%}

 
 

-    DECLARE_DEF_STRING2(DateFormatStr, wxT("%c"));
-    DECLARE_DEF_STRING2(TimeSpanFormatStr, wxT("%H:%M:%S"));
-
-%}    
+MAKE_CONST_WXSTRING(DefaultDateTimeFormat);
+MAKE_CONST_WXSTRING(DefaultTimeSpanFormat);

 
 //---------------------------------------------------------------------------
 
 
 
 //---------------------------------------------------------------------------
 
 

-%typemap(in) wxDateTime::TimeZone& (bool temp=False) {
+%typemap(in) wxDateTime::TimeZone& (bool temp=false) {

     $1 = new wxDateTime::TimeZone((wxDateTime::TZ)PyInt_AsLong($input));
     $1 = new wxDateTime::TimeZone((wxDateTime::TZ)PyInt_AsLong($input));

-    temp = True;
+    temp = true;

 }
 %typemap(python,freearg) wxDateTime::TimeZone& {
     if (temp$argnum) delete $1;
 }
 %typemap(python,freearg) wxDateTime::TimeZone& {
     if (temp$argnum) delete $1;


@@ -344,15 +343,15 @@ public:
 
         // returns the number of days in this year (356 or 355 for Gregorian
         // calendar usually :-)
 
         // returns the number of days in this year (356 or 355 for Gregorian
         // calendar usually :-)

-    %name(GetNumberOfDaysinYear)
-        static wxDateTime_t GetNumberOfDays(int year, Calendar cal = Gregorian);
+    %Rename(GetNumberOfDaysinYear, 
+        static wxDateTime_t, GetNumberOfDays(int year, Calendar cal = Gregorian));

 
         // get the number of the days in the given month (default value for
         // the year means the current one)
 
         // get the number of the days in the given month (default value for
         // the year means the current one)

-    %name(GetNumberOfDaysInMonth)
-        static wxDateTime_t GetNumberOfDays(Month month,
+    %Rename(GetNumberOfDaysInMonth, 
+        static wxDateTime_t, GetNumberOfDays(Month month,

                                             int year = Inv_Year,
                                             int year = Inv_Year,

-                                            Calendar cal = Gregorian);
+                                            Calendar cal = Gregorian));

 
         // get the full (default) or abbreviated month name in the current
         // locale, returns empty string on error
 
         // get the full (default) or abbreviated month name in the current
         // locale, returns empty string on error


@@ -364,11 +363,24 @@ public:
     static wxString GetWeekDayName(WeekDay weekday,
                                    NameFlags flags = Name_Full);
 
     static wxString GetWeekDayName(WeekDay weekday,
                                    NameFlags flags = Name_Full);
 

-    DocDeclAStr(
-        static void, GetAmPmStrings(wxString *OUTPUT, wxString *OUTPUT),
-        "GetAmPmStrings() -> (am, pm)",
-        "Get the AM and PM strings in the current locale (may be empty)");
-
+    %extend {
+        DocAStr(
+            GetAmPmStrings,
+            "GetAmPmStrings() -> (am, pm)",
+            "Get the AM and PM strings in the current locale (may be empty)", "");
+        static PyObject* GetAmPmStrings() {
+            wxString am;
+            wxString pm;
+            wxDateTime::GetAmPmStrings(&am, &pm);
+            wxPyBlock_t blocked = wxPyBeginBlockThreads();
+            PyObject* tup = PyTuple_New(2);
+            PyTuple_SET_ITEM(tup, 0, wx2PyString(am));
+            PyTuple_SET_ITEM(tup, 1, wx2PyString(pm));
+            wxPyEndBlockThreads(blocked);
+            return tup;
+        }
+    }
+                

         // return True if the given country uses DST for this year
     static bool IsDSTApplicable(int year = Inv_Year,
                                 Country country = Country_Default);
         // return True if the given country uses DST for this year
     static bool IsDSTApplicable(int year = Inv_Year,
                                 Country country = Country_Default);


@@ -401,19 +413,19 @@ public:
     // constructors
 
     wxDateTime();
     // constructors
 
     wxDateTime();

-    %name(DateTimeFromTimeT)wxDateTime(time_t timet);
-    %name(DateTimeFromJDN)wxDateTime(double jdn);
-    %name(DateTimeFromHMS)wxDateTime(wxDateTime_t hour,
+    %RenameCtor(DateTimeFromTimeT, wxDateTime(time_t timet));
+    %RenameCtor(DateTimeFromJDN, wxDateTime(double jdn));
+    %RenameCtor(DateTimeFromHMS, wxDateTime(wxDateTime_t hour,

                                      wxDateTime_t minute = 0,
                                      wxDateTime_t second = 0,
                                      wxDateTime_t minute = 0,
                                      wxDateTime_t second = 0,

-                                     wxDateTime_t millisec = 0);
-    %name(DateTimeFromDMY)wxDateTime(wxDateTime_t day,
+                                     wxDateTime_t millisec = 0));
+    %RenameCtor(DateTimeFromDMY, wxDateTime(wxDateTime_t day,

                                      Month        month = Inv_Month,
                                      int          year = Inv_Year,
                                      wxDateTime_t hour = 0,
                                      wxDateTime_t minute = 0,
                                      wxDateTime_t second = 0,
                                      Month        month = Inv_Month,
                                      int          year = Inv_Year,
                                      wxDateTime_t hour = 0,
                                      wxDateTime_t minute = 0,
                                      wxDateTime_t second = 0,

-                                     wxDateTime_t millisec = 0);
+                                     wxDateTime_t millisec = 0));

             
     ~wxDateTime();
 
             
     ~wxDateTime();
 


@@ -423,16 +435,16 @@ public:
     wxDateTime& SetToCurrent();
 
         // set to given time_t value
     wxDateTime& SetToCurrent();
 
         // set to given time_t value

-    %name(SetTimeT)wxDateTime& Set(time_t timet);
+    %Rename(SetTimeT, wxDateTime&, Set(time_t timet));

 
         // set to given JDN (beware of rounding errors)
 
         // set to given JDN (beware of rounding errors)

-    %name(SetJDN)wxDateTime& Set(double jdn);
+    %Rename(SetJDN, wxDateTime&, Set(double jdn));

 
         // set to given time, date = today
 
         // set to given time, date = today

-    %name(SetHMS)wxDateTime& Set(wxDateTime_t hour,
+    %Rename(SetHMS, wxDateTime&, Set(wxDateTime_t hour,

                     wxDateTime_t minute = 0,
                     wxDateTime_t second = 0,
                     wxDateTime_t minute = 0,
                     wxDateTime_t second = 0,

-                    wxDateTime_t millisec = 0);
+                    wxDateTime_t millisec = 0));

 
         // from separate values for each component with explicit date
         // (defaults for month and year are the current values)
 
         // from separate values for each component with explicit date
         // (defaults for month and year are the current values)


@@ -508,6 +520,17 @@ public:
     bool SetToTheWeek(wxDateTime_t numWeek, WeekDay weekday = Mon, WeekFlags flags = Monday_First);
     wxDateTime GetWeek(wxDateTime_t numWeek, WeekDay weekday = Mon, WeekFlags flags = Monday_First);
 
     bool SetToTheWeek(wxDateTime_t numWeek, WeekDay weekday = Mon, WeekFlags flags = Monday_First);
     wxDateTime GetWeek(wxDateTime_t numWeek, WeekDay weekday = Mon, WeekFlags flags = Monday_First);
 

+    %pythoncode {
+        SetToTheWeek = wx._deprecated(SetToTheWeek, "SetToTheWeek is deprecated, use (static) SetToWeekOfYear instead")
+        GetWeek = wx._deprecated(GetWeek, "GetWeek is deprecated, use GetWeekOfYear instead")
+    }
+            
+        // returns the date corresponding to the given week day of the given
+        // week (in ISO notation) of the specified year
+    static wxDateTime SetToWeekOfYear(int year,
+                                      wxDateTime_t numWeek,
+                                      WeekDay weekday = Mon);
+    

         // sets the date to the last day of the given (or current) month or the
         // given (or current) year
     wxDateTime& SetToLastMonthDay(Month month = Inv_Month,
         // sets the date to the last day of the given (or current) month or the
         // given (or current) year
     wxDateTime& SetToLastMonthDay(Month month = Inv_Month,


@@ -560,12 +583,12 @@ public:
     // timezone stuff
 
         // transform to any given timezone
     // timezone stuff
 
         // transform to any given timezone

-    wxDateTime ToTimezone(const wxDateTime::TimeZone& tz, bool noDST = False);
-    wxDateTime& MakeTimezone(const wxDateTime::TimeZone& tz, bool noDST = False);
+    wxDateTime ToTimezone(const wxDateTime::TimeZone& tz, bool noDST = false);
+    wxDateTime& MakeTimezone(const wxDateTime::TimeZone& tz, bool noDST = false);

 
         // transform to GMT/UTC
 
         // transform to GMT/UTC

-    wxDateTime ToGMT(bool noDST = False);
-    wxDateTime& MakeGMT(bool noDST = False);
+    wxDateTime ToGMT(bool noDST = false);
+    wxDateTime& MakeGMT(bool noDST = false);

 
         // is daylight savings time in effect at this moment according to the
         // rules of the specified country?
 
         // is daylight savings time in effect at this moment according to the
         // rules of the specified country?


@@ -581,7 +604,10 @@ public:
 
         // is the date valid (True even for non initialized objects)?
     inline bool IsValid() const;
 
         // is the date valid (True even for non initialized objects)?
     inline bool IsValid() const;

+    %pythoncode { Ok = IsValid }
+    %pythoncode { def __nonzero__(self): return self.Ok() };

 
 

+    

         // get the number of seconds since the Unix epoch - returns (time_t)-1
         // if the value is out of range
     inline time_t GetTicks() const;
         // get the number of seconds since the Unix epoch - returns (time_t)-1
         // if the value is out of range
     inline time_t GetTicks() const;


@@ -668,15 +694,15 @@ public:
     // arithmetics with dates (see also below for more operators)
 
         // add a time span (positive or negative)
     // arithmetics with dates (see also below for more operators)
 
         // add a time span (positive or negative)

-    %name(AddTS) wxDateTime& Add(const wxTimeSpan& diff);
+    %Rename(AddTS,  wxDateTime&, Add(const wxTimeSpan& diff));

         // add a date span (positive or negative)
         // add a date span (positive or negative)

-    %name(AddDS) wxDateTime& Add(const wxDateSpan& diff);
+    %Rename(AddDS,  wxDateTime&, Add(const wxDateSpan& diff));

 
         // subtract a time span (positive or negative)
 
         // subtract a time span (positive or negative)

-    %name(SubtractTS) wxDateTime& Subtract(const wxTimeSpan& diff);
+    %Rename(SubtractTS,  wxDateTime&, Subtract(const wxTimeSpan& diff));

 
         // subtract a date span (positive or negative)
 
         // subtract a date span (positive or negative)

-    %name(SubtractDS) wxDateTime& Subtract(const wxDateSpan& diff);
+    %Rename(SubtractDS,  wxDateTime&, Subtract(const wxDateSpan& diff));

 
         // return the difference between two dates
     wxTimeSpan Subtract(const wxDateTime& dt) const;
 
         // return the difference between two dates
     wxTimeSpan Subtract(const wxDateTime& dt) const;


@@ -695,14 +721,15 @@ public:
     inline wxDateTime& operator-=(const wxDateSpan& diff);
 
 
     inline wxDateTime& operator-=(const wxDateSpan& diff);
 
 

+//     inline bool operator<(const wxDateTime& dt) const;
+//     inline bool operator<=(const wxDateTime& dt) const;
+//     inline bool operator>(const wxDateTime& dt) const;
+//     inline bool operator>=(const wxDateTime& dt) const;
+//     inline bool operator==(const wxDateTime& dt) const;
+//     inline bool operator!=(const wxDateTime& dt) const;
+

     %nokwargs __add__;
     %nokwargs __sub__;
     %nokwargs __add__;
     %nokwargs __sub__;

-    %nokwargs __lt__;
-    %nokwargs __le__;
-    %nokwargs __gt__;
-    %nokwargs __ge__;
-    %nokwargs __eq__;
-    %nokwargs __ne__;

     %extend {
         wxDateTime __add__(const wxTimeSpan& other) { return *self + other; }
         wxDateTime __add__(const wxDateSpan& other) { return *self + other; }
     %extend {
         wxDateTime __add__(const wxTimeSpan& other) { return *self + other; }
         wxDateTime __add__(const wxDateSpan& other) { return *self + other; }


@@ -711,14 +738,39 @@ public:
         wxDateTime __sub__(const wxTimeSpan& other) { return *self - other; }
         wxDateTime __sub__(const wxDateSpan& other) { return *self - other; }
 
         wxDateTime __sub__(const wxTimeSpan& other) { return *self - other; }
         wxDateTime __sub__(const wxDateSpan& other) { return *self - other; }
 

-        bool __lt__(const wxDateTime& other) { return *self <  other; }
-        bool __le__(const wxDateTime& other) { return *self <= other; }
-        bool __gt__(const wxDateTime& other) { return *self >  other; }
-        bool __ge__(const wxDateTime& other) { return *self >= other; }
-        bool __eq__(const wxDateTime& other) { return *self == other; }
-        bool __ne__(const wxDateTime& other) { return *self != other; }
+        // These fall back to just comparing pointers if other is NULL, or if
+        // either operand is invalid.  This allows Python comparrisons to None
+        // to not assert and to return a sane value for the compare.
+        bool __lt__(const wxDateTime* other) { 
+            if (!other || !self->IsValid() || !other->IsValid()) return self <  other; 
+            return (*self <  *other);
+        }
+        bool __le__(const wxDateTime* other) { 
+            if (!other || !self->IsValid() || !other->IsValid()) return self <= other; 
+            return (*self <= *other);
+        }
+        bool __gt__(const wxDateTime* other) { 
+            if (!other || !self->IsValid() || !other->IsValid()) return self >  other; 
+            return (*self >  *other);
+        }
+        bool __ge__(const wxDateTime* other) { 
+            if (!other || !self->IsValid() || !other->IsValid()) return self >= other; 
+            return (*self >= *other);
+        }
+
+        bool __eq__(const wxDateTime* other) {
+            if (!other || !self->IsValid() || !other->IsValid()) return self == other; 
+            return (*self == *other);
+        }
+        bool __ne__(const wxDateTime* other) {
+            if (!other || !self->IsValid() || !other->IsValid()) return self != other; 
+            return (*self != *other);
+        }            

     }
 
     }
 

+
+
+   

         
     // ------------------------------------------------------------------------
     // conversion from text: all conversions from text return -1 on failure,
         
     // ------------------------------------------------------------------------
     // conversion from text: all conversions from text return -1 on failure,


@@ -743,7 +795,7 @@ public:
         // default, they will not change if they had valid values or will
         // default to Today() otherwise)
         int ParseFormat(const wxString& date,
         // default, they will not change if they had valid values or will
         // default to Today() otherwise)
         int ParseFormat(const wxString& date,

-                        const wxString& format = wxPyDateFormatStr,
+                        const wxString& format = wxPyDefaultDateTimeFormat,

                         const wxDateTime& dateDef = wxDefaultDateTime) {
             const wxChar* rv;
             const wxChar* _date = date;
                         const wxDateTime& dateDef = wxDefaultDateTime) {
             const wxChar* rv;
             const wxChar* _date = date;


@@ -788,7 +840,7 @@ public:
         // argument corresponds to the preferred date and time representation
         // for the current locale) and returns the string containing the
         // resulting text representation
         // argument corresponds to the preferred date and time representation
         // for the current locale) and returns the string containing the
         // resulting text representation

-    wxString Format(const wxString& format = wxPyDateFormatStr,
+    wxString Format(const wxString& format = wxPyDefaultDateTimeFormat,

                     const wxDateTime::TimeZone& tz = LOCAL_TZ) const;
 
         // preferred date representation for the current locale
                     const wxDateTime::TimeZone& tz = LOCAL_TZ) const;
 
         // preferred date representation for the current locale


@@ -807,9 +859,16 @@ public:
 
     %pythoncode {
     def __repr__(self):
 
     %pythoncode {
     def __repr__(self):

-        return '<wxDateTime: \"%s\" at %s>' % ( self.Format(), self.this)
+        if self.IsValid():
+            f = self.Format().encode(wx.GetDefaultPyEncoding())
+            return '<wx.DateTime: \"%s\" at %s>' % ( f, self.this)
+        else:
+            return '<wx.DateTime: \"INVALID\" at %s>' % self.this

     def __str__(self):
     def __str__(self):

-        return self.Format()
+        if self.IsValid():
+            return self.Format().encode(wx.GetDefaultPyEncoding())
+        else:
+            return "INVALID DateTime"

     }
 };
 
     }
 };
 


@@ -887,12 +946,13 @@ public:
         wxTimeSpan __sub__(const wxTimeSpan& other) { return *self - other; }
         wxTimeSpan __mul__(int n)                   { return *self * n; }
         wxTimeSpan __rmul__(int n)                  { return n * *self; }
         wxTimeSpan __sub__(const wxTimeSpan& other) { return *self - other; }
         wxTimeSpan __mul__(int n)                   { return *self * n; }
         wxTimeSpan __rmul__(int n)                  { return n * *self; }

-        bool __lt__(const wxTimeSpan& other) { return *self <  other; }
-        bool __le__(const wxTimeSpan& other) { return *self <= other; }
-        bool __gt__(const wxTimeSpan& other) { return *self >  other; }
-        bool __ge__(const wxTimeSpan& other) { return *self >= other; }
-        bool __eq__(const wxTimeSpan& other) { return *self == other; }
-        bool __ne__(const wxTimeSpan& other) { return *self != other; }
+        
+        bool __lt__(const wxTimeSpan* other) { return other ? (*self <  *other) : false; }
+        bool __le__(const wxTimeSpan* other) { return other ? (*self <= *other) : false; }
+        bool __gt__(const wxTimeSpan* other) { return other ? (*self >  *other) : true;  }
+        bool __ge__(const wxTimeSpan* other) { return other ? (*self >= *other) : true;  }
+        bool __eq__(const wxTimeSpan* other) { return other ? (*self == *other) : false; }
+        bool __ne__(const wxTimeSpan* other) { return other ? (*self != *other) : true;  }

     }
 
 
     }
 
 


@@ -948,13 +1008,14 @@ public:
         // resulting text representation. Notice that only some of format
         // specifiers valid for wxDateTime are valid for wxTimeSpan: hours,
         // minutes and seconds make sense, but not "PM/AM" string for example.
         // resulting text representation. Notice that only some of format
         // specifiers valid for wxDateTime are valid for wxTimeSpan: hours,
         // minutes and seconds make sense, but not "PM/AM" string for example.

-    wxString Format(const wxString& format = wxPyTimeSpanFormatStr) const;
+    wxString Format(const wxString& format = wxPyDefaultTimeSpanFormat) const;

 
     %pythoncode {
      def __repr__(self):
 
     %pythoncode {
      def __repr__(self):

-         return '<wxTimeSpan: \"%s\" at %s>' % ( self.Format(), self.this)
+         f = self.Format().encode(wx.GetDefaultPyEncoding())
+         return '<wx.TimeSpan: \"%s\" at %s>' % ( f, self.this)

      def __str__(self):
      def __str__(self):

-         return self.Format()
+         return self.Format().encode(wx.GetDefaultPyEncoding())

      }
 };
 
      }
 };
 


@@ -1072,12 +1133,14 @@ public:
         wxDateSpan __sub__(const wxDateSpan& other) { return *self - other; }
         wxDateSpan __mul__(int n)                   { return *self * n; }
         wxDateSpan __rmul__(int n)                  { return n * *self; }
         wxDateSpan __sub__(const wxDateSpan& other) { return *self - other; }
         wxDateSpan __mul__(int n)                   { return *self * n; }
         wxDateSpan __rmul__(int n)                  { return n * *self; }

-//         bool __lt__(const wxDateSpan& other) { return *self <  other; }
-//         bool __le__(const wxDateSpan& other) { return *self <= other; }
-//         bool __gt__(const wxDateSpan& other) { return *self >  other; }
-//         bool __ge__(const wxDateSpan& other) { return *self >= other; }
-        bool __eq__(const wxDateSpan& other) { return *self == other; }
-        bool __ne__(const wxDateSpan& other) { return *self != other; }
+        
+//         bool __lt__(const wxDateSpan* other) { return other ? (*self <  *other) : false; }
+//         bool __le__(const wxDateSpan* other) { return other ? (*self <= *other) : false; }
+//         bool __gt__(const wxDateSpan* other) { return other ? (*self >  *other) : true;  }
+//         bool __ge__(const wxDateSpan* other) { return other ? (*self >= *other) : true;  }
+        
+        bool __eq__(const wxDateSpan* other) { return other ? (*self == *other) : false; }
+        bool __ne__(const wxDateSpan* other) { return other ? (*self != *other) : true;  }

     }
 };
 
     }
 };
 


@@ -1093,5 +1156,9 @@ long wxGetUTCTime();
 long wxGetCurrentTime();
 wxLongLong wxGetLocalTimeMillis();
 
 long wxGetCurrentTime();
 wxLongLong wxGetLocalTimeMillis();
 

+%immutable;
+const wxDateTime        wxDefaultDateTime;
+%mutable;
+

 //---------------------------------------------------------------------------
 //---------------------------------------------------------------------------
 //---------------------------------------------------------------------------
 //---------------------------------------------------------------------------