From b32c6ff0624aca1857e5184c4cda675037efaf00 Mon Sep 17 00:00:00 2001
From: Robin Dunn <robin@alldunn.com>
Date: Fri, 29 Oct 1999 22:16:53 +0000
Subject: [PATCH] wxPython doc updates

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@4262 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/latex/wx/bitmap.tex   |  2 +-
 docs/latex/wx/htcontnr.tex | 18 ++++++++++++++----
 docs/latex/wx/hthelpct.tex | 11 +++++++----
 docs/latex/wx/hthlpfrm.tex |  5 ++++-
 docs/latex/wx/manual.tex   |  7 ++++---
 docs/latex/wx/scrolwin.tex | 20 ++++++++++++++++++--
 docs/latex/wx/tevent.tex   | 21 ++++++++++++++++++---
 docs/latex/wx/window.tex   |  2 ++
 docs/latex/wx/wxPython.tex |  5 +++++
 9 files changed, 73 insertions(+), 18 deletions(-)

diff --git a/docs/latex/wx/bitmap.tex b/docs/latex/wx/bitmap.tex
index efe5732d7b..eb20bd2cef 100644
--- a/docs/latex/wx/bitmap.tex
+++ b/docs/latex/wx/bitmap.tex
@@ -143,7 +143,7 @@ Under X, {\it type} defaults to wxBITMAP\_TYPE\_XPM.
 \pythonnote{Constructors supported by wxPython are:\par
 \indented{2cm}{\begin{twocollist}
 \twocolitem{\bf{wxBitmap(name, flag)}}{Loads a bitmap from a file}
-\twocolitem{\bf{wxBitmap(data, type, width, height, depth=1)}}{Creates
+\twocolitem{\bf{wxBitmapFromData(data, type, width, height, depth=1)}}{Creates
 a bitmap from the given data, which can be of arbitrary type.}
 \twocolitem{\bf{wxNoRefBitmap(name, flag)}}{This one won't own the
 reference, so Python won't call the destructor, this is good for toolbars
diff --git a/docs/latex/wx/htcontnr.tex b/docs/latex/wx/htcontnr.tex
index e43faa8409..f7662a26e7 100644
--- a/docs/latex/wx/htcontnr.tex
+++ b/docs/latex/wx/htcontnr.tex
@@ -184,7 +184,7 @@ of parent container}
 
 \func{void}{SetMinHeight}{\param{int }{h}, \param{int }{align = HTML_ALIGN_TOP}}
 
-Sets minimal height of the container. 
+Sets minimal height of the container.
 
 When container's \helpref{Layout}{wxhtmlcelllayout} is called, m\_Height
 is set depending on layout of subcells to the height of area covered
@@ -207,16 +207,16 @@ empty place!}
 
 \func{void}{SetWidthFloat}{\param{const wxHtmlTag\& }{tag}}
 
-Sets floating width adjustment. 
+Sets floating width adjustment.
 
-The normal behaviour of container is that its width is the same as the width of 
+The normal behaviour of container is that its width is the same as the width of
 parent container (and thus you can have only one sub-container per line).
 You can change this by setting FWA.
 
 \wxheading{Parameters}
 
 \docparam{w}{Width of the container. If the value is negative it means
-complement to full width of parent container (e.g. 
+complement to full width of parent container (e.g.
 {\tt SetWidthFloat(-50, HTML\_UNITS\_PIXELS)} sets the width
 of container to parent's width minus 50 pixels. This is useful when
 creating tables - you can call SetWidthFloat(50) and SetWidthFloat(-50))}
@@ -233,3 +233,13 @@ of parent container}
 \docparam{tag}{In the second version of method, {\it w} and {\it units}
 info is extracted from tag's {\tt WIDTH} parameter.}
 
+\pythonnote{The second form of this method is named
+SetWidthFloatFromTag in wxPython.}
+
+
+
+
+
+
+
+
diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex
index fab6403bc2..aa79aec117 100644
--- a/docs/latex/wx/hthelpct.tex
+++ b/docs/latex/wx/hthelpct.tex
@@ -9,7 +9,7 @@
 wxHelpController!}
 
 This help controller provides an easy way of displaying HTML help in your
-application (see {\it test} sample). The help system is based on {\bf books} 
+application (see {\it test} sample). The help system is based on {\bf books}
 (see \helpref{AddBook}{wxhtmlhelpcontrolleraddbook}). A book is a logical
 section of documentation (for example "User's Guide" or "Programmer's Guide" or
 "C++ Reference" or "wxWindows Reference"). The help controller can handle as
@@ -75,7 +75,7 @@ You can specify the page in many ways:
 \item as direct filename of HTML document
 \item as chapter name (from contents) or as a book name
 \item as some word from index
-\item even as any word (will be searched) 
+\item even as any word (will be searched)
 \end{itemize}
 
 Looking for the page runs in these steps:
@@ -92,6 +92,9 @@ Looking for the page runs in these steps:
 
 This alternative form is used to search help contents by numeric IDs.
 
+\pythonnote{The second form of this method is named DisplayId in
+wxPython.}
+
 \membersection{wxHtmlHelpController::DisplayContents}\label{wxhtmlhelpcontrollerdisplaycontents}
 
 \func{void}{DisplayContents}{\void}
@@ -126,7 +129,7 @@ Reads the controller's setting (position of window, etc.)
 
 Sets the path for storing temporary files - cached binary versions of index and contents files. These binary
 forms are much faster to read. Default value is empty string (empty string means
-that no cached data are stored). Note that these files are {\it not} 
+that no cached data are stored). Note that these files are {\it not}
 deleted when program exits.
 
 \membersection{wxHtmlHelpController::SetTitleFormat}\label{wxhtmlhelpcontrollersettitleformat}
@@ -145,7 +148,7 @@ Associates {\it config} object with the controller.
 If there is associated config object, wxHtmlHelpController automatically
 reads and writes settings (including wxHtmlWindow's settings) when needed.
 
-The only thing you must do is create wxConfig object and call UseConfig. 
+The only thing you must do is create wxConfig object and call UseConfig.
 
 \membersection{wxHtmlHelpController::WriteCustomization}\label{wxhtmlhelpcontrollerwritecustomization}
 
diff --git a/docs/latex/wx/hthlpfrm.tex b/docs/latex/wx/hthlpfrm.tex
index 309630c65a..4bd2956afe 100644
--- a/docs/latex/wx/hthlpfrm.tex
+++ b/docs/latex/wx/hthlpfrm.tex
@@ -8,7 +8,7 @@
 
 This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}
 to display help.
-It is internal class and should not be used directly - except for the case 
+It is internal class and should not be used directly - except for the case
 you're writing your own HTML help controller.
 
 
@@ -93,6 +93,9 @@ Looking for the page runs in these steps:
 The second form takes numeric ID as the parameter.
 (uses extension to MS format, <param name="ID" value=id>)
 
+\pythonnote{The second form of this method is named DisplayId in
+wxPython.}
+
 \membersection{wxHtmlHelpFrame::DisplayContents}\label{wxhtmlhelpframedisplaycontents}
 
 \func{bool}{DisplayContents}{\void}
diff --git a/docs/latex/wx/manual.tex b/docs/latex/wx/manual.tex
index 90d74612f2..c0f4ba5883 100644
--- a/docs/latex/wx/manual.tex
+++ b/docs/latex/wx/manual.tex
@@ -25,12 +25,13 @@
 %\special{!/@scaleunit 1 def}
 \parskip=10pt
 \parindent=0pt
-\title{wxWindows 2.1: a portable C++ GUI toolkit}
+\title{wxWindows 2.1: a portable C++ and Python GUI toolkit}
 \winhelponly{\author{by Julian Smart et al
 %\winhelponly{\\$$\image{1cm;0cm}{wxwin.wmf}$$}
 }}
-\winhelpignore{\author{Julian Smart, Robert Roebling, Vadim Zeitlin et al}
-\date{August 27th 1999}
+\winhelpignore{\author{Julian Smart, Robert Roebling, Vadim Zeitlin,
+Robin Dunn, et al}
+\date{November 1st 1999}
 }
 \makeindex
 \begin{document}
diff --git a/docs/latex/wx/scrolwin.tex b/docs/latex/wx/scrolwin.tex
index e8a364b900..ef24da24c9 100644
--- a/docs/latex/wx/scrolwin.tex
+++ b/docs/latex/wx/scrolwin.tex
@@ -22,7 +22,7 @@ call \helpref{SetTargetWindow}{wxscrolledwindowsettargetwindow} which means that
 the scrollbars will scroll a different window.
 
 Note that the underlying system knows nothing about scrolling coordinates, so that all system
-functions (mouse events, expose events, refresh calls etc) as well as the position of subwindows 
+functions (mouse events, expose events, refresh calls etc) as well as the position of subwindows
 are relative to the "physical" origin of the scrolled window. If the user insert a child window at
 position (10,10) and scrolls the window down 100 pixels (moving the child window out of the visible
 area), the child window will report a position of (10,-90).
@@ -118,6 +118,9 @@ CalcScrolledPosition(0, 0, \&xx, \&yy) will return 10 in yy.
 
 \helpref{CalcUnscrolledPosition}{wxscrolledwindowcalcunscrolledposition}
 
+\pythonnote{The wxPython version of this methods accepts only two
+parameters and returns xx and yy as a tuple of values.}
+
 \membersection{wxScrolledWindow::CalcUnscrolledPosition}\label{wxscrolledwindowcalcunscrolledposition}
 
 \constfunc{void}{CalcUnscrolledPosition}{
@@ -135,6 +138,9 @@ CalcUnscrolledPosition(0, 10, \&xx, \&yy) will return 0 in yy.
 
 \helpref{CalcScrolledPosition}{wxscrolledwindowcalcscrolledposition}
 
+\pythonnote{The wxPython version of this methods accepts only two
+parameters and returns xx and yy as a tuple of values.}
+
 \membersection{wxScrolledWindow::Create}\label{wxscrolledwindowcreate}
 
 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id = -1},\rtfsp
@@ -187,6 +193,10 @@ scrolling in that direction.
 \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars},\rtfsp
 \helpref{wxScrolledWindow::GetVirtualSize}{wxscrolledwindowgetvirtualsize}
 
+\pythonnote{The wxPython version of this methods accepts no
+parameters and returns a tuple of values for xUnit and yUnit.}
+
+
 \membersection{wxScrolledWindow::GetVirtualSize}\label{wxscrolledwindowgetvirtualsize}
 
 \constfunc{void}{GetVirtualSize}{\param{int* }{x}, \param{int* }{y}}
@@ -211,6 +221,9 @@ to translate these units to logical units.
 \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars},\rtfsp
 \helpref{wxScrolledWindow::GetScrollPixelsPerUnit}{wxscrolledwindowgetscrollpixelsperunit}
 
