#include <wx/richtext/richtextprint.h>

Inheritance diagram for wxRichTextHeaderFooterData:

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 ()
	Clears all text.

void	Copy (const wxRichTextHeaderFooterData &data)
	Copies the data.

const wxFont &	GetFont () const
	Returns the font specified for printing the header and footer.

int	GetFooterMargin () const
	Returns the margin between the text and the footer.

wxString	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	GetHeaderMargin () const
	Returns the margin between the text and the header.

wxString	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	GetShowOnFirstPage () const
	Returns true if the header and footer will be shown on the first page.

wxString	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 &	GetTextColour () const
	Returns the text colour for drawing the header and footer.

void	Init ()
	Initialises the object.

void	SetFont (const wxFont &font)
	Sets the font for drawing the header and footer.

void	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	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	SetMargins (int headerMargin, int footerMargin)
	Sets the margins between text and header or footer, in tenths of a millimeter.

void	SetShowOnFirstPage (bool showOnFirstPage)
	Pass true to show the header or footer on first page (the default).

void	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	SetTextColour (const wxColour &col)
	Sets the text colour for drawing the header and footer.

void	operator operator= (const wxRichTextHeaderFooterData &data)
	Assignment operator.


	wxRichTextHeaderFooterData ()
	Constructors.

	wxRichTextHeaderFooterData (const wxRichTextHeaderFooterData &data)
	Constructors.

Public Member Functions inherited from wxObject
	wxObject ()
	Default ctor; initializes to NULL the internal reference data.

	wxObject (const wxObject &other)
	Copy ctor.

virtual	~wxObject ()
	Destructor.

virtual wxClassInfo *	GetClassInfo () const
	This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).

wxObjectRefData *	GetRefData () const
	Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.

bool	IsKindOf (const wxClassInfo *info) const
	Determines whether this class is a subclass of (or the same class as) the given class.

bool	IsSameAs (const wxObject &obj) const
	Returns true if this object has the same data pointer as obj.

void	Ref (const wxObject &clone)
	Makes this object refer to the data in clone.

void	SetRefData (wxObjectRefData *data)
	Sets the wxObject::m_refData pointer.

void	UnRef ()
	Decrements the reference count in the associated data, and if it is zero, deletes the data.

void	UnShare ()
	This is the same of AllocExclusive() but this method is public.

void	operator delete (void *buf)
	The delete operator is defined for debugging versions of the library only, when the identifier `WXDEBUG` is defined.

void *	operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
	The new operator is defined for debugging versions of the library only, when the identifier `WXDEBUG` is defined.

Additional Inherited Members
Protected Member Functions inherited from wxObject
void	AllocExclusive ()
	Ensure that this object's data is not shared with any other object.

virtual wxObjectRefData *	CreateRefData () const
	Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it.

virtual wxObjectRefData *	CloneRefData (const wxObjectRefData *data) const
	Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data.

Protected Attributes inherited from wxObject
wxObjectRefData *	m_refData
	Pointer to an object which is the object's reference-counted 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::operator operator= ( const wxRichTextHeaderFooterData & data )

Assignment operator.

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.

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation