updated api documentation
[urpo] / www / apidoc / html / class_print_job.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <title>Urpo: PrintJob Class Reference</title>
6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
7 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
8 </head>
9 <body>
10 <!-- Generated by Doxygen 1.6.3 -->
11 <div class="navigation" id="top">
12   <div class="tabs">
13     <ul>
14       <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
15       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
16       <li><a href="files.html"><span>Files</span></a></li>
17     </ul>
18   </div>
19   <div class="tabs">
20     <ul>
21       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
22       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
23       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
24     </ul>
25   </div>
26 </div>
27 <div class="contents">
28 <h1>PrintJob Class Reference</h1><!-- doxytag: class="PrintJob" --><!-- doxytag: inherits="UrpoJob" -->
29 <p>File printing job'.  
30 <a href="#_details">More...</a></p>
31
32 <p><code>#include &lt;<a class="el" href="printjob_8h_source.html">printjob.h</a>&gt;</code></p>
33 <div class="dynheader">
34 Inheritance diagram for PrintJob:</div>
35 <div class="dynsection">
36  <div class="center">
37   <img src="class_print_job.png" usemap="#PrintJob_map" alt=""/>
38   <map id="PrintJob_map" name="PrintJob_map">
39 <area href="class_urpo_job.html" alt="UrpoJob" shape="rect" coords="0,0,60,24"/>
40 </map>
41  </div>
42 </div>
43
44 <p><a href="class_print_job-members.html">List of all members.</a></p>
45 <table border="0" cellpadding="0" cellspacing="0">
46 <tr><td colspan="2"><h2>Public Slots</h2></td></tr>
47 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2dacf12d369e28e30a5955aba14d4fcf"></a><!-- doxytag: member="PrintJob::copyReady" ref="a2dacf12d369e28e30a5955aba14d4fcf" args="(bool success)" -->
48 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_print_job.html#a2dacf12d369e28e30a5955aba14d4fcf">copyReady</a> (bool success)</td></tr>
49 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">When file has copied (internal use only). <br/></td></tr>
50 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af984397994fd563b0a0a810b77a68c2c"></a><!-- doxytag: member="PrintJob::printReady" ref="af984397994fd563b0a0a810b77a68c2c" args="(bool success)" -->
51 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_print_job.html#af984397994fd563b0a0a810b77a68c2c">printReady</a> (bool success)</td></tr>
52 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">When files has printed (internal use only). <br/></td></tr>
53 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb65a2765ae36c2ceab60e5a868b54f8"></a><!-- doxytag: member="PrintJob::deleteReady" ref="adb65a2765ae36c2ceab60e5a868b54f8" args="(bool success)" -->
54 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_print_job.html#adb65a2765ae36c2ceab60e5a868b54f8">deleteReady</a> (bool success)</td></tr>
55 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">When file has deleted (internal use only). <br/></td></tr>
56 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_print_job.html#a5ce2230a6599b03abefd3875a43ba62e">printFile</a> (const QString &amp;path, const QString &amp;printOptions)</td></tr>
57 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print sigle file.  <a href="#a5ce2230a6599b03abefd3875a43ba62e"></a><br/></td></tr>
58 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_print_job.html#a167ee653ddcb9f5130b9f92fce279050">startJob</a> ()</td></tr>
59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Do not use, thows execption!  <a href="#a167ee653ddcb9f5130b9f92fce279050"></a><br/></td></tr>
60 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a7f1167cd9d660a3fa1c16276d8b6b0"></a><!-- doxytag: member="PrintJob::cancelJob" ref="a6a7f1167cd9d660a3fa1c16276d8b6b0" args="()" -->
61 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_print_job.html#a6a7f1167cd9d660a3fa1c16276d8b6b0">cancelJob</a> ()</td></tr>
62 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cancel printing job. <br/></td></tr>
63 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
64 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f58997ec199e807b1149e49423d8199"></a><!-- doxytag: member="PrintJob::PrintJob" ref="a6f58997ec199e807b1149e49423d8199" args="(UrpoConnection *connection)" -->
65 &nbsp;</td><td class="memItemRight" valign="bottom"><b>PrintJob</b> (<a class="el" href="class_urpo_connection.html">UrpoConnection</a> *connection)</td></tr>
66 </table>
67 <hr/><a name="_details"></a><h2>Detailed Description</h2>
68 <p>File printing job'. </p>
69 <dl class="author"><dt><b>Author:</b></dt><dd>Arto Hyvättinen </dd></dl>
70 <dl class="date"><dt><b>Date:</b></dt><dd>2010-06-17 </dd></dl>
71 <dl class="version"><dt><b>Version:</b></dt><dd>0.1</dd></dl>
72 <p>Job for printing files. First, connect <a class="el" href="class_urpo_job.html#ab931a6a72a6f49c8919dcd695197288e" title="Job finished (successed of failed).">finished()</a>-signal (called when ready) Then, <a class="el" href="class_print_job.html#a5ce2230a6599b03abefd3875a43ba62e" title="Print sigle file.">printFile()</a></p>
73 <dl class="note"><dt><b>Note:</b></dt><dd><a class="el" href="class_urpo_job.html#ae4549ace1bc2331462d22281b8cbdf0f" title="Start job.">start()</a> is not for use! </dd></dl>
74
75 <p>Definition at line <a class="el" href="printjob_8h_source.html#l00042">42</a> of file <a class="el" href="printjob_8h_source.html">printjob.h</a>.</p>
76 <hr/><h2>Member Function Documentation</h2>
77 <a class="anchor" id="a5ce2230a6599b03abefd3875a43ba62e"></a><!-- doxytag: member="PrintJob::printFile" ref="a5ce2230a6599b03abefd3875a43ba62e" args="(const QString &amp;path, const QString &amp;printOptions)" -->
78 <div class="memitem">
79 <div class="memproto">
80       <table class="memname">
81         <tr>
82           <td class="memname">void PrintJob::printFile </td>
83           <td>(</td>
84           <td class="paramtype">const QString &amp;&nbsp;</td>
85           <td class="paramname"> <em>path</em>, </td>
86         </tr>
87         <tr>
88           <td class="paramkey"></td>
89           <td></td>
90           <td class="paramtype">const QString &amp;&nbsp;</td>
91           <td class="paramname"> <em>printOptions</em></td><td>&nbsp;</td>
92         </tr>
93         <tr>
94           <td></td>
95           <td>)</td>
96           <td></td><td></td><td><code> [slot]</code></td>
97         </tr>
98       </table>
99 </div>
100 <div class="memdoc">
101
102 <p>Print sigle file. </p>
103 <ul>
104 <li>path Path to file </li>
105 <li>printOptions cups print options for lp command</li>
106 </ul>
107 <p>When finished, emit <a class="el" href="class_urpo_job.html#ab931a6a72a6f49c8919dcd695197288e" title="Job finished (successed of failed).">finished()</a> signal </p>
108
109 <p>Definition at line <a class="el" href="printjob_8cpp_source.html#l00066">66</a> of file <a class="el" href="printjob_8cpp_source.html">printjob.cpp</a>.</p>
110
111 </div>
112 </div>
113 <a class="anchor" id="a167ee653ddcb9f5130b9f92fce279050"></a><!-- doxytag: member="PrintJob::startJob" ref="a167ee653ddcb9f5130b9f92fce279050" args="()" -->
114 <div class="memitem">
115 <div class="memproto">
116       <table class="memname">
117         <tr>
118           <td class="memname">void PrintJob::startJob </td>
119           <td>(</td>
120           <td class="paramname"></td>
121           <td>&nbsp;)&nbsp;</td>
122           <td><code> [virtual, slot]</code></td>
123         </tr>
124       </table>
125 </div>
126 <div class="memdoc">
127
128 <p>Do not use, thows execption! </p>
129 <p>This function exits only because of bad class planning. </p>
130 <dl class="note"><dt><b>Note:</b></dt><dd>Do NOT use!</dd></dl>
131 <dl><dt><b>Exceptions:</b></dt><dd>
132   <table border="0" cellspacing="2" cellpadding="0">
133     <tr><td valign="top"></td><td valign="top"><em>std::logic_error</em>&nbsp;</td><td>Thow error becouse this function is not for use! </td></tr>
134   </table>
135   </dd>
136 </dl>
137
138 <p>Implements <a class="el" href="class_urpo_job.html">UrpoJob</a>.</p>
139
140 <p>Definition at line <a class="el" href="printjob_8cpp_source.html#l00059">59</a> of file <a class="el" href="printjob_8cpp_source.html">printjob.cpp</a>.</p>
141
142 </div>
143 </div>
144 <hr/>The documentation for this class was generated from the following files:<ul>
145 <li>src/<a class="el" href="printjob_8h_source.html">printjob.h</a></li>
146 <li>src/<a class="el" href="printjob_8cpp_source.html">printjob.cpp</a></li>
147 </ul>
148 </div>
149 <hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Sep 27 18:46:05 2010 for Urpo by&nbsp;
150 <a href="http://www.doxygen.org/index.html">
151 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
152 </body>
153 </html>