Class: Wx::PRT::PrintDialog

Inherits:

Object

• Object
• Object
• Wx::PRT::PrintDialog

Defined in:

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

Overview

This class represents the print and print setup common dialogs.

You may obtain a PrinterDC device context from a successfully dismissed print dialog.

Category: Printing Framework

See Also:

• Framework Overview
• Overview

Requires:

• USE_PRINTING_ARCHITECTURE

Instance Method Summary

• #get_print_data ⇒ Wx::PRT::PrintData (also: #print_data)

  Returns (a copy of) the print data of the dialog.

• #get_print_dc ⇒ Wx::DC (also: #print_dc)

  Returns the device context created by the print dialog, if any.

• #get_print_dialog_data ⇒ Wx::PRT::PrintDialogData (also: #print_dialog_data)

  Returns (a copy of) the print dialog data of the dialog.

• #initialize(*args) ⇒ PrintDialog constructor

  A new instance of PrintDialog.

• #set_print_data(prt_data) ⇒ void (also: #print_data=)

  Updates the print data for the dialog.

• #set_print_dialog_data(prt_data) ⇒ void (also: #print_dialog_data=)

  Updates the print dialog 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::PrintDialog #initialize(parent, data) ⇒ Wx::PRT::PrintDialog

Returns a new instance of PrintDialog.

Overloads:

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

  Constructor.

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

  Parameters:

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

  See Also:

  • Wx::PRT::PrintDialogData
• #initialize(parent, data) ⇒ Wx::PRT::PrintDialog

  Parameters:

  • parent (Wx::Window)
  • data (Wx::PRT::PrintData)

# File 'lib/wx/doc/gen/prt/print_dialog.rb', line 35

def initialize(*args) end

Instance Method Details

#get_print_data ⇒ Wx::PRT::PrintData Also known as: print_data

Returns (a copy of) the print data of the dialog.

Returns:

• (Wx::PRT::PrintData) —

  print data copy

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

def get_print_data; end

#get_print_dc ⇒ Wx::DC Also known as: print_dc

Returns the device context created by the print dialog, if any.

When this function has been called, the ownership of the device context is transferred to the application, so it must then be deleted explicitly.

Returns:

• (Wx::DC)

# File 'lib/wx/doc/gen/prt/print_dialog.rb', line 41

def get_print_dc; end

#get_print_dialog_data ⇒ Wx::PRT::PrintDialogData Also known as: print_dialog_data

Returns (a copy of) the print dialog data of the dialog.

Returns:

• (Wx::PRT::PrintDialogData) —

  print dialog data copy

# File 'lib/wx/doc/prt/print_dialog.rb', line 27

def get_print_dialog_data; end

#set_print_data(prt_data) ⇒ void Also known as: print_data=

This method returns an undefined value.

Updates the print data for the dialog.

Parameters:

• prt_data (Wx::PRT::PrintData) —

  the print data to update the dialog with

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

def set_print_data(prt_data); end

#set_print_dialog_data(prt_data) ⇒ void Also known as: print_dialog_data=

This method returns an undefined value.

Updates the print dialog data for the dialog.

Parameters:

• prt_data (Wx::PRT::PrintDialogData) —

  the print dialog data to update the dialog with

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

def set_print_dialog_data(prt_data); end

#show_modal ⇒ Integer

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

After this function is called, a device context may be retrievable using #get_print_dc.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/prt/print_dialog.rb', line 48

def show_modal; end