wxRuby Documentation Home

# Wx::RichTextPrinting

This class provides a simple interface for performing RichTextBuffer printing
and previewing. It uses RichTextPrintout for layout and rendering.

## Derived from

Object

## Data structures

## Methods

- RichTextPrinting.new
- RichTextPrinting#get_footer_text
- RichTextPrinting#get_header_footer_data
- RichTextPrinting#get_header_text
- RichTextPrinting#get_page_setup_data
- RichTextPrinting#get_parent_window
- RichTextPrinting#get_preview_rect
- RichTextPrinting#get_print_data
- RichTextPrinting#get_title
- RichTextPrinting#page_setup
- RichTextPrinting#preview_buffer
- RichTextPrinting#preview_file
- RichTextPrinting#print_buffer
- RichTextPrinting#print_file
- RichTextPrinting#set_footer_text
- RichTextPrinting#set_header_footer_data
- RichTextPrinting#set_header_footer_font
- RichTextPrinting#set_header_footer_text_colour
- RichTextPrinting#set_header_text
- RichTextPrinting#set_page_setup_data
- RichTextPrinting#set_parent_window
- RichTextPrinting#set_preview_rect
- RichTextPrinting#set_print_data
- RichTextPrinting#set_show_on_first_page
- RichTextPrinting#set_title

### RichTextPrinting.new

RichTextPrinting.new(%(arg-type)String% name = T(“Printing”), Window parentWindow = nil)

Constructor. Optionally pass a title to be used in the preview frame and printing wait dialog, and
also a parent window for these windows.

### RichTextPrinting#get_footer_text

String get_footer_text(%(arg-type)RichTextOddEvenPage% page = RICHTEXT_PAGE_EVEN, RichTextPageLocation location = RICHTEXT_PAGE_CENTRE)

A convenience function to get the footer text. See RichTextHeaderFooterData for details.

### RichTextPrinting#get_header_footer_data

RichTextHeaderFooterData get_header_footer_data()

Returns the internal RichTextHeaderFooterData object.

### RichTextPrinting#get_header_text

String get_header_text(%(arg-type)RichTextOddEvenPage% page = RICHTEXT_PAGE_EVEN, RichTextPageLocation location = RICHTEXT_PAGE_CENTRE)

A convenience function to get the header text. See RichTextHeaderFooterData for details.

### RichTextPrinting#get_page_setup_data

PageSetupDialogData get_page_setup_data()

Returns a pointer to the internal page setup data.

### RichTextPrinting#get_parent_window

Window get_parent_window()

Returns the parent window to be used for the preview window and printing wait dialog.

### RichTextPrinting#get_preview_rect

Rect get_preview_rect()

Returns the dimensions to be used for the preview window.

### RichTextPrinting#get_print_data

PrintData get_print_data()

Returns a pointer to the internal print data.

### RichTextPrinting#get_title

String get_title()

Returns the title of the preview window or printing wait caption.

### RichTextPrinting#page_setup

page_setup()

Shows the page setup dialog.

### RichTextPrinting#preview_buffer

Boolean preview_buffer(%(arg-type)RichTextBuffer% buffer)

Shows a preview window for the given buffer. The function takes its own copy of buffer.

### RichTextPrinting#preview_file

Boolean preview_file(%(arg-type)String% richTextFile)

Shows a preview window for the given file. richTextFile can be a text file or XML file, or other file
depending on the available file handlers.

### RichTextPrinting#print_buffer

Boolean print_buffer(%(arg-type)RichTextBuffer% buffer)

Prints the given buffer. The function takes its own copy of buffer.

### RichTextPrinting#print_file

Boolean print_file(%(arg-type)String% richTextFile)

Prints the given file. richTextFile can be a text file or XML file, or other file
depending on the available file handlers.

### RichTextPrinting#set_footer_text

set_footer_text(%(arg-type)String% text, RichTextOddEvenPage page = RICHTEXT_PAGE_ALL, RichTextPageLocation location = RICHTEXT_PAGE_CENTRE)

A convenience function to set the footer text. See RichTextHeaderFooterData for details.

### RichTextPrinting#set_header_footer_data

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

Sets the internal RichTextHeaderFooterData object.

### RichTextPrinting#set_header_footer_font

set_header_footer_font(%(arg-type)Font% font)

Sets the RichTextHeaderFooterData font.

### RichTextPrinting#set_header_footer_text_colour

set_header_footer_text_colour(%(arg-type)Colour% colour)

Sets the RichTextHeaderFooterData text colour.

### RichTextPrinting#set_header_text

set_header_text(%(arg-type)String% text, RichTextOddEvenPage page = RICHTEXT_PAGE_ALL, RichTextPageLocation location = RICHTEXT_PAGE_CENTRE)

A convenience function to set the header text. See RichTextHeaderFooterData for details.

### RichTextPrinting#set_page_setup_data

set_page_setup_data(%(arg-type)PageSetupData% pageSetupData)

Sets the page setup data.

### RichTextPrinting#set_parent_window

set_parent_window(%(arg-type)Window% parent)

Sets the parent window to be used for the preview window and printing wait dialog.

### RichTextPrinting#set_preview_rect

set_preview_rect(%(arg-type)Rect% rect)

Sets the dimensions to be used for the preview window.

### RichTextPrinting#set_print_data

set_print_data(%(arg-type)PrintData% printData)

Sets the print data.

### RichTextPrinting#set_show_on_first_page

set_show_on_first_page(%(arg-type)Boolean% show)

Pass to show the header and footer on the first page.

### RichTextPrinting#set_title

set_title(%(arg-type)String% title)

Pass the title of the preview window or printing wait caption.

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