fix ReceiveTimeout() reference

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

diff --git a/docs/latex/wx/timespan.tex b/docs/latex/wx/timespan.tex
index 3b5b37e15a17f1e86accfa8e555575c11f016387..443cf9f0be10348223b71862298be45368500f28 100644 (file)
--- a/docs/latex/wx/timespan.tex
+++ b/docs/latex/wx/timespan.tex
@@ -21,6 +21,10 @@ No base class
 
 <wx/datetime.h>
 
 
 <wx/datetime.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{Date classes overview}{wxdatetimeoverview},\rtfsp
 \wxheading{See also}
 
 \helpref{Date classes overview}{wxdatetimeoverview},\rtfsp


@@ -28,8 +32,11 @@ No base class
 
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
 
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 

-\membersection{Static functions}

 
 

+\membersection{Static functions}\label{timespanstaticfunctions}
+
+\helpref{Milliseconds}{wxtimespanmilliseconds}\\
+\helpref{Millisecond}{wxtimespanmillisecond}\\

 \helpref{Seconds}{wxtimespanseconds}\\
 \helpref{Second}{wxtimespansecond}\\
 \helpref{Minutes}{wxtimespanminutes}\\
 \helpref{Seconds}{wxtimespanseconds}\\
 \helpref{Second}{wxtimespansecond}\\
 \helpref{Minutes}{wxtimespanminutes}\\


@@ -41,11 +48,13 @@ No base class
 \helpref{Weeks}{wxtimespanweeks}\\
 \helpref{Week}{wxtimespanweek}
 
 \helpref{Weeks}{wxtimespanweeks}\\
 \helpref{Week}{wxtimespanweek}
 

-\membersection{Constructors}

 
 

-\helpref{wxTimeSpan}{wxtimespan}
+\membersection{Constructors}\label{timespanconstructors}

 
 

-\membersection{Accessors}
+\helpref{wxTimeSpan}{wxtimespanctor}
+
+
+\membersection{Accessors}\label{timespanaccessors}

 
 \helpref{GetSeconds}{wxtimespangetseconds}\\
 \helpref{GetMinutes}{wxtimespangetminutes}\\
 
 \helpref{GetSeconds}{wxtimespangetseconds}\\
 \helpref{GetMinutes}{wxtimespangetminutes}\\


@@ -54,16 +63,18 @@ No base class
 \helpref{GetWeeks}{wxtimespangetweeks}\\
 \helpref{GetValue}{wxtimespangetvalue}
 
 \helpref{GetWeeks}{wxtimespangetweeks}\\
 \helpref{GetValue}{wxtimespangetvalue}
 

-\membersection{Operations}
+
+\membersection{Operations}\label{timespanoperations}

 
 \helpref{Add}{wxtimespanadd}\\
 
 \helpref{Add}{wxtimespanadd}\\

-\helpref{Substract}{wxtimespansubstract}\\
+\helpref{Subtract}{wxtimespansubtract}\\

 \helpref{Multiply}{wxtimespanmultiply}\\
 \helpref{Negate}{wxtimespannegate}\\
 \helpref{Neg}{wxtimespanneg}\\
 \helpref{Abs}{wxtimespanabs}
 
 \helpref{Multiply}{wxtimespanmultiply}\\
 \helpref{Negate}{wxtimespannegate}\\
 \helpref{Neg}{wxtimespanneg}\\
 \helpref{Abs}{wxtimespanabs}
 

-\membersection{Tests}
+
+\membersection{Tests}\label{timespantests}

 
 \helpref{IsNull}{wxtimespanisnull}\\
 \helpref{IsPositive}{wxtimespanispositive}\\
 
 \helpref{IsNull}{wxtimespanisnull}\\
 \helpref{IsPositive}{wxtimespanispositive}\\


@@ -72,7 +83,8 @@ No base class
 \helpref{IsLongerThan}{wxtimespanislongerthan}\\
 \helpref{IsShorterThan}{wxtimespanisshorterthan}
 
 \helpref{IsLongerThan}{wxtimespanislongerthan}\\
 \helpref{IsShorterThan}{wxtimespanisshorterthan}
 

