Class: Wx::PRT::PageSetupDialog

Inherits:

Object

• Object
• Object
• Wx::PRT::PageSetupDialog

Defined in:

lib/wx/doc/gen/prt/page_setup_dialog.rb,
lib/wx/doc/prt/page_setup_dialog.rb

Overview

This class represents the page setup common dialog.

The page setup dialog contains controls for paper size (letter, A4, A5 etc.), orientation (landscape or portrait), and, only under Windows currently, controls for setting left, top, right and bottom margin sizes in millimetres. The exact appearance of this dialog varies among the platforms as a native dialog is used when available (currently the case for all major platforms). When the dialog has been closed, you need to query the PageSetupDialogData object associated with the dialog. Note that the OK and Cancel buttons do not destroy the dialog; this must be done by the application.

Category: Printing Framework

See Also:

• Framework Overview
• PrintDialog
• PageSetupDialogData

Requires:

• USE_PRINTING_ARCHITECTURE

Instance Method Summary

• #get_page_setup_data ⇒ Wx::PRT::PageSetupDialogData (also: #page_setup_data)

  Returns (a copy of) the page setup data of the dialog.

• #initialize(parent, data = nil) ⇒ Wx::PRT::PageSetupDialog constructor

  Constructor.

• #set_page_setup_data(setup_data) ⇒ void (also: #page_setup_data=)

  Updates the page setup data for the dialog.

• #show_modal ⇒ Integer

  Shows the dialog, returning StandardID::ID_OK if the user pressed OK, and StandardID::ID_CANCEL otherwise.

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(parent, data = nil) ⇒ Wx::PRT::PageSetupDialog

Constructor.

Pass a parent window, and optionally a pointer to a block of page setup data, which will be copied to the print dialog’s internal data.

Parameters:

• parent (Wx::Window)
• data (Wx::PRT::PageSetupDialogData) (defaults to: nil)

# File 'lib/wx/doc/gen/prt/page_setup_dialog.rb', line 33

def initialize(parent, data=nil) end

Instance Method Details

#get_page_setup_data ⇒ Wx::PRT::PageSetupDialogData Also known as: page_setup_data

Returns (a copy of) the page setup data of the dialog.

Returns:

• (Wx::PRT::PageSetupDialogData) —

  page setup data copy

# File 'lib/wx/doc/prt/page_setup_dialog.rb', line 16

def get_page_setup_data; end

#set_page_setup_data(setup_data) ⇒ void Also known as: page_setup_data=

This method returns an undefined value.

Updates the page setup data for the dialog.

Parameters:

• setup_data (Wx::PRT::PageSetupDialogData) —

  the page setup data to update the dialog with

# File 'lib/wx/doc/prt/page_setup_dialog.rb', line 22

def set_page_setup_data(setup_data); end

#show_modal ⇒ Integer

Shows the dialog, returning StandardID::ID_OK if the user pressed OK, and StandardID::ID_CANCEL otherwise.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/prt/page_setup_dialog.rb', line 37

def show_modal; end