1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 %% Purpose: wxDateSpan documentation
4 %% Author: Vadim Zeitlin
8 %% Copyright: (c) Vadim Zeitlin
9 %% License: wxWindows license
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12 \section{\class{wxDateSpan
}}\label{wxdatespan
}
14 This class is a "logical time span" and is useful for implementing program
15 logic for such things as "add one month to the date" which, in general,
16 doesn't mean to add $
60*
60*
24*
31$ seconds to it, but to take the same date
17 the next month (to understand that this is indeed different consider adding
18 one month to Feb,
15 -- we want to get Mar,
15, of course).
20 When adding a month to the date, all lesser components (days, hours, ...)
21 won't be changed unless the resulting date would be invalid: for example,
22 Jan
31 +
1 month will be Feb
28, not (non-existing) Feb
31.
24 Because of this feature, adding and subtracting back again the same
25 wxDateSpan will
{\bf not
}, in general give back the original date: Feb
28 -
1
26 month will be Jan
28, not Jan
31!
28 wxDateSpan objects can be either positive or negative. They may be
29 multiplied by scalars which multiply all deltas by the scalar: i.e.
30 $
2*(
1 \hbox{ month and
} 1 \hbox{ day
})$ is $
2$ months and $
2$ days. They can
31 be added together and with
\helpref{wxDateTime
}{wxdatetime
} or
32 \helpref{wxTimeSpan
}{wxtimespan
}, but the type of result is different for each
35 Beware about weeks: if you specify both weeks and days, the total number of
36 days added will be $
7*
\hbox{weeks
} +
\hbox{days
}$! See also GetTotalDays()
39 Equality operators are defined for wxDateSpans. Two datespans are equal if
40 and only if they both give the same target date when added to
{\bf every
}\rtfsp
41 source date. Thus wxDateSpan::Months(
1) is not equal to wxDateSpan::Days(
30),
42 because they don't give the same date when added to
1 Feb. But
43 wxDateSpan::Days(
14) is equal to wxDateSpan::Weeks(
2)
45 Finally, notice that for adding hours, minutes and so on you don't need this
46 class at all:
\helpref{wxTimeSpan
}{wxtimespan
} will do the job because there
47 are no subtleties associated with those (we don't support leap seconds).
49 \wxheading{Derived from
}
53 \wxheading{Include files
}
59 \helpref{Date classes overview
}{wxdatetimeoverview
},
\rtfsp
60 \helpref{wxDateTime
}{wxdatetime
}
63 \latexignore{\rtfignore{\wxheading{Members
}}}
66 \membersection{wxDateSpan::wxDateSpan
}\label{wxdatespanwxdatespan
}
68 \func{}{wxDateSpan
}{\param{int
}{years = $
0$
},
\param{int
}{months = $
0$
},
\param{int
}{weeks = $
0$
},
\param{int
}{days = $
0$
}}
70 Constructs the date span object for the given number of years, months, weeks
71 and days. Note that the weeks and days add together if both are given.
74 \membersection{wxDateSpan::Add
}\label{wxdatespanadd
}
76 \constfunc{wxDateSpan
}{Add
}{\param{const wxDateSpan\&
}{other
}}
78 \func{wxDateSpan\&
}{Add
}{\param{const wxDateSpan\&
}{other
}}
80 \func{wxDateSpan\&
}{operator$+=$
}{\param{const wxDateSpan\&
}{other
}}
82 Returns the sum of two date spans. The first version returns a new object, the
83 second and third ones modify this object in place.
86 \membersection{wxDateSpan::Day
}\label{wxdatespanday
}
88 \func{static wxDateSpan
}{Day
}{\void}
90 Returns a date span object corresponding to one day.
94 \helpref{Days
}{wxdatespandays
}
97 \membersection{wxDateSpan::Days
}\label{wxdatespandays
}
99 \func{static wxDateSpan
}{Days
}{\param{int
}{days
}}
101 Returns a date span object corresponding to the given number of days.
105 \helpref{Day
}{wxdatespanday
}
107 % wxDateSpan::GetDays
108 \membersection{wxDateSpan::GetDays
}\label{wxdatespangetdays
}
110 \constfunc{int
}{GetDays
}{\void}
112 Returns the number of days (only, that it not counting the weeks component!)
117 \helpref{GetTotalDays
}{wxdatespangettotaldays
}
119 % wxDateSpan::GetMonths
120 \membersection{wxDateSpan::GetMonths
}\label{wxdatespangetmonths
}
122 \constfunc{int
}{GetMonths
}{\void}
124 Returns the number of the months (not counting the years) in this date span.
126 % wxDateSpan::GetTotalDays
127 \membersection{wxDateSpan::GetTotalDays
}\label{wxdatespangettotaldays
}
129 \constfunc{int
}{GetTotalDays
}{\void}
131 Returns the combined number of days in this date span, counting both weeks and
132 days. It still doesn't take neither months nor years into the account.
136 \helpref{GetWeeks
}{wxdatespangetweeks
},
\helpref{GetDays
}{wxdatespangetdays
}
138 % wxDateSpan::GetWeeks
139 \membersection{wxDateSpan::GetWeeks
}\label{wxdatespangetweeks
}
141 \constfunc{int
}{GetWeeks
}{\void}
143 Returns the number of weeks in this date span.
147 \helpref{GetTotalDays
}{wxdatespangettotaldays
}
149 % wxDateSpan::GetYears
150 \membersection{wxDateSpan::GetYears
}\label{wxdatespangetyears
}
152 \constfunc{int
}{GetYears
}{\void}
154 Returns the number of years in this date span.
157 \membersection{wxDateSpan::Month
}\label{wxdatespanmonth
}
159 \func{static wxDateSpan
}{Month
}{\void}
161 Returns a date span object corresponding to one month.
165 \helpref{Months
}{wxdatespanmonths
}
168 \membersection{wxDateSpan::Months
}\label{wxdatespanmonths
}
170 \func{static wxDateSpan
}{Months
}{\param{int
}{mon
}}
172 Returns a date span object corresponding to the given number of months.
176 \helpref{Month
}{wxdatespanmonth
}
178 % wxDateSpan::Multiply
179 \membersection{wxDateSpan::Multiply
}\label{wxdatespanmultiply
}
181 \constfunc{wxDateSpan
}{Multiply
}{\param{int
}{factor
}}
183 \func{wxDateSpan\&
}{Multiply
}{\param{int
}{factor
}}
185 \func{wxDateSpan\&
}{operator$*=$
}{\param{int
}{factor
}}
187 Returns the product of the date span by the specified
{\it factor
}. The
188 product is computed by multiplying each of the components by the factor.
190 The first version returns a new object, the second and third ones modify this
194 \membersection{wxDateSpan::Negate
}\label{wxdatespannegate
}
196 \constfunc{wxDateSpan
}{Negate
}{\void}
198 Returns the date span with the opposite sign.
202 \helpref{Neg
}{wxdatespanneg
}
205 \membersection{wxDateSpan::Neg
}\label{wxdatespanneg
}
207 \func{wxDateSpan\&
}{Neg
}{\void}
209 \func{wxDateSpan\&
}{operator$-$
}{\void}
211 Changes the sign of this date span.
215 \helpref{Negate
}{wxdatespannegate
}
217 % wxDateSpan::SetDays
218 \membersection{wxDateSpan::SetDays
}\label{wxdatespansetdays
}
220 \func{wxDateSpan\&
}{SetDays
}{\param{int
}{n
}}
222 Sets the number of days (without modifying any other components) in this date
225 % wxDateSpan::SetYears
226 \membersection{wxDateSpan::SetYears
}\label{wxdatespansetyears
}
228 \func{wxDateSpan\&
}{SetYears
}{\param{int
}{n
}}
230 Sets the number of years (without modifying any other components) in this date
233 % wxDateSpan::SetMonths
234 \membersection{wxDateSpan::SetMonths
}\label{wxdatespansetmonths
}
236 \func{wxDateSpan\&
}{SetMonths
}{\param{int
}{n
}}
238 Sets the number of months (without modifying any other components) in this
241 % wxDateSpan::SetWeeks
242 \membersection{wxDateSpan::SetWeeks
}\label{wxdatespansetweeks
}
244 \func{wxDateSpan\&
}{SetWeeks
}{\param{int
}{n
}}
246 Sets the number of weeks (without modifying any other components) in this date
249 % wxDateSpan::Subtract
250 \membersection{wxDateSpan::Subtract
}\label{wxdatespansubtract
}
252 \constfunc{wxDateSpan
}{Subtract
}{\param{const wxDateSpan\&
}{other
}}
254 \func{wxDateSpan\&
}{Subtract
}{\param{const wxDateSpan\&
}{other
}}
256 \func{wxDateSpan\&
}{operator$+=$
}{\param{const wxDateSpan\&
}{other
}}
258 Returns the difference of two date spans. The first version returns a new
259 object, the second and third ones modify this object in place.
262 \membersection{wxDateSpan::Week
}\label{wxdatespanweek
}
264 \func{static wxDateSpan
}{Week
}{\void}
266 Returns a date span object corresponding to one week.
270 \helpref{Weeks
}{wxdatespanweeks
}
273 \membersection{wxDateSpan::Weeks
}\label{wxdatespanweeks
}
275 \func{static wxDateSpan
}{Weeks
}{\param{int
}{weeks
}}
277 Returns a date span object corresponding to the given number of weeks.
281 \helpref{Week
}{wxdatespanweek
}
284 \membersection{wxDateSpan::Year
}\label{wxdatespanyear
}
286 \func{static wxDateSpan
}{Year
}{\void}
288 Returns a date span object corresponding to one year.
292 \helpref{Years
}{wxdatespanyears
}
295 \membersection{wxDateSpan::Years
}\label{wxdatespanyears
}
297 \func{static wxDateSpan
}{Years
}{\param{int
}{years
}}
299 Returns a date span object corresponding to the given number of years.
303 \helpref{Year
}{wxdatespanyear
}
305 % wxDateSpan::operator==
306 \membersection{wxDateSpan::operator$==$
}\label{wxdatespanoperatorequal
}
308 \constfunc{bool
}{operator$==$
}{\param{wxDateSpan\&
}{ other
}}
310 Returns
{\tt true
} if this date span is equal to the other one. Two date spans
311 are considered equal if and only if they have the same number of years and
312 months and the same total number of days (counting both days and weeks).
314 % wxDateSpan::operator!=
315 \membersection{wxDateSpan::operator$!=$
}\label{wxdatespanoperatornotequal
}
317 \constfunc{bool
}{operator$!=$
}{\param{wxDateSpan\&
}{ other
}}
319 Returns
{\tt true
} if this date span is different from the other one.
323 \helpref{operator==
}{wxdatespanoperatorequal
}
projects / wxWidgets.git / blob