wxPdfDocument  1.4.0
Library for generating PDF documents from wxWidgets applications
Loading...
Searching...
No Matches
wxPdfPrintPreview Class Reference

Class for managing the print preview process for PDF documents. More...

#include <pdfprint.h>

Inheritance diagram for wxPdfPrintPreview:

Public Member Functions

 wxPdfPrintPreview (wxPrintout *printout, wxPrintout *printoutForPrinting)
 Constructor.
 wxPdfPrintPreview (wxPrintout *printout, wxPrintout *printoutForPrinting, wxPrintDialogData *data)
 Constructor from wxPrintDialogData.
 wxPdfPrintPreview (wxPrintout *printout, wxPrintout *printoutForPrinting, wxPrintData *data)
 Constructor from wxPrintData.
 wxPdfPrintPreview (wxPrintout *printout, wxPrintout *printoutForPrinting, wxPdfPrintData *data)
 Constructor from wxPdfPrintData.
virtual ~wxPdfPrintPreview ()
 Destructor.
virtual bool SetCurrentPage (int pageNum)
 Set the current page.
virtual int GetCurrentPage () const
 Get the current page.
virtual void SetPrintout (wxPrintout *printout)
 Set the printout.
virtual wxPrintout * GetPrintout () const
 Get the preview printout.
virtual wxPrintout * GetPrintoutForPrinting () const
 Get the printing printout.
virtual void SetFrame (wxFrame *frame)
 Set the frame.
virtual void SetCanvas (wxPreviewCanvas *canvas)
 Set the canvas.
virtual wxFrame * GetFrame () const
 Get the frame.
virtual wxPreviewCanvas * GetCanvas () const
 Get the canvas.
virtual bool PaintPage (wxPreviewCanvas *canvas, wxDC &dc)
 Paint the page.
virtual bool UpdatePageRendering ()
 Update page rendering.
virtual bool DrawBlankPage (wxPreviewCanvas *canvas, wxDC &dc)
 Draw a blank page.
virtual void AdjustScrollbars (wxPreviewCanvas *canvas)
 Adjust scrollbars.
virtual bool RenderPage (int pageNum)
 Render the page.
virtual void SetZoom (int percent)
 Set the zoom factor.
virtual int GetZoom () const
 Get the zoom factor.
virtual bool Print (bool interactive)
 Print the document.
virtual void DetermineScaling ()
 Determine scaling.
virtual wxPrintDialogData & GetPrintDialogData ()
 Get the print dialog data.
virtual int GetMaxPage () const
 Get the maximum page number.
virtual int GetMinPage () const
 Get the minimum page number.
virtual bool Ok () const
 Check whether the preview is valid.
virtual bool IsOk () const
 Check whether the preview is valid.
virtual void SetOk (bool ok)
 Set the preview valid flag.

Detailed Description

Class for managing the print preview process for PDF documents.

Constructor & Destructor Documentation

◆ wxPdfPrintPreview() [1/4]

wxPdfPrintPreview::wxPdfPrintPreview ( wxPrintout * printout,
wxPrintout * printoutForPrinting )

Constructor.

Parameters
printoutThe printout to preview
printoutForPrintingThe printout to use for printing

◆ wxPdfPrintPreview() [2/4]

wxPdfPrintPreview::wxPdfPrintPreview ( wxPrintout * printout,
wxPrintout * printoutForPrinting,
wxPrintDialogData * data )

Constructor from wxPrintDialogData.

Parameters
printoutThe printout to preview
printoutForPrintingThe printout to use for printing
dataThe print dialog data

◆ wxPdfPrintPreview() [3/4]

wxPdfPrintPreview::wxPdfPrintPreview ( wxPrintout * printout,
wxPrintout * printoutForPrinting,
wxPrintData * data )

Constructor from wxPrintData.

Parameters
printoutThe printout to preview
printoutForPrintingThe printout to use for printing
dataThe print data

◆ wxPdfPrintPreview() [4/4]

wxPdfPrintPreview::wxPdfPrintPreview ( wxPrintout * printout,
wxPrintout * printoutForPrinting,
wxPdfPrintData * data )

Constructor from wxPdfPrintData.

Parameters
printoutThe printout to preview
printoutForPrintingThe printout to use for printing
dataThe PDF print data

◆ ~wxPdfPrintPreview()

virtual wxPdfPrintPreview::~wxPdfPrintPreview ( )
virtual

Destructor.

Member Function Documentation

◆ AdjustScrollbars()

