updates for wxPython docs

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@3759 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/latex/wx/accel.tex

@@ -137,6 +137,10 @@ Loads the accelerator table from a Windows resource (Windows only).
 
 \docparam{resource}{Name of a Windows accelerator.}
 
+\pythonnote{The wxPython constructor accepts a list of
+wxAcceleratorEntry objects, or 3-tuples consisting of flags, keyCode,
+and cmd values like you would construct wxAcceleratorEntry objects with.}
+
 \membersection{wxAcceleratorTable::\destruct{wxAcceleratorTable}}
 
 \func{}{\destruct{wxAcceleratorTable}}{\void}

docs/latex/wx/listbox.tex

@@ -282,6 +282,9 @@ Insert the given number of strings before the specified position.
 \docparam{pos}{Position before which to insert the items: for example, if {\it pos} is 0 the items
 will be inserted in the beginning of the listbox}
 
+\pythonnote{The first two parameters are collapsed into a single
+parameter for wxPython, which is a list of strings.}
+
 \membersection{wxListBox::Number}\label{wxlistboxnumber}
 
 \constfunc{int}{Number}{\void}

docs/latex/wx/listctrl.tex

@@ -246,8 +246,8 @@ Returns the specified image list. {\it which} may be one of:
 Gets information about the item. See \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem} for more
 information.
 
