wxRichTextHeaderFooterData Class Reference
[Rich Text]

#include <wx/richtext/richtextprint.h>

Inheritance diagram for wxRichTextHeaderFooterData:

List of all members.

---

Detailed Description

This class represents header and footer data to be passed to the wxRichTextPrinting and wxRichTextPrintout classes.

Headers and footers can be specified independently for odd, even or both page sides. Different text can be specified for left, centre and right locations on the page, and the font and text colour can also be specified.

You can specify the following keywords in header and footer text, which will be substituted for the actual values during printing and preview.

• @DATE@: the current date.
• @PAGESCNT@: the total number of pages.
• @PAGENUM@: the current page number.
• @TIME@: the current time.
• @TITLE@: the title of the document, as passed to the wxRichTextPrinting or wxRichTextLayout constructor.

Library:  wxRichText

Category:  Rich Text

Public Member Functions
void	Clear ()
void	Copy (const wxRichTextHeaderFooterData &data)
const wxFont &	GetFont () const
int	GetFooterMargin () const
wxString	GetFooterText (wxRichTextOddEvenPage page=wxRICHTEXT_PAGE_EVEN, wxRichTextPageLocation location=wxRICHTEXT_PAGE_CENTRE) const
int	GetHeaderMargin () const
wxString	GetHeaderText (wxRichTextOddEvenPage page=wxRICHTEXT_PAGE_EVEN, wxRichTextPageLocation location=wxRICHTEXT_PAGE_CENTRE) const
bool	GetShowOnFirstPage () const
wxString	GetText (int headerFooter, wxRichTextOddEvenPage page, wxRichTextPageLocation location) const
const wxColour &	GetTextColour () const
void	Init ()
void	SetFont (const wxFont &font)
void	SetFooterText (const wxString &text, wxRichTextOddEvenPage page=wxRICHTEXT_PAGE_ALL, wxRichTextPageLocation location=wxRICHTEXT_PAGE_CENTRE)
void	SetHeaderText (const wxString &text, wxRichTextOddEvenPage page=wxRICHTEXT_PAGE_ALL, wxRichTextPageLocation location=wxRICHTEXT_PAGE_CENTRE)
void	SetMargins (int headerMargin, int footerMargin)
void	SetShowOnFirstPage (bool showOnFirstPage)
void	SetText (const wxString &text, int headerFooter, wxRichTextOddEvenPage page, wxRichTextPageLocation location)
void	SetTextColour (const wxColour &col)
void	operator operator= (const wxRichTextHeaderFooterData &data)
	wxRichTextHeaderFooterData ()
	wxRichTextHeaderFooterData (const wxRichTextHeaderFooterData &data)

---

Constructor & Destructor Documentation

wxRichTextHeaderFooterData::wxRichTextHeaderFooterData

(

)

Constructors.

wxRichTextHeaderFooterData::wxRichTextHeaderFooterData

(

const wxRichTextHeaderFooterData &

data

)

Constructors.

---

Member Function Documentation

void wxRichTextHeaderFooterData::Clear

(

)

Clears all text.

void wxRichTextHeaderFooterData::Copy

(

const wxRichTextHeaderFooterData &

data

)

Copies the data.

const wxFont& wxRichTextHeaderFooterData::GetFont

(

)

const

Returns the font specified for printing the header and footer.

int wxRichTextHeaderFooterData::GetFooterMargin

(

)

const

Returns the margin between the text and the footer.

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

Returns the footer text on odd or even pages, and at a given position on the page (left, centre or right).

int wxRichTextHeaderFooterData::GetHeaderMargin

(

)

const

Returns the margin between the text and the header.

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

Returns the header text on odd or even pages, and at a given position on the page (left, centre or right).

bool wxRichTextHeaderFooterData::GetShowOnFirstPage

(

)

const

Returns true if the header and footer will be shown on the first page.

wxString wxRichTextHeaderFooterData::GetText	(	int	headerFooter,
		wxRichTextOddEvenPage	page,
		wxRichTextPageLocation	location
	)			const

Helper function for getting the header or footer text, odd or even pages, and at a given position on the page (left, centre or right).

const wxColour& wxRichTextHeaderFooterData::GetTextColour

(

)

const

Returns the text colour for drawing the header and footer.

void wxRichTextHeaderFooterData::Init

(

)

Initialises the object.

void wxRichTextHeaderFooterData::SetFont

(

const wxFont &

font

)

Sets the font for drawing the header and footer.

void wxRichTextHeaderFooterData::SetFooterText	(	const wxString &	text,
		wxRichTextOddEvenPage	page = wxRICHTEXT_PAGE_ALL,
		wxRichTextPageLocation	location = wxRICHTEXT_PAGE_CENTRE
	)

Sets the footer text on odd or even pages, and at a given position on the page (left, centre or right).

void wxRichTextHeaderFooterData::SetHeaderText	(	const wxString &	text,
		wxRichTextOddEvenPage	page = wxRICHTEXT_PAGE_ALL,
		wxRichTextPageLocation	location = wxRICHTEXT_PAGE_CENTRE
	)

Sets the header text on odd or even pages, and at a given position on the page (left, centre or right).

void wxRichTextHeaderFooterData::SetMargins	(	int	headerMargin,
		int	footerMargin
	)

Sets the margins between text and header or footer, in tenths of a millimeter.

void wxRichTextHeaderFooterData::SetShowOnFirstPage

(

bool

showOnFirstPage

)

Pass true to show the header or footer on first page (the default).

void wxRichTextHeaderFooterData::SetText	(	const wxString &	text,
		int	headerFooter,
		wxRichTextOddEvenPage	page,
		wxRichTextPageLocation	location
	)

Helper function for setting the header or footer text, odd or even pages, and at a given position on the page (left, centre or right).

void wxRichTextHeaderFooterData::SetTextColour

(

const wxColour &

col

)

Sets the text colour for drawing the header and footer.

void wxRichTextHeaderFooterData::operator operator=

(

const wxRichTextHeaderFooterData &

data

)

Assignment operator.