Implemented wxBitmap::HasAlpha() and ::UseAlpha().

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

diff --git a/docs/latex/wx/datetime.tex b/docs/latex/wx/datetime.tex
index a9bff2b6b16bfe6b35f8d91eca19edab032e103e..d87afb1c8ecff06e359216ad346eabaaee1a7fa5 100644 (file)
--- a/docs/latex/wx/datetime.tex
+++ b/docs/latex/wx/datetime.tex
@@ -121,7 +121,7 @@ parameters is one of the following values:
 \end{verbatim}
 
 Date calculations often depend on the country and wxDateTime allows to set the
 \end{verbatim}
 
 Date calculations often depend on the country and wxDateTime allows to set the

-country whose conventions should be used using 
+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:
 


@@ -148,7 +148,7 @@ values as parameter:
 Different parts 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
 Different parts 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

-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


@@ -192,7 +192,7 @@ 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 
+\pythonnote{These methods are standalone functions named

 {\tt wxDateTime\_<StaticMethodName>} in wxPython.}
 
 \helpref{SetCountry}{wxdatetimesetcountry}\\
 {\tt wxDateTime\_<StaticMethodName>} in wxPython.}
 
 \helpref{SetCountry}{wxdatetimesetcountry}\\


@@ -253,7 +253,7 @@ values were correct as constructors can not return an error code.
 \membersection{Accessors}\label{datetimeaccessors}
 
 Here are the trivial accessors. Other functions, which might have to perform
 \membersection{Accessors}\label{datetimeaccessors}
 
 Here are the trivial accessors. Other functions, which might have to perform

-some more complicated calculations to find the answer are under the 
+some more complicated calculations to find the answer are under the

 \helpref{Calendar calculations}{datetimecalculations} section.
 
 \helpref{IsValid}{wxdatetimeisvalid}\\
 \helpref{Calendar calculations}{datetimecalculations} section.
 
 \helpref{IsValid}{wxdatetimeisvalid}\\


@@ -298,7 +298,7 @@ added to wxDateTime, hence all functions are overloaded to accept both
 arguments.
 
 Also, both {\tt Add()} and {\tt Subtract()} have both const and non-const
 arguments.
 
 Also, both {\tt Add()} and {\tt Subtract()} have both const and non-const

-version. The first one returns a new obejct which represents the
+version. The first one returns a new object which represents the

 sum/difference of the original one with the argument while the second form
 modifies the object to which it is applied. The operators $-=$ and $+=$ are
 defined to be equivalent to the second forms of these functions.
 sum/difference of the original one with the argument while the second form
 modifies the object to which it is applied. The operators $-=$ and $+=$ are
 defined to be equivalent to the second forms of these functions.


@@ -316,34 +316,34 @@ defined to be equivalent to the second forms of these functions.
 
 \membersection{Parsing and formatting dates}\label{datetimeparsing}
 
 
 \membersection{Parsing and formatting dates}\label{datetimeparsing}
 

-These functions convert wxDateTime obejcts to and from text. The
+These functions convert wxDateTime objects to and from text. The

 conversions to text are mostly trivial: you can either do it using the default
 conversions to text are mostly trivial: you can either do it using the default

-date and time representations for the current locale ( 
-\helpref{FormatDate}{wxdatetimeformatdate} and 
+date and time representations for the current locale (
+\helpref{FormatDate}{wxdatetimeformatdate} and

 \helpref{FormatTime}{wxdatetimeformattime}), using the international standard
 \helpref{FormatTime}{wxdatetimeformattime}), using the international standard

-representation defined by ISO 8601 ( 
-\helpref{FormatISODate}{wxdatetimeformatisodate} and 
+representation defined by ISO 8601 (
+\helpref{FormatISODate}{wxdatetimeformatisodate} and

 \helpref{FormatISOTime}{wxdatetimeformatisotime}) or by specifying any format
 at all and using \helpref{Format}{wxdatetimeformat} directly.
 
 The conversions from text are more interesting, as there are much more
 \helpref{FormatISOTime}{wxdatetimeformatisotime}) or by specifying any format
 at all and using \helpref{Format}{wxdatetimeformat} directly.
 
 The conversions from text are more interesting, as there are much more

-possibilities to care about. The simplest cases can be taken care of with 
+possibilities to care about. The simplest cases can be taken care of with

 \helpref{ParseFormat}{wxdatetimeparseformat} which can parse any date in the
 given (rigid) format. \helpref{ParseRfc822Date}{wxdatetimeparserfc822date} is
 another function for parsing dates in predefined format -- the one of RFC 822
 which (still...) defines the format of email messages on the Internet. This
 \helpref{ParseFormat}{wxdatetimeparseformat} which can parse any date in the
 given (rigid) format. \helpref{ParseRfc822Date}{wxdatetimeparserfc822date} is
 another function for parsing dates in predefined format -- the one of RFC 822
 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 
