wxRichTextPrinting Class Reference
[Rich Text]

#include <wx/richtext/richtextprint.h>

Inheritance diagram for wxRichTextPrinting:

List of all members.

---

Detailed Description

This class provides a simple interface for performing wxRichTextBuffer printing and previewing. It uses wxRichTextPrintout for layout and rendering.

Library:  wxRichText

Category:  Rich Text

Public Member Functions
	wxRichTextPrinting (const wxString &name=wxT("Printing"), wxWindow *parentWindow=NULL)
wxString	GetFooterText (wxRichTextOddEvenPage page=wxRICHTEXT_PAGE_EVEN, wxRichTextPageLocation location=wxRICHTEXT_PAGE_CENTRE) const
const wxRichTextHeaderFooterData &	GetHeaderFooterData () const
wxString	GetHeaderText (wxRichTextOddEvenPage page=wxRICHTEXT_PAGE_EVEN, wxRichTextPageLocation location=wxRICHTEXT_PAGE_CENTRE) const
wxPageSetupDialogData *	GetPageSetupData ()
wxWindow *	GetParentWindow () const
const wxRect &	GetPreviewRect () const
wxPrintData *	GetPrintData ()
const wxString &	GetTitle () const
void	PageSetup ()
bool	PreviewBuffer (const wxRichTextBuffer &buffer)
bool	PreviewFile (const wxString &richTextFile)
bool	PrintBuffer (const wxRichTextBuffer &buffer)
bool	PrintFile (const wxString &richTextFile)
void	SetFooterText (const wxString &text, wxRichTextOddEvenPage page=wxRICHTEXT_PAGE_ALL, wxRichTextPageLocation location=wxRICHTEXT_PAGE_CENTRE)
void	SetHeaderFooterData (const wxRichTextHeaderFooterData &data)
void	SetHeaderFooterFont (const wxFont &font)
void	SetHeaderFooterTextColour (const wxColour &colour)
void	SetHeaderText (const wxString &text, wxRichTextOddEvenPage page=wxRICHTEXT_PAGE_ALL, wxRichTextPageLocation location=wxRICHTEXT_PAGE_CENTRE)
void	SetPageSetupData (const wxPageSetupDialogData &pageSetupData)
void	SetParentWindow (wxWindow *parent)
void	SetPreviewRect (const wxRect &rect)
void	SetPrintData (const wxPrintData &printData)
void	SetShowOnFirstPage (bool show)
void	SetTitle (const wxString &title)

---

Constructor & Destructor Documentation

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.

---

Member Function Documentation

wxString wxRichTextPrinting::GetFooterText	(	wxRichTextOddEvenPage	page = wxRICHTEXT_PAGE_EVEN,
		wxRichTextPageLocation	location = wxRICHTEXT_PAGE_CENTRE
	)			const

A convenience function to get the footer text. See wxRichTextHeaderFooterData for details.

const wxRichTextHeaderFooterData& wxRichTextPrinting::GetHeaderFooterData

(

)

const

Returns the internal wxRichTextHeaderFooterData object.

wxString wxRichTextPrinting::GetHeaderText	(	wxRichTextOddEvenPage	page = wxRICHTEXT_PAGE_EVEN,
		wxRichTextPageLocation	location = wxRICHTEXT_PAGE_CENTRE
	)			const

A convenience function to get the header text. See wxRichTextHeaderFooterData for details.

wxPageSetupDialogData* wxRichTextPrinting::GetPageSetupData

(

)

Returns a pointer to the internal page setup data.

wxWindow* wxRichTextPrinting::GetParentWindow

(

)

const

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

const wxRect& wxRichTextPrinting::GetPreviewRect

(

)

const

Returns the dimensions to be used for the preview window.

wxPrintData* wxRichTextPrinting::GetPrintData

(

)

Returns a pointer to the internal print data.

const wxString& wxRichTextPrinting::GetTitle

(

)

const

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

void wxRichTextPrinting::PageSetup

(

)

Shows the page setup dialog.

bool wxRichTextPrinting::PreviewBuffer

(

const wxRichTextBuffer &

buffer

)

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

bool wxRichTextPrinting::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.

bool wxRichTextPrinting::PrintBuffer

(

const wxRichTextBuffer &

buffer

)

Prints the given buffer. The function takes its own copy of buffer.

bool wxRichTextPrinting::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.

void wxRichTextPrinting::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.

void wxRichTextPrinting::SetHeaderFooterData

(

const wxRichTextHeaderFooterData &

data

)

Sets the internal wxRichTextHeaderFooterData object.

void wxRichTextPrinting::SetHeaderFooterFont

(

const wxFont &

font

)

Sets the wxRichTextHeaderFooterData font.

void wxRichTextPrinting::SetHeaderFooterTextColour

(

const wxColour &

colour

)

Sets the wxRichTextHeaderFooterData text colour.

void wxRichTextPrinting::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.

void wxRichTextPrinting::SetPageSetupData

(

const wxPageSetupDialogData &

pageSetupData

)

Sets the page setup data.

void wxRichTextPrinting::SetParentWindow

(

wxWindow *

parent

)

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

void wxRichTextPrinting::SetPreviewRect

(

const wxRect &

rect

)

Sets the dimensions to be used for the preview window.

void wxRichTextPrinting::SetPrintData

(

const wxPrintData &

printData

)

Sets the print data.

void wxRichTextPrinting::SetShowOnFirstPage

(

bool

show

)

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

void wxRichTextPrinting::SetTitle

(

const wxString &

title

)

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