Lines Matching refs:wxDateTime
3 %% Purpose: wxDateTime documentation
12 \section{\class{wxDateTime}}\label{wxdatetime}
14 wxDateTime class represents an absolute moment in the time.
18 The type {\tt wxDateTime\_t} is typedefed as {\tt unsigned short} and is used
24 wxDateTime object.
26 All the following constants are defined inside wxDateTime class (i.e., to refer to
27 them you should prepend their names with {\tt wxDateTime::}).
95 Inv\_Month for an invalid.month value are the values of {\tt wxDateTime::Month}
99 {\tt wxDateTime::WeekDay} enum.
127 Date calculations often depend on the country and wxDateTime allows to set the
200 {\tt wxDateTime\_<StaticMethodName>} in wxPython.}
230 \helpref{wxDateTime()}{wxdatetimewxdatetimedef}\\
231 \helpref{wxDateTime(time\_t)}{wxdatetimewxdatetimetimet}\\
232 \helpref{wxDateTime(struct tm)}{wxdatetimewxdatetimetm}\\
233 %\helpref{wxDateTime(struct Tm)}{wxdatetimewxdatetimetm} - Tm not documented yet\\
234 \helpref{wxDateTime(double jdn)}{wxdatetimewxdatetimejdn}\\
235 \helpref{wxDateTime(h, m, s, ms)}{wxdatetimewxdatetimetime}\\
236 \helpref{wxDateTime(day, mon, year, h, m, s, ms)}{wxdatetimewxdatetimedate}\\
286 global operators $>$, $<$ etc taking wxDateTime are defined.
300 These functions carry out \helpref{arithmetics}{tdatearithm} on the wxDateTime
302 added to wxDateTime, hence all functions are overloaded to accept both
315 \helpref{Subtract(wxDateTime)}{wxdatetimesubtractdt}\\
324 These functions convert wxDateTime objects to and from text. The
373 wxDateTime -- they only work with the date part of it.
395 provided. You can construct a wxDateTime object from a
400 \helpref{wxDateTime(double jdn)}{wxdatetimewxdatetimejdn}\\
433 \membersection{wxDateTime::ConvertYearToBC}\label{wxdatetimeconvertyeartobc}
445 wxDateTime dt(...);
447 printf("The year is %d%s", wxDateTime::ConvertYearToBC(y), y > 0 ? "AD" : "BC");
451 \membersection{wxDateTime::GetAmPmStrings}\label{wxdatetimegetampmstrings}
460 \membersection{wxDateTime::GetBeginDST}\label{wxdatetimegetbegindst}
462 \func{static wxDateTime}{GetBeginDST}{\param{int }{year = Inv\_Year}, \param{Country }{country = Country\_Default}}
473 \membersection{wxDateTime::GetCountry}\label{wxdatetimegetcountry}
485 \membersection{wxDateTime::GetCurrentYear}\label{wxdatetimegetcurrentyear}
492 \membersection{wxDateTime::GetCurrentMonth}\label{wxdatetimegetcurrentmonth}
499 \membersection{wxDateTime::GetCentury}\label{wxdatetimegetcenturystatic}
507 \membersection{wxDateTime::GetEndDST}\label{wxdatetimegetenddst}
509 \func{static wxDateTime}{GetEndDST}{\param{int }{year = Inv\_Year}, \param{Country }{country = Country\_Default}}
519 \membersection{wxDateTime::GetMonthName}\label{wxdatetimegetmonthname}
531 \membersection{wxDateTime::GetNumberOfDays}\label{wxdatetimegetnumberofdays}
533 \func{static wxDateTime\_t}{GetNumberOfDays}{\param{int }{year}, \param{Calendar }{cal = Gregorian}}
535 \func{static wxDateTime\_t}{GetNumberOfDays}{\param{Month }{month}, \param{int }{year = Inv\_Year}, \param{Calendar }{cal = Gregorian}}
546 \membersection{wxDateTime::GetTimeNow}\label{wxdatetimegettimenow}
553 \membersection{wxDateTime::GetTmNow}\label{wxdatetimegettmnow}
560 \membersection{wxDateTime::GetTmNow}
568 the flavour of function \helpref{wxDateTime::GetTmNow}{wxdatetimegettmnow}
571 \membersection{wxDateTime::GetWeekDayName}\label{wxdatetimegetweekdayname}
583 \membersection{wxDateTime::IsLeapYear}\label{wxdatetimeisleapyear}
592 \membersection{wxDateTime::IsWestEuropeanCountry}\label{wxdatetimeiswesteuropeancountry}
597 of Western European ones. It is used internally by wxDateTime to determine the
601 \membersection{wxDateTime::IsDSTApplicable}\label{wxdatetimeisdstapplicable}
609 \membersection{wxDateTime::Now}\label{wxdatetimenow}
611 \func{static wxDateTime}{Now}{\void}
618 wxDateTime now = wxDateTime::Now();
619 printf("Current time in Paris:\t%s\n", now.Format("%c", wxDateTime::CET).c_str());
623 \helpref{wxDateTime::UNow}{wxdatetimeunow} should be used for better precision
631 \membersection{wxDateTime::SetCountry}\label{wxdatetimesetcountry}
639 \helpref{wxDateTime constants section}{wxdatetime}.
646 \membersection{wxDateTime::Today}\label{wxdatetimetoday}
648 \func{static wxDateTime}{Today}{\void}
658 \membersection{wxDateTime::UNow}\label{wxdatetimeunow}
660 \func{static wxDateTime}{UNow}{\void}
673 \membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimedef}
675 \func{}{wxDateTime}{\void}
681 \membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimetimet}
683 \func{wxDateTime\&}{wxDateTime}{\param{time\_t }{timet}}
690 \membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimetm}
692 \func{wxDateTime\&}{wxDateTime}{\param{const struct tm\& }{tm}}
699 \membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimejdn}
701 \func{wxDateTime\&}{wxDateTime}{\param{double }{jdn}}
708 \membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimetime}
710 \func{wxDateTime\&}{wxDateTime}{\param{wxDateTime\_t }{hour}, \param{wxDateTime\_t }{minute = 0}, \param{wxDateTime\_t }{second = 0}, \param{wxDateTime\_t }{millisec = 0}}
717 \membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimedate}
719 \func{wxDateTime\&}{wxDateTime}{\param{wxDateTime\_t }{day}, \param{Month }{month = Inv\_Month}, \param{int}{ Inv\_Year},
720 \param{wxDateTime\_t }{hour = 0}, \param{wxDateTime\_t }{minute = 0}, \param{wxDateTime\_t }{second = 0}, \param{wxDateTime\_t }{millisec = 0}}
727 \membersection{wxDateTime::SetToCurrent}\label{wxdatetimesettocurrent}
729 \func{wxDateTime\&}{SetToCurrent}{\void}
735 \membersection{wxDateTime::Set}\label{wxdatetimesettimet}
737 \func{wxDateTime\&}{Set}{\param{time\_t }{timet}}
745 \membersection{wxDateTime::Set}\label{wxdatetimesettm}
747 \func{wxDateTime\&}{Set}{\param{const struct tm\& }{tm}}
755 \membersection{wxDateTime::Set}\label{wxdatetimesetjdn}
757 \func{wxDateTime\&}{Set}{\param{double }{jdn}}
769 \membersection{wxDateTime::Set}\label{wxdatetimesettime}
771 \func{wxDateTime\&}{Set}{\param{wxDateTime\_t }{hour}, \param{wxDateTime\_t }{minute = 0}, \param{wxDateTime\_t }{second = 0}, \param{wxDateTime\_t }{millisec = 0}}
779 \membersection{wxDateTime::Set}\label{wxdatetimesetdate}
781 \func{wxDateTime\&}{Set}{\param{wxDateTime\_t }{day}, \param{Month }{month = Inv\_Month}, \param{int }{year = Inv\_Year}, \param{wxDateTime\_t }{hour = 0}, \param{wxDateTime\_t }{minute = 0}, \param{wxDateTime\_t }{second = 0}, \param{wxDateTime\_t }{millisec = 0}}
786 \membersection{wxDateTime::ResetTime}\label{wxdatetimeresettime}
788 \func{wxDateTime\&}{ResetTime}{\void}
793 \membersection{wxDateTime::SetYear}\label{wxdatetimesetyear}
795 \func{wxDateTime\&}{SetYear}{\param{int }{year}}
800 \membersection{wxDateTime::SetMonth}\label{wxdatetimesetmonth}
802 \func{wxDateTime\&}{SetMonth}{\param{Month }{month}}
807 \membersection{wxDateTime::SetDay}\label{wxdatetimesetday}
809 \func{wxDateTime\&}{SetDay}{\param{wxDateTime\_t }{day}}
814 \membersection{wxDateTime::SetHour}\label{wxdatetimesethour}
816 \func{wxDateTime\&}{SetHour}{\param{wxDateTime\_t }{hour}}
821 \membersection{wxDateTime::SetMinute}\label{wxdatetimesetminute}
823 \func{wxDateTime\&}{SetMinute}{\param{wxDateTime\_t }{minute}}
828 \membersection{wxDateTime::SetSecond}\label{wxdatetimesetsecond}
830 \func{wxDateTime\&}{SetSecond}{\param{wxDateTime\_t }{second}}
835 \membersection{wxDateTime::SetMillisecond}\label{wxdatetimesetmillisecond}
837 \func{wxDateTime\&}{SetMillisecond}{\param{wxDateTime\_t }{millisecond}}
842 \membersection{wxDateTime::operator$=$}\label{wxdatetimeoperatoreqtimet}
844 \func{wxDateTime\&}{operator}{\param{time\_t }{timet}}
849 \membersection{wxDateTime::operator$=$}\label{wxdatetimeoperatoreqtm}
851 \func{wxDateTime\&}{operator}{\param{const struct tm\& }{tm}}
858 \membersection{wxDateTime::IsValid}\label{wxdatetimeisvalid}
865 \membersection{wxDateTime::GetDateOnly}\label{wxdatetimegetdateonly}
867 \constfunc{wxDateTime}{GetDateOnly}{\void}
879 \membersection{wxDateTime::GetTm}\label{wxdatetimegettm}
886 \membersection{wxDateTime::GetTicks}\label{wxdatetimegetticks}
894 \membersection{wxDateTime::GetCentury}\label{wxdatetimegetcentury}
901 \membersection{wxDateTime::GetYear}\label{wxdatetimegetyear}
908 \membersection{wxDateTime::GetMonth}\label{wxdatetimegetmonth}
915 \membersection{wxDateTime::GetDay}\label{wxdatetimegetday}
917 \constfunc{wxDateTime\_t}{GetDay}{\param{const TimeZone\& }{tz = Local}}
922 \membersection{wxDateTime::GetWeekDay}\label{wxdatetimegetweekday}
929 \membersection{wxDateTime::GetHour}\label{wxdatetimegethour}
931 \constfunc{wxDateTime\_t}{GetHour}{\param{const TimeZone\& }{tz = Local}}
936 \membersection{wxDateTime::GetMinute}\label{wxdatetimegetminute}
938 \constfunc{wxDateTime\_t}{GetMinute}{\param{const TimeZone\& }{tz = Local}}
943 \membersection{wxDateTime::GetSecond}\label{wxdatetimegetsecond}
945 \constfunc{wxDateTime\_t}{GetSecond}{\param{const TimeZone\& }{tz = Local}}
950 \membersection{wxDateTime::GetMillisecond}\label{wxdatetimegetmillisecond}
952 \constfunc{wxDateTime\_t}{GetMillisecond}{\param{const TimeZone\& }{tz = Local}}
957 \membersection{wxDateTime::GetDayOfYear}\label{wxdatetimegetdayofyear}
959 \constfunc{wxDateTime\_t}{GetDayOfYear}{\param{const TimeZone\& }{tz = Local}}
965 \membersection{wxDateTime::GetWeekOfYear}\label{wxdatetimegetweekofyear}
967 \constfunc{wxDateTime\_t}{GetWeekOfYear}{\param{WeekFlags }{flags = Monday\_First}, \param{const TimeZone\& }{tz = Local}}
982 \membersection{wxDateTime::GetWeekOfMonth}\label{wxdatetimegetweekofmonth}
984 \constfunc{wxDateTime\_t}{GetWeekOfMonth}{\param{WeekFlags }{flags = Monday\_First}, \param{const TimeZone\& }{tz = Local}}
993 \membersection{wxDateTime::IsWorkDay}\label{wxdatetimeisworkday}
1000 \membersection{wxDateTime::IsGregorianDate}\label{wxdatetimeisgregoriandate}
1011 \membersection{wxDateTime::SetFromDOS}\label{wxdatetimesetfromdos}
1013 \func{wxDateTime\&}{Set}{\param{unsigned long }{ddt}}
1020 \membersection{wxDateTime::GetAsDOS}\label{wxdatetimegetasdos}
1031 \membersection{wxDateTime::IsEqualTo}\label{wxdatetimeisequalto}
1033 \constfunc{bool}{IsEqualTo}{\param{const wxDateTime\& }{datetime}}
1038 \membersection{wxDateTime::IsEarlierThan}\label{wxdatetimeisearlierthan}
1040 \constfunc{bool}{IsEarlierThan}{\param{const wxDateTime\& }{datetime}}
1045 \membersection{wxDateTime::IsLaterThan}\label{wxdatetimeislaterthan}
1047 \constfunc{bool}{IsLaterThan}{\param{const wxDateTime\& }{datetime}}
1052 \membersection{wxDateTime::IsStrictlyBetween}\label{wxdatetimeisstrictlybetween}
1054 \constfunc{bool}{IsStrictlyBetween}{\param{const wxDateTime\& }{t1}, \param{const wxDateTime\& }{t2}}
1063 \membersection{wxDateTime::IsBetween}\label{wxdatetimeisbetween}
1065 \constfunc{bool}{IsBetween}{\param{const wxDateTime\& }{t1}, \param{const wxDateTime\& }{t2}}
1075 \membersection{wxDateTime::IsSameDate}\label{wxdatetimeissamedate}
1077 \constfunc{bool}{IsSameDate}{\param{const wxDateTime\& }{dt}}
1082 \membersection{wxDateTime::IsSameTime}\label{wxdatetimeissametime}
1084 \constfunc{bool}{IsSameTime}{\param{const wxDateTime\& }{dt}}
1089 \membersection{wxDateTime::IsEqualUpTo}\label{wxdatetimeisequalupto}
1091 \constfunc{bool}{IsEqualUpTo}{\param{const wxDateTime\& }{dt}, \param{const wxTimeSpan\& }{ts}}
1100 \membersection{wxDateTime::Add}\label{wxdatetimeaddts}
1102 \constfunc{wxDateTime}{Add}{\param{const wxTimeSpan\& }{diff}}
1104 \func{wxDateTime\&}{Add}{\param{const wxTimeSpan\& }{diff}}
1106 \func{wxDateTime\&}{operator$+=$}{\param{const wxTimeSpan\& }{diff}}
1114 \membersection{wxDateTime::Add}\label{wxdatetimeaddds}
1116 \constfunc{wxDateTime}{Add}{\param{const wxDateSpan\& }{diff}}
1118 \func{wxDateTime\&}{Add}{\param{const wxDateSpan\& }{diff}}
1120 \func{wxDateTime\&}{operator$+=$}{\param{const wxDateSpan\& }{diff}}
1128 \membersection{wxDateTime::Subtract}\label{wxdatetimesubtractts}
1130 \constfunc{wxDateTime}{Subtract}{\param{const wxTimeSpan\& }{diff}}
1132 \func{wxDateTime\&}{Subtract}{\param{const wxTimeSpan\& }{diff}}
1134 \func{wxDateTime\&}{operator$-=$}{\param{const wxTimeSpan\& }{diff}}
1142 \membersection{wxDateTime::Subtract}\label{wxdatetimesubtractds}
1144 \constfunc{wxDateTime}{Subtract}{\param{const wxDateSpan\& }{diff}}
1146 \func{wxDateTime\&}{Subtract}{\param{const wxDateSpan\& }{diff}}
1148 \func{wxDateTime\&}{operator$-=$}{\param{const wxDateSpan\& }{diff}}
1156 \membersection{wxDateTime::Subtract}\label{wxdatetimesubtractdt}
1158 \constfunc{wxTimeSpan}{Subtract}{\param{const wxDateTime\& }{dt}}
1166 \membersection{wxDateTime::ParseRfc822Date}\label{wxdatetimeparserfc822date}
1187 \membersection{wxDateTime::ParseFormat}\label{wxdatetimeparseformat}
1189 \func{const wxChar *}{ParseFormat}{\param{const wxChar *}{date}, \param{const wxChar *}{format = wxDefaultDateTimeFormat}, \param{const wxDateTime\& }{dateDef = wxDefaultDateTime}}
1212 \membersection{wxDateTime::ParseDateTime}\label{wxdatetimeparsedatetime}
1226 \membersection{wxDateTime::ParseDate}\label{wxdatetimeparsedate}
1239 \membersection{wxDateTime::ParseTime}\label{wxdatetimeparsetime}
1250 \membersection{wxDateTime::Format}\label{wxdatetimeformat}
1266 \membersection{wxDateTime::FormatDate}\label{wxdatetimeformatdate}
1274 \membersection{wxDateTime::FormatTime}\label{wxdatetimeformattime}
1282 \membersection{wxDateTime::FormatISODate}\label{wxdatetimeformatisodate}
1290 \membersection{wxDateTime::FormatISOTime}\label{wxdatetimeformatisotime}
1300 \membersection{wxDateTime::SetToWeekDayInSameWeek}\label{wxdatetimesettoweekdayinsameweek}
1302 \func{wxDateTime\&}{SetToWeekDayInSameWeek}{\param{WeekDay }{weekday}, \param{WeekFlags}{flags = {\tt Monday\_First}}}
1310 \membersection{wxDateTime::GetWeekDayInSameWeek}\label{wxdatetimegetweekdayinsameweek}
1312 \constfunc{wxDateTime}{GetWeekDayInSameWeek}{\param{WeekDay }{weekday}, \param{WeekFlags}{flags = {\tt Monday\_First}}}
1319 \membersection{wxDateTime::SetToNextWeekDay}\label{wxdatetimesettonextweekday}
1321 \func{wxDateTime\&}{SetToNextWeekDay}{\param{WeekDay }{weekday}}
1329 \membersection{wxDateTime::GetNextWeekDay}\label{wxdatetimegetnextweekday}
1331 \constfunc{wxDateTime}{GetNextWeekDay}{\param{WeekDay }{weekday}}
1337 \membersection{wxDateTime::SetToPrevWeekDay}\label{wxdatetimesettoprevweekday}
1339 \func{wxDateTime\&}{SetToPrevWeekDay}{\param{WeekDay }{weekday}}
1347 \membersection{wxDateTime::GetPrevWeekDay}\label{wxdatetimegetprevweekday}
1349 \constfunc{wxDateTime}{GetPrevWeekDay}{\param{WeekDay }{weekday}}
1355 \membersection{wxDateTime::SetToWeekDay}\label{wxdatetimesettoweekday}
1364 For example, {\tt SetToWeekDay(2, wxDateTime::Wed)} will set the date to the
1366 {\tt SetToWeekDay(-1, wxDateTime::Sun)} -- to the last Sunday in it.
1372 \membersection{wxDateTime::GetWeekDay}\label{wxdatetimegetweekday2}
1374 \constfunc{wxDateTime}{GetWeekDay}{\param{WeekDay }{weekday}, \param{int }{n = 1}, \param{Month }{month = Inv\_Month}, \param{int }{year = Inv\_Year}}
1380 \membersection{wxDateTime::SetToLastWeekDay}\label{wxdatetimesettolastweekday}
1391 \membersection{wxDateTime::GetLastWeekDay}\label{wxdatetimegetlastweekday}
1393 \func{wxDateTime}{GetLastWeekDay}{\param{WeekDay }{weekday}, \param{Month }{month = Inv\_Month}, \param{int }{year = Inv\_Year}}
1399 \membersection{wxDateTime::SetToWeekOfYear}\label{wxdatetimesettoweekofyear}
1401 \func{static wxDateTime}{SetToWeekOfYear}{\param{int }{year}, \param{wxDateTime\_t }{numWeek}, \param{WeekDay }{weekday = Mon}}
1413 \membersection{wxDateTime::SetToLastMonthDay}\label{wxdatetimesettolastmonthday}
1415 \func{wxDateTime\&}{SetToLastMonthDay}{\param{Month }{month = Inv\_Month}, \param{int }{year = Inv\_Year}}
1423 \membersection{wxDateTime::GetLastMonthDay}\label{wxdatetimegetlastmonthday}
1425 \constfunc{wxDateTime}{GetLastMonthDay}{\param{Month }{month = Inv\_Month}, \param{int }{year = Inv\_Year}}
1431 \membersection{wxDateTime::SetToYearDay}\label{wxdatetimesettoyearday}
1433 \func{wxDateTime\&}{SetToYearDay}{\param{wxDateTime\_t }{yday}}
1443 \membersection{wxDateTime::GetYearDay}\label{wxdatetimegetyearday}
1445 \constfunc{wxDateTime}{GetYearDay}{\param{wxDateTime\_t }{yday}}
1453 \membersection{wxDateTime::GetJulianDayNumber}\label{wxdatetimegetjuliandaynumber}
1465 \membersection{wxDateTime::GetJDN}\label{wxdatetimegetjdn}
1472 \membersection{wxDateTime::GetModifiedJulianDayNumber}\label{wxdatetimegetmodifiedjuliandaynumber}
1482 \membersection{wxDateTime::GetMJD}\label{wxdatetimegetmjd}
1489 \membersection{wxDateTime::GetRataDie}\label{wxdatetimegetratadie}
1502 \membersection{wxDateTime::FromTimezone}\label{wxdatetimefromtimezone}
1504 \constfunc{wxDateTime}{FromTimezone}{\param{const TimeZone\& }{tz}, \param{bool }{noDST = false}}
1512 \membersection{wxDateTime::ToTimezone}\label{wxdatetimetotimezone}
1514 \constfunc{wxDateTime}{ToTimezone}{\param{const TimeZone\& }{tz}, \param{bool }{noDST = false}}
1522 \membersection{wxDateTime::MakeTimezone}\label{wxdatetimemaketimezone}
1524 \func{wxDateTime\&}{MakeTimezone}{\param{const TimeZone\& }{tz}, \param{bool }{noDST = false}}
1530 \membersection{wxDateTime::MakeFromTimezone}\label{wxdatetimemakefromtimezone}
1532 \func{wxDateTime\&}{MakeFromTimezone}{\param{const TimeZone\& }{tz}, \param{bool }{noDST = false}}
1538 \membersection{wxDateTime::ToUTC}\label{wxdatetimetoutc}
1540 \constfunc{wxDateTime}{ToUTC}{\param{bool }{noDST = false}}
1546 \membersection{wxDateTime::MakeUTC}\label{wxdatetimemakeutc}
1548 \func{wxDateTime\&}{MakeUTC}{\param{bool }{noDST = false}}
1554 \membersection{wxDateTime::IsDST}\label{wxdatetimeisdst}