Some PythonNotes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_2_BRANCH@7478 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2000-05-24 17:30:38 +00:00
parent 37bb827fa9
commit 9be0381b20
4 changed files with 103 additions and 56 deletions

View File

@@ -91,7 +91,7 @@ Month names: Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec and
Inv\_Month for an invalid.month value are the values of {\tt wxDateTime::Month} Inv\_Month for an invalid.month value are the values of {\tt wxDateTime::Month}
enum. enum.
Likely, Sun, Mon, Tue, Wed, Thu, Fri, Sat, and Inv\_WeekDay are the values in Likewise, Sun, Mon, Tue, Wed, Thu, Fri, Sat, and Inv\_WeekDay are the values in
{\tt wxDateTime::WeekDay} enum. {\tt wxDateTime::WeekDay} enum.
Finally, Inv\_Year is defined to be an invalid value for year parameter. Finally, Inv\_Year is defined to be an invalid value for year parameter.
@@ -192,6 +192,9 @@ Please note that although several function accept an extra {\it Calendar}
parameter, it is currently ignored as only the Gregorian calendar is parameter, it is currently ignored as only the Gregorian calendar is
supported. Future versions will support other calendars. supported. Future versions will support other calendars.
\pythonnote{These methods are standalone functions named
{\tt wxDateTime_<StaticMethodName>} in wxPython.}
\helpref{SetCountry}{wxdatetimesetcountry}\\ \helpref{SetCountry}{wxdatetimesetcountry}\\
\helpref{GetCountry}{wxdatetimegetcountry}\\ \helpref{GetCountry}{wxdatetimegetcountry}\\
\helpref{IsWestEuropeanCountry}{wxdatetimeiswesteuropeancountry}\\ \helpref{IsWestEuropeanCountry}{wxdatetimeiswesteuropeancountry}\\
@@ -381,7 +384,7 @@ provided. You can construct a wxDateTime object from a
\helpref{Rata Die number}{wxdatetimegetratadie} from it. \helpref{Rata Die number}{wxdatetimegetratadie} from it.
\helpref{wxDateTime(double jdn)}{wxdatetimewxdatetimejdn}\\ \helpref{wxDateTime(double jdn)}{wxdatetimewxdatetimejdn}\\
\helpref{Set(double jdn)}{wxdatetimesetjdn} \helpref{Set(double jdn)}{wxdatetimesetjdn}\\
\helpref{GetJulianDayNumber}{wxdatetimegetjuliandaynumber}\\ \helpref{GetJulianDayNumber}{wxdatetimegetjuliandaynumber}\\
\helpref{GetJDN}{wxdatetimegetjdn}\\ \helpref{GetJDN}{wxdatetimegetjdn}\\
\helpref{GetModifiedJulianDayNumber}{wxdatetimegetmodifiedjuliandaynumber}\\ \helpref{GetModifiedJulianDayNumber}{wxdatetimegetmodifiedjuliandaynumber}\\
@@ -509,6 +512,9 @@ year.
The only supported value for {\it cal} parameter is currently {\tt Gregorian}. The only supported value for {\it cal} parameter is currently {\tt Gregorian}.
\pythonnote{These two methods are named {\tt GetNumberOfDaysInYear}
and {\tt GetNumberOfDaysInMonth} in wxPython.}
\membersection{wxDateTime::GetWeekDayName}\label{wxdatetimegetweekdayname} \membersection{wxDateTime::GetWeekDayName}\label{wxdatetimegetweekdayname}
\func{static wxString}{GetWeekDayName}{\param{WeekDay }{weekday}, \param{NameFlags }{flags = Name\_Full}} \func{static wxString}{GetWeekDayName}{\param{WeekDay }{weekday}, \param{NameFlags }{flags = Name\_Full}}
@@ -600,30 +606,40 @@ later.
Same as \helpref{Set}{wxdatetimewxdatetimetimet}. Same as \helpref{Set}{wxdatetimewxdatetimetimet}.
\pythonnote{This constructor is named {\tt wxDateTimeFromTimeT} in wxPython.}
\membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimetm} \membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimetm}
\func{wxDateTime\&}{wxDateTime}{\param{const struct tm\& }{tm}} \func{wxDateTime\&}{wxDateTime}{\param{const struct tm\& }{tm}}
Same as \helpref{Set}{wxdatetimewxdatetimetm} Same as \helpref{Set}{wxdatetimewxdatetimetm}
\pythonnote{Unsupported.}
\membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimejdn} \membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimejdn}
\func{wxDateTime\&}{wxDateTime}{\param{double }{jdn}} \func{wxDateTime\&}{wxDateTime}{\param{double }{jdn}}
Same as \helpref{Set}{wxdatetimewxdatetimejdn} Same as \helpref{Set}{wxdatetimewxdatetimejdn}
\pythonnote{This constructor is named {\tt wxDateTimeFromJDN} in wxPython.}
\membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimetime} \membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimetime}
\func{wxDateTime\&}{wxDateTime}{\param{wxDateTime\_t }{hour}, \param{wxDateTime\_t }{minute = 0}, \param{wxDateTime\_t }{second = 0}, \param{wxDateTime\_t }{millisec = 0}} \func{wxDateTime\&}{wxDateTime}{\param{wxDateTime\_t }{hour}, \param{wxDateTime\_t }{minute = 0}, \param{wxDateTime\_t }{second = 0}, \param{wxDateTime\_t }{millisec = 0}}
Same as \helpref{Set}{wxdatetimewxdatetimetime} Same as \helpref{Set}{wxdatetimewxdatetimetime}
\pythonnote{This constructor is named {\tt wxDateTimeFromHMS} in wxPython.}
\membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimedate} \membersection{wxDateTime::wxDateTime}\label{wxdatetimewxdatetimedate}
\func{wxDateTime\&}{wxDateTime}{\param{wxDateTime\_t }{day}, \param{Month }{month = Inv\_Month}, \param{wxDateTime\_t }{hour = 0}, \param{wxDateTime\_t }{minute = 0}, \param{wxDateTime\_t }{second = 0}, \param{wxDateTime\_t }{millisec = 0}} \func{wxDateTime\&}{wxDateTime}{\param{wxDateTime\_t }{day}, \param{Month }{month = Inv\_Month}, \param{wxDateTime\_t }{hour = 0}, \param{wxDateTime\_t }{minute = 0}, \param{wxDateTime\_t }{second = 0}, \param{wxDateTime\_t }{millisec = 0}}
Same as \helpref{Set}{wxdatetimesetdate} Same as \helpref{Set}{wxdatetimesetdate}
\pythonnote{This constructor is named {\tt wxDateTimeFromDMY} in wxPython.}
\membersection{wxDateTime::SetToCurrent}\label{wxdatetimesettocurrent} \membersection{wxDateTime::SetToCurrent}\label{wxdatetimesettocurrent}
\func{wxDateTime&}{SetToCurrent}{\void} \func{wxDateTime&}{SetToCurrent}{\void}
@@ -638,6 +654,8 @@ of \helpref{Now()}{wxdatetimenow} to this object.
Constructs the object from {\it timet} value holding the number of seconds Constructs the object from {\it timet} value holding the number of seconds
since Jan 1, 1970. since Jan 1, 1970.
\pythonnote{This method is named {\tt SetTimeT} in wxPython.}
\membersection{wxDateTime::Set}\label{wxdatetimesettm} \membersection{wxDateTime::Set}\label{wxdatetimesettm}
\func{wxDateTime\&}{Set}{\param{const struct tm\& }{tm}} \func{wxDateTime\&}{Set}{\param{const struct tm\& }{tm}}
@@ -645,6 +663,8 @@ since Jan 1, 1970.
Sets the date and tiem from the broken down representation in the standard Sets the date and tiem from the broken down representation in the standard
{\tt tm} structure. {\tt tm} structure.
\pythonnote{Unsupported.}
\membersection{wxDateTime::Set}\label{wxdatetimesetjdn} \membersection{wxDateTime::Set}\label{wxdatetimesetjdn}
\func{wxDateTime\&}{Set}{\param{double }{jdn}} \func{wxDateTime\&}{Set}{\param{double }{jdn}}
@@ -656,6 +676,8 @@ particular instant is the fractional number of days since 12 hours Universal
Coordinated Time (Greenwhich mean noon) on January 1 of the year -4712 in the Coordinated Time (Greenwhich mean noon) on January 1 of the year -4712 in the
Julian proleptic calendar. Julian proleptic calendar.
\pythonnote{This method is named {\tt SetJDN} in wxPython.}
\membersection{wxDateTime::Set}\label{wxdatetimesettime} \membersection{wxDateTime::Set}\label{wxdatetimesettime}
\func{wxDateTime\&}{Set}{\param{wxDateTime\_t }{hour}, \param{wxDateTime\_t }{minute = 0}, \param{wxDateTime\_t }{second = 0}, \param{wxDateTime\_t }{millisec = 0}} \func{wxDateTime\&}{Set}{\param{wxDateTime\_t }{hour}, \param{wxDateTime\_t }{minute = 0}, \param{wxDateTime\_t }{second = 0}, \param{wxDateTime\_t }{millisec = 0}}
@@ -663,6 +685,8 @@ Julian proleptic calendar.
Sets the date to be equal to \helpref{Today}{wxdatetimetoday} and the time Sets the date to be equal to \helpref{Today}{wxdatetimetoday} and the time
from supplied parameters. from supplied parameters.
\pythonnote{This method is named {\tt SetHMS} in wxPython.}
\membersection{wxDateTime::Set}\label{wxdatetimesetdate} \membersection{wxDateTime::Set}\label{wxdatetimesetdate}
\func{wxDateTime\&}{Set}{\param{wxDateTime\_t }{day}, \param{Month }{month = Inv\_Month}, \param{wxDateTime\_t }{hour = 0}, \param{wxDateTime\_t }{minute = 0}, \param{wxDateTime\_t }{second = 0}, \param{wxDateTime\_t }{millisec = 0}} \func{wxDateTime\&}{Set}{\param{wxDateTime\_t }{day}, \param{Month }{month = Inv\_Month}, \param{wxDateTime\_t }{hour = 0}, \param{wxDateTime\_t }{minute = 0}, \param{wxDateTime\_t }{second = 0}, \param{wxDateTime\_t }{millisec = 0}}
@@ -913,6 +937,8 @@ this interval.
Adds the given time span to this object. Adds the given time span to this object.
\pythonnote{This method is named {\tt AddTS} in wxPython.}
\membersection{wxDateTime::Subtract}\label{wxdatetimesubtractts} \membersection{wxDateTime::Subtract}\label{wxdatetimesubtractts}
\constfunc{wxDateTime}{Subtract}{\param{const wxTimeSpan\& }{diff}} \constfunc{wxDateTime}{Subtract}{\param{const wxTimeSpan\& }{diff}}
@@ -923,6 +949,8 @@ Adds the given time span to this object.
Subtracts the given time span from this object. Subtracts the given time span from this object.
\pythonnote{This method is named {\tt SubtractTS} in wxPython.}
\membersection{wxDateTime::Add}\label{wxdatetimeaddds} \membersection{wxDateTime::Add}\label{wxdatetimeaddds}
\constfunc{wxDateTime}{Add}{\param{const wxDateSpan\& }{diff}} \constfunc{wxDateTime}{Add}{\param{const wxDateSpan\& }{diff}}
@@ -933,6 +961,8 @@ Subtracts the given time span from this object.
Adds the given date span to this object. Adds the given date span to this object.
\pythonnote{This method is named {\tt AddDS} in wxPython.}
\membersection{wxDateTime::Subtract}\label{wxdatetimesubtractds} \membersection{wxDateTime::Subtract}\label{wxdatetimesubtractds}
\constfunc{wxDateTime}{Subtract}{\param{const wxDateSpan\& }{diff}} \constfunc{wxDateTime}{Subtract}{\param{const wxDateSpan\& }{diff}}
@@ -943,6 +973,8 @@ Adds the given date span to this object.
Subtracts the given date span from this object. Subtracts the given date span from this object.
\pythonnote{This method is named {\tt SubtractDS} in wxPython.}
\membersection{wxDateTime::Subtract}\label{wxdatetimesubtractdt} \membersection{wxDateTime::Subtract}\label{wxdatetimesubtractdt}
\constfunc{wxTimeSpan}{Subtract}{\param{const wxDateTime\& }{dt}} \constfunc{wxTimeSpan}{Subtract}{\param{const wxDateTime\& }{dt}}

