Class: Wx::PRT::PageSetupDialogData

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 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).

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::PageSetupDialogData #initialize(data) ⇒ Wx::PRT::PageSetupDialogData #initialize(printData) ⇒ Wx::PRT::PageSetupDialogData

Returns a new instance of PageSetupDialogData.

Overloads:



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

def initialize(*args) end

Instance Method Details

#enable_help(flag) ⇒ void

This method returns an undefined value.

Enables or disables the “Help” button (Windows only).

Parameters:

  • flag (Boolean) 


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

def enable_help(flag) end

#enable_margins(flag) ⇒ void

This method returns an undefined value.

Enables or disables the margin controls (Windows only).

Parameters:

  • flag (Boolean) 


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

def enable_margins(flag) end

#enable_orientation(flag) ⇒ void

This method returns an undefined value.

Enables or disables the orientation control (Windows only).

Parameters:

  • flag (Boolean) 


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

def enable_orientation(flag) end

#enable_paper(flag) ⇒ void

This method returns an undefined value.

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

Parameters:

  • flag (Boolean) 


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

def enable_paper(flag) end

#enable_printer(flag) ⇒ void

This method returns an undefined value.

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

Parameters:

  • flag (Boolean) 


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

def enable_printer(flag) end

#get_default_info ⇒ Boolean Also known as: default_info

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

Returns:

  • (Boolean) 


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

def get_default_info; end

#get_default_min_margins ⇒ Boolean Also known as: default_min_margins

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

Returns:

  • (Boolean) 


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

def get_default_min_margins; end

#get_enable_help ⇒ Boolean

Returns true if the printer setup button is enabled.

Returns:

  • (Boolean) 


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

def get_enable_help; end

#get_enable_margins ⇒ Boolean

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

Returns:

  • (Boolean) 


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

def get_enable_margins; end

#get_enable_orientation ⇒ Boolean

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

Returns:

  • (Boolean) 


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

def get_enable_orientation; end

#get_enable_paper ⇒ Boolean

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

Returns:

  • (Boolean) 


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

def get_enable_paper; end

#get_enable_printer ⇒ Boolean

Returns true if the printer setup button is enabled.

Returns:

  • (Boolean) 


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

def get_enable_printer; end

#get_margin_bottom_right ⇒ Wx::Point Also known as: margin_bottom_right

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

Returns:



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

def get_margin_bottom_right; end

#get_margin_top_left ⇒ Wx::Point Also known as: margin_top_left

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

Returns:



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

def get_margin_top_left; end

#get_min_margin_bottom_right ⇒ Wx::Point Also known as: min_margin_bottom_right

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

Units are in millimetres.

Returns:



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

def get_min_margin_bottom_right; end

#get_min_margin_top_left ⇒ Wx::Point Also known as: min_margin_top_left

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

Units are in millimetres.

Returns:



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

def get_min_margin_top_left; end

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

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

Returns:

See Also:



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

def get_paper_id; end

#get_paper_size ⇒ Wx::Size Also known as: paper_size

Returns the paper size in millimetres.

Returns:



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

def get_paper_size; end

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

Returns:



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

def get_print_data; end

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

Returns:

  • (Boolean) 


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

def is_ok; end

#set_default_info(flag) ⇒ void Also known as: default_info=

This method returns an undefined value.

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

Parameters:

  • flag (Boolean) 


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

def set_default_info(flag) end

#set_default_min_margins(flag) ⇒ void Also known as: default_min_margins=

This method returns an undefined value.

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.

Parameters:

  • flag (Boolean) 


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

def set_default_min_margins(flag) end

#set_margin_bottom_right(pt) ⇒ void Also known as: margin_bottom_right=

This method returns an undefined value.

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

Parameters:



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

def set_margin_bottom_right(pt) end

#set_margin_top_left(pt) ⇒ void Also known as: margin_top_left=

This method returns an undefined value.

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

Parameters:



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

def set_margin_top_left(pt) end

#set_min_margin_bottom_right(pt) ⇒ void Also known as: min_margin_bottom_right=

This method returns an undefined value.

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

Units are in millimetres.

Parameters:



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

def set_min_margin_bottom_right(pt) end

#set_min_margin_top_left(pt) ⇒ void Also known as: min_margin_top_left=

This method returns an undefined value.

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

Units are in millimetres.

Parameters:



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

def set_min_margin_top_left(pt) end

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

This method returns an undefined value.

Sets the paper size id.

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

Parameters:

See Also:



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

def set_paper_id(id) end

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

This method returns an undefined value.

Sets the paper size in millimetres.

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

Parameters:

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


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

def set_paper_size(size) end

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

This method returns an undefined value.

Sets the print data associated with this object.

Parameters:



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

def set_print_data(printData) end