Class: Wx::PRT::PrintDialogData

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/prt/print_data.rb,
lib/wx/doc/prt/print_data.rb

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

This class holds information related to the visual characteristics of PrintDialog.

It contains a PrintData object with underlying printing settings.

Category: Printing Framework, Common Dialogs, Data Structures

See Also:

Requires:

  • USE_PRINTING_ARCHITECTURE

Instance Method Summary collapse

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::PRT::PrintDialogData #initialize(dialogData) ⇒ Wx::PRT::PrintDialogData #initialize(printData) ⇒ Wx::PRT::PrintDialogData

Returns a new instance of PrintDialogData.

Overloads:



310
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 310

def initialize(*args) end

Instance Method Details

#enable_help(flag) ⇒ void

This method returns an undefined value.

Enables or disables the “Help” button.

Parameters:

  • flag (Boolean) 


315
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 315

def enable_help(flag) end

#enable_page_numbers(flag) ⇒ void

This method returns an undefined value.

Enables or disables the “Page numbers” controls.

Parameters:

  • flag (Boolean) 


320
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 320

def enable_page_numbers(flag) end

#enable_print_to_file(flag) ⇒ void

This method returns an undefined value.

Enables or disables the “Print to file” checkbox.

Parameters:

  • flag (Boolean) 


325
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 325

def enable_print_to_file(flag) end

#enable_selection(flag) ⇒ void

This method returns an undefined value.

Enables or disables the “Selection” radio button.

Parameters:

  • flag (Boolean) 


330
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 330

def enable_selection(flag) end

#get_all_pages ⇒ Boolean Also known as: all_pages

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

Returns:

  • (Boolean) 


334
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 334

def get_all_pages; end

#get_collate ⇒ Boolean Also known as: collate

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

Returns:

  • (Boolean) 


339
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 339

def get_collate; end

#get_from_page ⇒ Integer Also known as: from_page

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

Returns:

  • (Integer) 


344
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 344

def get_from_page; end

#get_max_page ⇒ Integer Also known as: max_page

Returns the maximum page number.

Returns:

  • (Integer) 


349
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 349

def get_max_page; end

#get_min_page ⇒ Integer Also known as: min_page

Returns the minimum page number.

Returns:

  • (Integer) 


354
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 354

def get_min_page; end

#get_no_copies ⇒ Integer Also known as: no_copies

Returns the number of copies requested by the user.

Returns:

  • (Integer) 


359
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 359

def get_no_copies; end

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

Returns a reference to the internal Wx::PRT::PrintData object.

Returns:

  • (Wx::PrintData) 


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

def get_print_data; end

#get_print_to_file ⇒ Boolean Also known as: print_to_file

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

Returns:

  • (Boolean) 


369
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 369

def get_print_to_file; end

#get_selection ⇒ Boolean Also known as: selection

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

Returns:

  • (Boolean) 


374
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 374

def get_selection; end

#get_to_page ⇒ Integer Also known as: to_page

Returns the “print to” page number, as entered by the user.

Returns:

  • (Integer) 


379
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 379

def get_to_page; end

#is_ok ⇒ Boolean Also known as: 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.

Returns:

  • (Boolean) 


386
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 386

def is_ok; end

#set_collate(flag) ⇒ void Also known as: collate=

This method returns an undefined value.

Sets the “Collate” checkbox to true or false.

Parameters:

  • flag (Boolean) 


392
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 392

def set_collate(flag) end

#set_from_page(page) ⇒ void Also known as: from_page=

This method returns an undefined value.

Sets the from page number.

Parameters:

  • page (Integer) 


398
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 398

def set_from_page(page) end

#set_max_page(page) ⇒ void Also known as: max_page=

This method returns an undefined value.

Sets the maximum page number.

Parameters:

  • page (Integer) 


404
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 404

def set_max_page(page) end

#set_min_page(page) ⇒ void Also known as: min_page=

This method returns an undefined value.

Sets the minimum page number.

Parameters:

  • page (Integer) 


410
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 410

def set_min_page(page) end

#set_no_copies(n) ⇒ void Also known as: no_copies=

This method returns an undefined value.

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

Parameters:

  • n (Integer) 


416
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 416

def set_no_copies(n) end

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

This method returns an undefined value.

Sets the internal Wx::PRT::PrintData.

Parameters:



422
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 422

def set_print_data(printData) end

#set_print_to_file(flag) ⇒ void Also known as: print_to_file=

This method returns an undefined value.

Sets the “Print to file” checkbox to true or false.

Parameters:

  • flag (Boolean) 


428
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 428

def set_print_to_file(flag) end

#set_selection(flag) ⇒ void Also known as: selection=

This method returns an undefined value.

Selects the “Selection” radio button.

The effect of printing the selection depends on how the application implements this command, if at all.

Parameters:

  • flag (Boolean) 


436
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 436

def set_selection(flag) end

#set_to_page(page) ⇒ void Also known as: to_page=

This method returns an undefined value.

Sets the “print to” page number.

Parameters:

  • page (Integer) 


442
 
# File 'lib/wx/doc/gen/prt/print_data.rb', line 442

def set_to_page(page) end