View File

@@ -204,6 +204,9 @@ and refreshes the window.
Sets the number of fields, and optionally the field widths. Sets the number of fields, and optionally the field widths.
\pythonnote{Only the first parameter is accepted. Use SetStatusWidths
to set the widths of the fields.}
\wxheading{Parameters} \wxheading{Parameters}
\docparam{number}{The number of fields.} \docparam{number}{The number of fields.}

View File

@@ -476,6 +476,9 @@ Inserts an item after a given one ({\it previous}) or before one identified by i
If {\it image} > -1 and {\it selImage} is -1, the same image is used for If {\it image} > -1 and {\it selImage} is -1, the same image is used for
both selected and unselected items. both selected and unselected items.
\pythonnote{The second form of this method is called
\tt{InsertItemBefore} in wxPython.}
\membersection{wxTreeCtrl::IsBold}\label{wxtreectrlisbold} \membersection{wxTreeCtrl::IsBold}\label{wxtreectrlisbold}
\constfunc{bool}{IsBold}{\param{const wxTreeItemId\& }{item}} \constfunc{bool}{IsBold}{\param{const wxTreeItemId\& }{item}}

View File

@@ -360,6 +360,7 @@ as possible to the C++ spec over time.
\item \helpref{wxBusyCursor}{wxbusycursor} \item \helpref{wxBusyCursor}{wxbusycursor}
\item \helpref{wxButton}{wxbutton} \item \helpref{wxButton}{wxbutton}
\item \helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent} \item \helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent}
\item \helpref{wxCalendarCtrl}{wxcalendarctrl}
\item wxCaret \item wxCaret
\item \helpref{wxCheckBox}{wxcheckbox} \item \helpref{wxCheckBox}{wxcheckbox}
\item \helpref{wxCheckListBox}{wxchecklistbox} \item \helpref{wxCheckListBox}{wxchecklistbox}
@@ -380,6 +381,8 @@ as possible to the C++ spec over time.
\item \helpref{wxDataObject}{wxdataobject} \item \helpref{wxDataObject}{wxdataobject}
\item \helpref{wxDataObjectComposite}{wxdataobjectcomposite} \item \helpref{wxDataObjectComposite}{wxdataobjectcomposite}
\item \helpref{wxDataObjectSimple}{wxdataobjectsimple} \item \helpref{wxDataObjectSimple}{wxdataobjectsimple}
\item \helpref{wxDateTime}{wxdatetime}
\item \helpref{wxDateSpan}{wxdatespan}
\item \helpref{wxDC}{wxdc} \item \helpref{wxDC}{wxdc}
\item \helpref{wxDialog}{wxdialog} \item \helpref{wxDialog}{wxdialog}
\item \helpref{wxDirDialog}{wxdirdialog} \item \helpref{wxDirDialog}{wxdirdialog}
@@ -390,6 +393,7 @@ as possible to the C++ spec over time.
\item \helpref{wxEraseEvent}{wxeraseevent} \item \helpref{wxEraseEvent}{wxeraseevent}
\item \helpref{wxEvent}{wxevent} \item \helpref{wxEvent}{wxevent}
\item \helpref{wxEvtHandler}{wxevthandler} \item \helpref{wxEvtHandler}{wxevthandler}
\item wxFileConfig
\item \helpref{wxFileDataObject}{wxfiledataobject} \item \helpref{wxFileDataObject}{wxfiledataobject}
\item \helpref{wxFileDialog}{wxfiledialog} \item \helpref{wxFileDialog}{wxfiledialog}
\item \helpref{wxFileDropTarget}{wxfiledroptarget} \item \helpref{wxFileDropTarget}{wxfiledroptarget}
@@ -401,9 +405,11 @@ as possible to the C++ spec over time.
\item \helpref{wxGauge}{wxgauge} \item \helpref{wxGauge}{wxgauge}
\item wxGIFHandler \item wxGIFHandler
\item wxGLCanvas \item wxGLCanvas
\begin{comment}
\item wxGridCell \item wxGridCell
\item wxGridEvent \item wxGridEvent
\item \helpref{wxGrid}{wxgrid} \item \helpref{wxGrid}{wxgrid}
\end{comment}
\item \helpref{wxHtmlCell}{wxhtmlcell} \item \helpref{wxHtmlCell}{wxhtmlcell}
\item \helpref{wxHtmlContainerCell}{wxhtmlcontainercell} \item \helpref{wxHtmlContainerCell}{wxhtmlcontainercell}
\item \helpref{wxHtmlDCRenderer}{wxhtmldcrenderer} \item \helpref{wxHtmlDCRenderer}{wxhtmldcrenderer}
@@ -505,6 +511,8 @@ as possible to the C++ spec over time.
\item \helpref{wxTextDropTarget}{wxtextdroptarget} \item \helpref{wxTextDropTarget}{wxtextdroptarget}
\item \helpref{wxTextEntryDialog}{wxtextentrydialog} \item \helpref{wxTextEntryDialog}{wxtextentrydialog}
\item \helpref{wxTimer}{wxtimer} \item \helpref{wxTimer}{wxtimer}
\item \helpref{wxTimerEvent}{wxtimerevent}
\item \helpref{wxTimeSpan}{wxtimespan}
\item \helpref{wxTipProvider}{wxtipprovider} \item \helpref{wxTipProvider}{wxtipprovider}
\item wxToolBarTool \item wxToolBarTool
\item \helpref{wxToolBar}{wxtoolbar} \item \helpref{wxToolBar}{wxtoolbar}
@@ -524,14 +532,15 @@ as possible to the C++ spec over time.
Since wxPython is a blending of multiple technologies, help comes from Since wxPython is a blending of multiple technologies, help comes from
multiple sources. See multiple sources. See
\urlref{http://alldunn.com/wxPython}{http://alldunn.com/wxPython} for details on \urlref{http://wxpython.org/}{http://wxpython.org/} for details on
various sources of help, but probably the best source is the various sources of help, but probably the best source is the
wxPython-users mail list. You can view the archive or subscribe by wxPython-users mail list. You can view the archive or subscribe by
going to going to
\urlref{http://starship.python.net/mailman/listinfo/wxpython-users}{http://starship.python.net/mailman/listinfo/wxpython-users} \urlref{http://wxwindows.org/mailman/listinfo/wxpython-users}{http://wxwindows.org/mailman/listinfo/wxpython-users}
Or you can send mail directly to the list using this address: Or you can send mail directly to the list using this address:
wxpython-users@starship.python.net wxpython-users@wxwindows.org