wxPython documentation updates
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@2856 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -440,8 +440,13 @@ printer page:
|
|||||||
dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY));
|
dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY));
|
||||||
\end{verbatim}
|
\end{verbatim}
|
||||||
|
|
||||||
\pythonnote{No arguments are required and the two values defining the
|
\pythonnote{In place of a single overloaded method name, wxPython
|
||||||
size are returned as a tuple.}
|
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}
|
\membersection{wxDC::GetTextBackground}\label{wxdcgettextbackground}
|
||||||
|
|
||||||
|
@@ -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.
|
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}
|
\membersection{wxPrintout::GetPageSizeMM}\label{wxprintoutgetpagesizemm}
|
||||||
|
|
||||||
\func{void}{GetPageSizeMM}{\param{int *}{w}, \param{int *}{h}}
|
\func{void}{GetPageSizeMM}{\param{int *}{w}, \param{int *}{h}}
|
||||||
|
|
||||||
Returns the size of the printer page in millimetres.
|
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}
|
\membersection{wxPrintout::GetPageSizePixels}\label{wxprintoutgetpagesizepixels}
|
||||||
|
|
||||||
\func{void}{GetPageSizePixels}{\param{int *}{w}, \param{int *}{h}}
|
\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
|
preview zoom. The application must take this discrepancy into account if
|
||||||
previewing is to be supported.
|
previewing is to be supported.
|
||||||
|
|
||||||
|
\pythonnote{This method returns the output-only parameters as a tuple.}
|
||||||
|
|
||||||
\membersection{wxPrintout::GetPPIPrinter}\label{wxprintoutgetppiprinter}
|
\membersection{wxPrintout::GetPPIPrinter}\label{wxprintoutgetppiprinter}
|
||||||
|
|
||||||
\func{void}{GetPPIPrinter}{\param{int *}{w}, \param{int *}{h}}
|
\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
|
factor for drawing text onto the printer. Remember to multiply
|
||||||
this by a scaling factor to take the preview DC size into account.
|
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}
|
\membersection{wxPrintout::GetPPIScreen}\label{wxprintoutgetppiscreen}
|
||||||
|
|
||||||
\func{void}{GetPPIScreen}{\param{int *}{w}, \param{int *}{h}}
|
\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
|
factor for drawing text onto the printer. Remember to multiply
|
||||||
this by a scaling factor to take the preview DC size into account.
|
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}
|
\membersection{wxPrintout::HasPage}\label{wxprintouthaspage}
|
||||||
|
|
||||||
\func{bool}{HasPage}{\param{int}{ pageNum}}
|
\func{bool}{HasPage}{\param{int}{ pageNum}}
|
||||||
@@ -777,6 +790,10 @@ copy printed.
|
|||||||
The base wxPrintout::OnBeginDocument {\it must} be called (and the return value
|
The base wxPrintout::OnBeginDocument {\it must} be called (and the return value
|
||||||
checked) from within the overriden function, since it calls wxDC::StartDoc.
|
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}
|
\membersection{wxPrintout::OnEndDocument}\label{wxprintoutonenddocument}
|
||||||
|
|
||||||
\func{void}{OnEndDocument}{\void}
|
\func{void}{OnEndDocument}{\void}
|
||||||
|
@@ -454,9 +454,14 @@ as possible to the C++ spec over time.
|
|||||||
\item wxPNGHandler
|
\item wxPNGHandler
|
||||||
\item \helpref{wxPoint}{wxpoint}
|
\item \helpref{wxPoint}{wxpoint}
|
||||||
\item \helpref{wxPostScriptDC}{wxpostscriptdc}
|
\item \helpref{wxPostScriptDC}{wxpostscriptdc}
|
||||||
|
\item \helpref{wxPreviewFrame}{wxpreviewframe}
|
||||||
\item \helpref{wxPrintData}{wxprintdata}
|
\item \helpref{wxPrintData}{wxprintdata}
|
||||||
|
\item \helpref{wxPrintDialogData}{wxprintdialogdata}
|
||||||
\item \helpref{wxPrintDialog}{wxprintdialog}
|
\item \helpref{wxPrintDialog}{wxprintdialog}
|
||||||
|
\item \helpref{wxPrinter}{wxprinter}
|
||||||
|
\item \helpref{wxPrintPreview}{wxprintpreview}
|
||||||
\item \helpref{wxPrinterDC}{wxprinterdc}
|
\item \helpref{wxPrinterDC}{wxprinterdc}
|
||||||
|
\item \helpref{wxPrintout}{wxprintout}
|
||||||
\item \helpref{wxQueryLayoutInfoEvent}{wxquerylayoutinfoevent}
|
\item \helpref{wxQueryLayoutInfoEvent}{wxquerylayoutinfoevent}
|
||||||
\item \helpref{wxRadioBox}{wxradiobox}
|
\item \helpref{wxRadioBox}{wxradiobox}
|
||||||
\item \helpref{wxRadioButton}{wxradiobutton}
|
\item \helpref{wxRadioButton}{wxradiobutton}
|
||||||
@@ -481,6 +486,7 @@ as possible to the C++ spec over time.
|
|||||||
\item \helpref{wxSplitterWindow}{wxsplitterwindow}
|
\item \helpref{wxSplitterWindow}{wxsplitterwindow}
|
||||||
\item \helpref{wxStaticBitmap}{wxstaticbitmap}
|
\item \helpref{wxStaticBitmap}{wxstaticbitmap}
|
||||||
\item \helpref{wxStaticBox}{wxstaticbox}
|
\item \helpref{wxStaticBox}{wxstaticbox}
|
||||||
|
\item wxStaticLine
|
||||||
\item \helpref{wxStaticText}{wxstatictext}
|
\item \helpref{wxStaticText}{wxstatictext}
|
||||||
\item \helpref{wxStatusBar}{wxstatusbar}
|
\item \helpref{wxStatusBar}{wxstatusbar}
|
||||||
\item \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}
|
\item \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}
|
||||||
@@ -498,6 +504,8 @@ as possible to the C++ spec over time.
|
|||||||
\item \helpref{wxUpdateUIEvent}{wxupdateuievent}
|
\item \helpref{wxUpdateUIEvent}{wxupdateuievent}
|
||||||
\item \helpref{wxWindowDC}{wxwindowdc}
|
\item \helpref{wxWindowDC}{wxwindowdc}
|
||||||
\item \helpref{wxWindow}{wxwindow}
|
\item \helpref{wxWindow}{wxwindow}
|
||||||
|
|
||||||
|
|
||||||
\end{itemize}
|
\end{itemize}
|
||||||
|
|
||||||
%----------------------------------------------------------------------
|
%----------------------------------------------------------------------
|
||||||
|
Reference in New Issue
Block a user