]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/date.tex
removed wxEncodingConverter from docs where wxMBConv should be mentioned instead
[wxWidgets.git] / docs / latex / wx / date.tex
index 373904db667338a86bd3972a496de0b48818571d..bd01fbf511f034bc9420b2caae05f0182dfe24ef 100644 (file)
@@ -2,10 +2,18 @@
 
 A class for manipulating dates.
 
+{\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}
+
+<wx/date.h>
+
 \wxheading{See also}
 
 \helpref{wxTime}{wxtime}
@@ -194,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}
 
@@ -237,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.
 
@@ -307,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}