wxDateTime class represents an absolute moment in the time.
Types
The type wxDateTime_t is typedefed as unsigned short and is used to contain the number of years, hours, minutes, seconds and milliseconds.
Constants
Global constant wxDefaultDateTime and synonym for it wxInvalidDateTime are defined. This constant will be different from any valid wxDateTime object.
All the following constants are defined inside wxDateTime class (i.e., to refer to them you should prepend their names with wxDateTime::).
Time zone symbolic names:
enum TZ { // the time in the current time zone Local, // zones from GMT (= Greenwhich Mean Time): they're guaranteed to be // consequent numbers, so writing something like `GMT0 + offset' is // safe if abs(offset) <= 12 // underscore stands for minus GMT_12, GMT_11, GMT_10, GMT_9, GMT_8, GMT_7, GMT_6, GMT_5, GMT_4, GMT_3, GMT_2, GMT_1, GMT0, GMT1, GMT2, GMT3, GMT4, GMT5, GMT6, GMT7, GMT8, GMT9, GMT10, GMT11, GMT12, // Note that GMT12 and GMT_12 are not the same: there is a difference // of exactly one day between them // some symbolic names for TZ // Europe WET = GMT0, // Western Europe Time WEST = GMT1, // Western Europe Summer Time CET = GMT1, // Central Europe Time CEST = GMT2, // Central Europe Summer Time EET = GMT2, // Eastern Europe Time EEST = GMT3, // Eastern Europe Summer Time MSK = GMT3, // Moscow Time MSD = GMT4, // Moscow Summer Time // US and Canada AST = GMT_4, // Atlantic Standard Time ADT = GMT_3, // Atlantic Daylight Time EST = GMT_5, // Eastern Standard Time EDT = GMT_4, // Eastern Daylight Saving Time CST = GMT_6, // Central Standard Time CDT = GMT_5, // Central Daylight Saving Time MST = GMT_7, // Mountain Standard Time MDT = GMT_6, // Mountain Daylight Saving Time PST = GMT_8, // Pacific Standard Time PDT = GMT_7, // Pacific Daylight Saving Time HST = GMT_10, // Hawaiian Standard Time AKST = GMT_9, // Alaska Standard Time AKDT = GMT_8, // Alaska Daylight Saving Time // Australia A_WST = GMT8, // Western Standard Time A_CST = GMT12 + 1, // Central Standard Time (+9.5) A_EST = GMT10, // Eastern Standard Time A_ESST = GMT11, // Eastern Summer Time // Universal Coordinated Time = the new and politically correct name // for GMT UTC = GMT0 };Month names: Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec and Inv_Month for an invalid.month value are the values of wxDateTime::Month enum.
Likely, Sun, Mon, Tue, Wed, Thu, Fri, Sat, and Inv_WeekDay are the values in wxDateTime::WeekDay enum.
Finally, Inv_Year is defined to be an invalid value for year parameter.
Derived from
No base class
Include files
<wx/datetime.h>
See also
wxTimeSpan, wxDateSpan, wxCalendarCtrl
Function groups
Static functions
Constructors, assignment operators and setters
Accessors
Date comparison
Date arithmetics
Parsing and formatting dates
Calendar calculations
Astronomical/historical functions
Time zone support
wxDateTime::ConvertYearToBC
wxDateTime::GetAmPmStrings
wxDateTime::GetBeginDST
wxDateTime::GetCountry
wxDateTime::GetCurrentYear
wxDateTime::GetCurrentMonth
wxDateTime::GetCentury
wxDateTime::GetEndDST
wxDateTime::GetMonthName
wxDateTime::GetNumberOfDays
wxDateTime::GetWeekDayName
wxDateTime::IsLeapYear
wxDateTime::IsWestEuropeanCountry
wxDateTime::IsDSTApplicable
wxDateTime::Now
wxDateTime::SetCountry
wxDateTime::Today
For convenience, all static functions are collected here. These functions either set or return the static variables of wxDateSpan (the country), return the current moment, year, month or number of days in it, or do some general calendar-related actions.
SetCountry
GetCountry
IsWestEuropeanCountry
GetCurrentYear
ConvertYearToBC
GetCurrentMonth
IsLeapYear
GetCentury
GetNumberOfDays
GetNumberOfDays
GetMonthName
GetWeekDayName
GetAmPmStrings
IsDSTApplicable
GetBeginDST
GetEndDST
Now
Today
static int ConvertYearToBC(int year)
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.
This function should be used like this:
wxDateTime dt(...); int y = dt.GetYear(); printf("The year is %d%s", wxDateTime::ConvertYearToBC(y), y > 0 ? "AD" : "BC");
static void GetAmPmStrings(wxString *am, wxString *pm)
static wxDateTime GetBeginDST(int year = Inv_Year, Country country = Country_Default)
static Country GetCountry()
static int GetCurrentYear(Calendar cal = Gregorian)
static Month GetCurrentMonth(Calendar cal = Gregorian)
static int GetCentury(int year = Inv_Year)
static wxDateTime GetEndDST(int year = Inv_Year, Country country = Country_Default)
static wxString GetMonthName(Month month, NameFlags flags = Name_Full)
static wxDateTime_t GetNumberOfDays(int year, Calendar cal = Gregorian)
static wxDateTime_t GetNumberOfDays(Month month, int year = Inv_Year, Calendar cal = Gregorian)
static wxString GetWeekDayName(WeekDay weekday, NameFlags flags = Name_Full)
static bool IsLeapYear(int year = Inv_Year, Calendar cal = Gregorian)
static bool IsWestEuropeanCountry(Country country = Country_Default)
static bool IsDSTApplicable(int year = Inv_Year, Country country = Country_Default)
static wxDateTime Now()
static void SetCountry(Country country)
static wxDateTime Today()