Class: Wx::PRT::PrintData

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

Overview

Note:

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

This class holds a variety of information related to printers and printer device contexts.

This class is used to create a PrinterDC and a PostScriptDC. It is also used as a data member of PrintDialogData and PageSetupDialogData, as part of the mechanism for transferring data between the print dialogs and the application.

Category: Printing Framework, 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::PrintData #initialize(data) ⇒ Wx::PRT::PrintData

Returns a new instance of PrintData.

Overloads:



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

def initialize(*args) end

Instance Method Details

#get_bin ⇒ Wx::PrintBin Also known as: bin

Returns the current bin (papersource).

By default, the system is left to select the bin (Wx::PRT::PrintBin::PRINTBIN_DEFAULT is returned). See #set_bin for the full list of bin values.

Returns:

  • (Wx::PrintBin) 


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

def get_bin; end

#get_collate ⇒ Boolean Also known as: collate

Returns true if collation is on.

Returns:

  • (Boolean) 


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

def get_collate; end

#get_colour ⇒ Boolean Also known as: colour

Returns true if colour printing is on.

Returns:

  • (Boolean) 


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

def get_colour; end

#get_duplex ⇒ Wx::DuplexMode Also known as: duplex

Returns the duplex mode.

One of DuplexMode::DUPLEX_SIMPLEX, DuplexMode::DUPLEX_HORIZONTAL, DuplexMode::DUPLEX_VERTICAL.

Returns:



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

def get_duplex; end

#get_filename ⇒ String Also known as: filename

Returns:

  • (String) 


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

def get_filename; end

#get_no_copies ⇒ Integer Also known as: no_copies

Returns the number of copies requested by the user.

Returns:

  • (Integer) 


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

def get_no_copies; end

#get_orientation ⇒ Wx::PrintOrientation Also known as: orientation

Gets the orientation.

This can be Wx::PrintOrientation::LANDSCAPE or Wx::PrintOrientation::PORTRAIT.

Returns:



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

def get_orientation; end

#get_paper_id ⇒ Wx::PaperSize Also known as: paper_id

Returns the paper size id.

Returns:

See Also:



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

def get_paper_id; end

#get_print_mode ⇒ Wx::PrintMode Also known as: print_mode

Returns:



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

def get_print_mode; end

#get_printer_name ⇒ Wx::String Also known as: printer_name

Returns the printer name.

If the printer name is the empty string, it indicates that the default printer should be used.

Returns:

  • (Wx::String) 


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

def get_printer_name; end

#get_quality ⇒ Integer Also known as: quality

Returns the current print quality.

This can be a positive integer, denoting the number of dots per inch, or one of the following identifiers:

On input you should pass one of these identifiers, but on return you may get back a positive integer indicating the current resolution setting.

Returns:

  • (Integer) 


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

def get_quality; 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) 


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

def is_ok; end

#set_bin(flag) ⇒ void Also known as: bin=

This method returns an undefined value.

Sets the current bin.

Parameters:

  • flag (Wx::PrintBin) 


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

def set_bin(flag) end

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

This method returns an undefined value.

Sets collation to on or off.

Parameters:

  • flag (Boolean) 


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

def set_collate(flag) end

#set_colour(flag) ⇒ void Also known as: colour=

This method returns an undefined value.

Sets colour printing on or off.

Parameters:

  • flag (Boolean) 


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

def set_colour(flag) end

#set_duplex(mode) ⇒ void Also known as: duplex=

This method returns an undefined value.

Returns the duplex mode.

One of DuplexMode::DUPLEX_SIMPLEX, DuplexMode::DUPLEX_HORIZONTAL, DuplexMode::DUPLEX_VERTICAL.

Parameters:



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

def set_duplex(mode) end

#set_filename(filename) ⇒ void Also known as: filename=

This method returns an undefined value.

Parameters:

  • filename (String) 


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

def set_filename(filename) end

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

This method returns an undefined value.

Sets the default number of copies to be printed out.

Parameters:

  • n (Integer) 


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

def set_no_copies(n) end

#set_orientation(orientation) ⇒ void Also known as: orientation=

This method returns an undefined value.

Sets the orientation.

This can be Wx::PrintOrientation::LANDSCAPE or Wx::PrintOrientation::PORTRAIT.

Parameters:



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

def set_orientation(orientation) end

#set_paper_id(paperId) ⇒ void Also known as: paper_id=

This method returns an undefined value.

Sets the paper id.

This indicates the type of paper to be used. For a mapping between paper id, paper size and string name, see Wx::PrintPaperDatabase in "paper.h" (not yet documented).

Parameters:

See Also:



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

def set_paper_id(paperId) end

#set_paper_size(size) ⇒ void Also known as: paper_size=

This method returns an undefined value.

Sets custom paper size.

This method can be used to set up custom paper size. When using a standard size, prefer to use #set_paper_id instead.

Parameters:

  • size (Array(Integer, Integer), Wx::Size) 


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

def set_paper_size(size) end

#set_print_mode(printMode) ⇒ void Also known as: print_mode=

This method returns an undefined value.

Parameters:



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

def set_print_mode(printMode) end

#set_printer_name(printerName) ⇒ void Also known as: printer_name=

This method returns an undefined value.

Sets the printer name.

This can be the empty string to indicate that the default printer should be used.

Parameters:

  • printerName (String) 


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

def set_printer_name(printerName) end

#set_quality(quality) ⇒ void Also known as: quality=

This method returns an undefined value.

Sets the desired print quality.

This can be a positive integer, denoting the number of dots per inch, or one of the following identifiers:

On input you should pass one of these identifiers, but on return you may get back a positive integer indicating the current resolution setting.

Parameters:

  • quality (Integer) 


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

def set_quality(quality) end