X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/600902562da4b1008c006a1d9daca40fc932b7ef..4948ebf3ffe886443ec61bbecd1d0d3b794dfee2:/docs/latex/wx/print.tex diff --git a/docs/latex/wx/print.tex b/docs/latex/wx/print.tex index 201fd633bd..cc02e3158d 100644 --- a/docs/latex/wx/print.tex +++ b/docs/latex/wx/print.tex @@ -59,7 +59,7 @@ void SetPrintMode(wxPrintMode printMode) ; \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxPrintData::wxPrintData} +\membersection{wxPrintData::wxPrintData}\label{wxprintdatactor} \func{}{wxPrintData}{\void} @@ -70,7 +70,7 @@ Default constructor. Copy constructor. -\membersection{wxPrintData::\destruct{wxPrintData}} +\membersection{wxPrintData::\destruct{wxPrintData}}\label{wxprintdatadtor} \func{}{\destruct{wxPrintData}}{\void} @@ -376,7 +376,7 @@ a successfully dismissed print dialog. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxPrintDialog::wxPrintDialog} +\membersection{wxPrintDialog::wxPrintDialog}\label{wxprintdialogctor} \func{}{wxPrintDialog}{\param{wxWindow* }{parent}, \param{wxPrintDialogData* }{data = NULL}} @@ -388,7 +388,7 @@ data, which will be copied to the print dialog's print data. \helpref{wxPrintDialogData}{wxprintdialogdata} -\membersection{wxPrintDialog::\destruct{wxPrintDialog}} +\membersection{wxPrintDialog::\destruct{wxPrintDialog}}\label{wxprintdialogdtor} \func{}{\destruct{wxPrintDialog}}{\void} @@ -413,15 +413,6 @@ 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. - - \membersection{wxPrintDialog::ShowModal}\label{wxprintdialogshowmodal} \func{int}{ShowModal}{\void} @@ -450,7 +441,7 @@ It contains a wxPrintData object with underlying printing settings. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxPrintDialogData::wxPrintDialogData} +\membersection{wxPrintDialogData::wxPrintDialogData}\label{wxprintdialogdatactor} \func{}{wxPrintDialogData}{\void} @@ -465,7 +456,7 @@ Copy constructor. Construct an object from a print dialog data object. -\membersection{wxPrintDialogData::\destruct{wxPrintDialogData}} +\membersection{wxPrintDialogData::\destruct{wxPrintDialogData}}\label{wxprintdialogdatadtor} \func{}{\destruct{wxPrintDialogData}}{\void} @@ -644,9 +635,7 @@ implements this command, if at all. Determines whether the dialog to be shown will be the Print dialog (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. - +This function has been deprecated since version 2.5.4. \membersection{wxPrintDialogData::SetToPage}\label{wxprintdialogdatasettopage} @@ -689,7 +678,7 @@ method of printing. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxPrinter::wxPrinter} +\membersection{wxPrinter::wxPrinter}\label{wxprinterctor} \func{}{wxPrinter}{\param{wxPrintDialogData* }{data = NULL}} @@ -702,19 +691,6 @@ dialog data, which will be copied to the printer object's local data. \helpref{wxPrintData}{wxprintdata} -\membersection{wxPrinter::\destruct{wxPrinter}} - -\func{}{\destruct{wxPrinter}}{\void} - -Destructor. - - -\membersection{wxPrinter::Abort}\label{wxprinterabort} - -\func{bool}{Abort}{\void} - -Returns true if the user has aborted the print job. - \membersection{wxPrinter::CreateAbortWindow}\label{wxprintercreateabortwindow} @@ -723,6 +699,12 @@ Returns true if the user has aborted the print job. Creates the default printing abort window, with a cancel button. +\membersection{wxPrinter::GetAbort}\label{wxprintergetabort} + +\func{bool}{GetAbort}{\void} + +Returns true if the user has aborted the print job. + \membersection{wxPrinter::GetLastError}\label{wxprintergetlasterror} @@ -814,13 +796,16 @@ achieving the correct scaling for the page. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxPrinterDC::wxPrinterDC} +\membersection{wxPrinterDC::wxPrinterDC}\label{wxprinterdcctor} \func{}{wxPrinterDC}{\param{const wxPrintData\& }{printData}} Pass a \helpref{wxPrintData}{wxprintdata} object with information necessary for setting up a suitable printer device context. This -is the recommended way to construct a wxPrinterDC. +is the recommended way to construct a wxPrinterDC. Make sure you +specify a reference to a \helpref{wxPrintData}{wxprintdata} object, +not a pointer - you may not even get a warning if you pass a pointer +instead. \func{}{wxPrinterDC}{\param{const wxString\& }{driver}, \param{const wxString\& }{device}, \param{const wxString\& }{output}, \param{const bool }{interactive = true}, \param{int }{orientation = wxPORTRAIT}} @@ -857,7 +842,7 @@ wxPrintPreview object to initiate printing or previewing. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxPrintout::wxPrintout} +\membersection{wxPrintout::wxPrintout}\label{wxprintoutctor} \func{}{wxPrintout}{\param{const wxString\& }{title = "Printout"}} @@ -865,7 +850,7 @@ Constructor. Pass an optional title argument - the current filename would be a g (at least in MSW) -\membersection{wxPrintout::\destruct{wxPrintout}} +\membersection{wxPrintout::\destruct{wxPrintout}}\label{wxprintoutdtor} \func{}{\destruct{wxPrintout}}{\void} @@ -1069,7 +1054,7 @@ immediately after the frame is shown. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxPrintPreview::wxPrintPreview} +\membersection{wxPrintPreview::wxPrintPreview}\label{wxprintpreviewctor} \func{}{wxPrintPreview}{\param{wxPrintout* }{printout}, \param{wxPrintout* }{printoutForPrinting}, \param{wxPrintData* }{data=NULL}} @@ -1091,7 +1076,7 @@ Ok could return false if there was a problem initializing the printer device con (current printer not set, for example). -\membersection{wxPrintPreview::\destruct{wxPrintPreview}} +\membersection{wxPrintPreview::\destruct{wxPrintPreview}}\label{wxprintpreviewdtor} \func{}{\destruct{wxPrinter}}{\void} @@ -1099,14 +1084,6 @@ 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{wxPreviewCanvas* }{GetCanvas}{\void} @@ -1143,13 +1120,6 @@ Returns the maximum page number. 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} @@ -1175,7 +1145,7 @@ problem initializing the printer device context (current printer not set, for ex \membersection{wxPrintPreview::PaintPage}\label{wxprintpreviewpaintpage} -\func{bool}{PaintPage}{\param{wxWindow* }{window}} +\func{bool}{PaintPage}{\param{wxPreviewCanvas *}{canvas}, \param{wxDC& }{dc}} This refreshes the preview window with the preview image. It must be called from the preview window's OnPaint member. @@ -1207,7 +1177,7 @@ Renders a page into a wxMemoryDC. Used internally by wxPrintPreview. \membersection{wxPrintPreview::SetCanvas}\label{wxprintpreviewsetcanvas} -\func{void}{SetCanvas}{\param{wxPreviewCanvas** }{window}} +\func{void}{SetCanvas}{\param{wxPreviewCanvas* }{window}} Sets the window to be used for displaying the print preview image.