From: Robin Dunn <robin@alldunn.com>
Date: Tue, 22 Jun 1999 06:53:24 +0000 (+0000)
Subject: wxPython documentation updates
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/2233e5b82c14c529f97b3fd0cba99908de2d5d0c

wxPython documentation updates


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

diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex
index 8237643877..4c5f1b94d4 100644
--- a/docs/latex/wx/dc.tex
+++ b/docs/latex/wx/dc.tex
@@ -440,8 +440,13 @@ printer page:
   dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY));
 \end{verbatim}
 
-\pythonnote{No arguments are required and the two values defining the
-size are returned as a tuple.}
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{GetSize()}}{Returns a wxSize}
+\twocolitem{\bf{GetSizeTuple()}}{Returns a 2-tuple (width, height)}
+\end{twocollist}}
+}
 
 \membersection{wxDC::GetTextBackground}\label{wxdcgettextbackground}
 
diff --git a/docs/latex/wx/print.tex b/docs/latex/wx/print.tex
index ba16f85b95..96af356c34 100644
--- a/docs/latex/wx/print.tex
+++ b/docs/latex/wx/print.tex
@@ -16,12 +16,12 @@ between the print dialogs and the application.
 
 \wxheading{See also}
 
-\helpref{wxPrintDialog}{wxprintdialog}, 
-\helpref{wxPageSetupDialog}{wxpagesetupdialog}, 
-\helpref{wxPrintDialogData}{wxprintdialogdata}, 
-\helpref{wxPageSetupDialogData}{wxpagesetupdialogdata}, 
-\helpref{wxPrintDialog Overview}{wxprintdialogoverview}, 
-\helpref{wxPrinterDC}{wxprinterdc}, 
+\helpref{wxPrintDialog}{wxprintdialog},
+\helpref{wxPageSetupDialog}{wxpagesetupdialog},
+\helpref{wxPrintDialogData}{wxprintdialogdata},
+\helpref{wxPageSetupDialogData}{wxpagesetupdialogdata},
+\helpref{wxPrintDialog Overview}{wxprintdialogoverview},
+\helpref{wxPrinterDC}{wxprinterdc},
 \helpref{wxPostScriptDC}{wxpostscriptdc}
 
 \wxheading{Remarks}
@@ -563,7 +563,7 @@ dialog data, which will be copied to the printer object's local data.
 
 \wxheading{See also}
 
-\helpref{wxPrintDialogData}{wxprintdialogdata}, 
+\helpref{wxPrintDialogData}{wxprintdialogdata},
 \helpref{wxPrintData}{wxprintdata}
 
 \membersection{wxPrinter::\destruct{wxPrinter}}
@@ -717,12 +717,19 @@ returns 1, 32000 for the page minimum and maximum values, and 1, 1 for the requi
 
 If {\it minPage} is zero, the page number controls in the print dialog will be disabled.
 
+\pythonnote{When this method is implemented in a derived Python class,
+it should be designed to take no parameters (other than the self
+reference) and to return a tuple of four integers.
+}
+
 \membersection{wxPrintout::GetPageSizeMM}\label{wxprintoutgetpagesizemm}
 
 \func{void}{GetPageSizeMM}{\param{int *}{w}, \param{int *}{h}}
 
 Returns the size of the printer page in millimetres.
 
+\pythonnote{This method returns the output-only parameters as a tuple.}
+
 \membersection{wxPrintout::GetPageSizePixels}\label{wxprintoutgetpagesizepixels}
 
 \func{void}{GetPageSizePixels}{\param{int *}{w}, \param{int *}{h}}
@@ -734,6 +741,8 @@ memory device context is used, using a bitmap size reflecting the current
 preview zoom. The application must take this discrepancy into account if
 previewing is to be supported.
 
+\pythonnote{This method returns the output-only parameters as a tuple.}
+
 \membersection{wxPrintout::GetPPIPrinter}\label{wxprintoutgetppiprinter}
 
 \func{void}{GetPPIPrinter}{\param{int *}{w}, \param{int *}{h}}
@@ -743,6 +752,8 @@ Dividing the printer PPI by the screen PPI can give a suitable scaling
 factor for drawing text onto the printer. Remember to multiply
 this by a scaling factor to take the preview DC size into account.
 
+\pythonnote{This method returns the output-only parameters as a tuple.}
+
 \membersection{wxPrintout::GetPPIScreen}\label{wxprintoutgetppiscreen}
 
 \func{void}{GetPPIScreen}{\param{int *}{w}, \param{int *}{h}}
@@ -752,6 +763,8 @@ Dividing the printer PPI by the screen PPI can give a suitable scaling
 factor for drawing text onto the printer. Remember to multiply
 this by a scaling factor to take the preview DC size into account.
 
+\pythonnote{This method returns the output-only parameters as a tuple.}
+
 \membersection{wxPrintout::HasPage}\label{wxprintouthaspage}
 
 \func{bool}{HasPage}{\param{int}{ pageNum}}
@@ -777,6 +790,10 @@ copy printed.
 The base wxPrintout::OnBeginDocument {\it must} be called (and the return value
 checked) from within the overriden function, since it calls wxDC::StartDoc.
 
+\pythonnote{If this method is overriden in a Python class then the
+base class version can be called by using the method
+\tt{base_OnBeginDocument(startPage, endPage)}. }
+
 \membersection{wxPrintout::OnEndDocument}\label{wxprintoutonenddocument}
 
 \func{void}{OnEndDocument}{\void}
diff --git a/docs/latex/wx/wxPython.tex b/docs/latex/wx/wxPython.tex
index 0d5afd89f5..e8230b56d2 100644
--- a/docs/latex/wx/wxPython.tex
+++ b/docs/latex/wx/wxPython.tex
@@ -454,9 +454,14 @@ as possible to the C++ spec over time.
 \item wxPNGHandler
 \item \helpref{wxPoint}{wxpoint}
 \item \helpref{wxPostScriptDC}{wxpostscriptdc}
+\item \helpref{wxPreviewFrame}{wxpreviewframe}
 \item \helpref{wxPrintData}{wxprintdata}
+\item \helpref{wxPrintDialogData}{wxprintdialogdata}
 \item \helpref{wxPrintDialog}{wxprintdialog}
+\item \helpref{wxPrinter}{wxprinter}
+\item \helpref{wxPrintPreview}{wxprintpreview}
 \item \helpref{wxPrinterDC}{wxprinterdc}
+\item \helpref{wxPrintout}{wxprintout}
 \item \helpref{wxQueryLayoutInfoEvent}{wxquerylayoutinfoevent}
 \item \helpref{wxRadioBox}{wxradiobox}
 \item \helpref{wxRadioButton}{wxradiobutton}
@@ -481,6 +486,7 @@ as possible to the C++ spec over time.
 \item \helpref{wxSplitterWindow}{wxsplitterwindow}
 \item \helpref{wxStaticBitmap}{wxstaticbitmap}
 \item \helpref{wxStaticBox}{wxstaticbox}
+\item wxStaticLine
 \item \helpref{wxStaticText}{wxstatictext}
 \item \helpref{wxStatusBar}{wxstatusbar}
 \item \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}
@@ -498,6 +504,8 @@ as possible to the C++ spec over time.
 \item \helpref{wxUpdateUIEvent}{wxupdateuievent}
 \item \helpref{wxWindowDC}{wxwindowdc}
 \item \helpref{wxWindow}{wxwindow}
+
+
 \end{itemize}
 
 %----------------------------------------------------------------------