<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXPrinter
— FXRuby API Documentation
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Fox::FXPrinter";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (F)</a> »
<span class='title'><span class='object_link'><a href="../Fox.html" title="Fox (module)">Fox</a></span></span>
»
<span class="title">FXPrinter</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Fox::FXPrinter
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Fox::FXPrinter</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>rdoc-sources/FXDCPrint.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Describes printer</p>
<h3 id="label-Printer+flags">Printer flags</h3>
<dl class="rdoc-list note-list"><dt><code>PRINT_DEST_PAPER</code>
<dd>
<p>Send print to paper</p>
</dd><dt><code>PRINT_DEST_FILE</code>
<dd>
<p>Send print to file</p>
</dd><dt><code>PRINT_PAGES_ALL</code>
<dd>
<p>Print all pages</p>
</dd><dt><code>PRINT_PAGES_EVEN</code>
<dd>
<p>Print even pages only</p>
</dd><dt><code>PRINT_PAGES_ODD</code>
<dd>
<p>Print odd pages only</p>
</dd><dt><code>PRINT_PAGES_RANGE</code>
<dd>
<p>Print range of pages</p>
</dd><dt><code>PRINT_COLLATE_NORMAL</code>
<dd>
<p>Normal collate order</p>
</dd><dt><code>PRINT_COLLATE_REVERSED</code>
<dd>
<p>Reversed collate order</p>
</dd><dt><code>PRINT_PORTRAIT</code>
<dd>
<p>Portrait orientation</p>
</dd><dt><code>PRINT_LANDSCAPE</code>
<dd>
<p>Landscape orientation</p>
</dd><dt><code>PRINT_BLACKANDWHITE</code>
<dd>
<p>Black and white output</p>
</dd><dt><code>PRINT_COLOR</code>
<dd>
<p>Color output</p>
</dd><dt><code>PRINT_NOBOUNDS</code>
<dd>
<p>Must determine bounding box</p>
</dd></dl>
<h3 id="label-Printer+media+size">Printer media size</h3>
<dl class="rdoc-list note-list"><dt><code>MEDIA_CUSTOM</code>
<dd>
<p>Custom paper size</p>
</dd><dt><code>MEDIA_USLETTER</code>
<dd>
<p>US Letter size</p>
</dd><dt><code>MEDIA_LEGAL</code>
<dd>
<p>US Legal size</p>
</dd><dt><code>MEDIA_A4</code>
<dd>
<p>A4</p>
</dd><dt><code>MEDIA_ENVELOPE</code>
<dd>
<p>#10 Envelope</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#bottommargin-instance_method" title="#bottommargin (instance method)">#<strong>bottommargin</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Bottom margin [Float].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#currentpage-instance_method" title="#currentpage (instance method)">#<strong>currentpage</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Current page to print [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#firstpage-instance_method" title="#firstpage (instance method)">#<strong>firstpage</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>First page that can be printed [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#flags-instance_method" title="#flags (instance method)">#<strong>flags</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Flags [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#frompage-instance_method" title="#frompage (instance method)">#<strong>frompage</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>On output, this is the first page to print [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#lastpage-instance_method" title="#lastpage (instance method)">#<strong>lastpage</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Last page that can be printed [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#leftmargin-instance_method" title="#leftmargin (instance method)">#<strong>leftmargin</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Left margin [Float].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#mediaheight-instance_method" title="#mediaheight (instance method)">#<strong>mediaheight</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Height of paper in points [Float].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#mediasize-instance_method" title="#mediasize (instance method)">#<strong>mediasize</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Media size index, one of <code>MEDIA_CUSTOM</code>, <code>MEDIA_USLETTER</code>, <code>MEDIA_LEGAL</code>, <code>MEDIA_A4</code> or <code>MEDIA_ENVELOPE</code> [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#mediawidth-instance_method" title="#mediawidth (instance method)">#<strong>mediawidth</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Width of paper in points (1/72 of an inch) [Float].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Printer name [String].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#numcopies-instance_method" title="#numcopies (instance method)">#<strong>numcopies</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Number of copies [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#rightmargin-instance_method" title="#rightmargin (instance method)">#<strong>rightmargin</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Right margin [Float].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#topage-instance_method" title="#topage (instance method)">#<strong>topage</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>On output, last page to print [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#topmargin-instance_method" title="#topmargin (instance method)">#<strong>topmargin</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Top margin [Float].</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ FXPrinter </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Returns an initialized FXPrinter instance.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong> ⇒ <tt><span class='object_link'><a href="" title="Fox::FXPrinter (class)">FXPrinter</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns an initialized FXPrinter instance</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
101</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDCPrint.rb', line 101</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="bottommargin=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="bottommargin-instance_method">
#<strong>bottommargin</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Bottom margin [Float]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
92
93
94</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDCPrint.rb', line 92</span>
<span class='kw'>def</span> <span class='id identifier rubyid_bottommargin'>bottommargin</span>
<span class='ivar'>@bottommargin</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="currentpage=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="currentpage-instance_method">
#<strong>currentpage</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Current page to print [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
62
63
64</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDCPrint.rb', line 62</span>
<span class='kw'>def</span> <span class='id identifier rubyid_currentpage'>currentpage</span>
<span class='ivar'>@currentpage</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="firstpage=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="firstpage-instance_method">
#<strong>firstpage</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>First page that can be printed [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
56
57
58</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDCPrint.rb', line 56</span>
<span class='kw'>def</span> <span class='id identifier rubyid_firstpage'>firstpage</span>
<span class='ivar'>@firstpage</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="flags=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="flags-instance_method">
#<strong>flags</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Flags [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
98
99
100</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDCPrint.rb', line 98</span>
<span class='kw'>def</span> <span class='id identifier rubyid_flags'>flags</span>
<span class='ivar'>@flags</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="frompage=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="frompage-instance_method">
#<strong>frompage</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>On output, this is the first page to print [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
65
66
67</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDCPrint.rb', line 65</span>
<span class='kw'>def</span> <span class='id identifier rubyid_frompage'>frompage</span>
<span class='ivar'>@frompage</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="lastpage=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="lastpage-instance_method">
#<strong>lastpage</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Last page that can be printed [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
59
60
61</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDCPrint.rb', line 59</span>
<span class='kw'>def</span> <span class='id identifier rubyid_lastpage'>lastpage</span>
<span class='ivar'>@lastpage</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="leftmargin=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="leftmargin-instance_method">
#<strong>leftmargin</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Left margin [Float]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
83
84
85</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDCPrint.rb', line 83</span>
<span class='kw'>def</span> <span class='id identifier rubyid_leftmargin'>leftmargin</span>
<span class='ivar'>@leftmargin</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="mediaheight=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="mediaheight-instance_method">
#<strong>mediaheight</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Height of paper in points [Float]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
80
81
82</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDCPrint.rb', line 80</span>
<span class='kw'>def</span> <span class='id identifier rubyid_mediaheight'>mediaheight</span>
<span class='ivar'>@mediaheight</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="mediasize=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="mediasize-instance_method">
#<strong>mediasize</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Media size index, one of <code>MEDIA_CUSTOM</code>, <code>MEDIA_USLETTER</code>, <code>MEDIA_LEGAL</code>, <code>MEDIA_A4</code> or <code>MEDIA_ENVELOPE</code> [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
74
75
76</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDCPrint.rb', line 74</span>
<span class='kw'>def</span> <span class='id identifier rubyid_mediasize'>mediasize</span>
<span class='ivar'>@mediasize</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="mediawidth=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="mediawidth-instance_method">
#<strong>mediawidth</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Width of paper in points (1/72 of an inch) [Float]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
77
78
79</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDCPrint.rb', line 77</span>
<span class='kw'>def</span> <span class='id identifier rubyid_mediawidth'>mediawidth</span>
<span class='ivar'>@mediawidth</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="name=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="name-instance_method">
#<strong>name</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Printer name [String]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
53
54
55</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDCPrint.rb', line 53</span>
<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
<span class='ivar'>@name</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="numcopies=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="numcopies-instance_method">
#<strong>numcopies</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Number of copies [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
95
96
97</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDCPrint.rb', line 95</span>
<span class='kw'>def</span> <span class='id identifier rubyid_numcopies'>numcopies</span>
<span class='ivar'>@numcopies</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="rightmargin=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="rightmargin-instance_method">
#<strong>rightmargin</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Right margin [Float]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
86
87
88</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDCPrint.rb', line 86</span>
<span class='kw'>def</span> <span class='id identifier rubyid_rightmargin'>rightmargin</span>
<span class='ivar'>@rightmargin</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="topage=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="topage-instance_method">
#<strong>topage</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>On output, last page to print [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
68
69
70</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDCPrint.rb', line 68</span>
<span class='kw'>def</span> <span class='id identifier rubyid_topage'>topage</span>
<span class='ivar'>@topage</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="topmargin=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="topmargin-instance_method">
#<strong>topmargin</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Top margin [Float]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
89
90
91</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDCPrint.rb', line 89</span>
<span class='kw'>def</span> <span class='id identifier rubyid_topmargin'>topmargin</span>
<span class='ivar'>@topmargin</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jan 2 11:47:33 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.2).
</div>
</div>
</body>
</html>