X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5b6aa0ff15be125c6f5f641e586002ec0c0330a2..ed39ff57b30a70a2395e07887a70bc01e7a3b7ec:/docs/latex/wx/date.tex diff --git a/docs/latex/wx/date.tex b/docs/latex/wx/date.tex index db4ce21197..bd01fbf511 100644 --- a/docs/latex/wx/date.tex +++ b/docs/latex/wx/date.tex @@ -2,14 +2,18 @@ A class for manipulating dates. -NOTE: this class should be -used with caution, since it is not fully tested. It may be replaced -with a new class in the near future. +{\bf NOTE:} this class is retained only for compatibility, +and has been replaced by \helpref{wxDateTime}{wxdatetime}. wxDate +may be withdrawn in future versions of wxWindows. \wxheading{Derived from} \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{See also} \helpref{wxTime}{wxtime} @@ -198,7 +202,7 @@ Returns the date representing the first day of the year. \constfunc{bool}{IsLeapYear}{\void} -Returns TRUE if the year of this date is a leap year. +Returns true if the year of this date is a leap year. \membersection{wxDate::Set}\label{wxdateset} @@ -241,7 +245,7 @@ Sets the current format type. \membersection{wxDate::SetOption}\label{wxdatesetoption} -\func{int}{SetOption}{\param{int}{ option}, \param{const bool}{ enable=TRUE}} +\func{int}{SetOption}{\param{int}{ option}, \param{const bool}{ enable=true}} Enables or disables an option for formatting. @@ -311,37 +315,37 @@ Decrements the date (postfix or prefix). \func{friend bool}{operator $<$}{\param{const wxDate\&}{ date1}, \param{const wxDate\&}{ date2}} -Function to compare two dates, returning TRUE if {\it date1} is earlier than {\it date2}. +Function to compare two dates, returning true if {\it date1} is earlier than {\it date2}. \membersection{wxDate::operator $<=$}\label{wxdatelessthaneq} \func{friend bool}{operator $<=$}{\param{const wxDate\&}{ date1}, \param{const wxDate\&}{ date2}} -Function to compare two dates, returning TRUE if {\it date1} is earlier than or equal to {\it date2}. +Function to compare two dates, returning true if {\it date1} is earlier than or equal to {\it date2}. \membersection{wxDate::operator $>$}\label{wxdategreaterthan} \func{friend bool}{operator $>$}{\param{const wxDate\&}{ date1}, \param{const wxDate\&}{ date2}} -Function to compare two dates, returning TRUE if {\it date1} is later than {\it date2}. +Function to compare two dates, returning true if {\it date1} is later than {\it date2}. \membersection{wxDate::operator $>=$}\label{wxdategreaterthaneq} \func{friend bool}{operator $>=$}{\param{const wxDate\&}{ date1}, \param{const wxDate\&}{ date2}} -Function to compare two dates, returning TRUE if {\it date1} is later than or equal to {\it date2}. +Function to compare two dates, returning true if {\it date1} is later than or equal to {\it date2}. \membersection{wxDate::operator $==$}\label{wxdateequals} \func{friend bool}{operator $==$}{\param{const wxDate\&}{ date1}, \param{const wxDate\&}{ date2}} -Function to compare two dates, returning TRUE if {\it date1} is equal to {\it date2}. +Function to compare two dates, returning true if {\it date1} is equal to {\it date2}. \membersection{wxDate::operator $!=$}\label{wxdatenotequals} \func{friend bool}{operator $!=$}{\param{const wxDate\&}{ date1}, \param{const wxDate\&}{ date2}} -Function to compare two dates, returning TRUE if {\it date1} is not equal to {\it date2}. +Function to compare two dates, returning true if {\it date1} is not equal to {\it date2}. \membersection{wxDate::operator \cinsert}\label{wxdateinsert}