X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc81d32f2bf8c159f3b1bf6ddaf62e6d77720209..097119648b492237f16acdf484eff8900c7c94d2:/docs/latex/wx/datespan.tex diff --git a/docs/latex/wx/datespan.tex b/docs/latex/wx/datespan.tex index 6fba885f1f..8ea57e0fa8 100644 --- a/docs/latex/wx/datespan.tex +++ b/docs/latex/wx/datespan.tex @@ -19,7 +19,7 @@ one month to Feb, 15 -- we want to get Mar, 15, of course). When adding a month to the date, all lesser components (days, hours, ...) won't be changed unless the resulting date would be invalid: for example, -Jan 31 + 1 month will be Feb 28, not (non existing) Feb 31. +Jan 31 + 1 month will be Feb 28, not (non-existing) Feb 31. Because of this feature, adding and subtracting back again the same wxDateSpan will {\bf not}, in general give back the original date: Feb 28 - 1 @@ -37,9 +37,9 @@ days added will be $7*\hbox{weeks} + \hbox{days}$! See also GetTotalDays() function. Equality operators are defined for wxDateSpans. Two datespans are equal if -and only if they both give the same target date when added to {\bf every} +and only if they both give the same target date when added to {\bf every}\rtfsp source date. Thus wxDateSpan::Months(1) is not equal to wxDateSpan::Days(30), -because they not give the same date when added to 1 Feb. But +because they don't give the same date when added to 1 Feb. But wxDateSpan::Days(14) is equal to wxDateSpan::Weeks(2) Finally, notice that for adding hours, minutes and so on you don't need this @@ -54,6 +54,10 @@ No base class +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{Date classes overview}{wxdatetimeoverview},\rtfsp @@ -71,7 +75,7 @@ Constructs the date span object for the given number of years, months, weeks and days. Note that the weeks and days add together if both are given. % wxDateSpan::Add -\membersection{wxDateSpan::Add}{wxdatespanadd} +\membersection{wxDateSpan::Add}\label{wxdatespanadd} \constfunc{wxDateSpan}{Add}{\param{const wxDateSpan\& }{other}} @@ -83,7 +87,7 @@ Returns the sum of two date spans. The first version returns a new object, the second and third ones modify this object in place. % wxDateSpan::Day -\membersection{wxDateSpan::Day}{wxdatespanday} +\membersection{wxDateSpan::Day}\label{wxdatespanday} \func{static wxDateSpan}{Day}{\void} @@ -94,7 +98,7 @@ Returns a date span object corresponding to one day. \helpref{Days}{wxdatespandays} % wxDateSpan::Days -\membersection{wxDateSpan::Days}{wxdatespandays} +\membersection{wxDateSpan::Days}\label{wxdatespandays} \func{static wxDateSpan}{Days}{\param{int }{days}} @@ -105,7 +109,7 @@ Returns a date span object corresponding to the given number of days. \helpref{Day}{wxdatespanday} % wxDateSpan::GetDays -\membersection{wxDateSpan::GetDays}{wxdatespangetdays} +\membersection{wxDateSpan::GetDays}\label{wxdatespangetdays} \constfunc{int}{GetDays}{\void} @@ -117,14 +121,14 @@ in this date span. \helpref{GetTotalDays}{wxdatespangettotaldays} % wxDateSpan::GetMonths -\membersection{wxDateSpan::GetMonths}{wxdatespangetmonths} +\membersection{wxDateSpan::GetMonths}\label{wxdatespangetmonths} \constfunc{int}{GetMonths}{\void} Returns the number of the months (not counting the years) in this date span. % wxDateSpan::GetTotalDays -\membersection{wxDateSpan::GetTotalDays}{wxdatespangettotaldays} +\membersection{wxDateSpan::GetTotalDays}\label{wxdatespangettotaldays} \constfunc{int}{GetTotalDays}{\void} @@ -136,7 +140,7 @@ days. It still doesn't take neither months nor years into the account. \helpref{GetWeeks}{wxdatespangetweeks}, \helpref{GetDays}{wxdatespangetdays} % wxDateSpan::GetWeeks -\membersection{wxDateSpan::GetWeeks}{wxdatespangetweeks} +\membersection{wxDateSpan::GetWeeks}\label{wxdatespangetweeks} \constfunc{int}{GetWeeks}{\void} @@ -147,14 +151,14 @@ Returns the number of weeks in this date span. \helpref{GetTotalDays}{wxdatespangettotaldays} % wxDateSpan::GetYears -\membersection{wxDateSpan::GetYears}{wxdatespangetyears} +\membersection{wxDateSpan::GetYears}\label{wxdatespangetyears} \constfunc{int}{GetYears}{\void} Returns the number of years in this date span. % wxDateSpan::Month -\membersection{wxDateSpan::Month}{wxdatespanmonth} +\membersection{wxDateSpan::Month}\label{wxdatespanmonth} \func{static wxDateSpan}{Month}{\void} @@ -165,7 +169,7 @@ Returns a date span object corresponding to one month. \helpref{Months}{wxdatespanmonths} % wxDateSpan::Months -\membersection{wxDateSpan::Months}{wxdatespanmonths} +\membersection{wxDateSpan::Months}\label{wxdatespanmonths} \func{static wxDateSpan}{Months}{\param{int }{mon}} @@ -176,7 +180,7 @@ Returns a date span object corresponding to the given number of months. \helpref{Month}{wxdatespanmonth} % wxDateSpan::Multiply -\membersection{wxDateSpan::Multiply}{wxdatespanmultiply} +\membersection{wxDateSpan::Multiply}\label{wxdatespanmultiply} \constfunc{wxDateSpan}{Multiply}{\param{int }{factor}} @@ -191,7 +195,7 @@ The first version returns a new object, the second and third ones modify this object in place. % wxDateSpan::Negate -\membersection{wxDateSpan::Negate}{wxdatespannegate} +\membersection{wxDateSpan::Negate}\label{wxdatespannegate} \constfunc{wxDateSpan}{Negate}{\void} @@ -202,7 +206,7 @@ Returns the date span with the opposite sign. \helpref{Neg}{wxdatespanneg} % wxDateSpan::Neg -\membersection{wxDateSpan::Neg}{wxdatespanneg} +\membersection{wxDateSpan::Neg}\label{wxdatespanneg} \func{wxDateSpan\&}{Neg}{\void} @@ -215,7 +219,7 @@ Changes the sign of this date span. \helpref{Negate}{wxdatespannegate} % wxDateSpan::SetDays -\membersection{wxDateSpan::SetDays}{wxdatespansetdays} +\membersection{wxDateSpan::SetDays}\label{wxdatespansetdays} \func{wxDateSpan\&}{SetDays}{\param{int }{n}} @@ -223,7 +227,7 @@ Sets the number of days (without modifying any other components) in this date span. % wxDateSpan::SetYears -\membersection{wxDateSpan::SetYears}{wxdatespansetyears} +\membersection{wxDateSpan::SetYears}\label{wxdatespansetyears} \func{wxDateSpan\&}{SetYears}{\param{int }{n}} @@ -231,7 +235,7 @@ Sets the number of years (without modifying any other components) in this date span. % wxDateSpan::SetMonths -\membersection{wxDateSpan::SetMonths}{wxdatespansetmonths} +\membersection{wxDateSpan::SetMonths}\label{wxdatespansetmonths} \func{wxDateSpan\&}{SetMonths}{\param{int }{n}} @@ -239,7 +243,7 @@ Sets the number of months (without modifying any other components) in this date span. % wxDateSpan::SetWeeks -\membersection{wxDateSpan::SetWeeks}{wxdatespansetweeks} +\membersection{wxDateSpan::SetWeeks}\label{wxdatespansetweeks} \func{wxDateSpan\&}{SetWeeks}{\param{int }{n}} @@ -247,7 +251,7 @@ Sets the number of weeks (without modifying any other components) in this date span. % wxDateSpan::Subtract -\membersection{wxDateSpan::Subtract}{wxdatespansubtract} +\membersection{wxDateSpan::Subtract}\label{wxdatespansubtract} \constfunc{wxDateSpan}{Subtract}{\param{const wxDateSpan\& }{other}} @@ -259,7 +263,7 @@ Returns the difference of two date spans. The first version returns a new object, the second and third ones modify this object in place. % wxDateSpan::Week -\membersection{wxDateSpan::Week}{wxdatespanweek} +\membersection{wxDateSpan::Week}\label{wxdatespanweek} \func{static wxDateSpan}{Week}{\void} @@ -270,7 +274,7 @@ Returns a date span object corresponding to one week. \helpref{Weeks}{wxdatespanweeks} % wxDateSpan::Weeks -\membersection{wxDateSpan::Weeks}{wxdatespanweeks} +\membersection{wxDateSpan::Weeks}\label{wxdatespanweeks} \func{static wxDateSpan}{Weeks}{\param{int }{weeks}} @@ -281,7 +285,7 @@ Returns a date span object corresponding to the given number of weeks. \helpref{Week}{wxdatespanweek} % wxDateSpan::Year -\membersection{wxDateSpan::Year}{wxdatespanyear} +\membersection{wxDateSpan::Year}\label{wxdatespanyear} \func{static wxDateSpan}{Year}{\void} @@ -292,7 +296,7 @@ Returns a date span object corresponding to one year. \helpref{Years}{wxdatespanyears} % wxDateSpan::Years -\membersection{wxDateSpan::Years}{wxdatespanyears} +\membersection{wxDateSpan::Years}\label{wxdatespanyears} \func{static wxDateSpan}{Years}{\param{int }{years}} @@ -303,7 +307,7 @@ Returns a date span object corresponding to the given number of years. \helpref{Year}{wxdatespanyear} % wxDateSpan::operator== -\membersection{wxDateSpan::operator$==$}{wxdatespanoperatorequal} +\membersection{wxDateSpan::operator$==$}\label{wxdatespanoperatorequal} \constfunc{bool}{operator$==$}{\param{wxDateSpan\&}{ other}} @@ -312,7 +316,7 @@ are considered equal if and only if they have the same number of years and months and the same total number of days (counting both days and weeks). % wxDateSpan::operator!= -\membersection{wxDateSpan::operator$!=$}{wxdatespanoperatornotequal} +\membersection{wxDateSpan::operator$!=$}\label{wxdatespanoperatornotequal} \constfunc{bool}{operator$!=$}{\param{wxDateSpan\&}{ other}} @@ -321,3 +325,4 @@ Returns {\tt true} if this date span is different from the other one. \wxheading{See also} \helpref{operator==}{wxdatespanoperatorequal} +