corrected Get/SetFrame() parameter/return type

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

diff --git a/docs/latex/wx/datetime.tex b/docs/latex/wx/datetime.tex
index 1b8e204cf499432cbf7ed8f06e34983656826c36..9de18864b28de9677b2033aa840ee025b6458226 100644 (file)
--- a/docs/latex/wx/datetime.tex
+++ b/docs/latex/wx/datetime.tex
@@ -145,8 +145,8 @@ values as parameter:
     };
 \end{verbatim}
 
     };
 \end{verbatim}
 

-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.
+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 
 \helpref{GetWeekOfMonth}{wxdatetimegetweekofmonth}).
 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 
 \helpref{GetWeekOfMonth}{wxdatetimegetweekofmonth}).


@@ -235,6 +235,7 @@ values were correct as constructors can not return an error code.
 \helpref{Set(double jdn)}{wxdatetimesetjdn}\\
 \helpref{Set(h, m, s, ms)}{wxdatetimesettime}\\
 \helpref{Set(day, mon, year, h, m, s, ms)}{wxdatetimesetdate}\\
 \helpref{Set(double jdn)}{wxdatetimesetjdn}\\
 \helpref{Set(h, m, s, ms)}{wxdatetimesettime}\\
 \helpref{Set(day, mon, year, h, m, s, ms)}{wxdatetimesetdate}\\

+\helpref{SetFromDOS(unsigned long ddt)}{wxdatetimesetfromdos}\\

 \helpref{ResetTime}{wxdatetimeresettime}\\
 \helpref{SetYear}{wxdatetimesetyear}\\
 \helpref{SetMonth}{wxdatetimesetmonth}\\
 \helpref{ResetTime}{wxdatetimeresettime}\\
 \helpref{SetYear}{wxdatetimesetyear}\\
 \helpref{SetMonth}{wxdatetimesetmonth}\\


@@ -260,7 +261,7 @@ some more complicated calculations to find the answer are under the
 \helpref{GetDay}{wxdatetimegetday}\\
 \helpref{GetWeekDay}{wxdatetimegetweekday}\\
 \helpref{GetHour}{wxdatetimegethour}\\
 \helpref{GetDay}{wxdatetimegetday}\\
 \helpref{GetWeekDay}{wxdatetimegetweekday}\\
 \helpref{GetHour}{wxdatetimegethour}\\

-\helpref{GeTMinute}{wxdatetimegetminute}\\
+\helpref{GetMinute}{wxdatetimegetminute}\\

 \helpref{GetSecond}{wxdatetimegetsecond}\\
 \helpref{GetMillisecond}{wxdatetimegetmillisecond}\\
 \helpref{GetDayOfYear}{wxdatetimegetdayofyear}\\
 \helpref{GetSecond}{wxdatetimegetsecond}\\
 \helpref{GetMillisecond}{wxdatetimegetmillisecond}\\
 \helpref{GetDayOfYear}{wxdatetimegetdayofyear}\\


@@ -268,7 +269,8 @@ some more complicated calculations to find the answer are under the
 \helpref{GetWeekOfMonth}{wxdatetimegetweekofmonth}\\
 \helpref{GetYearDay}{wxdatetimegetyearday}\\
 \helpref{IsWorkDay}{wxdatetimeisworkday}\\
 \helpref{GetWeekOfMonth}{wxdatetimegetweekofmonth}\\
 \helpref{GetYearDay}{wxdatetimegetyearday}\\
 \helpref{IsWorkDay}{wxdatetimeisworkday}\\

-\helpref{IsGregorianDate}{wxdatetimeisgregoriandate}
+\helpref{IsGregorianDate}{wxdatetimeisgregoriandate}\\
+\helpref{GetAsDOS}{wxdatetimegetasdos}

 
 \membersection{Date comparison}
 
 
 \membersection{Date comparison}
 


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

-These functions perform convert wxDateTime obejcts to and from text. The
+These functions convert wxDateTime obejcts 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 simples 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
 \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
+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
 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.
 
 But the most interesting functions are 
 \helpref{Format}{wxdatetimeformat}, hence the need for a separate function.
 
 But the most interesting functions are 

-\helpref{ParseDateTime}{wxdatetimeparsedatetime} and 
+\helpref{ParseTime}{wxdatetimeparsetime}, 

 \helpref{ParseDate}{wxdatetimeparsedate} 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
