]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/timespan.tex
slight warnings in wxprinterdc docs about constructor confusion - see http://www...
[wxWidgets.git] / docs / latex / wx / timespan.tex
index a46b716600be1ea7b3306504cefdd326f7835624..6150c18987562e2ab9cb5bddaec2865ff138ff9f 100644 (file)
@@ -6,7 +6,7 @@
 %% Created:     04.04.00
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin
-%% License:     wxWindows license
+%% License:     wxWidgets license
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxTimeSpan}}\label{wxtimespan}
@@ -28,7 +28,7 @@ No base class
 
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
-\membersection{Static functions}
+\membersection{Static functions}\label{timespanstaticfunctions}
 
 \helpref{Seconds}{wxtimespanseconds}\\
 \helpref{Second}{wxtimespansecond}\\
@@ -41,11 +41,11 @@ No base class
 \helpref{Weeks}{wxtimespanweeks}\\
 \helpref{Week}{wxtimespanweek}
 
-\membersection{Constructors}
+\membersection{Constructors}\label{timespanconstructors}
 
 \helpref{wxTimeSpan}{wxtimespanctor}
 
-\membersection{Accessors}
+\membersection{Accessors}\label{timespanaccessors}
 
 \helpref{GetSeconds}{wxtimespangetseconds}\\
 \helpref{GetMinutes}{wxtimespangetminutes}\\
@@ -54,16 +54,16 @@ No base class
 \helpref{GetWeeks}{wxtimespangetweeks}\\
 \helpref{GetValue}{wxtimespangetvalue}
 
-\membersection{Operations}
+\membersection{Operations}\label{timespanoperations}
 
 \helpref{Add}{wxtimespanadd}\\
-\helpref{Substract}{wxtimespansubstract}\\
+\helpref{Subtract}{wxtimespansubtract}\\
 \helpref{Multiply}{wxtimespanmultiply}\\
 \helpref{Negate}{wxtimespannegate}\\
 \helpref{Neg}{wxtimespanneg}\\
 \helpref{Abs}{wxtimespanabs}
 
-\membersection{Tests}
+\membersection{Tests}\label{timespantests}
 
 \helpref{IsNull}{wxtimespanisnull}\\
 \helpref{IsPositive}{wxtimespanispositive}\\
@@ -72,7 +72,7 @@ No base class
 \helpref{IsLongerThan}{wxtimespanislongerthan}\\
 \helpref{IsShorterThan}{wxtimespanisshorterthan}
 
-\membersection{Formatting time spans}
+\membersection{Formatting time spans}\label{timespanformatting}
 
 \helpref{Format}{wxtimespanformat}
 
@@ -115,7 +115,7 @@ Returns the timespan for one day.
 
 \membersection{wxTimeSpan::Format}\label{wxtimespanformat}
 
-\func{wxString}{Format}{\param{const wxChar * }{format = "\%H:\%M:\%S"}}
+\func{wxString}{Format}{\param{const wxChar * }{format = wxDefaultTimeSpanFormat}}
 
 Returns the string containing the formatted representation of the time span.
 The following format specifiers are allowed after \%:
@@ -202,40 +202,40 @@ Returns the timespan for one hour.
 
 \constfunc{bool}{IsEqualTo}{\param{const wxTimeSpan\& }{ts}}
 
-Returns {\tt TRUE} if two timespans are equal.
+Returns {\tt true} if two timespans are equal.
 
 \membersection{wxTimeSpan::IsLongerThan}\label{wxtimespanislongerthan}
 
 \constfunc{bool}{IsLongerThan}{\param{const wxTimeSpan\& }{ts}}
 
 Compares two timespans: works with the absolute values, i.e. -2
-hours is longer than 1 hour. Also, it will return {\tt FALSE} if
+hours is longer than 1 hour. Also, it will return {\tt false} if
 the timespans are equal in absolute value.
 
 \membersection{wxTimeSpan::IsNegative}\label{wxtimespanisnegative}
 
 \constfunc{bool}{IsNegative}{\void}
 
-Returns {\tt TRUE} if the timespan is negative.
+Returns {\tt true} if the timespan is negative.
 
 \membersection{wxTimeSpan::IsNull}\label{wxtimespanisnull}
 
 \constfunc{bool}{IsNull}{\void}
 
-Returns {\tt TRUE} if the timespan is empty.
+Returns {\tt true} if the timespan is empty.
 
 \membersection{wxTimeSpan::IsPositive}\label{wxtimespanispositive}
 
 \constfunc{bool}{IsPositive}{\void}
 
-Returns {\tt TRUE} if the timespan is positive.
+Returns {\tt true} if the timespan is positive.
 
 \membersection{wxTimeSpan::IsShorterThan}\label{wxtimespanisshorterthan}
 
 \constfunc{bool}{IsShorterThan}{\param{const wxTimeSpan\& }{ts}}
 
 Compares two timespans: works with the absolute values, i.e. 1
-hour is shorter than -2 hours. Also, it will return {\tt FALSE} if
+hour is shorter than -2 hours. Also, it will return {\tt false} if
 the timespans are equal in absolute value.
 
 \membersection{wxTimeSpan::Minutes}\label{wxtimespanminutes}
@@ -264,7 +264,7 @@ Multiplies timespan by a scalar.
 
 \constfunc{wxTimeSpan}{Negate}{\void}
 
-Returns timespan with inversed sign.
+Returns timespan with inverted sign.
 
 \membersection{wxTimeSpan::Neg}\label{wxtimespanneg}
 
@@ -286,11 +286,11 @@ Returns the timespan for the given number of seconds.
 
 Returns the timespan for one second.
 
-\membersection{wxTimeSpan::Substract}\label{wxtimespansubstract}
+\membersection{wxTimeSpan::Subtract}\label{wxtimespansubtract}
 
-\constfunc{wxTimeSpan}{Substract}{\param{const wxTimeSpan\&}{diff}}
+\constfunc{wxTimeSpan}{Subtract}{\param{const wxTimeSpan\&}{diff}}
 
-\func{wxTimeSpan\&}{Substract}{\param{const wxTimeSpan\& }{diff}}
+\func{wxTimeSpan\&}{Subtract}{\param{const wxTimeSpan\& }{diff}}
 
 \func{wxTimeSpan\&}{operator$-=$}{\param{const wxTimeSpan\&}{diff}}