Inheritance diagram for wx.DateTime:
wx.DateTime class represents an absolute moment in the time.
Adds the wx.DateSpan diff to self.
Parameters:
Returns:
Adds the wx.TimeSpan diff to self.
Parameters:
Returns:
Converts the year in absolute notation (i.e. a number which can be negative, positive or zero) to the year in BC/AD notation. For the positive years, nothing is done, but the year 0 is year 1 BC and so for other years there is a difference of 1.
Parameters:
Returns:
int
This function does the same as the standard ANSI C strftime(3) function. Please see its description for the meaning of format parameter.
Parameters:
Returns:
string
See also
Identical to calling Format with "%x" argument (which means ‘preferred date representation for the current locale’).
Returns:
string
This function returns the date representation in the ISO 8601 format (YYYY-MM-DD).
Returns:
string
This function returns the time representation in the ISO 8601 format (HH:MM:SS).
Returns:
string
Identical to calling Format with "%X" argument (which means ‘preferred time representation for the current locale’).
Returns:
string
Transform the date from the given time zone to the local one. If noDST is True, no DST adjustments will be made.
Returns the date in the local time zone.
Parameters:
Returns:
Parameters:
Returns:
Returns the translations of the strings AM and PM used for time formatting for the current locale. Either of the pointers may be None if the corresponding value is not needed.
Returns:
(am, pm)
Get the beginning of DST for the given country in the given year (current one by default).
Parameters:
Returns:
See also
Returns the century of this date.
Parameters:
Returns:
int
Returns the current default country. The default country is used for DST calculations, for example.
Returns:
int
See also
Get the current month in given calendar (only Gregorian is currently supported).
Parameters:
Returns:
int
Get the current year in given calendar (only Gregorian is currently supported).
Parameters:
Returns:
int
Returns the object having the same date component as this one but time of 00:00:00.
This function is new since wxWidgets version 2.8.2
Returns:
See also
Returns the day in the given timezone (local one by default).
Returns:
int
Returns the day of the year (in 1...366 range) in the given timezone (local one by default).
Returns:
int
Returns the end of DST for the given country in the given year (current one by default).
Parameters:
Returns:
See also
Returns the hour in the given timezone (local one by default).
Returns:
int
Synonym for GetJulianDayNumber.
Returns:
double
Warning
Beware of rounding errors!
See also
Returns the copy of this object to which SetToLastMonthDay was applied.
Parameters:
Returns:
Returns the copy of this object to which SetToLastWeekDay was applied.
Parameters:
Returns:
Synonym for GetModifiedJulianDayNumber.
Returns:
double
Returns the milliseconds in the given timezone (local one by default).
Returns:
int
Returns the minute in the given timezone (local one by default).
Returns:
int
Returns the Modified Julian Day Number (MJD) which is, by definition, equal to JDN - 2400000.5.
The MJDs are simpler to work with as the integral MJDs correspond to midnights of the dates in the Gregorian calendar and not th noons like JDN. The MJD 0 is Nov 17, 1858.
Returns:
double
Returns the month in the given timezone (local one by default).
Returns:
int
Gets the full (default) or abbreviated (specify wx.DateTime.Name_Abbr name of the given month.
Parameters:
Returns:
string
See also
Returns the copy of this object to which SetToNextWeekDay was applied.
Parameters:
Returns:
Returns the number of days in the given month of the given year, using the specified calendar.
Parameters:
Returns:
int
Returns the number of days in the given year, using the specified calendar.
Parameters:
Returns:
int
Returns the copy of this object to which SetToPrevWeekDay was applied.
Parameters:
Returns:
Return the Rata Die number of this date.
By definition, the Rata Die number is a date specified as the number of days relative to a base date of December 31 of the year 0. Thus January 1 of the year 1 is Rata Die day 1.
Returns:
double
Returns the seconds in the given timezone (local one by default).
Returns:
int
Returns the number of seconds since Jan 1, 1970. An assert failure will occur if the date is not in the range covered by time_t type.
Returns:
time_t
Returns the copy of this object to which SetToWeekDay was applied.
Parameters:
Returns:
Returns the copy of this object to which SetToWeekDayInSameWeek was applied.
Parameters:
Returns:
Gets the full (default) or abbreviated (specify wx.DateTime.Name_Abbr name of the given week day.
Parameters:
Returns:
string
See also
Returns the ordinal number of the week in the month (in 1...5 range).
As GetWeekOfYear, this function supports both conventions for the week start.
Parameters:
Returns:
int
Returns the number of the week of the year this date is in.
The first week of the year is, according to international standards, the one containing Jan 4 or, equivalently, the first week which has Thursday in this year. Both of these definitions are the same as saying that the first week of the year must contain more than half of its days in this year.
Accordingly, the week number will always be in 1...53 range (52 for non-leap years).
The function depends on the convention specified by the flags argument but its results for wx.DateTime.Sunday_First are not well-defined as the ISO definition quoted above applies to the weeks starting on Monday only.
Parameters:
Returns:
int
Returns the year in the given timezone (local one by default).
Returns:
int
Returns the copy of this object to which SetToYearDay was applied.
Parameters:
Returns:
Returns True if IsStrictlyBetween is True or if the date is equal to one of the limit values.
Parameters:
Returns:
bool
See also
Returns True if the DST is applied for this date in the given country.
Parameters:
Returns:
int
Returns True if DST was used n the given year (the current one by default) in the given country.
Parameters:
Returns:
bool
Returns True if this date precedes the given one.
Parameters:
Returns:
bool
Returns True if the two dates are strictly identical.
Parameters:
Returns:
bool
Returns True if the date is equal to another one up to the given time interval, i.e. if the absolute difference between the two dates is less than this interval.
Parameters:
Returns:
bool
Returns True if this date is later than the given one.
Parameters:
Returns:
bool
Returns True if the year is a leap one in the specified calendar.
This functions supports Gregorian and Julian calendars.
Parameters:
Returns:
bool
Returns True if the date is the same without comparing the time parts.
Parameters:
Returns:
bool
Returns True if the time is the same (although dates may differ).
Parameters:
Returns:
bool
Returns True if this date lies strictly between the two others,
Parameters:
Returns:
bool
See also
Returns True if the object represents a valid time moment.
Returns:
bool
This function returns True if the specified (or default) country is one of Western European ones.
It is used internally by wx.DateTime to determine the DST convention and date and time formatting rules.
Parameters:
Returns:
bool
Returns True is this day is not a holiday in the given country.
Parameters:
Returns:
bool
Same as FromTimezone but modifies the object in place.
Returns:
Parameters:
Returns:
Parameters:
Returns:
Modifies the object in place to represent the date in another time zone. If noDST is True, no DST adjustments will be made.
Returns:
This is the same as calling MakeTimezone with the argument wx.DateTime.GMT0.
Parameters:
Returns:
Returns the object corresponding to the current time.
Returns:
Note
Note that this function is accurate up to second: UNow should be used for better precision (but it is less efficient and might not be available on all platforms).
See also
This function is like ParseDateTime, but it only allows the date to be specified. It is thus less flexible then ParseDateTime, but also has less chances to misinterpret the user input.
Returns None if the conversion failed, otherwise return the pointer to the character which stopped the scan.
Parameters:
Returns:
string
Parses the string datetime containing the date and time in free format. 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.
Returns None if the conversion failed, otherwise return the pointer to the character which stopped the scan.
Parameters:
Returns:
string
This function parses the string date according to the given format. The system strptime(3) function is used whenever available, but even if it is not, this function is still implemented, although support for locale-dependent format specifiers such as "%c", "%x" or "%X" may not be perfect and GNU extensions such as "%z" and "%Z" are not implemented. This function does handle the month and weekday names in the current locale on all platforms, however.
Please see the description of the ANSI C function strftime(3) for the syntax of the format string.
The dateDef parameter is used to fill in the fields which could not be determined from the format string. For example, if the format is "%d" (the ay of the month), the month and the year are taken from dateDef. If it is not specified, Today is used as the default date.
Returns None if the conversion failed, otherwise return the pointer to the character which stopped the scan.
Parameters:
Returns:
string
Parses the string date looking for a date formatted according to the RFC 822 in it. The exact description of this format may, of course, be found in the RFC (section 5), but, briefly, this is the format used in the headers of Internet email messages and one of the most common strings expressing date in this format may be something like "Sat, 18 Dec 1999 00:48:30 +0100".
Returns None if the conversion failed, otherwise return the pointer to the character immediately following the part of the string which could be parsed. If the entire string contains only the date in RFC 822 format, the returned pointer will be pointing to a NULL character.
This function is intentionally strict, it will return an error for any string which is not RFC 822 compliant. If you need to parse date formatted in more free ways, you should use ParseDateTime or ParseDate instead.
Parameters:
Returns:
string
This functions is like ParseDateTime, but only allows the time to be specified in the input string.
Returns None if the conversion failed, otherwise return the pointer to the character which stopped the scan.
Parameters:
Returns:
string
Reset time to midnight (00:00:00) without changing the date.
Returns:
Sets the date and time from the parameters.
Parameters:
Returns:
Sets the country to use by default. This setting influences the DST calculations, date formatting and other things.
Parameters:
See also
Sets the day without changing other date components.
Parameters:
Returns:
Parameters:
Returns:
Sets the hour without changing other date components.
Parameters:
Returns:
Parameters:
Returns:
Sets the millisecond without changing other date components.
Parameters:
Returns:
Sets the minute without changing other date components.
Parameters:
Returns:
Sets the month without changing other date components.
Parameters:
Returns:
Sets the second without changing other date components.
Parameters:
Returns:
Parameters:
Returns:
Sets the date and time of to the current values. Same as assigning the result of Now to this object.
Returns:
Sets the date to the last day in the specified month (the current one by default). Returns the reference to the modified object itself.
Parameters:
Returns:
The effect of calling this function is the same as of calling SetToWeekDay (-1, weekday, month, year).
The date will be set to the last weekday in the given month and year (the current ones by default).
Always returns True.
Parameters:
Returns:
bool
Sets the date so that it will be the first weekday following the current date.
Returns the reference to the modified object itself.
Parameters:
Returns:
Sets the date so that it will be the last weekday before the current date.
Returns the reference to the modified object itself.
Parameters:
Returns:
Sets the date to the n -th weekday in the given month of the given year (the current month and year are used by default). The parameter n may be either positive (counting from the beginning of the month) or negative (counting from the end of it).
For example, SetToWeekDay(2, wx.DateTime.Wed) will set the date to the second Wednesday in the current month and SetToWeekDay(-1, wx.DateTime.Sun) – to the last Sunday in it.
Returns True if the date was modified successfully, False otherwise meaning that the specified date doesn’t exist.
Parameters:
Returns:
bool
Adjusts the date so that it will still lie in the same week as before, but its week day will be the given one.
Returns the reference to the modified object itself.
Parameters:
Returns:
Set the date to the given weekday in the week number numWeek of the given year. The number should be in range 1...53.
Parameters:
Returns:
Note
Note that the returned date may be in a different year than the one passed to this function because both the week 1 and week 52 or 53 (for leap years) contain days from different years. See GetWeekOfYear for the explanation of how the year weeks are counted.
Sets the date to the day number yday in the same year (i.e., unlike the other functions, this one does not use the current year). The day number should be in the range 1...366 for the leap years and 1...365 for the other ones.
Returns the reference to the modified object itself.
Parameters:
Returns:
Sets the year without changing other date components.
Parameters:
Returns:
Subtracts another date from this one and returns the difference between them as wx.TimeSpan.
Parameters:
Returns:
Subtracts the wx.DateSpan diff from self.
Parameters:
Returns:
Subtracts the wx.TimeSpan diff from self.
Parameters:
Returns:
Parameters:
Returns:
Transform the date to the given time zone. If noDST is True, no DST adjustments will be made.
Returns the date in the new time zone.
Returns:
This is the same as calling ToTimezone with the argument wx.DateTime.GMT0.
Parameters:
Returns:
Returns the object corresponding to the midnight of the current day (i.e. the same as Now, but the time part is set to 0).
Returns:
See also
Returns the object corresponding to the current time including the milliseconds if a function to get time with such precision is available on the current platform (supported under most Unices and Win32).
Returns:
See also
