wxRuby Documentation Home

# Wx::PrintDialogData

This class holds information related to the visual characteristics of PrintDialog.
It contains a PrintData object with underlying printing settings.

## Derived from

Object

## See also

PrintDialog, PrintDialog Overview

## Methods

- PrintDialogData.new
- PrintDialogData#enable_help
- PrintDialogData#enable_page_numbers
- PrintDialogData#enable_print_to_file
- PrintDialogData#enable_selection
- PrintDialogData#get_all_pages
- PrintDialogData#get_collate
- PrintDialogData#get_from_page
- PrintDialogData#get_max_page
- PrintDialogData#get_min_page
- PrintDialogData#get_no_copies
- PrintDialogData#get_print_data
- PrintDialogData#get_print_to_file
- PrintDialogData#get_selection
- PrintDialogData#get_to_page
- PrintDialogData#ok
- PrintDialogData#set_collate
- PrintDialogData#set_from_page
- PrintDialogData#set_max_page
- PrintDialogData#set_min_page
- PrintDialogData#set_no_copies
- PrintDialogData#set_print_data
- PrintDialogData#set_print_to_file
- PrintDialogData#set_selection
- PrintDialogData#set_setup_dialog
- PrintDialogData#set_to_page

### PrintDialogData.new

PrintDialogData.new(%(arg-type)PrintDialogData% dialogData)

Copy constructor.

PrintDialogData.new(%(arg-type)PrintData% printData)

Construct an object from a print dialog data object.

destructor()

Destructor.

### PrintDialogData#enable_help

enable_help(%(arg-type)Boolean% flag)

Enables or disables the `Help’ button.

### PrintDialogData#enable_page_numbers

enable_page_numbers(%(arg-type)Boolean% flag)

Enables or disables the `Page numbers’ controls.

### PrintDialogData#enable_print_to_file

enable_print_to_file(%(arg-type)Boolean% flag)

Enables or disables the `Print to file’ checkbox.

### PrintDialogData#enable_selection

enable_selection(%(arg-type)Boolean% flag)

Enables or disables the `Selection’ radio button.

### PrintDialogData#get_all_pages

Boolean get_all_pages()

Returns true if the user requested that all pages be printed.

### PrintDialogData#get_collate

Boolean get_collate()

Returns true if the user requested that the document(s) be collated.

### PrintDialogData#get_from_page

Integer get_from_page()

Returns the from page number, as entered by the user.

### PrintDialogData#get_max_page

Integer get_max_page()

Returns the maximum page number.

### PrintDialogData#get_min_page

Integer get_min_page()

Returns the minimum page number.

### PrintDialogData#get_no_copies

Integer get_no_copies()

Returns the number of copies requested by the user.

### PrintDialogData#get_print_data

PrintData get_print_data()

Returns a reference to the internal PrintData object.

### PrintDialogData#get_print_to_file

Boolean get_print_to_file()

Returns true if the user has selected printing to a file.

### PrintDialogData#get_selection

Boolean get_selection()

Returns true if the user requested that the selection be printed (where ‘selection’ is
a concept specific to the application).

### PrintDialogData#get_to_page

Integer get_to_page()

Returns the to page number, as entered by the user.

### PrintDialogData#ok

Boolean ok()

Returns true if the print data is valid for using in print dialogs.
This can return false on Windows if the current printer is not set, for example.
On all other platforms, it returns true.

### PrintDialogData#set_collate

set_collate(%(arg-type)Boolean% flag)

Sets the ‘Collate’ checkbox to true or false.

### PrintDialogData#set_from_page

set_from_page(%(arg-type)Integer% page)

Sets the from page number.

### PrintDialogData#set_max_page

set_max_page(%(arg-type)Integer% page)

Sets the maximum page number.

### PrintDialogData#set_min_page

set_min_page(%(arg-type)Integer% page)

Sets the minimum page number.

### PrintDialogData#set_no_copies

set_no_copies(%(arg-type)Integer% n)

Sets the default number of copies the user has requested to be printed out.

### PrintDialogData#set_print_data

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

Sets the internal PrintData.

### PrintDialogData#set_print_to_file

set_print_to_file(%(arg-type)Boolean% flag)

Sets the ‘Print to file’ checkbox to true or false.

### PrintDialogData#set_selection

set_selection(%(arg-type)Boolean% flag)

Selects the ‘Selection’ radio button. The effect of printing the selection depends on how the application
implements this command, if at all.

### PrintDialogData#set_setup_dialog

set_setup_dialog(%(arg-type)Boolean% flag)

Determines whether the dialog to be shown will be the Print dialog
(pass false) or Print Setup dialog (pass true).

This function has been deprecated since version 2.5.4.

### PrintDialogData#set_to_page

set_to_page(%(arg-type)Integer% page)

Sets the to page number.

### PrintDialogData#=

operator $=$(%(arg-type)PrintData% data)

Assigns print data to this object.

operator $=$(%(arg-type)PrintDialogData% data)

Assigns another print dialog data object to this object.

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