Class: Wx::RTC::RichTextPrintout

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

Overview

This class implements print layout for RichTextBuffer.

Instead of using it directly, you should normally use the RichTextPrinting class.

Category: Rich Text

Requires:

  • USE_PRINTING_ARCHITECTURE
  • USE_RICHTEXT

Instance Method Summary collapse

Constructor Details

#initialize(title = ("Wx::PRT::Printout")) ⇒ Wx::RTC::RichTextPrintout

Constructor.

Parameters:

  • title (String) (defaults to: ("Wx::PRT::Printout")) 


188
 
# File 'lib/wx/doc/gen/rtc/rich_text_printing.rb', line 188

def initialize(title=("Wx::PRT::Printout")) end

Instance Method Details

#calculate_scaling(dc, textRect, headerRect, footerRect) ⇒ void

This method returns an undefined value.

Calculates scaling and text, header and footer rectangles.

Parameters:



196
 
# File 'lib/wx/doc/gen/rtc/rich_text_printing.rb', line 196

def calculate_scaling(dc, textRect, headerRect, footerRect) end

#get_header_footer_data ⇒ Wx::RTC::RichTextHeaderFooterData Also known as: header_footer_data

Returns the header and footer data associated with the printout.

Returns:



200
 
# File 'lib/wx/doc/gen/rtc/rich_text_printing.rb', line 200

def get_header_footer_data; end

#get_page_info ⇒ Array(Integer,Integer,Integer,Integer) Also known as: page_info

Gets the page information.

Returns:

  • (Array(Integer,Integer,Integer,Integer)) 


205
 
# File 'lib/wx/doc/gen/rtc/rich_text_printing.rb', line 205

def get_page_info; end

#get_rich_text_buffer ⇒ Wx::RTC::RichTextBuffer Also known as: rich_text_buffer

Returns a pointer to the buffer being rendered.

Returns:



210
 
# File 'lib/wx/doc/gen/rtc/rich_text_printing.rb', line 210

def get_rich_text_buffer; end

#has_page(page) ⇒ Boolean Also known as: has_page?

Returns true if the given page exists in the printout.

Parameters:

  • page (Integer)

Returns:

  • (Boolean) 


216
 
# File 'lib/wx/doc/gen/rtc/rich_text_printing.rb', line 216

def has_page(page) end

#on_prepare_printing ⇒ void

This method returns an undefined value.

Prepares for printing, laying out the buffer and calculating pagination.



221
 
# File 'lib/wx/doc/gen/rtc/rich_text_printing.rb', line 221

def on_prepare_printing; end

#on_print_page(page) ⇒ Boolean

Does the actual printing for this page.

Parameters:

  • page (Integer)

Returns:

  • (Boolean) 


226
 
# File 'lib/wx/doc/gen/rtc/rich_text_printing.rb', line 226

def on_print_page(page) end

#set_header_footer_data(data) ⇒ void Also known as: header_footer_data=

This method returns an undefined value.

Sets the header and footer data associated with the printout.

Parameters:



231
 
# File 'lib/wx/doc/gen/rtc/rich_text_printing.rb', line 231

def set_header_footer_data(data) end

#set_margins(top = 254, bottom = 254, left = 254, right = 254) ⇒ void Also known as: margins=

This method returns an undefined value.

Sets margins in 10ths of millimetre.

Defaults to 1 inch for margins.

Parameters:

  • top (Integer) (defaults to: 254)
  • bottom (Integer) (defaults to: 254)
  • left (Integer) (defaults to: 254)
  • right (Integer) (defaults to: 254) 


242
 
# File 'lib/wx/doc/gen/rtc/rich_text_printing.rb', line 242

def set_margins(top=254, bottom=254, left=254, right=254) end

#set_rich_text_buffer(buffer) ⇒ void Also known as: rich_text_buffer=

This method returns an undefined value.

Sets the buffer to print.

Wx::RTC::RichTextPrintout does not manage this pointer; it should be managed by the calling code, such as Wx::RTC::RichTextPrinting.

Parameters:



250
 
# File 'lib/wx/doc/gen/rtc/rich_text_printing.rb', line 250

def set_rich_text_buffer(buffer) end