wxRuby Documentation Home

# Wx::RichTextPrintout

This class implements print layout for RichTextBuffer. Instead of using it directly, you
should normally use the RichTextPrinting class.

## Derived from

Printout

## Data structures

## Methods

- RichTextPrintout.new
- RichTextPrintout#calculate_scaling
- RichTextPrintout#get_header_footer_data
- RichTextPrintout#get_page_info
- RichTextPrintout#get_rich_text_buffer
- RichTextPrintout#has_page
- RichTextPrintout#on_prepare_printing
- RichTextPrintout#on_print_page
- RichTextPrintout#set_header_footer_data
- RichTextPrintout#set_margins
- RichTextPrintout#set_rich_text_buffer

### RichTextPrintout.new

RichTextPrintout.new(%(arg-type)String% title = T(“Printout”))

Constructor.

### RichTextPrintout#calculate_scaling

calculate_scaling(%(arg-type)DC% dc, Rect textRect, Rect headerRect, Rect footerRect)

Calculates scaling and text, header and footer rectangles.

### RichTextPrintout#get_header_footer_data

RichTextHeaderFooterData get_header_footer_data()

Returns the header and footer data associated with the printout.

### RichTextPrintout#get_page_info

get_page_info(%(arg-type)Integer% minPage, Integer maxPage, Integer selPageFrom, Integer selPageTo)

Gets the page information.

### RichTextPrintout#get_rich_text_buffer

RichTextBuffer get_rich_text_buffer()

Returns a pointer to the buffer being rendered.

### RichTextPrintout#has_page

Boolean has_page(%(arg-type)Integer% page)

Returns if the given page exists in the printout.

### RichTextPrintout#on_prepare_printing

on_prepare_printing()

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

### RichTextPrintout#on_print_page

Boolean on_print_page(%(arg-type)Integer% page)

Does the actual printing for this page.

### RichTextPrintout#set_header_footer_data

set_header_footer_data(%(arg-type)RichTextHeaderFooterData% data)

Sets the header and footer data associated with the printout.

### RichTextPrintout#set_margins

set_margins(%(arg-type)Integer% top = 252, Integer bottom = 252, Integer left = 252, Integer right = 252)

Sets margins in 10ths of millimetre. Defaults to 1 inch for margins.

### RichTextPrintout#set_rich_text_buffer

set_rich_text_buffer(%(arg-type)RichTextBuffer% buffer)

Sets the buffer to print. RichTextPrintout does not manage this pointer; it should
be managed by the calling code, such as RichTextPrinting.

[This page automatically generated from the Textile source at 2023-06-09 00:45:27 +0000]