I like if things compile with --enable-unicode + --enable-mediactrl. Code shamelessly...

[wxWidgets.git] / docs / latex / wx / datetime.tex

diff --git a/docs/latex/wx/datetime.tex b/docs/latex/wx/datetime.tex
index 9bd4c436e357b24c2a3c3bcef84bcd3b19cc973c..8d85f76d820f45f7e4008f352210c024070ce30b 100644 (file)
--- a/docs/latex/wx/datetime.tex
+++ b/docs/latex/wx/datetime.tex
@@ -97,7 +97,7 @@ Likewise, Sun, Mon, Tue, Wed, Thu, Fri, Sat, and Inv\_WeekDay are the values in
 Finally, Inv\_Year is defined to be an invalid value for year parameter.
 
 \helpref{GetMonthName()}{wxdatetimegetmonthname} and
 Finally, Inv\_Year is defined to be an invalid value for year parameter.
 
 \helpref{GetMonthName()}{wxdatetimegetmonthname} and

-\helpref{GetWeekDayName}{wxdatetimegetweekdayname} functions use the followign
+\helpref{GetWeekDayName}{wxdatetimegetweekdayname} functions use the following

 flags:
 
 \begin{verbatim}
 flags:
 
 \begin{verbatim}


@@ -406,10 +406,12 @@ provided. You can construct a wxDateTime object from a
 Please see the \helpref{time zone overview}{tdatetimezones} for more
 information about time zones. Normally, these functions should be rarely used.
 
 Please see the \helpref{time zone overview}{tdatetimezones} for more
 information about time zones. Normally, these functions should be rarely used.
 

+\helpref{FromTimezone}{wxdatetimefromtimezone}\\

 \helpref{ToTimezone}{wxdatetimetotimezone}\\
 \helpref{MakeTimezone}{wxdatetimemaketimezone}\\
 \helpref{ToTimezone}{wxdatetimetotimezone}\\
 \helpref{MakeTimezone}{wxdatetimemaketimezone}\\

-\helpref{ToGMT}{wxdatetimetogmt}\\
-\helpref{MakeGMT}{wxdatetimemakegmt}\\
+\helpref{MakeFromTimezone}{wxdatetimemakefromtimezone}\\
+\helpref{ToUTC}{wxdatetimetoutc}\\
+\helpref{MakeUTC}{wxdatetimemakeutc}\\

 \helpref{GetBeginDST}{wxdatetimegetbegindst}\\
 \helpref{GetEndDST}{wxdatetimegetenddst}\\
 \helpref{IsDST}{wxdatetimeisdst}
 \helpref{GetBeginDST}{wxdatetimegetbegindst}\\
 \helpref{GetEndDST}{wxdatetimegetenddst}\\
 \helpref{IsDST}{wxdatetimeisdst}


@@ -545,10 +547,21 @@ Returns the current time.
 
 \membersection{wxDateTime::GetTmNow}\label{wxdatetimegettmnow}
 
 
 \membersection{wxDateTime::GetTmNow}\label{wxdatetimegettmnow}
 

-\func{static struct tm *}{GetTmNow}{\void}
+\func{static struct tm *}{GetTmNow}{\param{struct tm *}{tm}}
+
+Returns the current time broken down, uses the buffer whose adress is
+passed to the function via {\it tm} to store the result.

 
 

-Returns the current time broken down.
+\membersection{wxDateTime::GetTmNow}
+
+\func{static struct tm *}{GetTmNow}{\void}

 
 

+Returns the current time broken down. Note that this function returns a
+pointer to a static buffer that's reused by calls to this function and
+certain C library functions (e.g. localtime). If there is any chance your
+code might be used in a multi-threaded application, you really should use
+the flavour of function \helpref{wxDateTime::GetTmNow}{wxdatetimegettmnow}
+taking a parameter.

 
 \membersection{wxDateTime::GetWeekDayName}\label{wxdatetimegetweekdayname}
 
 
 \membersection{wxDateTime::GetWeekDayName}\label{wxdatetimegetweekdayname}
 


@@ -1181,8 +1194,7 @@ will accept anything that may be accepted and will only reject strings which
 can not be parsed in any way at all.
 
 Returns {\tt NULL} if the conversion failed, otherwise return the pointer to
 can not be parsed in any way at all.
 
 Returns {\tt NULL} if the conversion failed, otherwise return the pointer to

-the character which stopped the scan.  This method is currently not
-implemented, so always returns NULL.
+the character which stopped the scan.

 
 
 \membersection{wxDateTime::ParseDate}\label{wxdatetimeparsedate}
 
 
 \membersection{wxDateTime::ParseDate}\label{wxdatetimeparsedate}


@@ -1461,6 +1473,16 @@ year 1 is Rata Die day 1.
 %%%%%%%%%%%%%%%%%%%%%%%%%%% timezone and DST %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%% timezone and DST %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 

+\membersection{wxDateTime::FromTimezone}\label{wxdatetimefromtimezone}
+
+\constfunc{wxDateTime}{FromTimezone}{\param{const TimeZone\& }{tz}, \param{bool }{noDST = false}}
+
+Transform the date from the given time zone to the local one. If {\it noDST} is 
+{\tt true}, no DST adjustments will be made.
+
+Returns the date in the local time zone.
+
+

 \membersection{wxDateTime::ToTimezone}\label{wxdatetimetotimezone}
 
 \constfunc{wxDateTime}{ToTimezone}{\param{const TimeZone\& }{tz}, \param{bool }{noDST = false}}
 \membersection{wxDateTime::ToTimezone}\label{wxdatetimetotimezone}
 
 \constfunc{wxDateTime}{ToTimezone}{\param{const TimeZone\& }{tz}, \param{bool }{noDST = false}}


@@ -1479,17 +1501,25 @@ Modifies the object in place to represent the date in another time zone. If
 {\it noDST} is {\tt true}, no DST adjustments will be made.
 
 
 {\it noDST} is {\tt true}, no DST adjustments will be made.
 
 

-\membersection{wxDateTime::ToGMT}\label{wxdatetimetogmt}
+\membersection{wxDateTime::MakeFromTimezone}\label{wxdatetimemakefromtimezone}
+
+\func{wxDateTime\&}{MakeFromTimezone}{\param{const TimeZone\& }{tz}, \param{bool }{noDST = false}}
+
+Same as \helpref{FromTimezone}{wxdatetimefromtimezone} but modifies the object
+in place.
+
+
+\membersection{wxDateTime::ToUTC}\label{wxdatetimetoutc}

 
 

-\constfunc{wxDateTime}{ToGMT}{\param{bool }{noDST = false}}
+\constfunc{wxDateTime}{ToUTC}{\param{bool }{noDST = false}}

 
 This is the same as calling \helpref{ToTimezone}{wxdatetimetotimezone} with
 the argument {\tt GMT0}.
 
 
 
 This is the same as calling \helpref{ToTimezone}{wxdatetimetotimezone} with
 the argument {\tt GMT0}.
 
 

-\membersection{wxDateTime::MakeGMT}\label{wxdatetimemakegmt}
+\membersection{wxDateTime::MakeUTC}\label{wxdatetimemakeutc}

 
 

-\func{wxDateTime\&}{MakeGMT}{\param{bool }{noDST = false}}
+\func{wxDateTime\&}{MakeUTC}{\param{bool }{noDST = false}}

 
 This is the same as calling \helpref{MakeTimezone}{wxdatetimemaketimezone} with
 the argument {\tt GMT0}.
 
 This is the same as calling \helpref{MakeTimezone}{wxdatetimemaketimezone} with
 the argument {\tt GMT0}.