+\pythonnote{The wxPython version of this methods accepts no
+parameters and returns a tuple of values for x and y.}
+
 \membersection{wxScrolledWindow::IsRetained}\label{wxscrolledwindowisretained}
 
 \constfunc{bool}{IsRetained}{\void}
@@ -253,7 +266,7 @@ void MyWindow::OnEvent(wxMouseEvent& event)
 \func{virtual void}{OnDraw}{\param{wxDC\& }{dc}}
 
 Called by the default paint event handler to allow the application to define
-painting behaviour without having to worry about calling 
+painting behaviour without having to worry about calling
 \helpref{wxScrolledWindow::PrepareDC}{wxscrolledwindowpreparedc}.
 
 Instead of overriding this function you may also just process the paint event
@@ -363,3 +376,6 @@ by the number of pixels per scroll increment.
 
 \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}
 
+\pythonnote{The wxPython version of this methods accepts no
+parameters and returns a tuple of values for x and y.}
+
diff --git a/docs/latex/wx/tevent.tex b/docs/latex/wx/tevent.tex
index 1dc49fd843..84e7e58ec0 100644
--- a/docs/latex/wx/tevent.tex
+++ b/docs/latex/wx/tevent.tex
@@ -100,14 +100,14 @@ void MyTextCtrl::OnChar(wxKeyEvent& event)
        // key code is within legal range. we call event.Skip() so the
        // event can be processed either in the base wxWindows class
        // or the native control.