+format can not be described with {\tt strptime(3)}-like format strings used by

 \helpref{Format}{wxdatetimeformat}, hence the need for a separate function.
 
 \helpref{Format}{wxdatetimeformat}, hence the need for a separate function.
 

-But the most interesting functions are 
-\helpref{ParseTime}{wxdatetimeparsetime}, 
-\helpref{ParseDate}{wxdatetimeparsedate} and 
+But the most interesting functions are
+\helpref{ParseTime}{wxdatetimeparsetime},
+\helpref{ParseDate}{wxdatetimeparsedate} and

 \helpref{ParseDateTime}{wxdatetimeparsedatetime}. 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 (interactive) user input which is not bound to be in any predefined
 format. As an example, \helpref{ParseDateTime}{wxdatetimeparsedatetime} can
 \helpref{ParseDateTime}{wxdatetimeparsedatetime}. 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 (interactive) user input which is not bound to be in any predefined
 format. As an example, \helpref{ParseDateTime}{wxdatetimeparsedatetime} can

-parse the strings such as {\tt "tomorrow"}, {\tt "March first"} and even 
+parse the strings such as {\tt "tomorrow"}, {\tt "March first"} and even

 {\tt "next Sunday"}.
 
 \helpref{ParseRfc822Date}{wxdatetimeparserfc822date}\\
 {\tt "next Sunday"}.
 
 \helpref{ParseRfc822Date}{wxdatetimeparserfc822date}\\


@@ -404,7 +404,7 @@ provided. You can construct a wxDateTime object from a
 \membersection{Time zone and DST support}\label{datetimedstzone}
 
 Please see the \helpref{time zone overview}{tdatetimezones} for more
 \membersection{Time zone and DST support}\label{datetimedstzone}
 
 Please see the \helpref{time zone overview}{tdatetimezones} for more

-information about time zones. ormally, these functions should be rarely used.
+information about time zones. Normally, these functions should be rarely used.

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


@@ -536,6 +536,20 @@ The only supported value for {\it cal} parameter is currently {\tt Gregorian}.
 and {\tt GetNumberOfDaysInMonth} in wxPython.}
 
 
 and {\tt GetNumberOfDaysInMonth} in wxPython.}
 
 

+\membersection{wxDateTime::GetTimeNow}\label{wxdatetimegettimenow}
+
+\func{static time\_t}{GetTimeNow}{\void}
+
+Returns the current time.
+
+
+\membersection{wxDateTime::GetTmNow}\label{wxdatetimegettmnow}
+
+\func{static struct tm *}{GetTmNow}{\void}
+
+Returns the current time broken down.
+
+

 \membersection{wxDateTime::GetWeekDayName}\label{wxdatetimegetweekdayname}
 
 \func{static wxString}{GetWeekDayName}{\param{WeekDay }{weekday}, \param{NameFlags }{flags = Name\_Full}}
 \membersection{wxDateTime::GetWeekDayName}\label{wxdatetimegetweekdayname}
 
 \func{static wxString}{GetWeekDayName}{\param{WeekDay }{weekday}, \param{NameFlags }{flags = Name\_Full}}


@@ -587,7 +601,7 @@ Example:
     printf("Current time in Paris:\t%s\n", now.Format("%c", wxDateTime::CET).c_str());
 \end{verbatim}
 
     printf("Current time in Paris:\t%s\n", now.Format("%c", wxDateTime::CET).c_str());
 \end{verbatim}
 

-Note that this function is accurate up to second: 
+Note that this function is accurate up to second:

 \helpref{wxDateTime::UNow}{wxdatetimeunow} should be used for better precision
 (but it is less efficient and might not be available on all platforms).
 
 \helpref{wxDateTime::UNow}{wxdatetimeunow} should be used for better precision
 (but it is less efficient and might not be available on all platforms).
 


@@ -684,7 +698,7 @@ 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{int}{ Inv\_Year}, 
+\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}
 \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}


@@ -921,7 +935,7 @@ more than half of its days in this year. Accordingly, the week number will
 always be in $1\ldots53$ range ($52$ for non leap years).
 
 The function depends on the \helpref{week start}{wxdatetime} convention
 always be in $1\ldots53$ range ($52$ for non leap years).
 
 The function depends on the \helpref{week start}{wxdatetime} convention

-specified by the {\it flags} argument but its results for 
+specified by the {\it flags} argument but its results for

 \texttt{Sunday\_First} are not well-defined as the ISO definition quoted above
 applies to the weeks starting on Monday only.
 
 \texttt{Sunday\_First} are not well-defined as the ISO definition quoted above
 applies to the weeks starting on Monday only.
 


