wxrichtextprinting

this class provides a simple interface for performing wxrichtextbuffer printing and previewing. it uses wxrichtextprintout for layout and rendering. derived from

wxobject

include files

data structures

members

wxrichtextprinting::wxrichtextprinting

wxrichtextprinting(const wxstring& name = wxt("printing"), wxwindow* parentwindow = null)

constructor. optionally pass a title to be used in the preview frame and printing wait dialog, and also a parent window for these windows.

wxrichtextprinting::getfootertext

wxstring getfootertext(wxrichtextoddevenpage page = wxrichtext_page_even, wxrichtextpagelocation location = wxrichtext_page_centre) const

a convenience function to get the footer text. see wxrichtextheaderfooterdata for details.

wxrichtextprinting::getheaderfooterdata

const wxrichtextheaderfooterdata& getheaderfooterdata() const

returns the internal wxrichtextheaderfooterdata object.

wxrichtextprinting::getheadertext

wxstring getheadertext(wxrichtextoddevenpage page = wxrichtext_page_even, wxrichtextpagelocation location = wxrichtext_page_centre) const

a convenience function to get the header text. see wxrichtextheaderfooterdata for details.

wxrichtextprinting::getpagesetupdata

wxpagesetupdialogdata* getpagesetupdata()

returns a pointer to the internal page setup data.

wxrichtextprinting::getparentwindow

wxwindow* getparentwindow() const

returns the parent window to be used for the preview window and printing wait dialog.

wxrichtextprinting::getpreviewrect

const wxrect& getpreviewrect() const

returns the dimensions to be used for the preview window.

wxrichtextprinting::getprintdata

wxprintdata* getprintdata()

returns a pointer to the internal print data.

wxrichtextprinting::gettitle

const wxstring& gettitle() const

returns the title of the preview window or printing wait caption.

wxrichtextprinting::pagesetup

void pagesetup()

shows the page setup dialog.

wxrichtextprinting::previewbuffer

bool previewbuffer(const wxrichtextbuffer& buffer)

shows a preview window for the given buffer. the function takes its own copy of buffer.

wxrichtextprinting::previewfile

bool previewfile(const wxstring& richtextfile)

shows a preview window for the given file. richtextfile can be a text file or xml file, or other file depending on the available file handlers.

wxrichtextprinting::printbuffer

bool printbuffer(const wxrichtextbuffer& buffer)

prints the given buffer. the function takes its own copy of buffer.

wxrichtextprinting::printfile

bool printfile(const wxstring& richtextfile)

prints the given file. richtextfile can be a text file or xml file, or other file depending on the available file handlers.

wxrichtextprinting::setfootertext

void setfootertext(const wxstring& text, wxrichtextoddevenpage page = wxrichtext_page_all, wxrichtextpagelocation location = wxrichtext_page_centre)

a convenience function to set the footer text. see wxrichtextheaderfooterdata for details.

wxrichtextprinting::setheaderfooterdata

void setheaderfooterdata(const wxrichtextheaderfooterdata& data)

sets the internal wxrichtextheaderfooterdata object.

wxrichtextprinting::setheaderfooterfont

void setheaderfooterfont(const wxfont& font)

sets the wxrichtextheaderfooterdata font.

wxrichtextprinting::setheaderfootertextcolour

void setheaderfootertextcolour(const wxcolour& colour)

sets the wxrichtextheaderfooterdata text colour.

wxrichtextprinting::setheadertext

void setheadertext(const wxstring& text, wxrichtextoddevenpage page = wxrichtext_page_all, wxrichtextpagelocation location = wxrichtext_page_centre)

a convenience function to set the header text. see wxrichtextheaderfooterdata for details.

wxrichtextprinting::setpagesetupdata

void setpagesetupdata(const wxpagesetupdata& pagesetupdata)

sets the page setup data.

wxrichtextprinting::setparentwindow

void setparentwindow(wxwindow* parent)

sets the parent window to be used for the preview window and printing wait dialog.

wxrichtextprinting::setpreviewrect

void setpreviewrect(const wxrect& rect)

sets the dimensions to be used for the preview window.

wxrichtextprinting::setprintdata

void setprintdata(const wxprintdata& printdata)

sets the print data.

wxrichtextprinting::setshowonfirstpage

void setshowonfirstpage(bool show)

pass true to show the header and footer on the first page.

wxrichtextprinting::settitle

void settitle(const wxstring& title)

pass the title of the preview window or printing wait caption.