-\membersection{Formatting time spans}
+
+\membersection{Formatting time spans}\label{timespanformatting}

 
 \helpref{Format}{wxtimespanformat}
 
 
 \helpref{Format}{wxtimespanformat}
 


@@ -84,6 +96,7 @@ No base class
     \wxheading{Members}
 }}
 
     \wxheading{Members}
 }}
 

+

 \membersection{wxTimeSpan::Abs}\label{wxtimespanabs}
 
 \constfunc{wxTimeSpan}{Abs}{\void}
 \membersection{wxTimeSpan::Abs}\label{wxtimespanabs}
 
 \constfunc{wxTimeSpan}{Abs}{\void}


@@ -91,6 +104,7 @@ No base class
 Returns the absolute value of the timespan: does not modify the
 object.
 
 Returns the absolute value of the timespan: does not modify the
 object.
 

+

 \membersection{wxTimeSpan::Add}\label{wxtimespanadd}
 
 \constfunc{wxTimeSpan}{Add}{\param{const wxTimeSpan\& }{diff}}
 \membersection{wxTimeSpan::Add}\label{wxtimespanadd}
 
 \constfunc{wxTimeSpan}{Add}{\param{const wxTimeSpan\& }{diff}}


@@ -101,21 +115,24 @@ object.
 
 Returns the sum of two timespans.
 
 
 Returns the sum of two timespans.
 

+

 \membersection{wxTimeSpan::Days}\label{wxtimespandays}
 
 \func{static wxTimespan}{Days}{\param{long }{days}}
 
 Returns the timespan for the given number of days.
 
 \membersection{wxTimeSpan::Days}\label{wxtimespandays}
 
 \func{static wxTimespan}{Days}{\param{long }{days}}
 
 Returns the timespan for the given number of days.
 

+

 \membersection{wxTimeSpan::Day}\label{wxtimespanday}
 
 \func{static wxTimespan}{Day}{\void}
 
 Returns the timespan for one day.
 
 \membersection{wxTimeSpan::Day}\label{wxtimespanday}
 
 \func{static wxTimespan}{Day}{\void}
 
 Returns the timespan for one day.
 

+

 \membersection{wxTimeSpan::Format}\label{wxtimespanformat}
 
 \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 \%:
 
 Returns the string containing the formatted representation of the time span.
 The following format specifiers are allowed after \%:


@@ -144,112 +161,130 @@ interpreted as $2$. Otherwise, it is $50$.
 The same applies to all other format specifiers: if they follow a specifier of
 larger unit, only the rest part is taken, otherwise the full value is used.
 
 The same applies to all other format specifiers: if they follow a specifier of
 larger unit, only the rest part is taken, otherwise the full value is used.
 

+

 \membersection{wxTimeSpan::GetDays}\label{wxtimespangetdays}
 
 \constfunc{int}{GetDays}{\void}
 
 Returns the difference in number of days.
 
 \membersection{wxTimeSpan::GetDays}\label{wxtimespangetdays}
 
 \constfunc{int}{GetDays}{\void}
 
 Returns the difference in number of days.
 

+

 \membersection{wxTimeSpan::GetHours}\label{wxtimespangethours}
 
 \constfunc{int}{GetHours}{\void}
 
 Returns the difference in number of hours.
 
 \membersection{wxTimeSpan::GetHours}\label{wxtimespangethours}
 
 \constfunc{int}{GetHours}{\void}
 
 Returns the difference in number of hours.
 

+

 \membersection{wxTimeSpan::GetMilliseconds}\label{wxtimespangetmilliseconds}
 
 \constfunc{wxLongLong}{GetMilliseconds}{\void}
 
 Returns the difference in number of milliseconds.
 
 \membersection{wxTimeSpan::GetMilliseconds}\label{wxtimespangetmilliseconds}
 
 \constfunc{wxLongLong}{GetMilliseconds}{\void}
 
 Returns the difference in number of milliseconds.
 

