]>
Commit | Line | Data |
---|---|---|
d7da9756 VZ |
1 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
2 | %% Name: datetime.tex | |
3 | %% Purpose: wxDateTime documentation | |
4 | %% Author: Vadim Zeitlin | |
5 | %% Modified by: | |
6 | %% Created: 07.03.00 | |
7 | %% RCS-ID: $Id$ | |
8 | %% Copyright: (c) Vadim Zeitlin | |
f6bcfd97 | 9 | %% License: wxWindows license |
d7da9756 VZ |
10 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
11 | ||
12 | \section{\class{wxDateTime}}\label{wxdatetime} | |
13 | ||
14 | wxDateTime class represents an absolute moment in the time. | |
15 | ||
16 | \wxheading{Types} | |
17 | ||
18 | The type {\tt wxDateTime\_t} is typedefed as {\tt unsigned short} and is used | |
19 | to contain the number of years, hours, minutes, seconds and milliseconds. | |
20 | ||
21 | \wxheading{Constants} | |
22 | ||
66f55ec6 | 23 | Global constant {\tt wxDefaultDateTime} and synonym for it {\tt wxInvalidDateTime} are defined. This constant will be different from any valid |
d7da9756 VZ |
24 | wxDateTime object. |
25 | ||
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::}). | |
28 | ||
fa482912 | 29 | Time zone symbolic names: |
d7da9756 VZ |
30 | |
31 | \begin{verbatim} | |
32 | enum TZ | |
33 | { | |
34 | // the time in the current time zone | |
35 | Local, | |
36 | ||
37 | // zones from GMT (= Greenwhich Mean Time): they're guaranteed to be | |
38 | // consequent numbers, so writing something like `GMT0 + offset' is | |
39 | // safe if abs(offset) <= 12 | |
40 | ||
41 | // underscore stands for minus | |
42 | GMT_12, GMT_11, GMT_10, GMT_9, GMT_8, GMT_7, | |
43 | GMT_6, GMT_5, GMT_4, GMT_3, GMT_2, GMT_1, | |
44 | GMT0, | |
45 | GMT1, GMT2, GMT3, GMT4, GMT5, GMT6, | |
46 | GMT7, GMT8, GMT9, GMT10, GMT11, GMT12, | |
47 | // Note that GMT12 and GMT_12 are not the same: there is a difference | |
48 | // of exactly one day between them | |
49 | ||
50 | // some symbolic names for TZ | |
51 | ||
52 | // Europe | |
53 | WET = GMT0, // Western Europe Time | |
54 | WEST = GMT1, // Western Europe Summer Time | |
55 | CET = GMT1, // Central Europe Time | |
56 | CEST = GMT2, // Central Europe Summer Time | |
57 | EET = GMT2, // Eastern Europe Time | |
58 | EEST = GMT3, // Eastern Europe Summer Time | |
59 | MSK = GMT3, // Moscow Time | |
60 | MSD = GMT4, // Moscow Summer Time | |
61 | ||
62 | // US and Canada | |
63 | AST = GMT_4, // Atlantic Standard Time | |
64 | ADT = GMT_3, // Atlantic Daylight Time | |
65 | EST = GMT_5, // Eastern Standard Time | |
66 | EDT = GMT_4, // Eastern Daylight Saving Time | |
67 | CST = GMT_6, // Central Standard Time | |
68 | CDT = GMT_5, // Central Daylight Saving Time | |
69 | MST = GMT_7, // Mountain Standard Time | |
70 | MDT = GMT_6, // Mountain Daylight Saving Time | |
71 | PST = GMT_8, // Pacific Standard Time | |
72 | PDT = GMT_7, // Pacific Daylight Saving Time | |
73 | HST = GMT_10, // Hawaiian Standard Time | |
74 | AKST = GMT_9, // Alaska Standard Time | |
75 | AKDT = GMT_8, // Alaska Daylight Saving Time | |
76 | ||
77 | // Australia | |
78 | ||
79 | A_WST = GMT8, // Western Standard Time | |
80 | A_CST = GMT12 + 1, // Central Standard Time (+9.5) | |
81 | A_EST = GMT10, // Eastern Standard Time | |
82 | A_ESST = GMT11, // Eastern Summer Time | |
83 | ||
84 | // Universal Coordinated Time = the new and politically correct name | |
85 | // for GMT | |
86 | UTC = GMT0 | |
87 | }; | |
88 | \end{verbatim} | |
89 | ||
90 | Month names: Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec and | |
f6bcfd97 | 91 | Inv\_Month for an invalid.month value are the values of {\tt wxDateTime::Month} |
d7da9756 VZ |
92 | enum. |
93 | ||
f6bcfd97 | 94 | Likewise, Sun, Mon, Tue, Wed, Thu, Fri, Sat, and Inv\_WeekDay are the values in |
d7da9756 VZ |
95 | {\tt wxDateTime::WeekDay} enum. |
96 | ||
97 | Finally, Inv\_Year is defined to be an invalid value for year parameter. | |
98 | ||
f6bcfd97 BP |
99 | \helpref{GetMonthName()}{wxdatetimegetmonthname} and |
100 | \helpref{GetWeekDayName}{wxdatetimegetweekdayname} functions use the followign | |
101 | flags: | |
102 | ||
103 | \begin{verbatim} | |
104 | enum NameFlags | |
105 | { | |
106 | Name_Full = 0x01, // return full name | |
107 | Name_Abbr = 0x02 // return abbreviated name | |
108 | }; | |
109 | \end{verbatim} | |
110 | ||
111 | Several functions accept an extra parameter specifying the calendar to use | |
112 | (although most of them only support now the Gregorian calendar). This | |
113 | parameters is one of the following values: | |
114 | ||
115 | \begin{verbatim} | |
116 | enum Calendar | |
117 | { | |
118 | Gregorian, // calendar currently in use in Western countries | |
119 | Julian // calendar in use since -45 until the 1582 (or later) | |
120 | }; | |
121 | \end{verbatim} | |
122 | ||
d3c7cfeb JS |
123 | Date calculations often depend on the country and wxDateTime allows to set the |
124 | country whose conventions should be used using | |
f6bcfd97 BP |
125 | \helpref{SetCountry}{wxdatetimesetcountry}. It takes one of the following |
126 | values as parameter: | |
127 | ||
128 | \begin{verbatim} | |
129 | enum Country | |
130 | { | |
131 | Country_Unknown, // no special information for this country | |
132 | Country_Default, // set the default country with SetCountry() method | |
133 | // or use the default country with any other | |
134 | ||
135 | Country_WesternEurope_Start, | |
136 | Country_EEC = Country_WesternEurope_Start, | |
137 | France, | |
138 | Germany, | |
139 | UK, | |
140 | Country_WesternEurope_End = UK, | |
141 | ||
142 | Russia, | |
143 | ||
144 | USA | |
145 | }; | |
146 | \end{verbatim} | |
147 | ||
df05cdc5 | 148 | Different parst of the world use different conventions for the week start. |
f6bcfd97 BP |
149 | In some countries, the week starts on Sunday, while in others - on Monday. |
150 | The ISO standard doesn't address this issue, so we support both conventions in | |
d3c7cfeb | 151 | the functions whose result depends on it (\helpref{GetWeekOfYear}{wxdatetimegetweekofyear} and |
f6bcfd97 BP |
152 | \helpref{GetWeekOfMonth}{wxdatetimegetweekofmonth}). |
153 | ||
154 | The desired behvaiour may be specified by giving one of the following | |
155 | constants as argument to these functions: | |
156 | ||
157 | \begin{verbatim} | |
158 | enum WeekFlags | |
159 | { | |
160 | Default_First, // Sunday_First for US, Monday_First for the rest | |
161 | Monday_First, // week starts with a Monday | |
162 | Sunday_First // week starts with a Sunday | |
163 | }; | |
164 | \end{verbatim} | |
165 | ||
d7da9756 VZ |
166 | \wxheading{Derived from} |
167 | ||
168 | No base class | |
169 | ||
170 | \wxheading{Include files} | |
171 | ||
172 | <wx/datetime.h> | |
173 | ||
174 | \wxheading{See also} | |
175 | ||
f6bcfd97 | 176 | \helpref{Date classes overview}{wxdatetimeoverview},\rtfsp |
df05cdc5 VZ |
177 | \helpref{wxTimeSpan}{wxtimespan},\rtfsp |
178 | \helpref{wxDateSpan}{wxdatespan},\rtfsp | |
d7da9756 VZ |
179 | \helpref{wxCalendarCtrl}{wxcalendarctrl} |
180 | ||
181 | \latexignore{\rtfignore{\wxheading{Function groups}}} | |
182 | ||
183 | \membersection{Static functions} | |
184 | ||
fa482912 | 185 | For convenience, all static functions are collected here. These functions |
d7da9756 VZ |
186 | either set or return the static variables of wxDateSpan (the country), return |
187 | the current moment, year, month or number of days in it, or do some general | |
188 | calendar-related actions. | |
189 | ||
f6bcfd97 BP |
190 | Please note that although several function accept an extra {\it Calendar} |
191 | parameter, it is currently ignored as only the Gregorian calendar is | |
192 | supported. Future versions will support other calendars. | |
193 | ||
d3c7cfeb | 194 | \pythonnote{These methods are standalone functions named |
e7240349 | 195 | {\tt wxDateTime\_<StaticMethodName>} in wxPython.} |
f6bcfd97 | 196 | |
d7da9756 VZ |
197 | \helpref{SetCountry}{wxdatetimesetcountry}\\ |
198 | \helpref{GetCountry}{wxdatetimegetcountry}\\ | |
199 | \helpref{IsWestEuropeanCountry}{wxdatetimeiswesteuropeancountry}\\ | |
200 | \helpref{GetCurrentYear}{wxdatetimegetcurrentyear}\\ | |
201 | \helpref{ConvertYearToBC}{wxdatetimeconvertyeartobc}\\ | |
202 | \helpref{GetCurrentMonth}{wxdatetimegetcurrentmonth}\\ | |
203 | \helpref{IsLeapYear}{wxdatetimeisleapyear}\\ | |
204 | \helpref{GetCentury}{wxdatetimegetcentury}\\ | |
205 | \helpref{GetNumberOfDays}{wxdatetimegetnumberofdays}\\ | |
206 | \helpref{GetNumberOfDays}{wxdatetimegetnumberofdays}\\ | |
207 | \helpref{GetMonthName}{wxdatetimegetmonthname}\\ | |
208 | \helpref{GetWeekDayName}{wxdatetimegetweekdayname}\\ | |
209 | \helpref{GetAmPmStrings}{wxdatetimegetampmstrings}\\ | |
210 | \helpref{IsDSTApplicable}{wxdatetimeisdstapplicable}\\ | |
211 | \helpref{GetBeginDST}{wxdatetimegetbegindst}\\ | |
212 | \helpref{GetEndDST}{wxdatetimegetenddst}\\ | |
213 | \helpref{Now}{wxdatetimenow}\\ | |
f6bcfd97 | 214 | \helpref{UNow}{wxdatetimeunow}\\ |
d7da9756 VZ |
215 | \helpref{Today}{wxdatetimetoday} |
216 | ||
217 | \membersection{Constructors, assignment operators and setters} | |
218 | ||
f6bcfd97 BP |
219 | Constructors and various {\tt Set()} methods are collected here. If you |
220 | construct a date object from separate values for day, month and year, you | |
221 | should use \helpref{IsValid}{wxdatetimeisvalid} method to check that the | |
222 | values were correct as constructors can not return an error code. | |
223 | ||
224 | \helpref{wxDateTime()}{wxdatetimewxdatetimedef}\\ | |
225 | \helpref{wxDateTime(time\_t)}{wxdatetimewxdatetimetimet}\\ | |
226 | \helpref{wxDateTime(struct tm)}{wxdatetimewxdatetimetm}\\ | |
227 | %\helpref{wxDateTime(struct Tm)}{wxdatetimewxdatetimetm} - Tm not documented yet\\ | |
228 | \helpref{wxDateTime(double jdn)}{wxdatetimewxdatetimejdn}\\ | |
229 | \helpref{wxDateTime(h, m, s, ms)}{wxdatetimewxdatetimetime}\\ | |
230 | \helpref{wxDateTime(day, mon, year, h, m, s, ms)}{wxdatetimewxdatetimedate}\\ | |
231 | \helpref{SetToCurrent}{wxdatetimesettocurrent}\\ | |
232 | \helpref{Set(time\_t)}{wxdatetimesettimet}\\ | |
233 | \helpref{Set(struct tm)}{wxdatetimesettm}\\ | |
234 | %\helpref{Set(struct Tm)}{wxdatetimesettm} - Tm not documented yet\\ | |
235 | \helpref{Set(double jdn)}{wxdatetimesetjdn}\\ | |
236 | \helpref{Set(h, m, s, ms)}{wxdatetimesettime}\\ | |
237 | \helpref{Set(day, mon, year, h, m, s, ms)}{wxdatetimesetdate}\\ | |
238 | \helpref{ResetTime}{wxdatetimeresettime}\\ | |
239 | \helpref{SetYear}{wxdatetimesetyear}\\ | |
240 | \helpref{SetMonth}{wxdatetimesetmonth}\\ | |
241 | \helpref{SetDay}{wxdatetimesetdate}\\ | |
242 | \helpref{SetHour}{wxdatetimesethour}\\ | |
243 | \helpref{SetMinute}{wxdatetimesetminute}\\ | |
244 | \helpref{SetSecond}{wxdatetimesetsecond}\\ | |
245 | \helpref{SetMillisecond}{wxdatetimesetmillisecond}\\ | |
246 | \helpref{operator$=$(time\_t)}{wxdatetimeoperatoreqtimet}\\ | |
247 | \helpref{operator$=$(struct tm)}{wxdatetimeoperatoreqtm} | |
248 | %\helpref{operator$=$(struct Tm)}{wxdatetimeoperatortm2} | |
249 | ||
d7da9756 VZ |
250 | \membersection{Accessors} |
251 | ||
f6bcfd97 | 252 | Here are the trivial accessors. Other functions, which might have to perform |
d3c7cfeb | 253 | some more complicated calculations to find the answer are under the |
f6bcfd97 BP |
254 | \helpref{Calendar calculations}{wxdatetimecalculations} section. |
255 | ||
256 | \helpref{IsValid}{wxdatetimeisvalid}\\ | |
257 | \helpref{GetTicks}{wxdatetimegetticks}\\ | |
258 | \helpref{GetYear}{wxdatetimegetyear}\\ | |
259 | \helpref{GetMonth}{wxdatetimegetmonth}\\ | |
260 | \helpref{GetDay}{wxdatetimegetday}\\ | |
261 | \helpref{GetWeekDay}{wxdatetimegetweekday}\\ | |
262 | \helpref{GetHour}{wxdatetimegethour}\\ | |
263 | \helpref{GeTMinute}{wxdatetimegetminute}\\ | |
264 | \helpref{GetSecond}{wxdatetimegetsecond}\\ | |
265 | \helpref{GetMillisecond}{wxdatetimegetmillisecond}\\ | |
266 | \helpref{GetDayOfYear}{wxdatetimegetdayofyear}\\ | |
267 | \helpref{GetWeekOfYear}{wxdatetimegetweekofyear}\\ | |
268 | \helpref{GetWeekOfMonth}{wxdatetimegetweekofmonth}\\ | |
269 | \helpref{GetYearDay}{wxdatetimegetyearday}\\ | |
270 | \helpref{IsWorkDay}{wxdatetimeisworkday}\\ | |
271 | \helpref{IsGregorianDate}{wxdatetimeisgregoriandate} | |
272 | ||
d7da9756 VZ |
273 | \membersection{Date comparison} |
274 | ||
f6bcfd97 BP |
275 | There are several function to allow date comparison. To supplement them, a few |
276 | global operators $>$, $<$ etc taking wxDateTime are defined. | |
277 | ||
278 | \helpref{IsEqualTo}{wxdatetimeisequalto}\\ | |
279 | \helpref{IsEarlierThan}{wxdatetimeisearlierthan}\\ | |
280 | \helpref{IsLaterThan}{wxdatetimeislaterthan}\\ | |
281 | \helpref{IsStrictlyBetween}{wxdatetimeisstrictlybetween}\\ | |
282 | \helpref{IsBetween}{wxdatetimeisbetween}\\ | |
283 | \helpref{IsSameDate}{wxdatetimeissamedate}\\ | |
284 | \helpref{IsSameTime}{wxdatetimeissametime}\\ | |
285 | \helpref{IsEqualUpTo}{wxdatetimeisequalupto} | |
286 | ||
d7da9756 VZ |
287 | \membersection{Date arithmetics} |
288 | ||
f6bcfd97 BP |
289 | These functions carry out \helpref{arithmetics}{tdatearithm} on the wxDateTime |
290 | objects. As explained in the overview, either wxTimeSpan or wxDateSpan may be | |
291 | added to wxDateTime, hence all functions are overloaded to accept both | |
292 | arguments. | |
293 | ||
294 | Also, both {\tt Add()} and {\tt Subtract()} have both const and non-const | |
295 | version. The first one returns a new obejct which represents the | |
296 | sum/difference of the original one with the argument while the second form | |
297 | modifies the object to which it is applied. The operators $-=$ and $+=$ are | |
298 | defined to be equivalent to the second forms of these functions. | |
299 | ||
300 | \helpref{Add(wxTimeSpan)}{wxdatetimeaddts}\\ | |
301 | \helpref{Add(wxDateSpan)}{wxdatetimeaddds}\\ | |
302 | \helpref{Subtract(wxTimeSpan)}{wxdatetimesubtractts}\\ | |
303 | \helpref{Subtract(wxDateSpan)}{wxdatetimesubtractds}\\ | |
304 | \helpref{Subtract(wxDateTime)}{wxdatetimesubtractdt}\\ | |
305 | \helpref{oparator$+=$(wxTimeSpan)}{wxdatetimeaddts}\\ | |
306 | \helpref{oparator$+=$(wxDateSpan)}{wxdatetimeaddds}\\ | |
307 | \helpref{oparator$-=$(wxTimeSpan)}{wxdatetimesubtractts}\\ | |
308 | \helpref{oparator$-=$(wxDateSpan)}{wxdatetimesubtractds} | |
309 | ||
d7da9756 VZ |
310 | \membersection{Parsing and formatting dates} |
311 | ||
f6bcfd97 BP |
312 | These functions perform convert wxDateTime obejcts to and from text. The |
313 | conversions to text are mostly trivial: you can either do it using the default | |
314 | date and time representations for the current locale ( | |
315 | \helpref{FormatDate}{wxdatetimeformatdate} and | |
316 | \helpref{FormatTime}{wxdatetimeformattime}), using the international standard | |
317 | representation defined by ISO 8601 ( | |
318 | \helpref{FormatISODate}{wxdatetimeformatisodate} and | |
319 | \helpref{FormatISOTime}{wxdatetimeformatisotime}) or by specifying any format | |
320 | at all and using \helpref{Format}{wxdatetimeformat} directly. | |
321 | ||
322 | The conversions from text are more interesting, as there are much more | |
323 | possibilities to care about. The simples cases can be taken care of with | |
324 | \helpref{ParseFormat}{wxdatetimeparseformat} which can parse any date in the | |
325 | given (rigid) format. \helpref{ParseRfc822Date}{wxdatetimeparserfc822date} is | |
326 | another function for parsing dates in predefined format - the one of RFC 822 | |
327 | which (still...) defines the format of email messages on the Internet. This | |
328 | format can not be described with {\tt strptime(3)}-like format strings used by | |
329 | \helpref{Format}{wxdatetimeformat}, hence the need for a separate function. | |
330 | ||
d3c7cfeb JS |
331 | But the most interesting functions are |
332 | \helpref{ParseDateTime}{wxdatetimeparsedatetime} and | |
333 | \helpref{ParseDate}{wxdatetimeparsedate} and | |
f6bcfd97 BP |
334 | \helpref{ParseTime}{wxdatetimeparsetime}. They try to parse the date ans time |
335 | (or only one of them) in `free' format, i.e. allow them to be specified in any | |
336 | of possible ways. These functions will usually be used to parse the | |
337 | (interactive) user input which is not bound to be in any predefined format. As | |
338 | an example, \helpref{ParseDateTime}{wxdatetimeparsedatetime} can parse the | |
339 | strings such as {\tt "tomorrow"}, {\tt "March first"}, {\tt "next Sunday"}. | |
340 | ||
341 | \helpref{ParseRfc822Date}{wxdatetimeparserfc822date}\\ | |
342 | \helpref{ParseFormat}{wxdatetimeparseformat}\\ | |
343 | \helpref{ParseDateTime}{wxdatetimeparsedatetime}\\ | |
344 | \helpref{ParseDate}{wxdatetimeparsedate}\\ | |
345 | \helpref{ParseTime}{wxdatetimeparsetime}\\ | |
346 | \helpref{Format}{wxdatetimeformat}\\ | |
347 | \helpref{FormatDate}{wxdatetimeformatdate}\\ | |
348 | \helpref{FormatTime}{wxdatetimeformattime}\\ | |
349 | \helpref{FormatISODate}{wxdatetimeformatisodate}\\ | |
350 | \helpref{FormatISOTime}{wxdatetimeformatisotime} | |
351 | ||
352 | \membersection{Calendar calculations}\label{wxdatetimecalculations} | |
353 | ||
354 | The functions in this section perform the basic calendar calculations, mostly | |
355 | related to the week days. They allow to find the given week day in the | |
356 | week with given number (either in the month or in the year) and so on. | |
357 | ||
358 | All (non-const) functions in this section don't modify the time part of the | |
359 | wxDateTime - they only work with the date part of it. | |
360 | ||
361 | \helpref{SetToWeekDayInSameWeek}{wxdatetimesettoweekdayinsameweek}\\ | |
362 | \helpref{GetWeekDayInSameWeek}{wxdatetimegetweekdayinsameweek}\\ | |
363 | \helpref{SetToNextWeekDay}{wxdatetimesettonextweekday}\\ | |
364 | \helpref{GetNextWeekDay}{wxdatetimegetnextweekday}\\ | |
365 | \helpref{SetToPrevWeekDay}{wxdatetimesettoprevweekday}\\ | |
366 | \helpref{GetPrevWeekDay}{wxdatetimegetprevweekday}\\ | |
367 | \helpref{SetToWeekDay}{wxdatetimesettoweekday}\\ | |
368 | \helpref{GetWeekDay}{wxdatetimegetweekday2}\\ | |
369 | \helpref{SetToLastWeekDay}{wxdatetimesettolastweekday}\\ | |
370 | \helpref{GetLastWeekDay}{wxdatetimegetlastweekday}\\ | |
371 | \helpref{SetToTheWeek}{wxdatetimesettotheweek}\\ | |
372 | \helpref{GetWeek}{wxdatetimegetweek}\\ | |
373 | \helpref{SetToLastMonthDay}{wxdatetimesettolastmonthday}\\ | |
374 | \helpref{GetLastMonthDay}{wxdatetimegetlastmonthday}\\ | |
375 | \helpref{SetToYearDay}{wxdatetimesettoyearday}\\ | |
376 | \helpref{GetYearDay}{wxdatetimegetyearday} | |
d7da9756 VZ |
377 | |
378 | \membersection{Astronomical/historical functions} | |
379 | ||
f6bcfd97 BP |
380 | Some degree of support for the date units used in astronomy and/or history is |
381 | provided. You can construct a wxDateTime object from a | |
382 | \helpref{JDN}{wxdatetimesetjdn} and you may also get its JDN, | |
383 | \helpref{MJD}{wxdatetimegetmodifiedjuliandaynumber} or | |
384 | \helpref{Rata Die number}{wxdatetimegetratadie} from it. | |
385 | ||
386 | \helpref{wxDateTime(double jdn)}{wxdatetimewxdatetimejdn}\\ | |
387 | \helpref{Set(double jdn)}{wxdatetimesetjdn}\\ | |
388 | \helpref{GetJulianDayNumber}{wxdatetimegetjuliandaynumber}\\ | |
389 | \helpref{GetJDN}{wxdatetimegetjdn}\\ | |
390 | \helpref{GetModifiedJulianDayNumber}{wxdatetimegetmodifiedjuliandaynumber}\\ | |
391 | \helpref{GetMJD}{wxdatetimegetmjd}\\ | |
392 | \helpref{GetRataDie}{wxdatetimegetratadie} | |
393 | ||
394 | \membersection{Time zone and DST support} | |
395 | ||
396 | Please see the \helpref{time zone overview}{tdatetimezones} for more | |
397 | information about time zones. ormally, these functions should be rarely used. | |
398 | ||
399 | \helpref{ToTimezone}{wxdatetimetotimezone}\\ | |
400 | \helpref{MakeTimezone}{wxdatetimemaketimezone}\\ | |
401 | \helpref{ToGMT}{wxdatetimetogmt}\\ | |
402 | \helpref{MakeGMT}{wxdatetimemakegmt}\\ | |
403 | \helpref{GetBeginDST}{wxdatetimegetbegindst}\\ | |
404 | \helpref{GetEndDST}{wxdatetimegetenddst}\\ | |
405 | \helpref{IsDST}{wxdatetimeisdst} | |
d7da9756 VZ |
406 | |
407 | \helponly{\insertatlevel{2}{ | |
408 | ||
409 | \wxheading{Members} | |
410 | ||
411 | }} | |
412 | ||
f6bcfd97 BP |
413 | %%%%%%%%%%%%%%%%%%%%%%%%%%% static functions %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
414 | ||
66f55ec6 | 415 | \membersection{wxDateTime::ConvertYearToBC}\label{wxdatetimeconvertyeartobc} |
d7da9756 | 416 | |
66f55ec6 | 417 | \func{static int}{ConvertYearToBC}{\param{int }{year}} |
d7da9756 VZ |
418 | |
419 | Converts the year in absolute notation (i.e. a number which can be negative, | |
420 | positive or zero) to the year in BC/AD notation. For the positive years, | |
421 | nothing is done, but the year 0 is year 1 BC and so for other years there is a | |
422 | difference of 1. | |
423 | ||
424 | This function should be used like this: | |
425 | ||
426 | \begin{verbatim} | |
427 | wxDateTime dt(...); | |
428 | int y = dt.GetYear(); | |
429 | printf("The year is %d%s", wxDateTime::ConvertYearToBC(y), y > 0 ? "AD" : "BC"); | |
430 | \end{verbatim} | |
431 | ||
66f55ec6 | 432 | \membersection{wxDateTime::GetAmPmStrings}\label{wxdatetimegetampmstrings} |
d7da9756 VZ |
433 | |
434 | \func{static void}{GetAmPmStrings}{\param{wxString *}{am}, \param{wxString *}{pm}} | |
435 | ||
f6bcfd97 BP |
436 | Returns the translations of the strings {\tt AM} and {\tt PM} used for time |
437 | formatting for the current locale. Either of the pointers may be {\tt NULL} if | |
438 | the corresponding value is not needed. | |
439 | ||
66f55ec6 | 440 | \membersection{wxDateTime::GetBeginDST}\label{wxdatetimegetbegindst} |
d7da9756 VZ |
441 | |
442 | \func{static wxDateTime}{GetBeginDST}{\param{int }{year = Inv\_Year}, \param{Country }{country = Country\_Default}} | |
443 | ||
f6bcfd97 BP |
444 | Get the beginning of DST for the given country in the given year (current one |
445 | by default). This function suffers from limitations described in | |
446 | \helpref{DST overview}{tdatedst}. | |
447 | ||
448 | \wxheading{See also} | |
449 | ||
450 | \helpref{GetEndDST}{wxdatetimegetenddst} | |
451 | ||
66f55ec6 | 452 | \membersection{wxDateTime::GetCountry}\label{wxdatetimegetcountry} |
d7da9756 VZ |
453 | |
454 | \func{static Country}{GetCountry}{\void} | |
455 | ||
f6bcfd97 BP |
456 | Returns the current default country. The default country is used for DST |
457 | calculations, for example. | |
458 | ||
459 | \wxheading{See also} | |
460 | ||
461 | \helpref{SetCountry}{wxdatetimesetcountry} | |
462 | ||
66f55ec6 | 463 | \membersection{wxDateTime::GetCurrentYear}\label{wxdatetimegetcurrentyear} |
d7da9756 VZ |
464 | |
465 | \func{static int}{GetCurrentYear}{\param{Calendar }{cal = Gregorian}} | |
466 | ||
f6bcfd97 BP |
467 | Get the current year in given calendar (only Gregorian is currently supported). |
468 | ||
66f55ec6 | 469 | \membersection{wxDateTime::GetCurrentMonth}\label{wxdatetimegetcurrentmonth} |
d7da9756 VZ |
470 | |
471 | \func{static Month}{GetCurrentMonth}{\param{Calendar }{cal = Gregorian}} | |
472 | ||
f6bcfd97 BP |
473 | Get the current month in given calendar (only Gregorian is currently supported). |
474 | ||
66f55ec6 | 475 | \membersection{wxDateTime::GetCentury}\label{wxdatetimegetcentury} |
d7da9756 VZ |
476 | |
477 | \func{static int}{GetCentury}{\param{int }{year = Inv\_Year}} | |
478 | ||
f6bcfd97 BP |
479 | Get the current century, i.e. first two digits of the year, in given calendar |
480 | (only Gregorian is currently supported). | |
481 | ||
66f55ec6 | 482 | \membersection{wxDateTime::GetEndDST}\label{wxdatetimegetenddst} |
d7da9756 VZ |
483 | |
484 | \func{static wxDateTime}{GetEndDST}{\param{int }{year = Inv\_Year}, \param{Country }{country = Country\_Default}} | |
485 | ||
f6bcfd97 BP |
486 | Returns the end of DST for the given country in the given year (current one by |
487 | default). | |
488 | ||
489 | \wxheading{See also} | |
490 | ||
491 | \helpref{GetBeginDST}{wxdatetimegetbegindst} | |
492 | ||
66f55ec6 | 493 | \membersection{wxDateTime::GetMonthName}\label{wxdatetimegetmonthname} |
d7da9756 VZ |
494 | |
495 | \func{static wxString}{GetMonthName}{\param{Month }{month}, \param{NameFlags }{flags = Name\_Full}} | |
496 | ||
f6bcfd97 BP |
497 | Gets the full (default) or abbreviated (specify {\tt Name\_Abbr} name of the |
498 | given month. | |
499 | ||
500 | \wxheading{See also} | |
501 | ||
502 | \helpref{GetWeekDayName}{wxdatetimegetweekdayname} | |
503 | ||
66f55ec6 | 504 | \membersection{wxDateTime::GetNumberOfDays}\label{wxdatetimegetnumberofdays} |
d7da9756 VZ |
505 | |
506 | \func{static wxDateTime\_t}{GetNumberOfDays}{\param{int }{year}, \param{Calendar }{cal = Gregorian}} | |
507 | ||
d7da9756 VZ |
508 | \func{static wxDateTime\_t}{GetNumberOfDays}{\param{Month }{month}, \param{int }{year = Inv\_Year}, \param{Calendar }{cal = Gregorian}} |
509 | ||
f6bcfd97 BP |
510 | Returns the number of days in the given year or in the given month of the |
511 | year. | |
512 | ||
513 | The only supported value for {\it cal} parameter is currently {\tt Gregorian}. | |
514 | ||
515 | \pythonnote{These two methods are named {\tt GetNumberOfDaysInYear} | |
516 | and {\tt GetNumberOfDaysInMonth} in wxPython.} | |
517 | ||
66f55ec6 | 518 | \membersection{wxDateTime::GetWeekDayName}\label{wxdatetimegetweekdayname} |
d7da9756 VZ |
519 | |
520 | \func{static wxString}{GetWeekDayName}{\param{WeekDay }{weekday}, \param{NameFlags }{flags = Name\_Full}} | |
521 | ||
f6bcfd97 BP |
522 | Gets the full (default) or abbreviated (specify {\tt Name\_Abbr} name of the |
523 | given week day. | |
524 | ||
525 | \wxheading{See also} | |
526 | ||
527 | \helpref{GetMonthName}{wxdatetimegetmonthname} | |
528 | ||
66f55ec6 | 529 | \membersection{wxDateTime::IsLeapYear}\label{wxdatetimeisleapyear} |
d7da9756 VZ |
530 | |
531 | \func{static bool}{IsLeapYear}{\param{int }{year = Inv\_Year}, \param{Calendar }{cal = Gregorian}} | |
532 | ||
f6bcfd97 BP |
533 | Returns {\tt TRUE} if the {\it year} is a leap one in the specified calendar. |
534 | ||
535 | This functions supports Gregorian and Julian calendars. | |
536 | ||
66f55ec6 | 537 | \membersection{wxDateTime::IsWestEuropeanCountry}\label{wxdatetimeiswesteuropeancountry} |
d7da9756 VZ |
538 | |
539 | \func{static bool}{IsWestEuropeanCountry}{\param{Country }{country = Country\_Default}} | |
540 | ||
f6bcfd97 BP |
541 | This function returns {\tt TRUE} if the specified (or default) country is one |
542 | of Western European ones. It is used internally by wxDateTime to determine the | |
543 | DST convention and date and time formatting rules. | |
544 | ||
66f55ec6 | 545 | \membersection{wxDateTime::IsDSTApplicable}\label{wxdatetimeisdstapplicable} |
d7da9756 VZ |
546 | |
547 | \func{static bool}{IsDSTApplicable}{\param{int }{year = Inv\_Year}, \param{Country }{country = Country\_Default}} | |
548 | ||
f6bcfd97 BP |
549 | Returns {\tt TRUE} if DST was usedi n the given year (the current one by |
550 | default) in the given country. | |
551 | ||
66f55ec6 | 552 | \membersection{wxDateTime::Now}\label{wxdatetimenow} |
d7da9756 VZ |
553 | |
554 | \func{static wxDateTime}{Now}{\void} | |
555 | ||
f6bcfd97 BP |
556 | Returns the object corresopnding to the current time. |
557 | ||
558 | Example: | |
559 | ||
560 | \begin{verbatim} | |
561 | wxDateTime now = wxDateTime::Now(); | |
562 | printf("Current time in Paris:\t%s\n", now.Format("%c", wxDateTime::CET).c_str()); | |
563 | \end{verbatim} | |
564 | ||
565 | Note that this function is accurate up to second: | |
566 | \helpref{wxDateTime::UNow}{wxdatetimeunow} should be used for better precision | |
567 | (but it is less efficient and might not be availabel on all platforms). | |
568 | ||
569 | \wxheading{See also} | |
570 | ||
571 | \helpref{Today}{wxdatetimetoday} | |
572 | ||
66f55ec6 | 573 | \membersection{wxDateTime::SetCountry}\label{wxdatetimesetcountry} |
d7da9756 VZ |
574 | |
575 | \func{static void}{SetCountry}{\param{Country }{country}} | |
576 | ||
f6bcfd97 BP |
577 | Sets the country to use by default. This setting influences the DST |
578 | calculations, date formatting and other things. | |
579 | ||
580 | The possible values for {\it country} parameter are enumerated in | |
581 | \helpref{wxDateTime constants section}{wxdatetime}. | |
582 | ||
583 | \wxheading{See also} | |
584 | ||
585 | \helpref{GetCountry}{wxdatetimegetcountry} | |
586 | ||
66f55ec6 | 587 | \membersection{wxDateTime::Today}\label{wxdatetimetoday} |
d7da9756 VZ |
588 | |
589 | \func{static wxDateTime}{Today}{\void} | |
590 | ||
f6bcfd97 BP |
591 | Returns the object corresponding to the midnight of the current day (i.e. the |
592 | same as \helpref{Now()}{wxdatetimenow}, but the time part is set to $0$). | |
593 | ||
594 | \wxheading{See also} | |
595 | ||
596 | \helpref{Now}{wxdatetimenow} | |
597 | ||
598 | \membersection{wxDateTime::UNow}\label{wxdatetimeunow} | |
599 | ||
600 | \func{static wxDateTime}{UNow}{\void} | |
601 | ||
602 | Returns the object corresopnding to the current time including the | |
603 | milliseconds if a function to get time with such precision is available on the | |
604 | current platform (supported under most Unices and Win32). | |
605 | ||
606 | \wxheading{See also} | |
607 | ||
608 | \helpref{Now}{wxdatetimenow} | |
609 | ||
610 | %%%%%%%%%%%%%%%%%%%%%%%%%%% constructors &c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
611 | ||
612 | \membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimedef} | |
613 | ||
614 | \func{}{wxDateTime}{\void} | |
615 | ||
616 | Default constructor. Use one of {\tt Set()} functions to initialize the object | |
617 | later. | |
618 | ||
619 | \membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimetimet} | |
620 | ||
621 | \func{wxDateTime\&}{wxDateTime}{\param{time\_t }{timet}} | |
622 | ||
623 | Same as \helpref{Set}{wxdatetimewxdatetimetimet}. | |
624 | ||
625 | \pythonnote{This constructor is named {\tt wxDateTimeFromTimeT} in wxPython.} | |
626 | ||
627 | \membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimetm} | |
628 | ||
629 | \func{wxDateTime\&}{wxDateTime}{\param{const struct tm\& }{tm}} | |
630 | ||
631 | Same as \helpref{Set}{wxdatetimewxdatetimetm} | |
632 | ||
633 | \pythonnote{Unsupported.} | |
634 | ||
635 | \membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimejdn} | |
636 | ||
637 | \func{wxDateTime\&}{wxDateTime}{\param{double }{jdn}} | |
638 | ||
639 | Same as \helpref{Set}{wxdatetimewxdatetimejdn} | |
640 | ||
641 | \pythonnote{This constructor is named {\tt wxDateTimeFromJDN} in wxPython.} | |
642 | ||
643 | \membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimetime} | |
644 | ||
645 | \func{wxDateTime\&}{wxDateTime}{\param{wxDateTime\_t }{hour}, \param{wxDateTime\_t }{minute = 0}, \param{wxDateTime\_t }{second = 0}, \param{wxDateTime\_t }{millisec = 0}} | |
646 | ||
647 | Same as \helpref{Set}{wxdatetimewxdatetimetime} | |
648 | ||
649 | \pythonnote{This constructor is named {\tt wxDateTimeFromHMS} in wxPython.} | |
650 | ||
651 | \membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimedate} | |
652 | ||
e98a0358 | 653 | \func{wxDateTime\&}{wxDateTime}{\param{wxDateTime\_t }{day}, \param{Month }{month = Inv\_Month}, \param{int}{ Inv\_Year}, |
a9d171bd | 654 | \param{wxDateTime\_t }{hour = 0}, \param{wxDateTime\_t }{minute = 0}, \param{wxDateTime\_t }{second = 0}, \param{wxDateTime\_t }{millisec = 0}} |
f6bcfd97 BP |
655 | |
656 | Same as \helpref{Set}{wxdatetimesetdate} | |
657 | ||
658 | \pythonnote{This constructor is named {\tt wxDateTimeFromDMY} in wxPython.} | |
659 | ||
660 | \membersection{wxDateTime::SetToCurrent}\label{wxdatetimesettocurrent} | |
661 | ||
7af3ca16 | 662 | \func{wxDateTime\&}{SetToCurrent}{\void} |
f6bcfd97 BP |
663 | |
664 | Sets the date and time of to the current values. Same as assigning the result | |
665 | of \helpref{Now()}{wxdatetimenow} to this object. | |
666 | ||
667 | \membersection{wxDateTime::Set}\label{wxdatetimesettimet} | |
668 | ||
669 | \func{wxDateTime\&}{Set}{\param{time\_t }{timet}} | |
670 | ||
671 | Constructs the object from {\it timet} value holding the number of seconds | |
672 | since Jan 1, 1970. | |
673 | ||
674 | \pythonnote{This method is named {\tt SetTimeT} in wxPython.} | |
675 | ||
676 | \membersection{wxDateTime::Set}\label{wxdatetimesettm} | |
677 | ||
678 | \func{wxDateTime\&}{Set}{\param{const struct tm\& }{tm}} | |
679 | ||
680 | Sets the date and tiem from the broken down representation in the standard | |
681 | {\tt tm} structure. | |
682 | ||
683 | \pythonnote{Unsupported.} | |
684 | ||
685 | \membersection{wxDateTime::Set}\label{wxdatetimesetjdn} | |
686 | ||
687 | \func{wxDateTime\&}{Set}{\param{double }{jdn}} | |
688 | ||
689 | Sets the date from the so-called {\it Julian Day Number}. | |
690 | ||
691 | By definition, the Julian Day Number, usually abbreviated as JDN, of a | |
692 | particular instant is the fractional number of days since 12 hours Universal | |
693 | Coordinated Time (Greenwhich mean noon) on January 1 of the year -4712 in the | |
694 | Julian proleptic calendar. | |
695 | ||
696 | \pythonnote{This method is named {\tt SetJDN} in wxPython.} | |
697 | ||
698 | \membersection{wxDateTime::Set}\label{wxdatetimesettime} | |
699 | ||
700 | \func{wxDateTime\&}{Set}{\param{wxDateTime\_t }{hour}, \param{wxDateTime\_t }{minute = 0}, \param{wxDateTime\_t }{second = 0}, \param{wxDateTime\_t }{millisec = 0}} | |
701 | ||
702 | Sets the date to be equal to \helpref{Today}{wxdatetimetoday} and the time | |
703 | from supplied parameters. | |
704 | ||
705 | \pythonnote{This method is named {\tt SetHMS} in wxPython.} | |
706 | ||
707 | \membersection{wxDateTime::Set}\label{wxdatetimesetdate} | |
708 | ||
fafcf127 | 709 | \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}} |
f6bcfd97 BP |
710 | |
711 | Sets the date and time from the parameters. | |
712 | ||
713 | \membersection{wxDateTime::ResetTime}\label{wxdatetimeresettime} | |
714 | ||
715 | \func{wxDateTime\&}{ResetTime}{\void} | |
716 | ||
717 | Reset time to midnight (00:00:00) without changing the date. | |
718 | ||
719 | \membersection{wxDateTime::SetYear}\label{wxdatetimesetyear} | |
720 | ||
721 | \func{wxDateTime\&}{SetYear}{\param{int }{year}} | |
722 | ||
723 | Sets the year without changing other date components. | |
724 | ||
725 | \membersection{wxDateTime::SetMonth}\label{wxdatetimesetmonth} | |
726 | ||
727 | \func{wxDateTime\&}{SetMonth}{\param{Month }{month}} | |
728 | ||
729 | Sets the month without changing other date components. | |
730 | ||
731 | \membersection{wxDateTime::SetDay}\label{wxdatetimesetday} | |
732 | ||
733 | \func{wxDateTime\&}{SetDay}{\param{wxDateTime\_t }{day}} | |
734 | ||
735 | Sets the day without changing other date components. | |
736 | ||
737 | \membersection{wxDateTime::SetHour}\label{wxdatetimesethour} | |
738 | ||
739 | \func{wxDateTime\&}{SetHour}{\param{wxDateTime\_t }{hour}} | |
740 | ||
741 | Sets the hour without changing other date components. | |
742 | ||
743 | \membersection{wxDateTime::SetMinute}\label{wxdatetimesetminute} | |
744 | ||
745 | \func{wxDateTime\&}{SetMinute}{\param{wxDateTime\_t }{minute}} | |
746 | ||
747 | Sets the minute without changing other date components. | |
748 | ||
749 | \membersection{wxDateTime::SetSecond}\label{wxdatetimesetsecond} | |
750 | ||
751 | \func{wxDateTime\&}{SetSecond}{\param{wxDateTime\_t }{second}} | |
752 | ||
753 | Sets the second without changing other date components. | |
754 | ||
755 | \membersection{wxDateTime::SetMillisecond}\label{wxdatetimesetmillisecond} | |
756 | ||
757 | \func{wxDateTime\&}{SetMillisecond}{\param{wxDateTime\_t }{millisecond}} | |
758 | ||
759 | Sets the millisecond without changing other date components. | |
760 | ||
761 | \membersection{wxDateTime::operator$=$}\label{wxdatetimeoperatoreqtimet} | |
762 | ||
763 | \func{wxDateTime\&}{operator}{\param{time\_t }{timet}} | |
764 | ||
765 | Same as \helpref{Set}{wxdatetimesettimet}. | |
766 | ||
767 | \membersection{wxDateTime::operator$=$}\label{wxdatetimeoperatoreqtm} | |
768 | ||
769 | \func{wxDateTime\&}{operator}{\param{const struct tm\& }{tm}} | |
770 | ||
771 | Same as \helpref{Set}{wxdatetimesettm}. | |
772 | ||
773 | %%%%%%%%%%%%%%%%%%%%%%%%%%% accessors %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
774 | ||
775 | \membersection{wxDateTime::IsValid}\label{wxdatetimeisvalid} | |
776 | ||
777 | \constfunc{bool}{IsValid}{\void} | |
778 | ||
779 | Returns {\tt TRUE} if the object represents a valid time moment. | |
780 | ||
781 | \membersection{wxDateTime::GetTm}\label{wxdatetimegettm} | |
782 | ||
783 | \constfunc{Tm}{GetTm}{\param{const TimeZone\& }{tz = Local}} | |
784 | ||
785 | Returns broken down representation of the date and time. | |
786 | ||
787 | \membersection{wxDateTime::GetTicks}\label{wxdatetimegetticks} | |
788 | ||
789 | \constfunc{time\_t}{GetTicks}{\void} | |
790 | ||
791 | Returns the number of seconds since Jan 1, 1970. An assert failure will occur | |
792 | if the date is not in the range covered by {\tt time\_t} type. | |
793 | ||
794 | \membersection{wxDateTime::GetYear}\label{wxdatetimegetyear} | |
795 | ||
796 | \constfunc{int}{GetYear}{\param{const TimeZone\& }{tz = Local}} | |
797 | ||
798 | Returns the year in the given timezone (local one by default). | |
799 | ||
800 | \membersection{wxDateTime::GetMonth}\label{wxdatetimegetmonth} | |
801 | ||
802 | \constfunc{Month}{GetMonth}{\param{const TimeZone\& }{tz = Local}} | |
803 | ||
804 | Returns the month in the given timezone (local one by default). | |
805 | ||
806 | \membersection{wxDateTime::GetDay}\label{wxdatetimegetday} | |
807 | ||
808 | \constfunc{wxDateTime\_t}{GetDay}{\param{const TimeZone\& }{tz = Local}} | |
809 | ||
810 | Returns the day in the given timezone (local one by default). | |
811 | ||
812 | \membersection{wxDateTime::GetWeekDay}\label{wxdatetimegetweekday} | |
813 | ||
814 | \constfunc{WeekDay}{GetWeekDay}{\param{const TimeZone\& }{tz = Local}} | |
815 | ||
816 | Returns the week day in the given timezone (local one by default). | |
817 | ||
818 | \membersection{wxDateTime::GetHour}\label{wxdatetimegethour} | |
819 | ||
820 | \constfunc{wxDateTime\_t}{GetHour}{\param{const TimeZone\& }{tz = Local}} | |
821 | ||
822 | Returns the hour in the given timezone (local one by default). | |
823 | ||
824 | \membersection{wxDateTime::GetMinute}\label{wxdatetimegetminute} | |
825 | ||
826 | \constfunc{wxDateTime\_t}{GetMinute}{\param{const TimeZone\& }{tz = Local}} | |
827 | ||
828 | Returns the minute in the given timezone (local one by default). | |
829 | ||
830 | \membersection{wxDateTime::GetSecond}\label{wxdatetimegetsecond} | |
831 | ||
832 | \constfunc{wxDateTime\_t}{GetSecond}{\param{const TimeZone\& }{tz = Local}} | |
833 | ||
834 | Returns the seconds in the given timezone (local one by default). | |
835 | ||
836 | \membersection{wxDateTime::GetMillisecond}\label{wxdatetimegetmillisecond} | |
837 | ||
838 | \constfunc{wxDateTime\_t}{GetMillisecond}{\param{const TimeZone\& }{tz = Local}} | |
839 | ||
840 | Returns the milliseconds in the given timezone (local one by default). | |
841 | ||
842 | \membersection{wxDateTime::GetDayOfYear}\label{wxdatetimegetdayofyear} | |
843 | ||
844 | \constfunc{wxDateTime\_t}{GetDayOfYear}{\param{const TimeZone\& }{tz = Local}} | |
845 | ||
846 | Returns the day of the year (in $1\ldots366$ range) in the given timezone | |
847 | (local one by default). | |
848 | ||
849 | \membersection{wxDateTime::GetWeekOfYear}\label{wxdatetimegetweekofyear} | |
850 | ||
851 | \constfunc{wxDateTime\_t}{GetWeekOfYear}{\param{WeekFlags }{flags = Monday\_First}, \param{const TimeZone\& }{tz = Local}} | |
852 | ||
853 | Returns the number of the week of the year this date is in. The first week of | |
854 | the year is, according to international standards, the one containing Jan 4. | |
855 | The week number is in $1\ldots53$ range ($52$ for non leap years). | |
856 | ||
857 | The function depends on the \helpref{week start}{wxdatetime} convention | |
858 | specified by the {\it flags} argument. | |
859 | ||
860 | \membersection{wxDateTime::GetWeekOfMonth}\label{wxdatetimegetweekofmonth} | |
861 | ||
862 | \constfunc{wxDateTime\_t}{GetWeekOfMonth}{\param{WeekFlags }{flags = Monday\_First}, \param{const TimeZone\& }{tz = Local}} | |
863 | ||
864 | Returns the ordinal number of the week in the month (in $1\ldots5$ range). | |
865 | ||
866 | As \helpref{GetWeekOfYear}{wxdatetimegetweekofyear}, this function supports | |
867 | both conventions for the week start. See the description of these | |
868 | \helpref{week start}{wxdatetime} conventions. | |
869 | ||
870 | \membersection{wxDateTime::IsWorkDay}\label{wxdatetimeisworkday} | |
871 | ||
872 | \constfunc{bool}{IsWorkDay}{\param{Country }{country = Country\_Default}} | |
873 | ||
874 | Returns {\tt TRUE} is this day is not a holiday in the given country. | |
875 | ||
876 | \membersection{wxDateTime::IsGregorianDate}\label{wxdatetimeisgregoriandate} | |
877 | ||
878 | \constfunc{bool}{IsGregorianDate}{\param{GregorianAdoption }{country = Gr\_Standard}} | |
879 | ||
880 | Returns {\tt TRUE} if the given date os later than the date of adoption of the | |
881 | Gregorian calendar in the given country (and hence the Gregorian calendar | |
882 | calculations make sense for it). | |
883 | ||
884 | %%%%%%%%%%%%%%%%%%%%%%%%%%% comparison %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
885 | ||
886 | \membersection{wxDateTime::IsEqualTo}\label{wxdatetimeisequalto} | |
887 | ||
7af3ca16 | 888 | \constfunc{bool}{IsEqualTo}{\param{const wxDateTime\& }{datetime}} |
f6bcfd97 BP |
889 | |
890 | Returns {\tt TRUE} if the two dates are strictly identical. | |
891 | ||
892 | \membersection{wxDateTime::IsEarlierThan}\label{wxdatetimeisearlierthan} | |
893 | ||
7af3ca16 | 894 | \constfunc{bool}{IsEarlierThan}{\param{const wxDateTime\& }{datetime}} |
f6bcfd97 BP |
895 | |
896 | Returns {\tt TRUE} if this date precedes the given one. | |
897 | ||
898 | \membersection{wxDateTime::IsLaterThan}\label{wxdatetimeislaterthan} | |
899 | ||
7af3ca16 | 900 | \constfunc{bool}{IsLaterThan}{\param{const wxDateTime\& }{datetime}} |
f6bcfd97 BP |
901 | |
902 | Returns {\tt TRUE} if this date is later than the given one. | |
903 | ||
904 | \membersection{wxDateTime::IsStrictlyBetween}\label{wxdatetimeisstrictlybetween} | |
905 | ||
7af3ca16 | 906 | \constfunc{bool}{IsStrictlyBetween}{\param{const wxDateTime\& }{t1}, \param{const wxDateTime\& }{t2}} |
f6bcfd97 BP |
907 | |
908 | Returns {\tt TRUE} if this date lies strictly between the two others, | |
909 | ||
910 | \wxheading{See also} | |
911 | ||
912 | \helpref{IsBetween}{wxdatetimeisbetween} | |
913 | ||
914 | \membersection{wxDateTime::IsBetween}\label{wxdatetimeisbetween} | |
915 | ||
7af3ca16 | 916 | \constfunc{bool}{IsBetween}{\param{const wxDateTime\& }{t1}, \param{const wxDateTime\& }{t2}} |
f6bcfd97 BP |
917 | |
918 | Returns {\tt TRUE} if \helpref{IsStrictlyBetween}{wxdatetimeisstrictlybetween} | |
919 | is {\tt TRUE} or if the date is equal to one of the limi values. | |
920 | ||
921 | \wxheading{See also} | |
922 | ||
923 | \helpref{IsStrictlyBetween}{wxdatetimeisstrictlybetween} | |
924 | ||
925 | \membersection{wxDateTime::IsSameDate}\label{wxdatetimeissamedate} | |
926 | ||
7af3ca16 | 927 | \constfunc{bool}{IsSameDate}{\param{const wxDateTime\& }{dt}} |
f6bcfd97 BP |
928 | |
929 | Returns {\tt TRUE} if the date is the same without comparing the time parts. | |
930 | ||
931 | \membersection{wxDateTime::IsSameTime}\label{wxdatetimeissametime} | |
932 | ||
7af3ca16 | 933 | \constfunc{bool}{IsSameTime}{\param{const wxDateTime\& }{dt}} |
f6bcfd97 BP |
934 | |
935 | Returns {\tt TRUE} if the time is the same (although dates may differ). | |
936 | ||
937 | \membersection{wxDateTime::IsEqualUpTo}\label{wxdatetimeisequalupto} | |
938 | ||
939 | \constfunc{bool}{IsEqualUpTo}{\param{const wxDateTime\& }{dt}, \param{const wxTimeSpan\& }{ts}} | |
940 | ||
941 | Returns {\tt TRUE} if the date is equal to another one up to the given time | |
942 | interval, i.e. if the absolute difference between the two dates is less than | |
943 | this interval. | |
944 | ||
945 | %%%%%%%%%%%%%%%%%%%%%%%%%%% arithmetics %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
946 | ||
947 | \membersection{wxDateTime::Add}\label{wxdatetimeaddts} | |
948 | ||
949 | \constfunc{wxDateTime}{Add}{\param{const wxTimeSpan\& }{diff}} | |
950 | ||
951 | \func{wxDateTime\&}{Add}{\param{const wxTimeSpan\& }{diff}} | |
952 | ||
953 | \func{wxDateTime\&}{operator$+=$}{\param{const wxTimeSpan\& }{diff}} | |
954 | ||
955 | Adds the given time span to this object. | |
956 | ||
957 | \pythonnote{This method is named {\tt AddTS} in wxPython.} | |
958 | ||
959 | \membersection{wxDateTime::Subtract}\label{wxdatetimesubtractts} | |
960 | ||
961 | \constfunc{wxDateTime}{Subtract}{\param{const wxTimeSpan\& }{diff}} | |
962 | ||
963 | \func{wxDateTime\&}{Subtract}{\param{const wxTimeSpan\& }{diff}} | |
964 | ||
965 | \func{wxDateTime\&}{operator$-=$}{\param{const wxTimeSpan\& }{diff}} | |
966 | ||
967 | Subtracts the given time span from this object. | |
968 | ||
969 | \pythonnote{This method is named {\tt SubtractTS} in wxPython.} | |
970 | ||
971 | \membersection{wxDateTime::Add}\label{wxdatetimeaddds} | |
972 | ||
973 | \constfunc{wxDateTime}{Add}{\param{const wxDateSpan\& }{diff}} | |
974 | ||
975 | \func{wxDateTime\&}{Add}{\param{const wxDateSpan\& }{diff}} | |
976 | ||
977 | \func{wxDateTime\&}{operator$+=$}{\param{const wxDateSpan\& }{diff}} | |
978 | ||
979 | Adds the given date span to this object. | |
980 | ||
981 | \pythonnote{This method is named {\tt AddDS} in wxPython.} | |
982 | ||
983 | \membersection{wxDateTime::Subtract}\label{wxdatetimesubtractds} | |
984 | ||
985 | \constfunc{wxDateTime}{Subtract}{\param{const wxDateSpan\& }{diff}} | |
986 | ||
987 | \func{wxDateTime\&}{Subtract}{\param{const wxDateSpan\& }{diff}} | |
988 | ||
989 | \func{wxDateTime\&}{operator$-=$}{\param{const wxDateSpan\& }{diff}} | |
990 | ||
991 | Subtracts the given date span from this object. | |
992 | ||
993 | \pythonnote{This method is named {\tt SubtractDS} in wxPython.} | |
994 | ||
995 | \membersection{wxDateTime::Subtract}\label{wxdatetimesubtractdt} | |
996 | ||
997 | \constfunc{wxTimeSpan}{Subtract}{\param{const wxDateTime\& }{dt}} | |
998 | ||
999 | Subtracts another date from this one and returns the difference between them | |
1000 | as wxTimeSpan. | |
1001 | ||
1002 | %%%%%%%%%%%%%%%%%%%%%%%%%%% parsing/formatting %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
1003 | ||
1004 | \membersection{wxDateTime::ParseRfc822Date}\label{wxdatetimeparserfc822date} | |
1005 | ||
1006 | \func{const wxChar *}{ParseRfc822Date}{\param{const wxChar* }{date}} | |
1007 | ||
1008 | Parses the string {\it date} looking for a date formatted according to the RFC | |
1009 | 822 in it. The exact description of this format may, of course, be found in | |
1010 | the RFC (section $5$), but, briefly, this is the format used in the headers of | |
1011 | Internet email messages and one of the most common strings expressing date in | |
1012 | this format may be something like {\tt "Sat, 18 Dec 1999 00:48:30 +0100"}. | |
1013 | ||
1014 | Returns {\tt NULL} if the conversion failed, otherwise return the pointer to | |
1015 | the character immediately following the part of the string which could be | |
1016 | parsed. If the entire string contains only the date in RFC 822 format, | |
1017 | the returned pointer will be pointing to a {\tt NUL} character. | |
1018 | ||
1019 | This function is intenionally strict, it will return an error for any string | |
1020 | which is not RFC 822 compliant. If you need to parse date formatted in more | |
1021 | free ways, you should use \helpref{ParseDateTime}{wxdatetimeparsedatetime} or | |
1022 | \helpref{ParseDate}{wxdatetimeparsedate} instead. | |
1023 | ||
1024 | \membersection{wxDateTime::ParseFormat}\label{wxdatetimeparseformat} | |
1025 | ||
1026 | \func{const wxChar *}{ParseFormat}{\param{const wxChar *}{date}, \param{const wxChar *}{format = "\%c"}, \param{const wxDateTime\& }{dateDef = wxDefaultDateTime}} | |
1027 | ||
1028 | This function parses the string {\it date} according to the given | |
1029 | {\it format}. The system {\tt strptime(3)} function is used whenever available, | |
1030 | but even if it is not, this function is still implemented (although support | |
1031 | for locale-dependent format specificators such as {\tt "\%c"}, {\tt "\%x"} or | |
1032 | {\tt "\%X"} may be not perfect). This function does handle the month and | |
1033 | weekday names in the current locale on all platforms, however. | |
1034 | ||
1035 | Please the description of ANSI C function {\tt strftime(3)} for the syntax of | |
1036 | the format string. | |
1037 | ||
1038 | The {\it dateDef} parameter is used to fill in the fields which could not be | |
1039 | determined from the format string. For example, if the format is {\tt "\%d"} | |
1040 | (the day of the month), the month and the year are taken from {\it dateDef}. | |
1041 | If it is not specified, \helpref{Today}{wxdatetimetoday} is used as the | |
1042 | default date. | |
1043 | ||
1044 | Returns {\tt NULL} if the conversion failed, otherwise return the pointer to | |
1045 | the character which stopped the scan. | |
1046 | ||
1047 | \membersection{wxDateTime::ParseDateTime}\label{wxdatetimeparsedatetime} | |
1048 | ||
1049 | \func{const wxChar *}{ParseDateTime}{\param{const wxChar *}{datetime}} | |
1050 | ||
1051 | Parses the string {\it datetime} containing the date and time in free format. | |
1052 | This function tries as hard as it can to interpret the given string as date | |
1053 | and time. Unlike \helpref{ParseRfc822Date}{wxdatetimeparserfc822date}, it | |
1054 | will accept anything that may be accepted and will only reject strings which | |
1055 | can not be parsed in any way at all. | |
1056 | ||
1057 | Returns {\tt NULL} if the conversion failed, otherwise return the pointer to | |
1058 | the character which stopped the scan. | |
1059 | ||
1060 | \membersection{wxDateTime::ParseDate}\label{wxdatetimeparsedate} | |
1061 | ||
1062 | \func{const wxChar *}{ParseDate}{\param{const wxChar *}{date}} | |
1063 | ||
1064 | This function is like \helpref{ParseDateTime}{wxdatetimeparsedatetime}, but it | |
d3c7cfeb | 1065 | only allows the date to be specified. It is thus less flexible then |
f6bcfd97 BP |
1066 | \helpref{ParseDateTime}{wxdatetimeparsedatetime}, but also has less chances to |
1067 | misinterpret the user input. | |
1068 | ||
1069 | Returns {\tt NULL} if the conversion failed, otherwise return the pointer to | |
1070 | the character which stopped the scan. | |
1071 | ||
1072 | \membersection{wxDateTime::ParseTime}\label{wxdatetimeparsetime} | |
1073 | ||
1074 | \func{const wxChar *}{ParseTime}{\param{const wxChar *}{time}} | |
1075 | ||
1076 | This functions is like \helpref{ParseDateTime}{wxdatetimeparsedatetime}, but | |
1077 | only allows the time to be specified in the input string. | |
1078 | ||
1079 | Returns {\tt NULL} if the conversion failed, otherwise return the pointer to | |
1080 | the character which stopped the scan. | |
1081 | ||
1082 | \membersection{wxDateTime::Format}\label{wxdatetimeformat} | |
1083 | ||
1084 | \constfunc{wxString }{Format}{\param{const wxChar *}{format = "\%c"}, \param{const TimeZone\& }{tz = Local}} | |
1085 | ||
1086 | This function does the same as the standard ANSI C {\tt strftime(3)} function. | |
1087 | Please see its description for the meaning of {\it format} parameter. | |
1088 | ||
1089 | It also accepts a few wxWindows-specific extensions: you can optionally specify | |
1090 | the width of the field to follow using {\tt printf(3)}-like syntax and the | |
1091 | format specificator {\tt \%l} can be used to get the number of milliseconds. | |
1092 | ||
1093 | \wxheading{See also} | |
1094 | ||
1095 | \helpref{ParseFormat}{wxdatetimeparseformat} | |
1096 | ||
1097 | \membersection{wxDateTime::FormatDate}\label{wxdatetimeformatdate} | |
1098 | ||
1099 | \constfunc{wxString }{FormatDate}{\void} | |
1100 | ||
1101 | Identical to calling \helpref{Format()}{wxdatetimeformat} with {\tt "\%x"} | |
1102 | argument (which means `preferred date representation for the current locale'). | |
1103 | ||
1104 | \membersection{wxDateTime::FormatTime}\label{wxdatetimeformattime} | |
1105 | ||
1106 | \constfunc{wxString }{FormatTime}{\void} | |
1107 | ||
1108 | Identical to calling \helpref{Format()}{wxdatetimeformat} with {\tt "\%X"} | |
1109 | argument (which means `preferred time representation for the current locale'). | |
1110 | ||
1111 | \membersection{wxDateTime::FormatISODate}\label{wxdatetimeformatisodate} | |
1112 | ||
1113 | \constfunc{wxString }{FormatISODate}{\void} | |
1114 | ||
1115 | This function returns the date representation in the ISO 8601 format | |
1116 | (YYYY-MM-DD). | |
1117 | ||
1118 | \membersection{wxDateTime::FormatISOTime}\label{wxdatetimeformatisotime} | |
1119 | ||
1120 | \constfunc{wxString }{FormatISOTime}{\void} | |
1121 | ||
1122 | This function returns the time representation in the ISO 8601 format | |
1123 | (HH:MM:SS). | |
1124 | ||
1125 | %%%%%%%%%%%%%%%%%%%%%%%%%%% calendar calculations %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
1126 | ||
1127 | \membersection{wxDateTime::SetToWeekDayInSameWeek}\label{wxdatetimesettoweekdayinsameweek} | |
1128 | ||
1129 | \func{wxDateTime\&}{SetToWeekDayInSameWeek}{\param{WeekDay }{weekday}} | |
1130 | ||
1131 | Adjusts the date so that it will still lie in the same week as before, but its | |
1132 | week day will be the given one. | |
1133 | ||
1134 | Returns the reference to the modified object itself. | |
1135 | ||
1136 | \membersection{wxDateTime::GetWeekDayInSameWeek}\label{wxdatetimegetweekdayinsameweek} | |
1137 | ||
1138 | \constfunc{wxDateTime}{GetWeekDayInSameWeek}{\param{WeekDay }{weekday}} | |
1139 | ||
1140 | Returns the copy of this object to which | |
1141 | \helpref{SetToWeekDayInSameWeek}{wxdatetimesettoweekdayinsameweek} was | |
1142 | applied. | |
1143 | ||
1144 | \membersection{wxDateTime::SetToNextWeekDay}\label{wxdatetimesettonextweekday} | |
1145 | ||
1146 | \func{wxDateTime\&}{SetToNextWeekDay}{\param{WeekDay }{weekday}} | |
1147 | ||
1148 | Sets the date so that it will be the first {\it weekday} following the current | |
1149 | date. | |
1150 | ||
1151 | Returns the reference to the modified object itself. | |
1152 | ||
1153 | \membersection{wxDateTime::GetNextWeekDay}\label{wxdatetimegetnextweekday} | |
1154 | ||
1155 | \constfunc{wxDateTime}{GetNextWeekDay}{\param{WeekDay }{weekday}} | |
1156 | ||
1157 | Returns the copy of this object to which | |
1158 | \helpref{SetToNextWeekDay}{wxdatetimesettonextweekday} was applied. | |
1159 | ||
1160 | \membersection{wxDateTime::SetToPrevWeekDay}\label{wxdatetimesettoprevweekday} | |
1161 | ||
1162 | \func{wxDateTime\&}{SetToPrevWeekDay}{\param{WeekDay }{weekday}} | |
1163 | ||
1164 | Sets the date so that it will be the last {\it weekday} before the current | |
1165 | date. | |
1166 | ||
1167 | Returns the reference to the modified object itself. | |
1168 | ||
1169 | \membersection{wxDateTime::GetPrevWeekDay}\label{wxdatetimegetprevweekday} | |
1170 | ||
1171 | \constfunc{wxDateTime}{GetPrevWeekDay}{\param{WeekDay }{weekday}} | |
1172 | ||
1173 | Returns the copy of this object to which | |
1174 | \helpref{SetToPrevWeekDay}{wxdatetimesettoprevweekday} was applied. | |
1175 | ||
1176 | \membersection{wxDateTime::SetToWeekDay}\label{wxdatetimesettoweekday} | |
1177 | ||
1178 | \func{bool}{SetToWeekDay}{\param{WeekDay }{weekday}, \param{int }{n = 1}, \param{Month }{month = Inv\_Month}, \param{int }{year = Inv\_Year}} | |
1179 | ||
1180 | Sets the date to the {\it n}-th {\it weekday} in the given month of the given | |
1181 | year (the current month and year are used by default). The parameter {\it n} | |
1182 | may be either opsitive (counting from the beginning of the month) or negative | |
1183 | (counting from the end of it). | |
1184 | ||
1185 | For example, {\tt SetToWeekDay(2, wxDateTime::Wed)} will set the date to the | |
1186 | second Wednesday in the current month and | |
1187 | {\tt SetToWeekDay(-1, wxDateTime::Sun)} - to the last Sunday in it. | |
1188 | ||
1189 | Returns {\tt TRUE} if the date was modified successfully, {\tt FALSE} | |
1190 | otherwise meaning that the specified date doesn't exist. | |
1191 | ||
1192 | \membersection{wxDateTime::GetWeekDay}\label{wxdatetimegetweekday2} | |
1193 | ||
1194 | \constfunc{wxDateTime}{GetWeekDay}{\param{WeekDay }{weekday}, \param{int }{n = 1}, \param{Month }{month = Inv\_Month}, \param{int }{year = Inv\_Year}} | |
1195 | ||
1196 | Returns the copy of this object to which | |
1197 | \helpref{SetToWeekDay}{wxdatetimesettoweekday} was applied. | |
1198 | ||
1199 | \membersection{wxDateTime::SetToLastWeekDay}\label{wxdatetimesettolastweekday} | |
1200 | ||
1201 | \func{bool}{SetToLastWeekDay}{\param{WeekDay }{weekday}, \param{Month }{month = Inv\_Month}, \param{int }{year = Inv\_Year}} | |
1202 | ||
1203 | The effect of calling this function is the same as of calling | |
1204 | {\tt SetToWeekDay(-1, weekday, month, year)}. The date will be set to the last | |
1205 | {\it weekday} in the given month and year (the current ones by default). | |
1206 | ||
1207 | Always returns {\tt TRUE}. | |
1208 | ||
1209 | \membersection{wxDateTime::GetLastWeekDay}\label{wxdatetimegetlastweekday} | |
1210 | ||
1211 | \func{wxDateTime}{GetLastWeekDay}{\param{WeekDay }{weekday}, \param{Month }{month = Inv\_Month}, \param{int }{year = Inv\_Year}} | |
1212 | ||
1213 | Returns the copy of this object to which | |
1214 | \helpref{SetToLastWeekDay}{wxdatetimesettolastweekday} was applied. | |
1215 | ||
1216 | \membersection{wxDateTime::SetToTheWeek}\label{wxdatetimesettotheweek} | |
1217 | ||
1218 | \func{bool}{SetToTheWeek}{\param{wxDateTime\_t }{numWeek}, \param{WeekDay }{weekday = Mon}} | |
1219 | ||
1220 | Set the date to the given {\it weekday} in the week with given number | |
1221 | {\it numWeek}. The number should be in range $1\ldots53$ and {\tt FALSE} will | |
1222 | be returned if the specified date doesn't exist. {\tt TRUE} is returned if the | |
1223 | date was changed successfully. | |
1224 | ||
1225 | \membersection{wxDateTime::GetWeek}\label{wxdatetimegetweek} | |
1226 | ||
1227 | \constfunc{wxDateTime}{GetWeek}{\param{wxDateTime\_t }{numWeek}, \param{WeekDay }{weekday = Mon}} | |
1228 | ||
1229 | Returns the copy of this object to which | |
1230 | \helpref{SetToTheWeek}{wxdatetimesettotheweek} was applied. | |
1231 | ||
1232 | \membersection{wxDateTime::SetToLastMonthDay}\label{wxdatetimesettolastmonthday} | |
1233 | ||
1234 | \func{wxDateTime\&}{SetToLastMonthDay}{\param{Month }{month = Inv\_Month}, \param{int }{year = Inv\_Year}} | |
1235 | ||
1236 | Sets the date to the last day in the specified month (the current one by | |
1237 | default). | |
1238 | ||
1239 | Returns the reference to the modified object itself. | |
1240 | ||
1241 | \membersection{wxDateTime::GetLastMonthDay}\label{wxdatetimegetlastmonthday} | |
1242 | ||
1243 | \constfunc{wxDateTime}{GetLastMonthDay}{\param{Month }{month = Inv\_Month}, \param{int }{year = Inv\_Year}} | |
1244 | ||
1245 | Returns the copy of this object to which | |
1246 | \helpref{SetToLastMonthDay}{wxdatetimesettolastmonthday} was applied. | |
1247 | ||
1248 | \membersection{wxDateTime::SetToYearDay}\label{wxdatetimesettoyearday} | |
1249 | ||
1250 | \func{wxDateTime\&}{SetToYearDay}{\param{wxDateTime\_t }{yday}} | |
1251 | ||
1252 | Sets the date to the day number {\it yday} in the same year (i.e., unlike the | |
1253 | other functions, this one does not use the current year). The day number | |
1254 | should be in the range $1\ldots366$ for the leap years and $1\ldots365$ for | |
1255 | the other ones. | |
1256 | ||
1257 | Returns the reference to the modified object itself. | |
1258 | ||
1259 | \membersection{wxDateTime::GetYearDay}\label{wxdatetimegetyearday} | |
1260 | ||
1261 | \constfunc{wxDateTime}{GetYearDay}{\param{wxDateTime\_t }{yday}} | |
1262 | ||
1263 | Returns the copy of this object to which | |
1264 | \helpref{SetToYearDay}{wxdatetimesettoyearday} was applied. | |
1265 | ||
1266 | %%%%%%%%%%%%%%%%%%%%%%%%%%% astronomical functions %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
1267 | ||
1268 | \membersection{wxDateTime::GetJulianDayNumber}\label{wxdatetimegetjuliandaynumber} | |
1269 | ||
1270 | \constfunc{double}{GetJulianDayNumber}{\void} | |
1271 | ||
1272 | Returns the \helpref{JDN}{wxdatetimesetjdn} corresponding to this date. Beware | |
1273 | of rounding errors! | |
1274 | ||
1275 | \wxheading{See also} | |
1276 | ||
1277 | \helpref{GetModifiedJulianDayNumber}{wxdatetimegetmodifiedjuliandaynumber} | |
1278 | ||
1279 | \membersection{wxDateTime::GetJDN}\label{wxdatetimegetjdn} | |
1280 | ||
1281 | \constfunc{double}{GetJDN}{\void} | |
1282 | ||
1283 | Synonym for \helpref{GetJulianDayNumber}{wxdatetimegetjuliandaynumber}. | |
1284 | ||
1285 | \membersection{wxDateTime::GetModifiedJulianDayNumber}\label{wxdatetimegetmodifiedjuliandaynumber} | |
1286 | ||
1287 | \constfunc{double}{GetModifiedJulianDayNumber}{\void} | |
1288 | ||
1289 | Returns the {\it Modified Julian Day Number} (MJD) which is, by definition, | |
1290 | equal to $JDN - 2400000.5$. The MJDs are simpler to work with as the integral | |
1291 | MJDs correspond to midnights of the dates in the Gregorian calendar and not th | |
1292 | noons like JDN. The MJD $0$ is Nov 17, 1858. | |
1293 | ||
1294 | \membersection{wxDateTime::GetMJD}\label{wxdatetimegetmjd} | |
1295 | ||
1296 | \constfunc{double}{GetMJD}{\void} | |
1297 | ||
1298 | Synonym for \helpref{GetModifiedJulianDayNumber}{wxdatetimegetmodifiedjuliandaynumber}. | |
1299 | ||
1300 | \membersection{wxDateTime::GetRataDie}\label{wxdatetimegetratadie} | |
1301 | ||
1302 | \constfunc{double}{GetRataDie}{\void} | |
1303 | ||
1304 | Return the {\it Rata Die number} of this date. | |
1305 | ||
1306 | By definition, the Rata Die number is a date specified as the number of days | |
1307 | relative to a base date of December 31 of the year 0. Thus January 1 of the | |
1308 | year 1 is Rata Die day 1. | |
1309 | ||
1310 | %%%%%%%%%%%%%%%%%%%%%%%%%%% timezone and DST %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
1311 | ||
1312 | \membersection{wxDateTime::ToTimezone}\label{wxdatetimetotimezone} | |
1313 | ||
1314 | \constfunc{wxDateTime}{ToTimezone}{\param{const TimeZone\& }{tz}, \param{bool }{noDST = FALSE}} | |
1315 | ||
1316 | Transform the date to the given time zone. If {\it noDST} is {\tt TRUE}, no | |
1317 | DST adjustments will be made. | |
1318 | ||
1319 | Returns the date in the new time zone. | |
1320 | ||
1321 | \membersection{wxDateTime::MakeTimezone}\label{wxdatetimemaketimezone} | |
1322 | ||
1323 | \func{wxDateTime\&}{MakeTimezone}{\param{const TimeZone\& }{tz}, \param{bool }{noDST = FALSE}} | |
1324 | ||
1325 | Modifies the object in place to represent the date in another time zone. If | |
1326 | {\it noDST} is {\tt TRUE}, no DST adjustments will be made. | |
1327 | ||
1328 | \membersection{wxDateTime::ToGMT}\label{wxdatetimetogmt} | |
1329 | ||
1330 | \constfunc{wxDateTime}{ToGMT}{\param{bool }{noDST = FALSE}} | |
1331 | ||
1332 | This is the same as calling \helpref{ToTimezone}{wxdatetimetotimezone} with | |
1333 | the argument {\tt GMT0}. | |
1334 | ||
1335 | \membersection{wxDateTime::MakeGMT}\label{wxdatetimemakegmt} | |
1336 | ||
1337 | \func{wxDateTime\&}{MakeGMT}{\param{bool }{noDST = FALSE}} | |
1338 | ||
1339 | This is the same as calling \helpref{MakeTimezone}{wxdatetimemaketimezone} with | |
1340 | the argument {\tt GMT0}. | |
1341 | ||
1342 | \membersection{wxDateTime::IsDST}\label{wxdatetimeisdst} | |
1343 | ||
1344 | \constfunc{int}{IsDST}{\param{Country }{country = Country\_Default}} | |
1345 | ||
1346 | Returns {\tt TRUE} if the DST is applied for this date in the given country. | |
1347 | ||
1348 | \wxheading{See also} | |
1349 | ||
1350 | \helpref{GetBeginDST}{wxdatetimegetbegindst} and | |
1351 | \helpref{GetEndDST}{wxdatetimegetenddst} | |
1352 | ||
1353 | \section{\class{wxDateTimeHolidayAuthority}}\label{wxdatetimeholidayauthority} | |
1354 | ||
1355 | TODO | |
1356 | ||
1357 | \section{\class{wxDateTimeWorkDays}}\label{wxdatetimeworkdays} | |
1358 | ||
1359 | TODO | |
1360 |