virtual void wxPdfPrintPreview::AdjustScrollbars ( wxPreviewCanvas * canvas)
virtual

Adjust scrollbars.

Parameters
canvasThe canvas

◆ DetermineScaling()

virtual void wxPdfPrintPreview::DetermineScaling ( )
virtual

Determine scaling.

◆ DrawBlankPage()

virtual bool wxPdfPrintPreview::DrawBlankPage ( wxPreviewCanvas * canvas,
wxDC & dc )
virtual

Draw a blank page.

Parameters
canvasThe canvas
dcThe device context
Returns
true if successful, false otherwise

◆ GetCanvas()

virtual wxPreviewCanvas * wxPdfPrintPreview::GetCanvas ( ) const
virtual

Get the canvas.

Returns
The canvas

◆ GetCurrentPage()

virtual int wxPdfPrintPreview::GetCurrentPage ( ) const
virtual

Get the current page.

Returns
The current page number

◆ GetFrame()

virtual wxFrame * wxPdfPrintPreview::GetFrame ( ) const
virtual

Get the frame.

Returns
The frame

◆ GetMaxPage()

virtual int wxPdfPrintPreview::GetMaxPage ( ) const
virtual

Get the maximum page number.

Returns
The maximum page number

◆ GetMinPage()

virtual int wxPdfPrintPreview::GetMinPage ( ) const
virtual

Get the minimum page number.

Returns
The minimum page number

◆ GetPrintDialogData()

virtual wxPrintDialogData & wxPdfPrintPreview::GetPrintDialogData ( )
virtual

Get the print dialog data.

Returns
The print dialog data

◆ GetPrintout()

virtual wxPrintout * wxPdfPrintPreview::GetPrintout ( ) const
virtual

Get the preview printout.

Returns
The preview printout

◆ GetPrintoutForPrinting()

virtual wxPrintout * wxPdfPrintPreview::GetPrintoutForPrinting ( ) const
virtual

Get the printing printout.

Returns
The printing printout

◆ GetZoom()

virtual int wxPdfPrintPreview::GetZoom ( ) const
virtual

Get the zoom factor.

Returns
The zoom factor in percent

◆ IsOk()

virtual bool wxPdfPrintPreview::IsOk ( ) const
virtual

Check whether the preview is valid.

Returns
true if valid, false otherwise

◆ Ok()

virtual bool wxPdfPrintPreview::Ok ( ) const
inlinevirtual

Check whether the preview is valid.

Returns
true if valid, false otherwise

◆ PaintPage()

virtual bool wxPdfPrintPreview::PaintPage ( wxPreviewCanvas * canvas,
wxDC & dc )
virtual

Paint the page.

Parameters
canvasThe canvas
dcThe device context
Returns
true if successful, false otherwise

◆ Print()

virtual bool wxPdfPrintPreview::Print ( bool interactive)
virtual

Print the document.

Parameters
interactivetrue to show the print dialog, false otherwise
Returns
true if successful, false otherwise

◆ RenderPage()

virtual bool wxPdfPrintPreview::RenderPage ( int pageNum)
virtual

Render the page.

Parameters
pageNumThe page number
Returns
true if successful, false otherwise

◆ SetCanvas()

virtual void wxPdfPrintPreview::SetCanvas ( wxPreviewCanvas * canvas)
virtual

Set the canvas.

Parameters
canvasThe canvas

◆ SetCurrentPage()

virtual bool wxPdfPrintPreview::SetCurrentPage ( int pageNum)
virtual

Set the current page.

Parameters
pageNumThe page number
Returns
true if successful, false otherwise

◆ SetFrame()

virtual void wxPdfPrintPreview::SetFrame ( wxFrame * frame)
virtual

Set the frame.

Parameters
frameThe frame

◆ SetOk()

virtual void wxPdfPrintPreview::SetOk ( bool ok)
virtual

Set the preview valid flag.

Parameters
oktrue if valid, false otherwise

◆ SetPrintout()

virtual void wxPdfPrintPreview::SetPrintout ( wxPrintout * printout)
virtual

Set the printout.

Parameters
printoutThe printout

◆ SetZoom()

virtual void wxPdfPrintPreview::SetZoom ( int percent)
virtual

Set the zoom factor.

Parameters
percentThe zoom factor in percent

◆ UpdatePageRendering()

virtual bool wxPdfPrintPreview::UpdatePageRendering ( )
virtual

Update page rendering.

Returns
true if successful, false otherwise

The documentation for this class was generated from the following file:
  • E:/github/wxpdfdoc-current/include/wx/pdfprint.h