-       
-       event.Skip(); 
+
+       event.Skip();
     }
     else
     {
        // illegal key hit. we don't call event.Skip() so the
        // event is not processed anywhere else.
-       
+
        wxBell();
     }
 }
@@ -132,6 +132,21 @@ recursively applied to the parent window's event handler. If this returns TRUE,
 \item Finally, {\bf ProcessEvent} is called on the wxApp object.
 \end{enumerate}
 
+{\bf Pay close attention to Step 5.}  People often overlook or get
+confused by this powerful feature of the wxWindows event processing
+system.  To put it a different way, events derived either directly or
+indirectly from wxCommandEvent will travel up the containment
+heirarchy from child to parent until an event handler is found that
+doesn't call event.Skip().  Events not derived from wxCommandEvent are
+sent only to the window they occurred in and then stop.
+
+Typically events that deal with a window as a window (size, motion,
+paint, mouse, keyboard, etc.) are sent only to the window.  Events
+that have a higher level of meaning and/or are generated by the window
+itself, (button click, menu select, tree expand, etc.) are command
+events and are sent up to the parent to see if it is interested in the
+event.
+
 Note that your application may wish to override ProcessEvent to redirect processing of
 events. This is done in the document/view framework, for example, to allow event handlers
 to be defined in the document or view. To test for command events (which will probably
diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index 9de0127e49..9e3be209fa 100644
--- a/docs/latex/wx/window.tex
+++ b/docs/latex/wx/window.tex
@@ -565,6 +565,8 @@ Returns the grandparent of a window, or NULL if there isn't one.
 Returns the platform-specific handle of the physical window. Cast it to an appropriate
 handle, such as {\bf HWND} for Windows, {\bf Widget} for Motif or {\bf GtkWidget} for GTK.
 
+\pythonnote{This method will return an integer in wxPython.}
+
 \membersection{wxWindow::GetId}\label{wxwindowgetid}
 
 \constfunc{int}{GetId}{\void}
diff --git a/docs/latex/wx/wxPython.tex b/docs/latex/wx/wxPython.tex
index 37a22553af..b4605b5d8f 100644
--- a/docs/latex/wx/wxPython.tex
+++ b/docs/latex/wx/wxPython.tex
@@ -367,6 +367,8 @@ as possible to the C++ spec over time.
 \item wxBMPHandler
 \item \helpref{wxBoxSizer}{wxboxsizer}
 \item \helpref{wxBrush}{wxbrush}
+\item \helpref{wxBusyInfo}{wxbusyinfo}
+\item \helpref{wxBusyCursor}{wxbusycursor}
 \item \helpref{wxButton}{wxbutton}
 \item \helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent}
 \item wxCaret
@@ -404,10 +406,13 @@ as possible to the C++ spec over time.
 \item \helpref{wxGrid}{wxgrid}
 \item \helpref{wxHtmlCell}{wxhtmlcell}
 \item \helpref{wxHtmlContainerCell}{wxhtmlcontainercell}
+\item \helpref{wxHtmlDCRenderer}{wxhtmldcrenderer}
+\item \helpref{wxHtmlEasyPrinting}{wxhtmleasyprinting}
 \item \helpref{wxHtmlParser}{wxhtmlparser}
 \item \helpref{wxHtmlTagHandler}{wxhtmltaghandler}
 \item \helpref{wxHtmlTag}{wxhtmltag}
 \item \helpref{wxHtmlWinParser}{wxhtmlwinparser}
+\item \helpref{wxHtmlPrintout}{wxhtmlprintout}
 \item \helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}
 \item \helpref{wxHtmlWindow}{wxhtmlwindow}
 \item wxIconizeEvent
-- 
2.50.0

