Class: Wx::RTC::RichTextHeaderFooterData

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

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

Category: Rich Text

Requires:

  • USE_PRINTING_ARCHITECTURE
  • USE_RICHTEXT

Instance Method Summary collapse

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::RTC::RichTextHeaderFooterData #initialize(data) ⇒ Wx::RTC::RichTextHeaderFooterData

Returns a new instance of RichTextHeaderFooterData.

Overloads:



77
 
# File 'lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb', line 77

def initialize(*args) end

Instance Method Details

#clear ⇒ void

This method returns an undefined value.

Clears all text.



81
 
# File 'lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb', line 81

def clear; end

#copy(data) ⇒ void

This method returns an undefined value.

Copies the data.

Parameters:



86
 
# File 'lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb', line 86

def copy(data) end

#get_font ⇒ Wx::Font, Wx::FontInfo Also known as: font

Returns the font specified for printing the header and footer.

Returns:



90
 
# File 'lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb', line 90

def get_font; end

#get_footer_margin ⇒ Integer Also known as: footer_margin

Returns the margin between the text and the footer.

Returns:

  • (Integer) 


95
 
# File 'lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb', line 95

def get_footer_margin; end

#get_footer_text(page = Wx::RTC::RichTextOddEvenPage::RICHTEXT_PAGE_EVEN, location = Wx::RTC::RichTextPageLocation::RICHTEXT_PAGE_CENTRE) ⇒ String Also known as: footer_text

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

Parameters:

  • page (Wx::RichTextOddEvenPage) (defaults to: Wx::RTC::RichTextOddEvenPage::RICHTEXT_PAGE_EVEN)
  • location (Wx::RichTextPageLocation) (defaults to: Wx::RTC::RichTextPageLocation::RICHTEXT_PAGE_CENTRE)

Returns:

  • (String) 


102
 
# File 'lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb', line 102

def get_footer_text(page=Wx::RTC::RichTextOddEvenPage::RICHTEXT_PAGE_EVEN, location=Wx::RTC::RichTextPageLocation::RICHTEXT_PAGE_CENTRE) end

#get_header_margin ⇒ Integer Also known as: header_margin

Returns the margin between the text and the header.

Returns:

  • (Integer) 


107
 
# File 'lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb', line 107

def get_header_margin; end

#get_header_text(page = Wx::RTC::RichTextOddEvenPage::RICHTEXT_PAGE_EVEN, location = Wx::RTC::RichTextPageLocation::RICHTEXT_PAGE_CENTRE) ⇒ String Also known as: header_text

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

Parameters:

  • page (Wx::RichTextOddEvenPage) (defaults to: Wx::RTC::RichTextOddEvenPage::RICHTEXT_PAGE_EVEN)
  • location (Wx::RichTextPageLocation) (defaults to: Wx::RTC::RichTextPageLocation::RICHTEXT_PAGE_CENTRE)

Returns:

  • (String) 


114
 
# File 'lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb', line 114

def get_header_text(page=Wx::RTC::RichTextOddEvenPage::RICHTEXT_PAGE_EVEN, location=Wx::RTC::RichTextPageLocation::RICHTEXT_PAGE_CENTRE) end

#get_show_on_first_page ⇒ Boolean Also known as: show_on_first_page

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

Returns:

  • (Boolean) 


119
 
# File 'lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb', line 119

def get_show_on_first_page; end

#get_text(headerFooter, page, location) ⇒ String Also known as: text

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 (Integer)
  • page (Wx::RichTextOddEvenPage)
  • location (Wx::RichTextPageLocation)

Returns:

  • (String) 


127
 
# File 'lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb', line 127

def get_text(headerFooter, page, location) end

#get_text_colour ⇒ Wx::Colour, ... Also known as: text_colour

Returns the text colour for drawing the header and footer.

Returns:



132
 
# File 'lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb', line 132

def get_text_colour; end

#init ⇒ void

This method returns an undefined value.

Initialises the object.



137
 
# File 'lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb', line 137

def init; end

#set_font(font) ⇒ void Also known as: font=

This method returns an undefined value.

Sets the font for drawing the header and footer.

Parameters:



142
 
# File 'lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb', line 142

def set_font(font) end

#set_footer_text(text, page = Wx::RTC::RichTextOddEvenPage::RICHTEXT_PAGE_ALL, location = Wx::RTC::RichTextPageLocation::RICHTEXT_PAGE_CENTRE) ⇒ void Also known as: footer_text=

This method returns an undefined value.

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 (Wx::RichTextOddEvenPage) (defaults to: Wx::RTC::RichTextOddEvenPage::RICHTEXT_PAGE_ALL)
  • location (Wx::RichTextPageLocation) (defaults to: Wx::RTC::RichTextPageLocation::RICHTEXT_PAGE_CENTRE) 


150
 
# File 'lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb', line 150

def set_footer_text(text, page=Wx::RTC::RichTextOddEvenPage::RICHTEXT_PAGE_ALL, location=Wx::RTC::RichTextPageLocation::RICHTEXT_PAGE_CENTRE) end

#set_header_text(text, page = Wx::RTC::RichTextOddEvenPage::RICHTEXT_PAGE_ALL, location = Wx::RTC::RichTextPageLocation::RICHTEXT_PAGE_CENTRE) ⇒ void Also known as: header_text=

This method returns an undefined value.

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 (Wx::RichTextOddEvenPage) (defaults to: Wx::RTC::RichTextOddEvenPage::RICHTEXT_PAGE_ALL)
  • location (Wx::RichTextPageLocation) (defaults to: Wx::RTC::RichTextPageLocation::RICHTEXT_PAGE_CENTRE) 


158
 
# File 'lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb', line 158

def set_header_text(text, page=Wx::RTC::RichTextOddEvenPage::RICHTEXT_PAGE_ALL, location=Wx::RTC::RichTextPageLocation::RICHTEXT_PAGE_CENTRE) end

#set_margins(headerMargin, footerMargin) ⇒ void

This method returns an undefined value.

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

Parameters:

  • headerMargin (Integer)
  • footerMargin (Integer) 


165
 
# File 'lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb', line 165

def set_margins(headerMargin, footerMargin) end

#set_show_on_first_page(showOnFirstPage) ⇒ void Also known as: show_on_first_page=

This method returns an undefined value.

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

Parameters:

  • showOnFirstPage (Boolean) 


170
 
# File 'lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb', line 170

def set_show_on_first_page(showOnFirstPage) end

#set_text(text, headerFooter, page, location) ⇒ void

This method returns an undefined value.

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 (Integer)
  • page (Wx::RichTextOddEvenPage)
  • location (Wx::RichTextPageLocation) 


179
 
# File 'lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb', line 179

def set_text(text, headerFooter, page, location) end

#set_text_colour(col) ⇒ void Also known as: text_colour=

This method returns an undefined value.

Sets the text colour for drawing the header and footer.

Parameters:



184
 
# File 'lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb', line 184

def set_text_colour(col) end