+

 \membersection{wxTimeSpan::GetMinutes}\label{wxtimespangetminutes}
 
 \constfunc{int}{GetMinutes}{\void}
 
 Returns the difference in number of minutes.
 
 \membersection{wxTimeSpan::GetMinutes}\label{wxtimespangetminutes}
 
 \constfunc{int}{GetMinutes}{\void}
 
 Returns the difference in number of minutes.
 

+

 \membersection{wxTimeSpan::GetSeconds}\label{wxtimespangetseconds}
 
 \constfunc{wxLongLong}{GetSeconds}{\void}
 
 Returns the difference in number of seconds.
 
 \membersection{wxTimeSpan::GetSeconds}\label{wxtimespangetseconds}
 
 \constfunc{wxLongLong}{GetSeconds}{\void}
 
 Returns the difference in number of seconds.
 

+

 \membersection{wxTimeSpan::GetValue}\label{wxtimespangetvalue}
 
 \constfunc{wxLongLong}{GetValue}{\void}
 
 Returns the internal representation of timespan.
 
 \membersection{wxTimeSpan::GetValue}\label{wxtimespangetvalue}
 
 \constfunc{wxLongLong}{GetValue}{\void}
 
 Returns the internal representation of timespan.
 

+

 \membersection{wxTimeSpan::GetWeeks}\label{wxtimespangetweeks}
 
 \constfunc{int}{GetWeeks}{\void}
 
 Returns the difference in number of weeks.
 
 \membersection{wxTimeSpan::GetWeeks}\label{wxtimespangetweeks}
 
 \constfunc{int}{GetWeeks}{\void}
 
 Returns the difference in number of weeks.
 

+

 \membersection{wxTimeSpan::Hours}\label{wxtimespanhours}
 
 \func{static wxTimespan}{Hours}{\param{long }{hours}}
 
 Returns the timespan for the given number of hours.
 
 \membersection{wxTimeSpan::Hours}\label{wxtimespanhours}
 
 \func{static wxTimespan}{Hours}{\param{long }{hours}}
 
 Returns the timespan for the given number of hours.
 

+

 \membersection{wxTimeSpan::Hour}\label{wxtimespanhour}
 
 \func{static wxTimespan}{Hour}{\void}
 
 Returns the timespan for one hour.
 
 \membersection{wxTimeSpan::Hour}\label{wxtimespanhour}
 
 \func{static wxTimespan}{Hour}{\void}
 
 Returns the timespan for one hour.
 

+

 \membersection{wxTimeSpan::IsEqualTo}\label{wxtimespanisequalto}
 
 \constfunc{bool}{IsEqualTo}{\param{const wxTimeSpan\& }{ts}}
 
 \membersection{wxTimeSpan::IsEqualTo}\label{wxtimespanisequalto}
 
 \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
 
 \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.
 
 the timespans are equal in absolute value.
 

+

 \membersection{wxTimeSpan::IsNegative}\label{wxtimespanisnegative}
 
 \constfunc{bool}{IsNegative}{\void}
 
 \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}
 
 
 \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}
 
 
 \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
 
 \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.
 
 the timespans are equal in absolute value.
 

+

 \membersection{wxTimeSpan::Minutes}\label{wxtimespanminutes}
 
 \func{static wxTimespan}{Minutes}{\param{long }{min}}
 
 Returns the timespan for the given number of minutes.
 
 \membersection{wxTimeSpan::Minutes}\label{wxtimespanminutes}
 
 \func{static wxTimespan}{Minutes}{\param{long }{min}}
 
 Returns the timespan for the given number of minutes.
 

+

 \membersection{wxTimeSpan::Minute}\label{wxtimespanminute}
 
 \func{static wxTimespan}{Minute}{\void}
 
 Returns the timespan for one minute.
 
 \membersection{wxTimeSpan::Minute}\label{wxtimespanminute}
 
 \func{static wxTimespan}{Minute}{\void}
 
 Returns the timespan for one minute.
 

