wxShapeFramework  1.13.0 beta
wxSFPrintout Class Reference

Auxiliary printout class providing all necessary functions needed for canvas printing. This class is used internally by the wxSFShapeCanvas class. It can be also used as a base class for other modified printout classes. More...

#include <Printout.h>

Inheritance diagram for wxSFPrintout:
Collaboration diagram for wxSFPrintout:

Public Member Functions

 wxSFPrintout (const wxString &title, wxSFShapeCanvas *canvas)
 Default constructor. More...
 
virtual ~wxSFPrintout ()
 Default destructor. More...
 
void SetPrintedCanvas (wxSFShapeCanvas *canvas)
 Set shape canvas which content should be printed. More...
 
virtual bool HasPage (int page)
 Called by printing framework. Functions TRUE if a page of given index already exists in printed document. This function can be overrided if necessary. More...
 
virtual bool OnBeginDocument (int startPage, int endPage)
 Called by printing framework. Initialize print job. This function can be overrided if necessary. More...
 
virtual void OnEndDocument ()
 Called by printing framework. Deinitialize the print job. This function can be overrided if necessary. More...
 
virtual bool OnPrintPage (int page)
 Called by printing framework. It does the print job. This function can be overrided if necessary. More...
 
virtual void GetPageInfo (int *minPage, int *maxPage, int *selPageFrom, int *selPageTo)
 Called by printing framework. Supply information about printed pages. This function can be overrided if necessary. More...
 

Protected Attributes

wxSFShapeCanvasm_pCanvas
 Pointer to parent shape canvas. More...
 

Detailed Description

Auxiliary printout class providing all necessary functions needed for canvas printing. This class is used internally by the wxSFShapeCanvas class. It can be also used as a base class for other modified printout classes.

Constructor & Destructor Documentation

◆ wxSFPrintout()

wxSFPrintout::wxSFPrintout ( const wxString &  title,
wxSFShapeCanvas canvas 
)

Default constructor.

◆ ~wxSFPrintout()

virtual wxSFPrintout::~wxSFPrintout ( )
virtual

Default destructor.

Member Function Documentation

◆ GetPageInfo()

virtual void wxSFPrintout::GetPageInfo ( int *  minPage,
int *  maxPage,
int *  selPageFrom,
int *  selPageTo 
)
virtual

Called by printing framework. Supply information about printed pages. This function can be overrided if necessary.

◆ HasPage()

virtual bool wxSFPrintout::HasPage ( int  page)
virtual

Called by printing framework. Functions TRUE if a page of given index already exists in printed document. This function can be overrided if necessary.

◆ OnBeginDocument()

virtual bool wxSFPrintout::OnBeginDocument ( int  startPage,
int  endPage 
)
virtual

Called by printing framework. Initialize print job. This function can be overrided if necessary.

◆ OnEndDocument()

virtual void wxSFPrintout::OnEndDocument ( )
virtual

Called by printing framework. Deinitialize the print job. This function can be overrided if necessary.

◆ OnPrintPage()

virtual bool wxSFPrintout::OnPrintPage ( int  page)
virtual

Called by printing framework. It does the print job. This function can be overrided if necessary.

◆ SetPrintedCanvas()

void wxSFPrintout::SetPrintedCanvas ( wxSFShapeCanvas canvas)
inline

Set shape canvas which content should be printed.

Parameters
canvasPointer to shape canvas

Member Data Documentation

◆ m_pCanvas

wxSFShapeCanvas* wxSFPrintout::m_pCanvas
protected

Pointer to parent shape canvas.


The documentation for this class was generated from the following file: