\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxPrintData::wxPrintData}
+
+\membersection{wxPrintData::wxPrintData}\label{wxprintdatactor}
\func{}{wxPrintData}{\void}
Copy constructor.
-\membersection{wxPrintData::\destruct{wxPrintData}}
+
+\membersection{wxPrintData::\destruct{wxPrintData}}\label{wxprintdatadtor}
\func{}{\destruct{wxPrintData}}{\void}
Destructor.
+
\membersection{wxPrintData::GetCollate}\label{wxprintdatagetcollate}
\constfunc{bool}{GetCollate}{\void}
-Returns TRUE if collation is on.
+Returns true if collation is on.
+
+
+\membersection{wxPrintData::GetBin}\label{wxprintdatagetbin}
+
+\constfunc{wxPrintBin}{GetBin}{\void}
+
+Returns the current bin (papersource). By default, the system is left to select
+the bin (\texttt{wxPRINTBIN\_DEFAULT} is returned).
+
+See \helpref{SetBin()}{wxprintdatasetbin} for the full list of bin values.
+
\membersection{wxPrintData::GetColour}\label{wxprintdatagetcolour}
\constfunc{bool}{GetColour}{\void}
-Returns TRUE if colour printing is on.
+Returns true if colour printing is on.
+
\membersection{wxPrintData::GetDuplex}\label{wxprintdatagetduplex}
Returns the duplex mode. One of wxDUPLEX\_SIMPLEX, wxDUPLEX\_HORIZONTAL, wxDUPLEX\_VERTICAL.
+
\membersection{wxPrintData::GetNoCopies}\label{wxprintdatagetnocopies}
\constfunc{int}{GetNoCopies}{\void}
Returns the number of copies requested by the user.
+
\membersection{wxPrintData::GetOrientation}\label{wxprintdatagetorientation}
\constfunc{int}{GetOrientation}{\void}
Gets the orientation. This can be wxLANDSCAPE or wxPORTRAIT.
+
\membersection{wxPrintData::GetPaperId}\label{wxprintdatagetpaperid}
\constfunc{wxPaperSize}{GetPaperId}{\void}
Returns the paper size id. For more information, see \helpref{wxPrintData::SetPaperId}{wxprintdatasetpaperid}.
+
\membersection{wxPrintData::GetPrinterName}\label{wxprintdatagetprintername}
\constfunc{const wxString\&}{GetPrinterName}{\void}
Returns the printer name. If the printer name is the empty string, it indicates that the default
printer should be used.
+
\membersection{wxPrintData::GetQuality}\label{wxprintdatagetquality}
-\constfunc{wxPaperQuality}{GetQuality}{\void}
+\constfunc{wxPrintQuality}{GetQuality}{\void}
Returns the current print quality. This can be a positive integer, denoting the number of dots per inch, or
one of the following identifiers:
On input you should pass one of these identifiers, but on return you may get back a positive integer
indicating the current resolution setting.
+
\membersection{wxPrintData::Ok}\label{wxprintdataok}
\constfunc{bool}{Ok}{\void}
-Returns TRUE if the print data is valid for using in print dialogs.
-This can return FALSE on Windows if the current printer is not set, for example.
-On all other platforms, it returns TRUE.
+Returns true if the print data is valid for using in print dialogs.
+This can return false on Windows if the current printer is not set, for example.
+On all other platforms, it returns true.
+
+
+\membersection{wxPrintData::SetBin}\label{wxprintdatasetbin}
+
+\func{void}{SetBin}{\param{wxPrintBin }{flag}}
+
+Sets the current bin. Possible values are:
+
+\small{
+\begin{verbatim}
+enum wxPrintBin
+{
+ wxPRINTBIN_DEFAULT,
+
+ wxPRINTBIN_ONLYONE,
+ wxPRINTBIN_LOWER,
+ wxPRINTBIN_MIDDLE,
+ wxPRINTBIN_MANUAL,
+ wxPRINTBIN_ENVELOPE,
+ wxPRINTBIN_ENVMANUAL,
+ wxPRINTBIN_AUTO,
+ wxPRINTBIN_TRACTOR,
+ wxPRINTBIN_SMALLFMT,
+ wxPRINTBIN_LARGEFMT,
+ wxPRINTBIN_LARGECAPACITY,
+ wxPRINTBIN_CASSETTE,
+ wxPRINTBIN_FORMSOURCE,
+
+ wxPRINTBIN_USER,
+};
+\end{verbatim}
+}
+
\membersection{wxPrintData::SetCollate}\label{wxprintdatasetcollate}
Sets collation to on or off.
+
\membersection{wxPrintData::SetColour}\label{wxprintdatasetcolour}
\func{void}{SetColour}{\param{bool }{flag}}
Sets colour printing on or off.
+
\membersection{wxPrintData::SetDuplex}\label{wxprintdatasetduplex}
\func{void}{SetDuplex}{\param{wxDuplexMode}{ mode}}
Returns the duplex mode. One of wxDUPLEX\_SIMPLEX, wxDUPLEX\_HORIZONTAL, wxDUPLEX\_VERTICAL.
+
\membersection{wxPrintData::SetNoCopies}\label{wxprintdatasetnocopies}
\func{void}{SetNoCopies}{\param{int }{n}}
Sets the default number of copies to be printed out.
+
\membersection{wxPrintData::SetOrientation}\label{wxprintdatasetorientation}
\func{void}{SetOrientation}{\param{int }{orientation}}
Sets the orientation. This can be wxLANDSCAPE or wxPORTRAIT.
+
\membersection{wxPrintData::SetPaperId}\label{wxprintdatasetpaperid}
\func{void}{SetPaperId}{\param{wxPaperSize}{ paperId}}
\end{verbatim}
}
+
\membersection{wxPrintData::SetPrinterName}\label{wxprintdatasetprintername}
\func{void}{SetPrinterName}{\param{const wxString\& }{printerName}}
Sets the printer name. This can be the empty string to indicate that the default
printer should be used.
+
\membersection{wxPrintData::SetQuality}\label{wxprintdatasetquality}
-\func{void}{SetQuality}{\param{wxPaperQuality}{ quality}}
+\func{void}{SetQuality}{\param{wxPrintQuality}{ quality}}
Sets the desired print quality. This can be a positive integer, denoting the number of dots per inch, or
one of the following identifiers:
On input you should pass one of these identifiers, but on return you may get back a positive integer
indicating the current resolution setting.
+
\membersection{wxPrintData::operator $=$}\label{wxprintdataassign}
\func{void}{operator $=$}{\param{const wxPrintData\&}{ data}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxPrintDialog::wxPrintDialog}
+
+\membersection{wxPrintDialog::wxPrintDialog}\label{wxprintdialogctor}
\func{}{wxPrintDialog}{\param{wxWindow* }{parent}, \param{wxPrintDialogData* }{data = NULL}}
\helpref{wxPrintDialogData}{wxprintdialogdata}
-\membersection{wxPrintDialog::\destruct{wxPrintDialog}}
+
+\membersection{wxPrintDialog::\destruct{wxPrintDialog}}\label{wxprintdialogdtor}
\func{}{\destruct{wxPrintDialog}}{\void}
Destructor. If wxPrintDialog::GetPrintDC has {\it not} been called,
the device context obtained by the dialog (if any) will be deleted.
+
\membersection{wxPrintDialog::GetPrintDialogData}\label{wxprintdialoggetprintdialogdata}
\func{wxPrintDialogData\&}{GetPrintDialogData}{\void}
Returns the \helpref{print dialog data}{wxprintdialogdata} associated with the print dialog.
+
\membersection{wxPrintDialog::GetPrintDC}\label{wxprintdialoggetprintdc}
\func{wxDC* }{GetPrintDC}{\void}
is transferred to the application, so it must then be deleted
explicitly.
+
\membersection{wxPrintDialog::Ok}\label{wxprintdialogok}
\constfunc{bool}{Ok}{\void}
-Returns TRUE if the print data associated with the dialog is valid.
-This can return FALSE on Windows if the current printer is not set, for example.
-On all other platforms, it returns TRUE.
+Returns true if the print data associated with the dialog is valid.
+This can return false on Windows if the current printer is not set, for example.
+On all other platforms, it returns true.
+
\membersection{wxPrintDialog::ShowModal}\label{wxprintdialogshowmodal}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxPrintDialogData::wxPrintDialogData}
+
+\membersection{wxPrintDialogData::wxPrintDialogData}\label{wxprintdialogdatactor}
\func{}{wxPrintDialogData}{\void}
Construct an object from a print dialog data object.
-\membersection{wxPrintDialogData::\destruct{wxprintdialogdata}}
+
+\membersection{wxPrintDialogData::\destruct{wxPrintDialogData}}\label{wxprintdialogdatadtor}
\func{}{\destruct{wxPrintDialogData}}{\void}
Destructor.
+
\membersection{wxPrintDialogData::EnableHelp}\label{wxprintdialogdataenablehelp}
\func{void}{EnableHelp}{\param{bool }{flag}}
Enables or disables the `Help' button.
+
\membersection{wxPrintDialogData::EnablePageNumbers}\label{wxprintdialogdataenablepagenumbers}
\func{void}{EnablePageNumbers}{\param{bool }{flag}}
Enables or disables the `Page numbers' controls.
+
\membersection{wxPrintDialogData::EnablePrintToFile}\label{wxprintdialogdataenableprinttofile}
\func{void}{EnablePrintToFile}{\param{bool }{flag}}
Enables or disables the `Print to file' checkbox.
+
\membersection{wxPrintDialogData::EnableSelection}\label{wxprintdialogdataenableselection}
\func{void}{EnableSelection}{\param{bool }{flag}}
Enables or disables the `Selection' radio button.
+
\membersection{wxPrintDialogData::GetAllPages}\label{wxprintdialogdatagetallpages}
\constfunc{bool}{GetAllPages}{\void}
-Returns TRUE if the user requested that all pages be printed.
+Returns true if the user requested that all pages be printed.
+
\membersection{wxPrintDialogData::GetCollate}\label{wxprintdialogdatagetcollate}
\constfunc{bool}{GetCollate}{\void}
-Returns TRUE if the user requested that the document(s) be collated.
+Returns true if the user requested that the document(s) be collated.
+
\membersection{wxPrintDialogData::GetFromPage}\label{wxprintdialogdatagetfrompage}
Returns the {\it from} page number, as entered by the user.
+
\membersection{wxPrintDialogData::GetMaxPage}\label{wxprintdialogdatagetmaxpage}
\constfunc{int}{GetMaxPage}{\void}
Returns the {\it maximum} page number.
+
\membersection{wxPrintDialogData::GetMinPage}\label{wxprintdialogdatagetminpage}
\constfunc{int}{GetMinPage}{\void}
Returns the {\it minimum} page number.
+
\membersection{wxPrintDialogData::GetNoCopies}\label{wxprintdialogdatagetnocopies}
\constfunc{int}{GetNoCopies}{\void}
Returns the number of copies requested by the user.
+
\membersection{wxPrintDialogData::GetPrintData}\label{wxprintdialogdatagetprintdata}
\func{wxPrintData\&}{GetPrintData}{\void}
Returns a reference to the internal wxPrintData object.
+
\membersection{wxPrintDialogData::GetPrintToFile}\label{wxprintdialogdatagetprinttofile}
\constfunc{bool}{GetPrintToFile}{\void}
-Returns TRUE if the user has selected printing to a file.
+Returns true if the user has selected printing to a file.
+
\membersection{wxPrintDialogData::GetSelection}\label{wxprintdialogdatagetselection}
\constfunc{bool}{GetSelection}{\void}
-Returns TRUE if the user requested that the selection be printed (where 'selection' is
+Returns true if the user requested that the selection be printed (where 'selection' is
a concept specific to the application).
+
\membersection{wxPrintDialogData::GetToPage}\label{wxprintdialogdatagettopage}
\constfunc{int}{GetToPage}{\void}
Returns the {\it to} page number, as entered by the user.
+
\membersection{wxPrintDialogData::Ok}\label{wxprintdialogdataok}
\constfunc{bool}{Ok}{\void}
-Returns TRUE if the print data is valid for using in print dialogs.
-This can return FALSE on Windows if the current printer is not set, for example.
-On all other platforms, it returns TRUE.
+Returns true if the print data is valid for using in print dialogs.
+This can return false on Windows if the current printer is not set, for example.
+On all other platforms, it returns true.
+
\membersection{wxPrintDialogData::SetCollate}\label{wxprintdialogdatasetcollate}
\func{void}{SetCollate}{\param{bool }{flag}}
-Sets the 'Collate' checkbox to TRUE or FALSE.
+Sets the 'Collate' checkbox to true or false.
+
\membersection{wxPrintDialogData::SetFromPage}\label{wxprintdialogdatasetfrompage}
Sets the {\it from} page number.
+
\membersection{wxPrintDialogData::SetMaxPage}\label{wxprintdialogdatasetmaxpage}
\func{void}{SetMaxPage}{\param{int }{page}}
Sets the {\it maximum} page number.
+
\membersection{wxPrintDialogData::SetMinPage}\label{wxprintdialogdatasetminpage}
\func{void}{SetMinPage}{\param{int }{page}}
Sets the {\it minimum} page number.
+
\membersection{wxPrintDialogData::SetNoCopies}\label{wxprintdialogdatasetnocopies}
\func{void}{SetNoCopies}{\param{int }{n}}
Sets the default number of copies the user has requested to be printed out.
+
\membersection{wxPrintDialogData::SetPrintData}\label{wxprintdialogdatasetprintdata}
\func{void}{SetPrintData}{\param{const wxPrintData\& }{printData}}
Sets the internal wxPrintData.
+
\membersection{wxPrintDialogData::SetPrintToFile}\label{wxprintdialogdatasetprinttofile}
\func{void}{SetPrintToFile}{\param{bool }{flag}}
-Sets the 'Print to file' checkbox to TRUE or FALSE.
+Sets the 'Print to file' checkbox to true or false.
+
\membersection{wxPrintDialogData::SetSelection}\label{wxprintdialogdatasetselection}
Selects the 'Selection' radio button. The effect of printing the selection depends on how the application
implements this command, if at all.
+
\membersection{wxPrintDialogData::SetSetupDialog}\label{wxprintdialogdatasetsetupdialog}
\func{void}{SetSetupDialog}{\param{bool }{flag}}
Determines whether the dialog to be shown will be the Print dialog
-(pass FALSE) or Print Setup dialog (pass TRUE).
+(pass false) or Print Setup dialog (pass true).
Note that the setup dialog is (according to Microsoft) obsolete from
Windows 95, though retained for backward compatibility.
+
\membersection{wxPrintDialogData::SetToPage}\label{wxprintdialogdatasettopage}
\func{void}{SetToPage}{\param{int }{page}}
Sets the {\it to} page number.
+
\membersection{wxPrintDialogData::operator $=$}\label{wxprintdialogdataassign}
\func{void}{operator $=$}{\param{const wxPrintData\&}{ data}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxPrinter::wxPrinter}
+
+\membersection{wxPrinter::wxPrinter}\label{wxprinterctor}
\func{}{wxPrinter}{\param{wxPrintDialogData* }{data = NULL}}
\helpref{wxPrintDialogData}{wxprintdialogdata},
\helpref{wxPrintData}{wxprintdata}
-\membersection{wxPrinter::\destruct{wxPrinter}}
+
+\membersection{wxPrinter::\destruct{wxPrinter}}\label{wxprinterdtor}
\func{}{\destruct{wxPrinter}}{\void}
Destructor.
+
\membersection{wxPrinter::Abort}\label{wxprinterabort}
\func{bool}{Abort}{\void}
-Returns TRUE if the user has aborted the print job.
+Returns true if the user has aborted the print job.
+
\membersection{wxPrinter::CreateAbortWindow}\label{wxprintercreateabortwindow}
Creates the default printing abort window, with a cancel button.
+
\membersection{wxPrinter::GetLastError}\label{wxprintergetlasterror}
\func{static wxPrinterError}{GetLastError}{\void}
\end{twocollist}
+
\membersection{wxPrinter::GetPrintDialogData}\label{wxprintergetprintdialogdata}
\func{wxPrintDialogData\&}{GetPrintDialogData}{\void}
Returns the \helpref{print data}{wxprintdata} associated with the printer object.
+
\membersection{wxPrinter::Print}\label{wxprinterprint}
-\func{bool}{Print}{\param{wxWindow *}{parent}, \param{wxPrintout *}{printout}, \param{bool }{prompt=TRUE}}
+\func{bool}{Print}{\param{wxWindow *}{parent}, \param{wxPrintout *}{printout}, \param{bool }{prompt=true}}
Starts the printing process. Provide a parent window, a user-defined wxPrintout object which controls
the printing of a document, and whether the print dialog should be invoked first.
-Print could return FALSE if there was a problem initializing the printer device context
+Print could return false if there was a problem initializing the printer device context
(current printer not set, for example) or the user cancelled printing. Call
\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
information about the kind of the error.
+
\membersection{wxPrinter::PrintDialog}\label{wxprinterprintdialog}
\func{wxDC*}{PrintDialog}{\param{wxWindow *}{parent}}
The application must delete this device context to avoid a memory leak.
+
\membersection{wxPrinter::ReportError}\label{wxprinterreporterror}
\func{void}{ReportError}{\param{wxWindow *}{parent}, \param{wxPrintout *}{printout}, \param{const wxString\& }{message}}
Default error-reporting function.
+
\membersection{wxPrinter::Setup}\label{wxprintersetup}
\func{bool}{Setup}{\param{wxWindow *}{parent}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxPrinterDC::wxPrinterDC}
+
+\membersection{wxPrinterDC::wxPrinterDC}\label{wxprinterdcctor}
\func{}{wxPrinterDC}{\param{const wxPrintData\& }{printData}}
is the recommended way to construct a wxPrinterDC.
\func{}{wxPrinterDC}{\param{const wxString\& }{driver}, \param{const wxString\& }{device}, \param{const wxString\& }{output},
- \param{const bool }{interactive = TRUE}, \param{int }{orientation = wxPORTRAIT}}
+ \param{const bool }{interactive = true}, \param{int }{orientation = wxPORTRAIT}}
Constructor. With empty strings for the first three arguments, the default printer dialog is
displayed. {\it device} indicates the type of printer and {\it output}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxPrintout::wxPrintout}
+
+\membersection{wxPrintout::wxPrintout}\label{wxprintoutctor}
\func{}{wxPrintout}{\param{const wxString\& }{title = "Printout"}}
Constructor. Pass an optional title argument - the current filename would be a good idea. This will appear in the printing list
(at least in MSW)
-\membersection{wxPrintout::\destruct{wxPrintout}}
+
+\membersection{wxPrintout::\destruct{wxPrintout}}\label{wxprintoutdtor}
\func{}{\destruct{wxPrintout}}{\void}
Destructor.
+
\membersection{wxPrintout::GetDC}\label{wxprintoutgetdc}
\func{wxDC *}{GetDC}{\void}
printing or previewing). This will be a wxPrinterDC if printing under Windows,
a wxPostScriptDC if printing on other platforms, and a wxMemoryDC if previewing.
+
\membersection{wxPrintout::GetPageInfo}\label{wxprintoutgetpageinfo}
\func{void}{GetPageInfo}{\param{int *}{minPage}, \param{int *}{maxPage}, \param{int *}{pageFrom}, \param{int *}{pageTo}}
}
\perlnote{When this method is overridden in a derived class,
-it must not take any parameters, an return a 4-element list.
+it must not take any parameters, and returns a 4-element list.
}
+
\membersection{wxPrintout::GetPageSizeMM}\label{wxprintoutgetpagesizemm}
\func{void}{GetPageSizeMM}{\param{int *}{w}, \param{int *}{h}}
\perlnote{In wxPerl this method takes no arguments and returns a
2-element list {\tt ( w, h )}}
+
\membersection{wxPrintout::GetPageSizePixels}\label{wxprintoutgetpagesizepixels}
\func{void}{GetPageSizePixels}{\param{int *}{w}, \param{int *}{h}}
\perlnote{In wxPerl this method takes no arguments and returns a
2-element list {\tt ( w, h )}}
+
\membersection{wxPrintout::GetPPIPrinter}\label{wxprintoutgetppiprinter}
\func{void}{GetPPIPrinter}{\param{int *}{w}, \param{int *}{h}}
\perlnote{In wxPerl this method takes no arguments and returns a
2-element list {\tt ( w, h )}}
+
\membersection{wxPrintout::GetPPIScreen}\label{wxprintoutgetppiscreen}
\func{void}{GetPPIScreen}{\param{int *}{w}, \param{int *}{h}}
factor for drawing text onto the printer. Remember to multiply
this by a scaling factor to take the preview DC size into account.
+
\membersection{wxPrintout::GetTitle}\label{wxprintoutgettitle}
\func{wxString}{GetTitle}{\void}
\perlnote{In wxPerl this method takes no arguments and returns a
2-element list {\tt ( w, h )}}
+
\membersection{wxPrintout::HasPage}\label{wxprintouthaspage}
\func{bool}{HasPage}{\param{int}{ pageNum}}
-Should be overridden to return TRUE if the document has this page, or FALSE
-if not. Returning FALSE signifies the end of the document. By default,
+Should be overridden to return true if the document has this page, or false
+if not. Returning false signifies the end of the document. By default,
HasPage behaves as if the document has only one page.
+
\membersection{wxPrintout::IsPreview}\label{wxprintoutispreview}
\func{bool}{IsPreview}{\void}
-Returns TRUE if the printout is currently being used for previewing.
+Returns true if the printout is currently being used for previewing.
+
\membersection{wxPrintout::OnBeginDocument}\label{wxprintoutonbegindocument}
\func{bool}{OnBeginDocument}{\param{int}{ startPage}, \param{int}{ endPage}}
-Called by the framework at the start of document printing. Return FALSE from
+Called by the framework at the start of document printing. Return false from
this function cancels the print job. OnBeginDocument is called once for every
copy printed.
base class version can be called by using the method
{\tt base\_OnBeginDocument(startPage, endPage)}. }
+
\membersection{wxPrintout::OnEndDocument}\label{wxprintoutonenddocument}
\func{void}{OnEndDocument}{\void}
The base wxPrintout::OnEndDocument {\it must} be called
from within the overridden function, since it calls wxDC::EndDoc.
+
\membersection{wxPrintout::OnBeginPrinting}\label{wxprintoutonbeginprinting}
\func{void}{OnBeginPrinting}{\void}
Called by the framework at the start of printing. OnBeginPrinting is called once for every
print job (regardless of how many copies are being printed).
+
\membersection{wxPrintout::OnEndPrinting}\label{wxprintoutonendprinting}
\func{void}{OnEndPrinting}{\void}
Called by the framework at the end of printing. OnEndPrinting
is called once for every print job (regardless of how many copies are being printed).
+
\membersection{wxPrintout::OnPreparePrinting}\label{wxprintoutonprepareprinting}
\func{void}{OnPreparePrinting}{\void}
wxPrintout object. This gives the object an opportunity to calculate the
number of pages in the document, for example.
+
\membersection{wxPrintout::OnPrintPage}\label{wxprintoutonprintpage}
\func{bool}{OnPrintPage}{\param{int}{ pageNum}}
-Called by the framework when a page should be printed. Returning FALSE cancels
+Called by the framework when a page should be printed. Returning false cancels
the print job. The application can use wxPrintout::GetDC to obtain a device
context to draw on.
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxPrintPreview::wxPrintPreview}
+
+\membersection{wxPrintPreview::wxPrintPreview}\label{wxprintpreviewctor}
\func{}{wxPrintPreview}{\param{wxPrintout* }{printout}, \param{wxPrintout* }{printoutForPrinting},
\param{wxPrintData* }{data=NULL}}
The same does not apply to the {\it data} argument.
Test the Ok member to check whether the wxPrintPreview object was created correctly.
-Ok could return FALSE if there was a problem initializing the printer device context
+Ok could return false if there was a problem initializing the printer device context
(current printer not set, for example).
-\membersection{wxPrintPreview::\destruct{wxPrintPreview}}
+
+\membersection{wxPrintPreview::\destruct{wxPrintPreview}}\label{wxprintpreviewdtor}
\func{}{\destruct{wxPrinter}}{\void}
Destructor. Deletes both print preview objects, so do not destroy these objects
in your application.
+
\membersection{wxPrintPreview::DrawBlankPage}\label{wxprintpreviewdrawblankpage}
\func{bool}{DrawBlankPage}{\param{wxWindow* }{window}}
Draws a representation of the blank page into the preview window. Used
internally.
+
\membersection{wxPrintPreview::GetCanvas}\label{wxprintpreviewgetcanvas}
-\func{wxWindow* }{GetCanvas}{\void}
+\func{wxPreviewCanvas* }{GetCanvas}{\void}
Gets the preview window used for displaying the print preview image.
+
\membersection{wxPrintPreview::GetCurrentPage}\label{wxprintpreviewgetcurrentpage}
\func{int}{GetCurrentPage}{\void}
Gets the page currently being previewed.
+
\membersection{wxPrintPreview::GetFrame}\label{wxprintpreviewgetframe}
\func{wxFrame *}{GetFrame}{\void}
Gets the frame used for displaying the print preview canvas
and control bar.
+
\membersection{wxPrintPreview::GetMaxPage}\label{wxprintpreviewgetmaxpage}
\func{int}{GetMaxPage}{\void}
Returns the maximum page number.
+
\membersection{wxPrintPreview::GetMinPage}\label{wxprintpreviewgetminpage}
\func{int}{GetMinPage}{\void}
Returns the minimum page number.
+
\membersection{wxPrintPreview::GetPrintData}\label{wxprintpreviewgetprintdata}
\func{wxPrintData\&}{GetPrintData}{\void}
Returns a reference to the internal print data.
+
\membersection{wxPrintPreview::GetPrintout}\label{wxprintpreviewgetprintout}
\func{wxPrintout *}{GetPrintout}{\void}
Gets the preview printout object associated with the wxPrintPreview object.
+
\membersection{wxPrintPreview::GetPrintoutForPrinting}\label{wxprintpreviewgetprintoutforprinting}
\func{wxPrintout *}{GetPrintoutForPrinting}{\void}
Gets the printout object to be used for printing from within the preview interface,
or NULL if none exists.
+
\membersection{wxPrintPreview::Ok}\label{wxprintpreviewok}
\func{bool}{Ok}{\void}
-Returns TRUE if the wxPrintPreview is valid, FALSE otherwise. It could return FALSE if there was a
+Returns true if the wxPrintPreview is valid, false otherwise. It could return false if there was a
problem initializing the printer device context (current printer not set, for example).
+
\membersection{wxPrintPreview::PaintPage}\label{wxprintpreviewpaintpage}
\func{bool}{PaintPage}{\param{wxWindow* }{window}}
The implementation simply blits the preview bitmap onto
the canvas, creating a new preview bitmap if none exists.
+
\membersection{wxPrintPreview::Print}\label{wxprintpreviewprint}
\func{bool}{Print}{\param{bool }{prompt}}
Will normally be called by the {\bf Print...} panel item on the
preview frame's control bar.
-Returns FALSE in case of error -- call
+Returns false in case of error -- call
\helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
information about the kind of the error.
+
\membersection{wxPrintPreview::RenderPage}\label{wxprintpreviewrenderpage}
\func{bool}{RenderPage}{\param{int }{pageNum}}
Renders a page into a wxMemoryDC. Used internally by wxPrintPreview.
+
\membersection{wxPrintPreview::SetCanvas}\label{wxprintpreviewsetcanvas}
-\func{void}{SetCanvas}{\param{wxWindow* }{window}}
+\func{void}{SetCanvas}{\param{wxPreviewCanvas** }{window}}
Sets the window to be used for displaying the print preview image.
+
\membersection{wxPrintPreview::SetCurrentPage}\label{wxprintpreviewsetcurrentpage}
\func{void}{SetCurrentPage}{\param{int}{ pageNum}}
Sets the current page to be previewed.
+
\membersection{wxPrintPreview::SetFrame}\label{wxprintpreviewsetframe}
\func{void}{SetFrame}{\param{wxFrame *}{frame}}
Sets the frame to be used for displaying the print preview canvas
and control bar.
+
\membersection{wxPrintPreview::SetPrintout}\label{wxprintpreviewsetprintout}
\func{void}{SetPrintout}{\param{wxPrintout *}{printout}}
Associates a printout object with the wxPrintPreview object.
+
\membersection{wxPrintPreview::SetZoom}\label{wxprintpreviewsetzoom}
\func{void}{SetZoom}{\param{int}{ percent}}
projects / wxWidgets.git / blobdiff