wx.richtext.RichTextHeaderFooterData

This class represents header and footer data to be passed to the wx.richtext.RichTextPrinting and wx.richtext.RichTextPrintout 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 wx.richtext.RichTextPrinting or RichTextLayout constructor.

Class Hierarchy

Inheritance diagram for class RichTextHeaderFooterData:

Methods Summary

__init__	Constructors.
Clear	Clears all text.
Copy	Copies the data.
GetFont	Returns the font specified for printing the header and footer.
GetFooterMargin	Returns the margin between the text and the footer.
GetFooterText	Returns the footer text on odd or even pages, and at a given position on the page (left, centre or right).
GetHeaderMargin	Returns the margin between the text and the header.
GetHeaderText	Returns the header text on odd or even pages, and at a given position on the page (left, centre or right).
GetShowOnFirstPage	Returns True if the header and footer will be shown on the first page.
GetText	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).
GetTextColour	Returns the text colour for drawing the header and footer.
Init	Initialises the object.
SetFont	Sets the font for drawing the header and footer.
SetFooterText	Sets the footer text on odd or even pages, and at a given position on the page (left, centre or right).
SetHeaderText	Sets the header text on odd or even pages, and at a given position on the page (left, centre or right).
SetMargins	Sets the margins between text and header or footer, in tenths of a millimeter.
SetShowOnFirstPage	Pass True to show the header or footer on first page (the default).
SetText	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).
SetTextColour	Sets the text colour for drawing the header and footer.

Properties Summary

Font	See GetFont and SetFont
FooterMargin	See GetFooterMargin
FooterText	See GetFooterText and SetFooterText
HeaderMargin	See GetHeaderMargin
HeaderText	See GetHeaderText and SetHeaderText
ShowOnFirstPage	See GetShowOnFirstPage and SetShowOnFirstPage
TextColour	See GetTextColour and SetTextColour

Class API

class wx.richtext.RichTextHeaderFooterData(Object)

Possible constructors:

RichTextHeaderFooterData() -> None

RichTextHeaderFooterData(data : RichTextHeaderFooterData) -> None

This class represents header and footer data to be passed to the RichTextPrinting and RichTextPrintout classes.

Methods

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self)

Constructors.

Return type:

None

---

__init__ (self, data : RichTextHeaderFooterData)

Parameters:

data (wx.richtext.RichTextHeaderFooterData)

Return type:

None

---

---

Clear(self)

Clears all text.

Return type:

None

---

Copy(self, data: RichTextHeaderFooterData)

Copies the data.

Parameters:

data (wx.richtext.RichTextHeaderFooterData)

Return type:

None

---

GetFont(self)

Returns the font specified for printing the header and footer.

Return type:

Font

---

GetFooterMargin(self)

Returns the margin between the text and the footer.

Return type:

int

---

GetFooterText(self, page: RichTextOddEvenPage = RICHTEXT_PAGE_EVEN, location: RichTextPageLocation = RICHTEXT_PAGE_CENTRE)

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

Parameters:

• page (RichTextOddEvenPage)

• location (RichTextPageLocation)

Return type:

str

---

GetHeaderMargin(self)

Returns the margin between the text and the header.

Return type:

int

---

GetHeaderText(self, page: RichTextOddEvenPage = RICHTEXT_PAGE_EVEN, location: RichTextPageLocation = RICHTEXT_PAGE_CENTRE)

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

Parameters:

• page (RichTextOddEvenPage)

• location (RichTextPageLocation)

Return type:

str

---

GetShowOnFirstPage(self)

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

Return type:

bool

---

GetText(self, headerFooter: int, page: RichTextOddEvenPage, location: RichTextPageLocation)

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).

Parameters:

• headerFooter (int)

• page (RichTextOddEvenPage)

• location (RichTextPageLocation)

Return type:

str

---

GetTextColour(self)

Returns the text colour for drawing the header and footer.

Return type:

Colour

---

Init(self)

Initialises the object.

Return type:

None

---

SetFont(self, font: Font)

Sets the font for drawing the header and footer.

Parameters:

font (wx.Font)

Return type:

None

---

SetFooterText(self, text: str, page: RichTextOddEvenPage = RICHTEXT_PAGE_ALL, location: RichTextPageLocation = RICHTEXT_PAGE_CENTRE)

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

Parameters:

• text (string)

• page (RichTextOddEvenPage)

• location (RichTextPageLocation)

Return type:

None

---

SetHeaderText(self, text: str, page: RichTextOddEvenPage = RICHTEXT_PAGE_ALL, location: RichTextPageLocation = RICHTEXT_PAGE_CENTRE)

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

Parameters:

• text (string)

• page (RichTextOddEvenPage)

• location (RichTextPageLocation)

Return type:

None

---

SetMargins(self, headerMargin: int, footerMargin: int)

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

Parameters:

• headerMargin (int)

• footerMargin (int)

Return type:

None

---

SetShowOnFirstPage(self, showOnFirstPage: bool)

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

Parameters:

showOnFirstPage (bool)

Return type:

None

---

SetText(self, text: str, headerFooter: int, page: RichTextOddEvenPage, location: RichTextPageLocation)

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).

Parameters:

• text (string)

• headerFooter (int)

• page (RichTextOddEvenPage)

• location (RichTextPageLocation)

Return type:

None

---

SetTextColour(self, col: Colour)

Sets the text colour for drawing the header and footer.

Parameters:

col (wx.Colour)

Return type:

None

Properties

Font

See GetFont and SetFont

---

FooterMargin

See GetFooterMargin

---

FooterText

See GetFooterText and SetFooterText

---

HeaderMargin

See GetHeaderMargin

---

HeaderText

See GetHeaderText and SetHeaderText

---

ShowOnFirstPage

See GetShowOnFirstPage and SetShowOnFirstPage

---

TextColour

See GetTextColour and SetTextColour