Documented wxClienData and friends.
[wxWidgets.git] / docs / latex / wx / datetime.tex
index 01d8b9e54c65bf66b15dfec70ad149c753d1955c..844bceca10f3094ddd4d6ddd2c6a5b6ebd79017e 100644 (file)
@@ -120,8 +120,8 @@ parameters is one of the following values:
     };
 \end{verbatim}
 
     };
 \end{verbatim}
 
-Date calculatiosn often depend on the country adn wxDateTime allows to set the
-country which conventions should be used using
+Date calculations often depend on the country and wxDateTime allows to set the
+country whose conventions should be used using 
 \helpref{SetCountry}{wxdatetimesetcountry}. It takes one of the following
 values as parameter:
 
 \helpref{SetCountry}{wxdatetimesetcountry}. It takes one of the following
 values as parameter:
 
@@ -145,11 +145,10 @@ values as parameter:
     };
 \end{verbatim}
 
     };
 \end{verbatim}
 
-Differnet parst of the world use different conventions for the week start.
+Different parst of the world use different conventions for the week start.
 In some countries, the week starts on Sunday, while in others - on Monday.
 The ISO standard doesn't address this issue, so we support both conventions in
 In some countries, the week starts on Sunday, while in others - on Monday.
 The ISO standard doesn't address this issue, so we support both conventions in
-the functions whose result depends on it (
-\helpref{GetWeekOfYear}{wxdatetimegetweekofyear} and
+the functions whose result depends on it (\helpref{GetWeekOfYear}{wxdatetimegetweekofyear} and 
 \helpref{GetWeekOfMonth}{wxdatetimegetweekofmonth}).
 
 The desired behvaiour may be specified by giving one of the following
 \helpref{GetWeekOfMonth}{wxdatetimegetweekofmonth}).
 
 The desired behvaiour may be specified by giving one of the following
@@ -175,8 +174,8 @@ No base class
 \wxheading{See also}
 
 \helpref{Date classes overview}{wxdatetimeoverview},\rtfsp
 \wxheading{See also}
 
 \helpref{Date classes overview}{wxdatetimeoverview},\rtfsp
-wxTimeSpan,\rtfsp
-wxDateSpan,\rtfsp
+\helpref{wxTimeSpan}{wxtimespan},\rtfsp
+\helpref{wxDateSpan}{wxdatespan},\rtfsp
 \helpref{wxCalendarCtrl}{wxcalendarctrl}
 
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 \helpref{wxCalendarCtrl}{wxcalendarctrl}
 
 \latexignore{\rtfignore{\wxheading{Function groups}}}
@@ -192,8 +191,8 @@ Please note that although several function accept an extra {\it Calendar}
 parameter, it is currently ignored as only the Gregorian calendar is
 supported. Future versions will support other calendars.
 
 parameter, it is currently ignored as only the Gregorian calendar is
 supported. Future versions will support other calendars.
 
-\pythonnote{These methods are standalone functions named
-{\tt wxDateTime_<StaticMethodName>} in wxPython.}
+\pythonnote{These methods are standalone functions named 
+{\tt wxDateTime\_<StaticMethodName>} in wxPython.}
 
 \helpref{SetCountry}{wxdatetimesetcountry}\\
 \helpref{GetCountry}{wxdatetimegetcountry}\\
 
 \helpref{SetCountry}{wxdatetimesetcountry}\\
 \helpref{GetCountry}{wxdatetimegetcountry}\\
@@ -251,7 +250,7 @@ values were correct as constructors can not return an error code.
 \membersection{Accessors}
 
 Here are the trivial accessors. Other functions, which might have to perform
 \membersection{Accessors}
 
 Here are the trivial accessors. Other functions, which might have to perform
-some more complicated calculations to find the answer are under
+some more complicated calculations to find the answer are under the 
 \helpref{Calendar calculations}{wxdatetimecalculations} section.
 
 \helpref{IsValid}{wxdatetimeisvalid}\\
 \helpref{Calendar calculations}{wxdatetimecalculations} section.
 
 \helpref{IsValid}{wxdatetimeisvalid}\\
@@ -329,9 +328,9 @@ which (still...) defines the format of email messages on the Internet. This
 format can not be described with {\tt strptime(3)}-like format strings used by
 \helpref{Format}{wxdatetimeformat}, hence the need for a separate function.
 
 format can not be described with {\tt strptime(3)}-like format strings used by
 \helpref{Format}{wxdatetimeformat}, hence the need for a separate function.
 
-But the most interesting functions are
-\helpref{ParseDateTime}{wxdatetimeparsedatetime} and
-\helpref{ParseDate}{wxdatetimeparsedate} and
+But the most interesting functions are 
+\helpref{ParseDateTime}{wxdatetimeparsedatetime} and 
+\helpref{ParseDate}{wxdatetimeparsedate} and 
 \helpref{ParseTime}{wxdatetimeparsetime}. They try to parse the date ans time
 (or only one of them) in `free' format, i.e. allow them to be specified in any
 of possible ways. These functions will usually be used to parse the
 \helpref{ParseTime}{wxdatetimeparsetime}. They try to parse the date ans time
 (or only one of them) in `free' format, i.e. allow them to be specified in any
 of possible ways. These functions will usually be used to parse the
@@ -651,7 +650,8 @@ Same as \helpref{Set}{wxdatetimewxdatetimetime}
 
 \membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimedate}
 
 
 \membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimedate}
 
-\func{wxDateTime\&}{wxDateTime}{\param{wxDateTime\_t }{day}, \param{Month        }{month = Inv\_Month}, \param{wxDateTime\_t }{hour = 0}, \param{wxDateTime\_t }{minute = 0}, \param{wxDateTime\_t }{second = 0}, \param{wxDateTime\_t }{millisec = 0}}
+\func{wxDateTime\&}{wxDateTime}{\param{wxDateTime\_t }{day}, \param{Month }{month = Inv\_Month}, \param{int}{ Inv\_Year}, 
+\param{wxDateTime\_t }{hour = 0}, \param{wxDateTime\_t }{minute = 0}, \param{wxDateTime\_t }{second = 0}, \param{wxDateTime\_t }{millisec = 0}}
 
 Same as \helpref{Set}{wxdatetimesetdate}
 
 
 Same as \helpref{Set}{wxdatetimesetdate}
 
@@ -659,7 +659,7 @@ Same as \helpref{Set}{wxdatetimesetdate}
 
 \membersection{wxDateTime::SetToCurrent}\label{wxdatetimesettocurrent}
 
 
 \membersection{wxDateTime::SetToCurrent}\label{wxdatetimesettocurrent}
 
-\func{wxDateTime&}{SetToCurrent}{\void}
+\func{wxDateTime\&}{SetToCurrent}{\void}
 
 Sets the date and time of to the current values. Same as assigning the result
 of \helpref{Now()}{wxdatetimenow} to this object.
 
 Sets the date and time of to the current values. Same as assigning the result
 of \helpref{Now()}{wxdatetimenow} to this object.
@@ -706,7 +706,7 @@ from supplied parameters.
 
 \membersection{wxDateTime::Set}\label{wxdatetimesetdate}
 
 
 \membersection{wxDateTime::Set}\label{wxdatetimesetdate}
 
-\func{wxDateTime\&}{Set}{\param{wxDateTime\_t }{day}, \param{Month        }{month = Inv\_Month}, \param{wxDateTime\_t }{hour = 0}, \param{wxDateTime\_t }{minute = 0}, \param{wxDateTime\_t }{second = 0}, \param{wxDateTime\_t }{millisec = 0}}
+\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}}
 
 Sets the date and time from the parameters.
 
 
 Sets the date and time from the parameters.
 
@@ -885,25 +885,25 @@ calculations make sense for it).
 
 \membersection{wxDateTime::IsEqualTo}\label{wxdatetimeisequalto}
 
 
 \membersection{wxDateTime::IsEqualTo}\label{wxdatetimeisequalto}
 
-\constfunc{bool}{IsEqualTo}{\param{const wxDateTime& }{datetime}}
+\constfunc{bool}{IsEqualTo}{\param{const wxDateTime\& }{datetime}}
 
 Returns {\tt TRUE} if the two dates are strictly identical.
 
 \membersection{wxDateTime::IsEarlierThan}\label{wxdatetimeisearlierthan}
 
 
 Returns {\tt TRUE} if the two dates are strictly identical.
 
 \membersection{wxDateTime::IsEarlierThan}\label{wxdatetimeisearlierthan}
 