+

 \membersection{wxTimeSpan::Multiply}\label{wxtimespanmultiply}
 
 \constfunc{wxTimeSpan}{Multiply}{\param{int }{n}}
 \membersection{wxTimeSpan::Multiply}\label{wxtimespanmultiply}
 
 \constfunc{wxTimeSpan}{Multiply}{\param{int }{n}}


@@ -260,11 +295,13 @@ Returns the timespan for one minute.
 
 Multiplies timespan by a scalar.
 
 
 Multiplies timespan by a scalar.
 

+

 \membersection{wxTimeSpan::Negate}\label{wxtimespannegate}
 
 \constfunc{wxTimeSpan}{Negate}{\void}
 
 \membersection{wxTimeSpan::Negate}\label{wxtimespannegate}
 
 \constfunc{wxTimeSpan}{Negate}{\void}
 

-Returns timespan with inversed sign.
+Returns timespan with inverted sign.
+

 
 \membersection{wxTimeSpan::Neg}\label{wxtimespanneg}
 
 
 \membersection{wxTimeSpan::Neg}\label{wxtimespanneg}
 


@@ -274,41 +311,61 @@ Returns timespan with inversed sign.
 
 Negate the value of the timespan.
 
 
 Negate the value of the timespan.
 

+
+\membersection{wxTimeSpan::Milliseconds}\label{wxtimespanmilliseconds}
+
+\func{static wxTimespan}{Milliseconds}{\param{long }{ms}}
+
+Returns the timespan for the given number of milliseconds.
+
+
+\membersection{wxTimeSpan::Millisecond}\label{wxtimespanmillisecond}
+
+\func{static wxTimespan}{Millisecond}{\void}
+
+Returns the timespan for one millisecond.
+
+

 \membersection{wxTimeSpan::Seconds}\label{wxtimespanseconds}
 
 \func{static wxTimespan}{Seconds}{\param{long }{sec}}
 
 Returns the timespan for the given number of seconds.
 
 \membersection{wxTimeSpan::Seconds}\label{wxtimespanseconds}
 
 \func{static wxTimespan}{Seconds}{\param{long }{sec}}
 
 Returns the timespan for the given number of seconds.
 

+

 \membersection{wxTimeSpan::Second}\label{wxtimespansecond}
 
 \func{static wxTimespan}{Second}{\void}
 
 Returns the timespan for one second.
 
 \membersection{wxTimeSpan::Second}\label{wxtimespansecond}
 
 \func{static wxTimespan}{Second}{\void}
 
 Returns the timespan for one second.
 

-\membersection{wxTimeSpan::Substract}\label{wxtimespansubstract}

 
 

-\constfunc{wxTimeSpan}{Substract}{\param{const wxTimeSpan\&}{diff}}
+\membersection{wxTimeSpan::Subtract}\label{wxtimespansubtract}
+
+\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}}
 
 Returns the difference of two timespans.
 
 
 \func{wxTimeSpan\&}{operator$-=$}{\param{const wxTimeSpan\&}{diff}}
 
 Returns the difference of two timespans.
 

+

 \membersection{wxTimeSpan::Weeks}\label{wxtimespanweeks}
 
 \func{static wxTimespan}{Weeks}{\param{long }{weeks}}
 
 Returns the timespan for the given number of weeks.
 
 \membersection{wxTimeSpan::Weeks}\label{wxtimespanweeks}
 
 \func{static wxTimespan}{Weeks}{\param{long }{weeks}}
 
 Returns the timespan for the given number of weeks.
 

+

 \membersection{wxTimeSpan::Week}\label{wxtimespanweek}
 
 \func{static wxTimespan}{Week}{\void}
 
 Returns the timespan for one week.
 
 \membersection{wxTimeSpan::Week}\label{wxtimespanweek}
 
 \func{static wxTimespan}{Week}{\void}
 
 Returns the timespan for one week.
 

-\membersection{wxTimeSpan::wxTimeSpan}\label{wxtimespan}
+
+\membersection{wxTimeSpan::wxTimeSpan}\label{wxtimespanctor}

 
 \func{}{wxTimeSpan}{\void}
 
 
 \func{}{wxTimeSpan}{\void}