Removed obsolete wxDate and wxTime classes.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@19738 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2003-03-23 20:14:19 +00:00
parent 621b931778
commit 2ab25aca26
20 changed files with 3 additions and 1660 deletions

View File

@@ -264,7 +264,6 @@ These are the data structure classes supported by wxWindows.
\twocolwidtha{6cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{\helpref{wxCmdLineParser}{wxcmdlineparser}}{Command line parser class}
\twocolitem{\helpref{wxDate}{wxdate}}{A class for date manipulation (deprecated in favour of wxDateTime)}
\twocolitem{\helpref{wxDateSpan}{wxdatespan}}{A logical time interval.}
\twocolitem{\helpref{wxDateTime}{wxdatetime}}{A class for date/time manipulations}
\twocolitem{\helpref{wxExpr}{wxexpr}}{A class for flexible I/O}
@@ -286,7 +285,6 @@ These are the data structure classes supported by wxWindows.
\twocolitem{\helpref{wxStringTokenizer}{wxstringtokenizer}}{A class for interpreting a string as a list of tokens or words}
\twocolitem{\helpref{wxRealPoint}{wxrealpoint}}{Representation of a point using floating point numbers}
\twocolitem{\helpref{wxSize}{wxsize}}{Representation of a size}
\twocolitem{\helpref{wxTime}{wxtime}}{A class for time manipulation (deprecated in favour of wxDateTime)}
\twocolitem{\helpref{wxTimeSpan}{wxtimespan}}{A time interval.}
\twocolitem{\helpref{wxVariant}{wxvariant}}{A class for storing arbitrary types that may change at run-time}
\end{twocollist}

View File

@@ -60,7 +60,6 @@
\input dobjcomp.tex
\input dobjsmpl.tex
\input datostrm.tex
\input date.tex
\input datespan.tex
\input datetime.tex
\input db.tex
@@ -296,7 +295,6 @@
\input txtstrm.tex
\input valtext.tex
\input thread.tex
\input time.tex
\input timer.tex
\input timespan.tex
\input tipprov.tex

View File

@@ -1,356 +0,0 @@
\section{\class{wxDate}}\label{wxdate}
A class for manipulating dates.
{\bf NOTE:} this class is retained only for compatibility,
and has been replaced by \helpref{wxDateTime}{wxdatetime}. wxDate
may be withdrawn in future versions of wxWindows.
\wxheading{Derived from}
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/date.h>
\wxheading{See also}
\helpref{wxTime}{wxtime}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxDate::wxDate}\label{wxdateconstr}
\func{}{wxDate}{\void}
Default constructor.
\func{}{wxDate}{\param{const wxDate\&}{ date}}
Copy constructor.
\func{}{wxDate}{\param{int}{ month}, \param{int}{ day}, \param{int}{ year}}
Constructor taking month, day and year.
\func{}{wxDate}{\param{long}{ julian}}
Constructor taking an integer representing the Julian date. This is the number of days since
1st January 4713 B.C., so to convert from the number of days since 1st January 1901,
construct a date for 1/1/1901, and add the number of days.
\func{}{wxDate}{\param{const wxString\& }{dateString}}
Constructor taking a string representing a date. This must be either the string TODAY, or of the
form {\tt MM/DD/YYYY} or {\tt MM-DD-YYYY}. For example:
\begin{verbatim}
wxDate date("11/26/1966");
\end{verbatim}
\wxheading{Parameters}
\docparam{date}{Date to copy.}
\docparam{month}{Month: a number between 1 and 12.}
\docparam{day}{Day: a number between 1 and 31.}
\docparam{year}{Year, such as 1995, 2005.}
\membersection{wxDate::\destruct{wxDate}}
\func{void}{\destruct{wxDate}}{\void}
Destructor.
\membersection{wxDate::AddMonths}\label{wxdateaddmonths}
\func{wxDate\&}{AddMonths}{\param{int}{ months=1}}
Adds the given number of months to the date, returning a reference to `this'.
\membersection{wxDate::AddWeeks}\label{wxdateaddweeks}
\func{wxDate\&}{AddWeeks}{\param{int}{ weeks=1}}
Adds the given number of weeks to the date, returning a reference to `this'.
\membersection{wxDate::AddYears}\label{wxdateaddyears}
\func{wxDate\&}{AddYears}{\param{int}{ years=1}}
Adds the given number of months to the date, returning a reference to `this'.
\membersection{wxDate::FormatDate}\label{wxdateformatdate}
\constfunc{wxString}{FormatDate}{\param{int}{ type=-1}}
Formats the date according to {\it type} if not -1, or according
to the current display type if -1.
\wxheading{Parameters}
\docparam{type}{-1 or one of:
\begin{twocollist}\itemsep=0pt
\twocolitem{wxDAY}{Format day only.}
\twocolitem{wxMONTH}{Format month only.}
\twocolitem{wxMDY}{Format MONTH, DAY, YEAR.}
\twocolitem{wxFULL}{Format day, month and year in US style: DAYOFWEEK, MONTH, DAY, YEAR.}
\twocolitem{wxEUROPEAN}{Format day, month and year in European style: DAY, MONTH, YEAR.}
\end{twocollist}}
\membersection{wxDate::GetDay}\label{wxdategetday}
\constfunc{int}{GetDay}{\void}
Returns the numeric day (in the range 1 to 31).
\membersection{wxDate::GetDayOfWeek}\label{wxdategetdayofweek}
\constfunc{int}{GetDayOfWeek}{\void}
Returns the integer day of the week (in the range 1 to 7).
\membersection{wxDate::GetDayOfWeekName}\label{wxdategetdayofweekname}
\constfunc{wxString}{GetDayOfWeekName}{\void}
Returns the name of the day of week.
\membersection{wxDate::GetDayOfYear}\label{wxdategetdayofyear}
\constfunc{long}{GetDayOfYear}{\void}
Returns the day of the year (from 1 to 365).
\membersection{wxDate::GetDaysInMonth}\label{wxdategetdaysinmonth}
\constfunc{int}{GetDaysInMonth}{\void}
Returns the number of days in the month (in the range 1 to 31).
\membersection{wxDate::GetFirstDayOfMonth}\label{wxdategetfirstdayofmonth}
\constfunc{int}{GetFirstDayOfMonth}{\void}
Returns the day of week that is first in the month (in the range 1 to 7).
\membersection{wxDate::GetJulianDate}\label{wxdategetjuliandate}
\constfunc{long}{GetJulianDate}{\void}
Returns the Julian date.
\membersection{wxDate::GetMonth}\label{wxdategetmonth}
\constfunc{int}{GetMonth}{\void}
Returns the month number (in the range 1 to 12).
\membersection{wxDate::GetMonthEnd}
\func{wxDate}{GetMonthEnd}{\void}
Returns the date representing the last day of the month.
\membersection{wxDate::GetMonthName}\label{wxdategetmonthname}
\constfunc{wxString}{GetMonthName}{\void}
Returns the name of the month. Do not delete the returned storage.
\membersection{wxDate::GetMonthStart}\label{wxdategetmonthstart}
\constfunc{wxDate}{GetMonthStart}{\void}
Returns the date representing the first day of the month.
\membersection{wxDate::GetWeekOfMonth}\label{wxdategetweekofmonth}
\constfunc{int}{GetWeekOfMonth}{\void}
Returns the week of month (in the range 1 to 6).
\membersection{wxDate::GetWeekOfYear}\label{wxdategetweekofyear}
\constfunc{int}{GetWeekOfYear}{\void}
Returns the week of year (in the range 1 to 52).
\membersection{wxDate::GetYear}\label{wxdategetyear}
\constfunc{int}{GetYear}{\void}
Returns the year as an integer (such as `1995').
\membersection{wxDate::GetYearEnd}\label{wxdategetyearend}
\constfunc{wxDate}{GetYearEnd}{\void}
Returns the date representing the last day of the year.
\membersection{wxDate::GetYearStart}\label{wxdategetyearstart}
\constfunc{wxDate}{GetYearStart}{\void}
Returns the date representing the first day of the year.
\membersection{wxDate::IsLeapYear}\label{wxdateisleapyear}
\constfunc{bool}{IsLeapYear}{\void}
Returns true if the year of this date is a leap year.
\membersection{wxDate::Set}\label{wxdateset}
\func{wxDate\&}{Set}{\void}
Sets the date to current system date, returning a reference to `this'.
\func{wxDate\&}{Set}{\param{long}{ julian}}
Sets the date to the given Julian date, returning a reference to `this'.
\func{wxDate\&}{Set}{\param{int}{ month}, \param{int}{ day}, \param{int}{ year}}
Sets the date to the given date, returning a reference to `this'.
{\it month} is a number from 1 to 12.
{\it day} is a number from 1 to 31.
{\it year} is a year, such as 1995, 2005.
\membersection{wxDate::SetFormat}\label{wxdatesetformat}
\func{void}{SetFormat}{\param{int}{ format}}
Sets the current format type.
\wxheading{Parameters}
\docparam{format}{-1 or one of:
\twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf wxDAY}}{Format day only.}
\twocolitem{{\bf wxMONTH}}{Format month only.}
\twocolitem{{\bf wxMDY}}{Format MONTH, DAY, YEAR.}
\twocolitem{{\bf wxFULL}}{Format day, month and year in US style: DAYOFWEEK, MONTH, DAY, YEAR.}
\twocolitem{{\bf wxEUROPEAN}}{Format day, month and year in European style: DAY, MONTH, YEAR.}
\end{twocollist}}
\membersection{wxDate::SetOption}\label{wxdatesetoption}
\func{int}{SetOption}{\param{int}{ option}, \param{const bool}{ enable=true}}
Enables or disables an option for formatting.
\wxheading{Parameters}
\docparam{option}{May be one of:
\twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf wxNO\_CENTURY}}{The century is not formatted.}
\twocolitem{{\bf wxDATE\_ABBR}}{Month and day names are abbreviated to 3 characters when formatting.}
\end{twocollist}}
\membersection{wxDate::operator wxString}\label{wxdatewxstring}
\func{}{operator wxString}{\void}
Conversion operator, to convert wxDate to wxString by calling FormatDate.
\membersection{wxDate::operator $+$}\label{wxdateplus}
\func{wxDate}{operator $+$}{\param{long}{ i}}
\func{wxDate}{operator $+$}{\param{int}{ i}}
Adds an integer number of days to the date, returning a date.
\membersection{wxDate::operator $-$}\label{wxdateminus}
\func{wxDate}{operator $-$}{\param{long}{ i}}
\func{wxDate}{operator $-$}{\param{int}{ i}}
Subtracts an integer number of days from the date, returning a date.
\func{long}{operator $-$}{\param{const wxDate\&}{ date}}
Subtracts one date from another, return the number of intervening days.
\membersection{wxDate::operator $+=$}\label{wxdateplusequals}
\func{wxDate\&}{operator $+=$}{\param{long}{ i}}
Postfix operator: adds an integer number of days to the date, returning
a reference to `this' date.
\membersection{wxDate::operator $-=$}\label{wxdateminusequals}
\func{wxDate\&}{operator $-=$}{\param{long}{ i}}
Postfix operator: subtracts an integer number of days from the date, returning
a reference to `this' date.
\membersection{wxDate::operator $++$}\label{wxdateplusplus}
\func{wxDate\&}{operator $++$}{\void}
Increments the date (postfix or prefix).
\membersection{wxDate::operator $--$}\label{wxdateminusminus}
\func{wxDate\&}{operator $--$}{\void}
Decrements the date (postfix or prefix).
\membersection{wxDate::operator $<$}\label{wxdatelessthan}
\func{friend bool}{operator $<$}{\param{const wxDate\&}{ date1}, \param{const wxDate\&}{ date2}}
Function to compare two dates, returning true if {\it date1} is earlier than {\it date2}.
\membersection{wxDate::operator $<=$}\label{wxdatelessthaneq}
\func{friend bool}{operator $<=$}{\param{const wxDate\&}{ date1}, \param{const wxDate\&}{ date2}}
Function to compare two dates, returning true if {\it date1} is earlier than or equal to {\it date2}.
\membersection{wxDate::operator $>$}\label{wxdategreaterthan}
\func{friend bool}{operator $>$}{\param{const wxDate\&}{ date1}, \param{const wxDate\&}{ date2}}
Function to compare two dates, returning true if {\it date1} is later than {\it date2}.
\membersection{wxDate::operator $>=$}\label{wxdategreaterthaneq}
\func{friend bool}{operator $>=$}{\param{const wxDate\&}{ date1}, \param{const wxDate\&}{ date2}}
Function to compare two dates, returning true if {\it date1} is later than or equal to {\it date2}.
\membersection{wxDate::operator $==$}\label{wxdateequals}
\func{friend bool}{operator $==$}{\param{const wxDate\&}{ date1}, \param{const wxDate\&}{ date2}}
Function to compare two dates, returning true if {\it date1} is equal to {\it date2}.
\membersection{wxDate::operator $!=$}\label{wxdatenotequals}
\func{friend bool}{operator $!=$}{\param{const wxDate\&}{ date1}, \param{const wxDate\&}{ date2}}
Function to compare two dates, returning true if {\it date1} is not equal to {\it date2}.
\membersection{wxDate::operator \cinsert}\label{wxdateinsert}
\func{friend ostream\&}{operator \cinsert}{\param{ostream\&}{ os}, \param{const wxDate\&}{ date}}
Function to output a wxDate to an ostream.

View File

@@ -1,230 +0,0 @@
\section{\class{wxTime}}\label{wxtime}
Representation of time and date.
{\bf NOTE:} this class is retained only for compatibility,
and has been replaced by \helpref{wxDateTime}{wxdatetime}. wxTime
may be withdrawn in future versions of wxWindows.
\wxheading{Derived from}
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/time.h>
\wxheading{Data structures}
\begin{verbatim}
typedef unsigned short hourTy;
typedef unsigned short minuteTy;
typedef unsigned short secondTy;
typedef unsigned long clockTy;
enum tFormat { wx12h, wx24h };
enum tPrecision { wxStdMinSec, wxStdMin };
\end{verbatim}
\wxheading{See also}
\helpref{wxDate}{wxdate}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxTime::wxTime}\label{wxtimewxtime}
\func{}{wxTime}{\void}
Initialize the object using the current time.
\func{}{wxTime}{\param{clockTy }{s}}
Initialize the object using the number of seconds that have elapsed since ???.
\func{}{wxTime}{\param{const wxTime\&}{ time}}
Copy constructor.
\func{}{wxTime}{\param{hourTy }{h}, \param{minuteTy }{m}, \param{secondTy }{s = 0}, \param{bool }{dst = false}}
Initialize using hours, minutes, seconds, and whether DST time.
\func{}{wxTime}{\param{const wxDate\&}{ date}, \param{hourTy }{h = 0}, \param{minuteTy }{m = 0}, \param{secondTy }{s = 0}, \param{bool }{dst = false}}
Initialize using a \helpref{wxDate}{wxdate} object, hours, minutes, seconds, and whether DST time.
\membersection{wxTime::GetDay}\label{wxtimegetday}
\constfunc{int}{GetDay}{\void}
Returns the day of the month.
\membersection{wxTime::GetDayOfWeek}\label{wxtimegetdatofweek}
\constfunc{int}{GetDayOfWeek}{\void}
Returns the day of the week, a number from 0 to 6 where 0 is Sunday and 6 is Saturday.
\membersection{wxTime::GetHour}\label{wxtimegethour}
\constfunc{hourTy}{GetHour}{\void}
Returns the hour in local time.
\membersection{wxTime::GetHourGMT}\label{wxtimegethourgmt}
\constfunc{hourTy}{GetHourGMT}{\void}
Returns the hour in GMT.
\membersection{wxTime::GetMinute}\label{wxtimegetminute}
\constfunc{minuteTy}{GetMinute}{\void}
Returns the minute in local time.
\membersection{wxTime::GetMinuteGMT}\label{wxtimegetminutegmt}
\constfunc{minuteTy}{GetMinuteGMT}{\void}
Returns the minute in GMT.
\membersection{wxTime::GetMonth}\label{wxtimegetmonth}
\constfunc{int}{GetMonth}{\void}
Returns the month.
\membersection{wxTime::GetSecond}\label{wxtimegetsecond}
\constfunc{secondTy}{GetSecond}{\void}
Returns the second in local time or GMT.
\membersection{wxTime::GetSecondGMT}\label{wxtimegetsecondgmt}
\constfunc{secondTy}{GetSecondGMT}{\void}
Returns the second in GMT.
\membersection{wxTime::GetSeconds}\label{wxtimegetseconds}
\constfunc{clockTy}{GetSeconds}{\void}
Returns the number of seconds since ???.
\membersection{wxTime::GetYear}\label{wxtimegetyear}
\constfunc{int}{GetYear}{\void}
Returns the year.
\membersection{wxTime::FormatTime}\label{wxtimeformattime}
\constfunc{char*}{FormatTime}{\void}
Formats the time according to the current formatting options: see \helpref{wxTime::SetFormat}{wxtimesetformat}.
\membersection{wxTime::IsBetween}\label{wxtimeisbetween}
\constfunc{bool}{IsBetween}{\param{const wxTime\& }{a}, \param{const wxTime\& }{b}}
Returns true if this time is between the two given times.
\membersection{wxTime::Max}\label{wxtimemax}
\constfunc{wxTime}{Max}{\param{const wxTime\& }{time}}
Returns the maximum of the two times.
\membersection{wxTime::Min}\label{wxtimemin}
\constfunc{wxTime}{Min}{\param{const wxTime\& }{time}}
Returns the minimum of the two times.
\membersection{wxTime::SetFormat}\label{wxtimesetformat}
\func{static void}{SetFormat}{\param{const tFormat}{ format = wx12h},
\param{const tPrecision}{ precision = wxStdMinSec}}
Sets the format and precision.
\membersection{wxTime::operator char*}\label{wxtimestring}
\func{operator}{char*}{\void}
Returns a pointer to a static char* containing the formatted time.
\membersection{wxTime::operator wxDate}\label{wxtimewxdate}
\constfunc{operator}{wxDate}{\void}
Converts the wxTime into a wxDate.
\membersection{wxTime::operator $=$}\label{wxtimeoperator}
\func{void}{operator $=$}{\param{const wxTime\& }{t}}
Assignment operator.
\membersection{wxTime::operator $<$}\label{wxtimeoperatorle}
\constfunc{bool}{operator $<$}{\param{const wxTime\& }{t}}
Less than operator.
\membersection{wxTime::operator $<=$}\label{wxtimeoperatorleq}
\constfunc{bool}{operator $<=$}{\param{const wxTime\& }{t}}
Less than or equal to operator.
\membersection{wxTime::operator $>$}\label{wxtimeoperatorge}
\constfunc{bool}{operator $>$}{\param{const wxTime\& }{t}}
Greater than operator.
\membersection{wxTime::operator $>=$}\label{wxtimeoperatorgeq}
\constfunc{bool}{operator $>=$}{\param{const wxTime\& }{t}}
Greater than or equal to operator.
\membersection{wxTime::operator $==$}\label{wxtimeoperatoreq}
\constfunc{bool}{operator $==$}{\param{const wxTime\& }{t}}
Equality operator.
\membersection{wxTime::operator $!=$}\label{wxtimeoperatorneq}
\constfunc{bool}{operator $!=$}{\param{const wxTime\& }{t}}
Inequality operator.
\membersection{wxTime::operator $+$}\label{wxtimeoperatorplus}
\constfunc{bool}{operator $+$}{\param{long }{sec}}
Addition operator.
\membersection{wxTime::operator $-$}\label{wxtimeoperatorminus}
\constfunc{bool}{operator $-$}{\param{long }{sec}}
Subtraction operator.
\membersection{wxTime::operator $+=$}\label{wxtimeoperatorpluseq}
\constfunc{bool}{operator $+=$}{\param{long }{sec}}
Increment operator.
\membersection{wxTime::operator $-=$}\label{wxtimeoperatorminuseq}
\constfunc{bool}{operator $-=$}{\param{long }{sec}}
Decrement operator.

View File

@@ -82,14 +82,6 @@ deleting {\it value} and its contents.
%Note: this constructor is currently disabled because it causes a C++ ambiguity.
\func{}{wxVariant}{\param{const wxTime\&}{ value}, \param{const wxString\& }{name = ``"}}
Construction from a time.
\func{}{wxVariant}{\param{const wxDate\&}{ value}, \param{const wxString\& }{name = ``"}}
Construction from a date.
\func{}{wxVariant}{\param{void*}{ value}, \param{const wxString\& }{name = ``"}}
Construction from a void pointer.
@@ -146,12 +138,6 @@ Returns the character value.
Returns a pointer to the internal variant data.
\membersection{wxVariant::GetDate}\label{wxvariantgetdate}
\constfunc{wxDate}{GetDate}{\void}
Gets the date value.
\membersection{wxVariant::GetDouble}\label{wxvariantgetdouble}
\constfunc{double}{GetDouble}{\void}
@@ -176,12 +162,6 @@ Returns a constant reference to the variant name.
Gets the string value.
\membersection{wxVariant::GetTime}\label{wxvariantgettime}
\constfunc{wxTime}{GetTime}{\void}
Gets the time value.
\membersection{wxVariant::GetType}\label{wxvariantgettype}
\constfunc{wxString}{GetType}{\void}
@@ -263,10 +243,6 @@ Sets the internal variant data, deleting the existing data if there is any.
\func{void}{operator $=$}{\param{const double }{value}}
\func{void}{operator $=$}{\param{const wxDate\& }{value}}
\func{void}{operator $=$}{\param{const wxTime\& }{value}}
\func{void}{operator $=$}{\param{void* }{value}}
\func{void}{operator $=$}{\param{const wxList\& }{value}}
@@ -291,10 +267,6 @@ Assignment operators.
\func{bool}{operator $==$}{\param{const double }{value}}
\func{bool}{operator $==$}{\param{const wxDate\& }{value}}
\func{bool}{operator $==$}{\param{const wxTime\& }{value}}
\func{bool}{operator $==$}{\param{void* }{value}}
\func{bool}{operator $==$}{\param{const wxList\& }{value}}
@@ -319,10 +291,6 @@ Equality test operators.
\func{bool}{operator $!=$}{\param{const double }{value}}
\func{bool}{operator $!=$}{\param{const wxDate\& }{value}}
\func{bool}{operator $!=$}{\param{const wxTime\& }{value}}
\func{bool}{operator $!=$}{\param{void* }{value}}
\func{bool}{operator $!=$}{\param{const wxList\& }{value}}
@@ -358,24 +326,12 @@ Operator for implicit conversion to a double, using \helpref{wxVariant::GetDoubl
Operator for implicit conversion to a long, using \helpref{wxVariant::GetLong}{wxvariantgetlong}.
\membersection{wxVariant::operator wxDate}\label{wxvariantwxdate}
\constfunc{wxDate}{operator wxDate}{\void}
Operator for implicit conversion to a wxDate, using \helpref{wxVariant::GetDate}{wxvariantgetdate}.
\membersection{wxVariant::operator wxString}\label{wxvariantwxstring}
\constfunc{wxString}{operator wxString}{\void}
Operator for implicit conversion to a string, using \helpref{wxVariant::MakeString}{wxvariantmakestring}.
\membersection{wxVariant::operator wxTime}\label{wxvariantwxtime}
\constfunc{wxTime}{operator wxTime}{\void}
Operator for implicit conversion to a wxTime, using \helpref{wxVariant::GetTime}{wxvariantgettime}.
\membersection{wxVariant::operator void*}\label{wxvariantvoid}
\constfunc{void*}{operator void*}{\void}