-\constfunc{bool}{IsEarlierThan}{\param{const wxDateTime& }{datetime}}
+\constfunc{bool}{IsEarlierThan}{\param{const wxDateTime\& }{datetime}}
 
 Returns {\tt TRUE} if this date precedes the given one.
 
 \membersection{wxDateTime::IsLaterThan}\label{wxdatetimeislaterthan}
 
 
 Returns {\tt TRUE} if this date precedes the given one.
 
 \membersection{wxDateTime::IsLaterThan}\label{wxdatetimeislaterthan}
 
-\constfunc{bool}{IsLaterThan}{\param{const wxDateTime& }{datetime}}
+\constfunc{bool}{IsLaterThan}{\param{const wxDateTime\& }{datetime}}
 
 Returns {\tt TRUE} if this date is later than the given one.
 
 \membersection{wxDateTime::IsStrictlyBetween}\label{wxdatetimeisstrictlybetween}
 
 
 Returns {\tt TRUE} if this date is later than the given one.
 
 \membersection{wxDateTime::IsStrictlyBetween}\label{wxdatetimeisstrictlybetween}
 
-\constfunc{bool}{IsStrictlyBetween}{\param{const wxDateTime& }{t1}, \param{const wxDateTime& }{t2}}
+\constfunc{bool}{IsStrictlyBetween}{\param{const wxDateTime\& }{t1}, \param{const wxDateTime\& }{t2}}
 
 Returns {\tt TRUE} if this date lies strictly between the two others,
 
 
 Returns {\tt TRUE} if this date lies strictly between the two others,
 
@@ -913,7 +913,7 @@ Returns {\tt TRUE} if this date lies strictly between the two others,
 
 \membersection{wxDateTime::IsBetween}\label{wxdatetimeisbetween}
 
 
 \membersection{wxDateTime::IsBetween}\label{wxdatetimeisbetween}
 
-\constfunc{bool}{IsBetween}{\param{const wxDateTime& }{t1}, \param{const wxDateTime& }{t2}}
+\constfunc{bool}{IsBetween}{\param{const wxDateTime\& }{t1}, \param{const wxDateTime\& }{t2}}
 
 Returns {\tt TRUE} if \helpref{IsStrictlyBetween}{wxdatetimeisstrictlybetween}
 is {\tt TRUE} or if the date is equal to one of the limi values.
 
 Returns {\tt TRUE} if \helpref{IsStrictlyBetween}{wxdatetimeisstrictlybetween}
 is {\tt TRUE} or if the date is equal to one of the limi values.
@@ -924,13 +924,13 @@ is {\tt TRUE} or if the date is equal to one of the limi values.
 
 \membersection{wxDateTime::IsSameDate}\label{wxdatetimeissamedate}
 
 
 \membersection{wxDateTime::IsSameDate}\label{wxdatetimeissamedate}
 
-\constfunc{bool}{IsSameDate}{\param{const wxDateTime& }{dt}}
+\constfunc{bool}{IsSameDate}{\param{const wxDateTime\& }{dt}}
 
 Returns {\tt TRUE} if the date is the same without comparing the time parts.
 
 \membersection{wxDateTime::IsSameTime}\label{wxdatetimeissametime}
 
 
 Returns {\tt TRUE} if the date is the same without comparing the time parts.
 
 \membersection{wxDateTime::IsSameTime}\label{wxdatetimeissametime}
 
-\constfunc{bool}{IsSameTime}{\param{const wxDateTime& }{dt}}
+\constfunc{bool}{IsSameTime}{\param{const wxDateTime\& }{dt}}
 
 Returns {\tt TRUE} if the time is the same (although dates may differ).
 
 
 Returns {\tt TRUE} if the time is the same (although dates may differ).
 
@@ -1062,7 +1062,7 @@ the character which stopped the scan.
 \func{const wxChar *}{ParseDate}{\param{const wxChar *}{date}}
 
 This function is like \helpref{ParseDateTime}{wxdatetimeparsedatetime}, but it
 \func{const wxChar *}{ParseDate}{\param{const wxChar *}{date}}
 
 This function is like \helpref{ParseDateTime}{wxdatetimeparsedatetime}, but it
-only allows the date to be specified. It is thus flexible then
+only allows the date to be specified. It is thus less flexible then 
 \helpref{ParseDateTime}{wxdatetimeparsedatetime}, but also has less chances to
 misinterpret the user input.
 
 \helpref{ParseDateTime}{wxdatetimeparsedatetime}, but also has less chances to
 misinterpret the user input.