-\pythonnote{The wxPython version of this method takes a parameter
+\pythonnote{The wxPython version of this method takes an integer parameter
-representing the item ID, and returns the wxListItem object.
+for the item ID, and returns the wxListItem object.
 }
 
 \membersection{wxListCtrl::GetItemData}\label{wxlistctrlgetitemdata}

docs/latex/wx/sizer.tex

@@ -21,6 +21,10 @@ or different window (dialog item) sizes on different platforms without problems.
 the standard font as well as the overall design of Motif widgets requires more space than
 on Windows, the intial dialog size will automatically be bigger on Motif than on Windows.
 
+\pythonnote{If you wish to create a sizer class in wxPython you should
+derive the class from \tt{wxPySizer} in order to get Python-aware
+capabilities for the various virtual methods.}
+
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
@@ -42,11 +46,11 @@ The destructor.
 
 \membersection{wxSizer::Add}\label{wxsizeradd}
 
-\func{void}{Add}{\param{wxWindow* }{window}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
+\func{void}{Add}{\param{wxWindow* }{window}, \param{int }{option = 0},\param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
-\func{void}{Add}{\param{wxSizer* }{sizer}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
+\func{void}{Add}{\param{wxSizer* }{sizer}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
-\func{void}{Add}{\param{int }{width}, \param{int }{height}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
+\func{void}{Add}{\param{int }{width}, \param{int }{height}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
 Adds the {\it window} to the sizer. As wxSizer itself is an abstract class, the parameters
 have no meaning in the wxSizer class itself, but as there currently is only one class
@@ -89,13 +93,17 @@ wxALIGN\_BOTTOM have their obvious meaning.}
 
 \docparam{border}{Determines the border width, if the {\it flag} parameter is set to any border.}
 
+\docparam{userData}{Allows an extra object to be attached to the sizer
+item, for use in derived classes when sizing information is more
+complex than what {\it option} and {\it flag} will allow for.}
+
 \membersection{wxSizer::Prepend}\label{wxsizerprepend}
 
-\func{void}{Prepend}{\param{wxWindow* }{window}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
+\func{void}{Prepend}{\param{wxWindow* }{window}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
-\func{void}{Prepend}{\param{wxSizer* }{sizer}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
+\func{void}{Prepend}{\param{wxSizer* }{sizer}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
-\func{void}{Prepend}{\param{int }{width}, \param{int }{height}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
+\func{void}{Prepend}{\param{int }{width}, \param{int }{height}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border= 0}, \param{wxObject* }{userData = NULL}}
 
 Same as \helpref{wxSizer::Add}{wxsizeradd}, but prepends the items to the beginning of the
 list of items (windows, subsizers or spaces) owned by this sizer.

docs/latex/wx/tex2rtf.ini

@@ -34,7 +34,7 @@ htmlIndex = true
 \constfunc [3] {{\bf #1} {\bf #2}(#3) {\bf const}\index{#2}}
 \windowstyle [1] {{\bf #1}\index{#1}}
 \bftt [1] {\bf{\tt{#1}}}
-\pythonnote [1] {{\bf \fcol{blue}{wxPython note:}}\\ #1}
+\pythonnote [1] {{\bf \fcol{blue}{wxPython note:}} #1}
 %\pythonnote [1] {}
 
 

docs/latex/wx/treectrl.tex

@@ -203,6 +203,10 @@ The return value is TRUE if the rectangle was successfully retrieved or FALSE
 if it was not (in this case {\it rect} is not changed) - for example, if the
 item is currently invisible.
 
+\pythonnote{The wxPython version of this method requires only the
+\tt{item} and \tt{textOnly} parameters.  The return value is either a
+\tt{wxRect} object or \tt{None}.}
+
 \membersection{wxTreeCtrl::GetChildrenCount}\label{wxtreectrlgetchildrencount}
 
 \constfunc{size\_t}{GetChildrenCount}{\param{const wxTreeItemId\&}{ item}, \param{bool}{ recursively = TRUE}}
@@ -413,6 +417,9 @@ function can be called only if the control has the wxTR\_MULTIPLE style.
 
 Returns the number of selected items.
 
+\pythonnote{The wxPython version of this method accepts no parameters
+and returns a Python list of \tt{wxTreeItemId}'s.}
+
 \membersection{wxTreeCtrl::HitTest}\label{wxtreectrlhittest}
 
 \func{long}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}}

docs/latex/wx/valgen.tex

@@ -73,13 +73,13 @@ Clones the generic validator using the copy constructor.
 
 \membersection{wxGenericValidator::TransferFromWindow}\label{wxgenericvalidatortransferfromwindow}
 
-\func{virtual bool}{TransferToWindow}{\param{wxWindow*}{ parent}}
+\func{virtual bool}{TransferToWindow}{}
 
 Transfers the value to the window.
 
 \membersection{wxGenericValidator::TransferToWindow}\label{wxgenericvalidatortransfertowindow}
 
-\func{virtual bool}{TransferToWindow}{\param{wxWindow*}{ parent}}
+\func{virtual bool}{TransferToWindow}{}
 
 Transfers the window value to the appropriate data type.
 

docs/latex/wx/validatr.tex

@@ -18,6 +18,10 @@ To specify a default, `null' validator, use the symbol {\bf wxDefaultValidator}.
 
 For more information, please see \helpref{Validator overview}{validatoroverview}.
 
+\pythonnote{If you wish to create a validator class in wxPython you should
+derive the class from \tt{wxPyValidator} in order to get Python-aware
+capabilities for the various virtual methods.}
+
 \wxheading{Derived from}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
@@ -31,7 +35,7 @@ For more information, please see \helpref{Validator overview}{validatoroverview}
 
 \helpref{Validator overview}{validatoroverview},
 \helpref{wxTextValidator}{wxtextvalidator},
-\helpref{wxTextValidator}{wxgenericvalidator},
+\helpref{wxGenericValidator}{wxgenericvalidator},
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
@@ -82,14 +86,14 @@ Associates a window with the validator.
 
 \membersection{wxValidator::TransferFromWindow}\label{wxvalidatortransferfromwindow}
 
-\func{virtual bool}{TransferToWindow}{\param{wxWindow*}{ parent}}
+\func{virtual bool}{TransferToWindow}{}
 
 This overridable function is called when the value in the window must be
 transferred to the validator. Return FALSE if there is a problem.
 
 \membersection{wxValidator::TransferToWindow}\label{wxvalidatortransfertowindow}
 
-\func{virtual bool}{TransferToWindow}{\param{wxWindow*}{ parent}}
+\func{virtual bool}{TransferToWindow}{}
 
 This overridable function is called when the value associated with the validator must be
 transferred to the window. Return FALSE if there is a problem.

docs/latex/wx/valtext.tex

@@ -111,13 +111,13 @@ Sets the validator style.
 
 \membersection{wxTextValidator::TransferFromWindow}\label{wxtextvalidatortransferfromwindow}
 
-\func{virtual bool}{TransferToWindow}{\param{wxWindow*}{ parent}}
+\func{virtual bool}{TransferFromWindow}{}
 
 Transfers the string value to the window.
 
 \membersection{wxTextValidator::TransferToWindow}\label{wxtextvalidatortransfertowindow}
 
-\func{virtual bool}{TransferToWindow}{\param{wxWindow*}{ parent}}
+\func{virtual bool}{TransferToWindow}{}
 
 Transfers the window value to the string.
 

docs/latex/wx/wxPython.tex

@@ -54,7 +54,7 @@ details about getting wxPython working for you.
 
 So why would you want to use wxPython over just C++ and wxWindows?
 Personally I prefer using Python for everything. I only use C++ when
-I absolutely have to eke more performance out of an algorithm, and even
+I absolutely have to eek more performance out of an algorithm, and even
 then I ususally code it as an extension module and leave the majority
 of the program in Python.
 
@@ -159,6 +159,7 @@ You can use whatever flags you want, but I know these work.
 
 For Win32 systems I use Visual C++ 6.0, but 5.0 should work also. The
 build utility currently does not support any other Win32 compilers.
+
 \item At this point you may want to make an alias or symlink, script,
 batch file, whatever on the PATH that invokes \tt{\$(WXWIN)/utils/wxPython/distrib/build.py} to
 help simplify matters somewhat. For example, on my Win32 system I have a file named
@@ -167,6 +168,7 @@ help simplify matters somewhat. For example, on my Win32 system I have a file na
 \tt{python \%WXWIN/utils/wxPython/distrib/build.py \%1 \%2 \%3 \%4 \%5 \%6}
 
 \item Change into the \tt{\$(WXWIN)/utils/wxPython/src} directory.
+
 \item Type "\tt{build -b}" to build wxPython and "\tt{build -i}" to
 install it, or "\tt{build -bi}" to do both steps at once.
 
@@ -176,10 +178,13 @@ If you have troubles building or you want it built or installed in
 a different way, take a look at the docstring in build.py. You are
 able to to override many configuration options in a file named
 build.local.
+
 \item To build and install the add-on modules, change to the appropriate
 directory under \tt{\$(WXWIN)/utils/wxPython/modules} and run the build
 utility again.
+
 \item Change to the \tt{\$(WXWIN)/utils/wxPython/demo} directory.
+
 \item Try executing the demo program. For example:
 
 \tt{python demo.py}
@@ -296,6 +301,7 @@ into the current module's namespace. If you prefer to reduce
 namespace pollution you can use "\tt{from wxPython import wx}" and
 then access all the wxPython identifiers through the wx module, for
 example, "\tt{wx.wxFrame}".
+
 \item At line 13 the frame's sizing and moving events are connected to
 methods of the class. These helper functions are intended to be like
 the event table macros that wxWindows employs. But since static event
@@ -303,9 +309,11 @@ tables are impossible with wxPython, we use helpers that are named the
 same to dynamically build the table. The only real difference is
 that the first arguemnt to the event helpers is always the window that
 the event table entry should be added to.
+
 \item Notice the use of \tt{wxDLG\_PNT} and \tt{wxDLG\_SZE} in lines 19
 - 29 to convert from dialog units to pixels. These helpers are unique
 to wxPython since Python can't do method overloading like C++.
+
 \item There is an \tt{OnCloseWindow} method at line 34 but no call to
 EVT\_CLOSE to attach the event to the method. Does it really get
 called?  The answer is, yes it does. This is because many of the
@@ -314,6 +322,7 @@ called?  The answer is, yes it does. This is because many of the
 C++ classes in this area to determine what is \em{standard} but since
 that changes from time to time I can make no guarentees, nor will it
 be fully documented. When in doubt, use an EVT\_*** function.
+
 \item At lines 17 to 21 notice that there are no saved references to
 the panel or the static text items that are created. Those of you
 who know Python might be wondering what happens when Python deletes
@@ -325,11 +334,13 @@ when necessary. For this reason, most wxPython objects do not need to
 have a \_\_del\_\_ method that explicitly causes the C++ object to be
 deleted. If you ever have the need to forcibly delete a window, use
 the Destroy() method as shown on line 36.
+
 \item Just like wxWindows in C++, wxPython apps need to create a class
 derived from \tt{wxApp} (line 56) that implements a method named
 \tt{OnInit}, (line 59.) This method should create the application's
 main window (line 62) and use \tt{wxApp.SetTopWindow()} (line 66) to
 inform wxWindows about it.
+
 \item And finally, at line 72 an instance of the application class is
 created. At this point wxPython finishes initializing itself, and calls
 the \tt{OnInit} method to get things started. (The zero parameter here is
@@ -354,6 +365,7 @@ as possible to the C++ spec over time.
 \item \helpref{wxBitmapButton}{wxbitmapbutton}
 \item \helpref{wxBitmap}{wxbitmap}
 \item wxBMPHandler
+\item \helpref{wxBoxSizer}{wxBoxSizer}
 \item \helpref{wxBrush}{wxbrush}
 \item \helpref{wxButton}{wxbutton}
 \item \helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent}
@@ -389,6 +401,14 @@ as possible to the C++ spec over time.
 \item wxGridCell
 \item wxGridEvent
 \item \helpref{wxGrid}{wxgrid}
+\item \helpref{wxHtmlCell}{wxHtmlCell}
+\item \helpref{wxHtmlContainerCell}{wxHtmlContainerCell}
+\item \helpref{wxHtmlParser}{wxHtmlParser}
+\item \helpref{wxHtmlTagHandler}{wxHtmlTagHandler}
+\item \helpref{wxHtmlTag}{wxHtmlTag}
+\item \helpref{wxHtmlWinParser}{wxHtmlWinParser}
+\item \helpref{wxHtmlWinTagHandler}{wxHtmlWinTagHandler}
+\item \helpref{wxHtmlWindow}{wxHtmlWindow}
 \item wxIconizeEvent
 \item \helpref{wxIcon}{wxicon}
 \item \helpref{wxIdleEvent}{wxidleevent}
@@ -455,16 +475,20 @@ as possible to the C++ spec over time.
 \item \helpref{wxScrollBar}{wxscrollbar}
 \item \helpref{wxScrollEvent}{wxscrollevent}
 \item \helpref{wxScrolledWindow}{wxscrolledwindow}
+\item \helpref{wxScrollWinEvent}{wxscrollwinevent}
 \item wxShowEvent
 \item \helpref{wxSingleChoiceDialog}{wxsinglechoicedialog}
 \item \helpref{wxSizeEvent}{wxsizeevent}
 \item \helpref{wxSize}{wxsize}
+\item \helpref{wxSizer}{wxSizer}
+\item wxSizerItem
 \item \helpref{wxSlider}{wxslider}
 \item \helpref{wxSpinButton}{wxspinbutton}
 \item wxSpinEvent
 \item \helpref{wxSplitterWindow}{wxsplitterwindow}
 \item \helpref{wxStaticBitmap}{wxstaticbitmap}
 \item \helpref{wxStaticBox}{wxstaticbox}
+\item \helpref{wxStaticBoxSizer}{wxStaticBoxSizer}
 \item wxStaticLine
 \item \helpref{wxStaticText}{wxstatictext}
 \item \helpref{wxStatusBar}{wxstatusbar}
@@ -481,8 +505,12 @@ as possible to the C++ spec over time.
 \item \helpref{wxTreeItemData}{wxtreeitemdata}
 \item wxTreeItemId
 \item \helpref{wxUpdateUIEvent}{wxupdateuievent}
+\item \helpref{wxValidator}{wxvalidator}
 \item \helpref{wxWindowDC}{wxwindowdc}
 \item \helpref{wxWindow}{wxwindow}
+
+
+
 \end{itemize}
 
 %----------------------------------------------------------------------