wxRuby Documentation Home

# Wx::PageSetupDialogData

This class holds a variety of information related to PageSetupDialog.

It contains a PrintData member which is used to hold basic printer configuration data (as opposed to the
user-interface configuration settings stored by PageSetupDialogData).

## Derived from

Object

## See also

PageSetupDialog

## Methods

- PageSetupDialogData.new
- PageSetupDialogData#enable_help
- PageSetupDialogData#enable_margins
- PageSetupDialogData#enable_orientation
- PageSetupDialogData#enable_paper
- PageSetupDialogData#enable_printer
- PageSetupDialogData#get_default_min_margins
- PageSetupDialogData#get_enable_margins
- PageSetupDialogData#get_enable_orientation
- PageSetupDialogData#get_enable_paper
- PageSetupDialogData#get_enable_printer
- PageSetupDialogData#get_enable_help
- PageSetupDialogData#get_default_info
- PageSetupDialogData#get_margin_top_left
- PageSetupDialogData#get_margin_bottom_right
- PageSetupDialogData#get_min_margin_top_left
- PageSetupDialogData#get_min_margin_bottom_right
- PageSetupDialogData#get_paper_id
- PageSetupDialogData#get_paper_size
- PageSetupDialogData#get_print_data
- PageSetupDialogData#ok
- PageSetupDialogData#set_default_info
- PageSetupDialogData#set_default_min_margins
- PageSetupDialogData#set_margin_top_left
- PageSetupDialogData#set_margin_bottom_right
- PageSetupDialogData#set_min_margin_top_left
- PageSetupDialogData#set_min_margin_bottom_right
- PageSetupDialogData#set_paper_id
- PageSetupDialogData#set_paper_size
- PageSetupDialogData#set_print_data

### PageSetupDialogData.new

PageSetupDialogData.new(%(arg-type)PageSetupDialogData% data)

Copy constructor.

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

Construct an object from a print data object.

destructor()

Destructor.

### PageSetupDialogData#enable_help

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

Enables or disables the `Help’ button (Windows only).

### PageSetupDialogData#enable_margins

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

Enables or disables the margin controls (Windows only).

### PageSetupDialogData#enable_orientation

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

Enables or disables the orientation control (Windows only).

### PageSetupDialogData#enable_paper

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

Enables or disables the paper size control (Windows only).

### PageSetupDialogData#enable_printer

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

Enables or disables the Printer button, which invokes a printer setup dialog.

### PageSetupDialogData#get_default_min_margins

Boolean get_default_min_margins()

Returns true if the page setup dialog will take its minimum margin values from the currently
selected printer properties. Windows only.

### PageSetupDialogData#get_enable_margins

Boolean get_enable_margins()

Returns true if the margin controls are enabled (Windows only).

### PageSetupDialogData#get_enable_orientation

Boolean get_enable_orientation()

Returns true if the orientation control is enabled (Windows only).

### PageSetupDialogData#get_enable_paper

Boolean get_enable_paper()

Returns true if the paper size control is enabled (Windows only).

### PageSetupDialogData#get_enable_printer

Boolean get_enable_printer()

Returns true if the printer setup button is enabled.

### PageSetupDialogData#get_enable_help

Boolean get_enable_help()

Returns true if the printer setup button is enabled.

### PageSetupDialogData#get_default_info

Boolean get_default_info()

Returns true if the dialog will simply return default printer information (such as orientation)
instead of showing a dialog. Windows only.

### PageSetupDialogData#get_margin_top_left

Point get_margin_top_left()

Returns the left (x) and top (y) margins in millimetres.

### PageSetupDialogData#get_margin_bottom_right

Point get_margin_bottom_right()

Returns the right (x) and bottom (y) margins in millimetres.

### PageSetupDialogData#get_min_margin_top_left

Point get_min_margin_top_left()

Returns the left (x) and top (y) minimum margins the user can enter (Windows only). Units
are in millimetres

### PageSetupDialogData#get_min_margin_bottom_right

Point get_min_margin_bottom_right()

Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only). Units
are in millimetres

### PageSetupDialogData#get_paper_id

PaperSize get_paper_id()

Returns the paper id (stored in the internal PrintData object).

For further information, see PrintData#set_paper_id.

### PageSetupDialogData#get_paper_size

Size get_paper_size()

Returns the paper size in millimetres.

### PageSetupDialogData#get_print_data

PrintData get_print_data()

Returns a reference to the print data associated with this object.

### PageSetupDialogData#ok

Boolean ok()

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

### PageSetupDialogData#set_default_info

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

Pass true if the dialog will simply return default printer information (such as orientation)
instead of showing a dialog. Windows only.

### PageSetupDialogData#set_default_min_margins

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

Pass true if the page setup dialog will take its minimum margin values from the currently
selected printer properties. Windows only. Units are in millimetres

### PageSetupDialogData#set_margin_top_left

set_margin_top_left(%(arg-type)Point% pt)

Sets the left (x) and top (y) margins in millimetres.

### PageSetupDialogData#set_margin_bottom_right

set_margin_bottom_right(%(arg-type)Point% pt)

Sets the right (x) and bottom (y) margins in millimetres.

### PageSetupDialogData#set_min_margin_top_left

set_min_margin_top_left(%(arg-type)Point% pt)

Sets the left (x) and top (y) minimum margins the user can enter (Windows only). Units are
in millimetres.

### PageSetupDialogData#set_min_margin_bottom_right

set_min_margin_bottom_right(%(arg-type)Point% pt)

Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only). Units are
in millimetres.

### PageSetupDialogData#set_paper_id

set_paper_id(%(arg-type)PaperSize% id)

Sets the paper size id. For further information, see PrintData#set_paper_id.

Calling this function overrides the explicit paper dimensions passed in PageSetupDialogData#set_paper_size.

### PageSetupDialogData#set_paper_size

set_paper_size(%(arg-type)Size% size)

Sets the paper size in millimetres. If a corresponding paper id is found, it will be set in the
internal PrintData object, otherwise the paper size overrides the paper id.

### PageSetupDialogData#set_print_data

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

Sets the print data associated with this object.

### PageSetupDialogData#=

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

Assigns print data to this object.

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

Assigns page setup data to this object.

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