]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/datetime.tex
cross-reference types in the generated docs (patch 1038083)
[wxWidgets.git] / docs / latex / wx / datetime.tex
index a20fb7fc655bac5a58fe3b89ff05c128bf7046fd..57ecb54df65b677019d741b0952ae60225364de6 100644 (file)
@@ -181,7 +181,7 @@ No base class
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
 
-\membersection{Static functions}
+\membersection{Static functions}\label{datetimestaticfunctions}
 
 For convenience, all static functions are collected here. These functions
 either set or return the static variables of wxDateSpan (the country), return
@@ -216,7 +216,7 @@ supported. Future versions will support other calendars.
 \helpref{Today}{wxdatetimetoday}
 
 
-\membersection{Constructors, assignment operators and setters}
+\membersection{Constructors, assignment operators and setters}\label{datetimeconstructors}
 
 Constructors and various {\tt Set()} methods are collected here. If you
 construct a date object from separate values for day, month and year, you
@@ -250,11 +250,11 @@ values were correct as constructors can not return an error code.
 \helpref{operator$=$(struct tm)}{wxdatetimeoperatoreqtm}\rtfsp
 
 
-\membersection{Accessors}
+\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 
-\helpref{Calendar calculations}{wxdatetimecalculations} section.
+\helpref{Calendar calculations}{datetimecalculations} section.
 
 \helpref{IsValid}{wxdatetimeisvalid}\\
 \helpref{GetTicks}{wxdatetimegetticks}\\
@@ -275,7 +275,7 @@ some more complicated calculations to find the answer are under the
 \helpref{GetAsDOS}{wxdatetimegetasdos}
 
 
-\membersection{Date comparison}
+\membersection{Date comparison}\label{datecomparison}
 
 There are several function to allow date comparison. To supplement them, a few
 global operators $>$, $<$ etc taking wxDateTime are defined.
@@ -290,7 +290,7 @@ global operators $>$, $<$ etc taking wxDateTime are defined.
 \helpref{IsEqualUpTo}{wxdatetimeisequalupto}
 
 
-\membersection{Date arithmetics}
+\membersection{Date arithmetics}\label{datearithmetics}
 
 These functions carry out \helpref{arithmetics}{tdatearithm} on the wxDateTime
 objects. As explained in the overview, either wxTimeSpan or wxDateSpan may be
@@ -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
-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.
@@ -314,9 +314,9 @@ defined to be equivalent to the second forms of these functions.
 \helpref{oparator$-=$(wxDateSpan)}{wxdatetimesubtractds}
 
 
-\membersection{Parsing and formatting dates}
+\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
 date and time representations for the current locale ( 
 \helpref{FormatDate}{wxdatetimeformatdate} and 
@@ -358,7 +358,7 @@ parse the strings such as {\tt "tomorrow"}, {\tt "March first"} and even
 \helpref{FormatISOTime}{wxdatetimeformatisotime}
 
 
-\membersection{Calendar calculations}\label{wxdatetimecalculations}
+\membersection{Calendar calculations}\label{datetimecalculations}
 
 The functions in this section perform the basic calendar calculations, mostly
 related to the week days. They allow to find the given week day in the
@@ -384,7 +384,7 @@ wxDateTime -- they only work with the date part of it.
 \helpref{GetYearDay}{wxdatetimegetyearday}
 
 
-\membersection{Astronomical/historical functions}
+\membersection{Astronomical/historical functions}\label{astronomyhistoryfunctions}
 
 Some degree of support for the date units used in astronomy and/or history is
 provided. You can construct a wxDateTime object from a
@@ -401,10 +401,10 @@ provided. You can construct a wxDateTime object from a
 \helpref{GetRataDie}{wxdatetimegetratadie}
 
 
-\membersection{Time zone and DST support}
+\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}\\
@@ -536,6 +536,20 @@ The only supported value for {\it cal} parameter is currently {\tt Gregorian}.
 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}}