@@ -959,8 +973,8 @@ calculations make sense for it).
 
 \func{wxDateTime\&}{Set}{\param{unsigned long }{ddt}}
 
 
 \func{wxDateTime\&}{Set}{\param{unsigned long }{ddt}}
 

-Sets the date from the date and time in 
-\urlref{DOS}{http://developer.novell.com/ndk/doc/smscomp/index.html?page=/ndk/doc/smscomp/sms\_docs/data/hc2vlu5i.html} 
+Sets the date from the date and time in
+\urlref{DOS}{http://developer.novell.com/ndk/doc/smscomp/index.html?page=/ndk/doc/smscomp/sms\_docs/data/hc2vlu5i.html}

 format.
 
 
 format.
 
 


@@ -968,8 +982,8 @@ format.
 
 \constfunc{unsigned long}{GetAsDOS}{\void}
 
 
 \constfunc{unsigned long}{GetAsDOS}{\void}
 

-Returns the date and time in 
-\urlref{DOS}{http://developer.novell.com/ndk/doc/smscomp/index.html?page=/ndk/doc/smscomp/sms\_docs/data/hc2vlu5i.html} 
+Returns the date and time in
+\urlref{DOS}{http://developer.novell.com/ndk/doc/smscomp/index.html?page=/ndk/doc/smscomp/sms\_docs/data/hc2vlu5i.html}

 format.
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%% comparison %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 format.
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%% comparison %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


@@ -1133,7 +1147,7 @@ free ways, you should use \helpref{ParseDateTime}{wxdatetimeparsedatetime} or
 
 \membersection{wxDateTime::ParseFormat}\label{wxdatetimeparseformat}
 
 
 \membersection{wxDateTime::ParseFormat}\label{wxdatetimeparseformat}
 

-\func{const wxChar *}{ParseFormat}{\param{const wxChar *}{date}, \param{const wxChar *}{format = "\%c"}, \param{const wxDateTime\& }{dateDef = wxDefaultDateTime}}
+\func{const wxChar *}{ParseFormat}{\param{const wxChar *}{date}, \param{const wxChar *}{format = wxDefaultDateTimeFormat}, \param{const wxDateTime\& }{dateDef = wxDefaultDateTime}}

 
 This function parses the string {\it date} according to the given
 {\it format}. The system {\tt strptime(3)} function is used whenever available,
 
 This function parses the string {\it date} according to the given
 {\it format}. The system {\tt strptime(3)} function is used whenever available,


@@ -1176,7 +1190,7 @@ implemented, so always returns NULL.
 \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 less 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.
 


@@ -1197,7 +1211,7 @@ the character which stopped the scan.
 
 \membersection{wxDateTime::Format}\label{wxdatetimeformat}
 
 
 \membersection{wxDateTime::Format}\label{wxdatetimeformat}
 

-\constfunc{wxString }{Format}{\param{const wxChar *}{format = "\%c"}, \param{const TimeZone\& }{tz = Local}}
+\constfunc{wxString }{Format}{\param{const wxChar *}{format = wxDefaultDateTimeFormat}, \param{const TimeZone\& }{tz = Local}}

 
 This function does the same as the standard ANSI C {\tt strftime(3)} function.
 Please see its description for the meaning of {\it format} parameter.
 
 This function does the same as the standard ANSI C {\tt strftime(3)} function.
 Please see its description for the meaning of {\it format} parameter.


@@ -1259,7 +1273,7 @@ Returns the reference to the modified object itself.
 
 \constfunc{wxDateTime}{GetWeekDayInSameWeek}{\param{WeekDay }{weekday}, \param{WeekFlags}{flags = {\tt Monday\_First}}}
 
 
 \constfunc{wxDateTime}{GetWeekDayInSameWeek}{\param{WeekDay }{weekday}, \param{WeekFlags}{flags = {\tt Monday\_First}}}
 

-Returns the copy of this object to which 
+Returns the copy of this object to which

 \helpref{SetToWeekDayInSameWeek}{wxdatetimesettoweekdayinsameweek} was
 applied.
 
 \helpref{SetToWeekDayInSameWeek}{wxdatetimesettoweekdayinsameweek} was
 applied.
 


@@ -1353,7 +1367,7 @@ given \arg{year} . The number should be in range $1\ldots53$.
 
 Note that the returned date may be in a different year than the one passed to
 this function because both the week $1$ and week $52$ or $53$ (for leap years)
 
 Note that the returned date may be in a different year than the one passed to
 this function because both the week $1$ and week $52$ or $53$ (for leap years)

-contain days from different years. See 
+contain days from different years. See

 \helpref{GetWeekOfYear}{wxdatetimegetweekofyear} for the explanation of how the
 year weeks are counted.
 
 \helpref{GetWeekOfYear}{wxdatetimegetweekofyear} for the explanation of how the
 year weeks are counted.