-(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"}, {\tt "next Sunday"}.
+\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 
+{\tt "next Sunday"}.

 
 \helpref{ParseRfc822Date}{wxdatetimeparserfc822date}\\
 \helpref{ParseFormat}{wxdatetimeparseformat}\\
 
 \helpref{ParseRfc822Date}{wxdatetimeparserfc822date}\\
 \helpref{ParseFormat}{wxdatetimeparseformat}\\


@@ -356,7 +359,7 @@ related to the week days. They allow to find the given week day in the
 week with given number (either in the month or in the year) and so on.
 
 All (non-const) functions in this section don't modify the time part of the
 week with given number (either in the month or in the year) and so on.
 
 All (non-const) functions in this section don't modify the time part of the

-wxDateTime - they only work with the date part of it.
+wxDateTime -- they only work with the date part of it.

 
 \helpref{SetToWeekDayInSameWeek}{wxdatetimesettoweekdayinsameweek}\\
 \helpref{GetWeekDayInSameWeek}{wxdatetimegetweekdayinsameweek}\\
 
 \helpref{SetToWeekDayInSameWeek}{wxdatetimesettoweekdayinsameweek}\\
 \helpref{GetWeekDayInSameWeek}{wxdatetimegetweekdayinsameweek}\\


@@ -881,6 +884,24 @@ Returns {\tt TRUE} if the given date os later than the date of adoption of the
 Gregorian calendar in the given country (and hence the Gregorian calendar
 calculations make sense for it).
 
 Gregorian calendar in the given country (and hence the Gregorian calendar
 calculations make sense for it).
 

+%%%%%%%%%%%%%%%%%%%%%% dos date and time format %%%%%%%%%%%%%%%%%%%%%%%
+
+\membersection{wxDateTime::SetFromDOS}\label{wxdatetimesetfromdos}
+
+\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} 
+format.
+
+\membersection{wxDateTime::GetAsDOS}\label{wxdatetimegetasdos}
+
+\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} 
+format.
+

 %%%%%%%%%%%%%%%%%%%%%%%%%%% comparison %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \membersection{wxDateTime::IsEqualTo}\label{wxdatetimeisequalto}
 %%%%%%%%%%%%%%%%%%%%%%%%%%% comparison %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \membersection{wxDateTime::IsEqualTo}\label{wxdatetimeisequalto}


@@ -1126,7 +1147,7 @@ This function returns the time representation in the ISO 8601 format
 
 \membersection{wxDateTime::SetToWeekDayInSameWeek}\label{wxdatetimesettoweekdayinsameweek}
 
 
 \membersection{wxDateTime::SetToWeekDayInSameWeek}\label{wxdatetimesettoweekdayinsameweek}
 

-\func{wxDateTime\&}{SetToWeekDayInSameWeek}{\param{WeekDay }{weekday}}
+\func{wxDateTime\&}{SetToWeekDayInSameWeek}{\param{WeekDay }{weekday}, \param{WeekFlags}{flags = {\tt Monday\_First}}}

 
 Adjusts the date so that it will still lie in the same week as before, but its
 week day will be the given one.
 
 Adjusts the date so that it will still lie in the same week as before, but its
 week day will be the given one.


@@ -1135,9 +1156,9 @@ Returns the reference to the modified object itself.
 
 \membersection{wxDateTime::GetWeekDayInSameWeek}\label{wxdatetimegetweekdayinsameweek}
 
 
 \membersection{wxDateTime::GetWeekDayInSameWeek}\label{wxdatetimegetweekdayinsameweek}
 

-\constfunc{wxDateTime}{GetWeekDayInSameWeek}{\param{WeekDay }{weekday}}
+\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.
 


@@ -1184,7 +1205,7 @@ may be either positive (counting from the beginning of the month) or negative
 
 For example, {\tt SetToWeekDay(2, wxDateTime::Wed)} will set the date to the
 second Wednesday in the current month and
 
 For example, {\tt SetToWeekDay(2, wxDateTime::Wed)} will set the date to the
 second Wednesday in the current month and

-{\tt SetToWeekDay(-1, wxDateTime::Sun)} - to the last Sunday in it.
+{\tt SetToWeekDay(-1, wxDateTime::Sun)} -- to the last Sunday in it.

 
 Returns {\tt TRUE} if the date was modified successfully, {\tt FALSE}
 otherwise meaning that the specified date doesn't exist.
 
 Returns {\tt TRUE} if the date was modified successfully, {\tt FALSE}
 otherwise meaning that the specified date doesn't exist.


@@ -1215,7 +1236,7 @@ Returns the copy of this object to which
 
 \membersection{wxDateTime::SetToTheWeek}\label{wxdatetimesettotheweek}
 
 
 \membersection{wxDateTime::SetToTheWeek}\label{wxdatetimesettotheweek}
 

-\func{bool}{SetToTheWeek}{\param{wxDateTime\_t }{numWeek}, \param{WeekDay }{weekday = Mon}}
+\func{bool}{SetToTheWeek}{\param{wxDateTime\_t }{numWeek}, \param{WeekDay }{weekday = Mon}, \param{WeekFlags}{flags = {\tt Monday\_First}}}

 
 Set the date to the given {\it weekday} in the week with given number
 {\it numWeek}. The number should be in range $1\ldots53$ and {\tt FALSE} will
 
 Set the date to the given {\it weekday} in the week with given number
 {\it numWeek}. The number should be in range $1\ldots53$ and {\tt FALSE} will


@@ -1224,7 +1245,7 @@ date was changed successfully.
 
 \membersection{wxDateTime::GetWeek}\label{wxdatetimegetweek}
 
 
 \membersection{wxDateTime::GetWeek}\label{wxdatetimegetweek}
 

-\constfunc{wxDateTime}{GetWeek}{\param{wxDateTime\_t }{numWeek}, \param{WeekDay }{weekday = Mon}}
+\constfunc{wxDateTime}{GetWeek}{\param{wxDateTime\_t }{numWeek}, \param{WeekDay }{weekday = Mon}, \param{WeekFlags}{flags = {\tt Monday\_First}}}

 
 Returns the copy of this object to which
 \helpref{SetToTheWeek}{wxdatetimesettotheweek} was applied.
 
 Returns the copy of this object to which
 \helpref{SetToTheWeek}{wxdatetimesettotheweek} was applied.