Add www pages
[urpo] / www / apidoc / html / class_print_job.html
1 <!-- This comment will put IE 6, 7 and 8 in quirks mode -->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <title>Urpo: PrintJob Class Reference</title>
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <link href="search/search.css" rel="stylesheet" type="text/css"/>
9 <script type="text/javaScript" src="search/search.js"></script>
10 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
11 </head>
12 <body onload='searchBox.OnSelectItem(0);'>
13 <!-- Generated by Doxygen 1.6.3 -->
14 <script type="text/javascript"><!--
15 var searchBox = new SearchBox("searchBox", "search",false,'Search');
16 --></script>
17 <div class="navigation" id="top">
18   <div class="tabs">
19     <ul>
20       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
21       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
22       <li><a href="files.html"><span>Files</span></a></li>
23       <li>
24         <div id="MSearchBox" class="MSearchBoxInactive">
25         <img id="MSearchSelect" src="search/search.png"
26              onmouseover="return searchBox.OnSearchSelectShow()"
27              onmouseout="return searchBox.OnSearchSelectHide()"
28              alt=""/>
29         <input type="text" id="MSearchField" value="Search" accesskey="S"
30              onfocus="searchBox.OnSearchFieldFocus(true)" 
31              onblur="searchBox.OnSearchFieldFocus(false)" 
32              onkeyup="searchBox.OnSearchFieldChange(event)"/>
33         <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
34         </div>
35       </li>
36     </ul>
37   </div>
38   <div class="tabs">
39     <ul>
40       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
41       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
42       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
43     </ul>
44   </div>
45 </div>
46 <div class="contents">
47 <h1>PrintJob Class Reference</h1><!-- doxytag: class="PrintJob" --><!-- doxytag: inherits="UrpoJob" -->
48 <p>File printing job'.  
49 <a href="#_details">More...</a></p>
50
51 <p><code>#include &lt;<a class="el" href="printjob_8h_source.html">printjob.h</a>&gt;</code></p>
52 <div class="dynheader">
53 Inheritance diagram for PrintJob:</div>
54 <div class="dynsection">
55  <div class="center">
56   <img src="class_print_job.png" usemap="#PrintJob_map" alt=""/>
57   <map id="PrintJob_map" name="PrintJob_map">
58 <area href="class_urpo_job.html" alt="UrpoJob" shape="rect" coords="0,0,60,24"/>
59 </map>
60  </div>
61 </div>
62
63 <p><a href="class_print_job-members.html">List of all members.</a></p>
64 <table border="0" cellpadding="0" cellspacing="0">
65 <tr><td colspan="2"><h2>Public Slots</h2></td></tr>
66 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2dacf12d369e28e30a5955aba14d4fcf"></a><!-- doxytag: member="PrintJob::copyReady" ref="a2dacf12d369e28e30a5955aba14d4fcf" args="(bool success)" -->
67 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_print_job.html#a2dacf12d369e28e30a5955aba14d4fcf">copyReady</a> (bool success)</td></tr>
68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">When file has copied (internal use only). <br/></td></tr>
69 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af984397994fd563b0a0a810b77a68c2c"></a><!-- doxytag: member="PrintJob::printReady" ref="af984397994fd563b0a0a810b77a68c2c" args="(bool success)" -->
70 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_print_job.html#af984397994fd563b0a0a810b77a68c2c">printReady</a> (bool success)</td></tr>
71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">When files has printed (internal use only). <br/></td></tr>
72 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb65a2765ae36c2ceab60e5a868b54f8"></a><!-- doxytag: member="PrintJob::deleteReady" ref="adb65a2765ae36c2ceab60e5a868b54f8" args="(bool success)" -->
73 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_print_job.html#adb65a2765ae36c2ceab60e5a868b54f8">deleteReady</a> (bool success)</td></tr>
74 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">When file has deleted (internal use only). <br/></td></tr>
75 <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>
76 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print sigle file.  <a href="#a5ce2230a6599b03abefd3875a43ba62e"></a><br/></td></tr>
77 <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>
78 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Do not use, thows execption!  <a href="#a167ee653ddcb9f5130b9f92fce279050"></a><br/></td></tr>
79 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a7f1167cd9d660a3fa1c16276d8b6b0"></a><!-- doxytag: member="PrintJob::cancelJob" ref="a6a7f1167cd9d660a3fa1c16276d8b6b0" args="()" -->
80 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_print_job.html#a6a7f1167cd9d660a3fa1c16276d8b6b0">cancelJob</a> ()</td></tr>
81 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cancel printing job. <br/></td></tr>
82 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
83 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f58997ec199e807b1149e49423d8199"></a><!-- doxytag: member="PrintJob::PrintJob" ref="a6f58997ec199e807b1149e49423d8199" args="(UrpoConnection *connection)" -->
84 &nbsp;</td><td class="memItemRight" valign="bottom"><b>PrintJob</b> (<a class="el" href="class_urpo_connection.html">UrpoConnection</a> *connection)</td></tr>
85 </table>
86 <hr/><a name="_details"></a><h2>Detailed Description</h2>
87 <p>File printing job'. </p>
88 <dl class="author"><dt><b>Author:</b></dt><dd>Arto Hyvättinen </dd></dl>
89 <dl class="date"><dt><b>Date:</b></dt><dd>2010-06-17 </dd></dl>
90 <dl class="version"><dt><b>Version:</b></dt><dd>0.1</dd></dl>
91 <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>
92 <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>
93
94 <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>
95 <hr/><h2>Member Function Documentation</h2>
96 <a class="anchor" id="a5ce2230a6599b03abefd3875a43ba62e"></a><!-- doxytag: member="PrintJob::printFile" ref="a5ce2230a6599b03abefd3875a43ba62e" args="(const QString &amp;path, const QString &amp;printOptions)" -->
97 <div class="memitem">
98 <div class="memproto">
99       <table class="memname">
100         <tr>
101           <td class="memname">void PrintJob::printFile </td>
102           <td>(</td>
103           <td class="paramtype">const QString &amp;&nbsp;</td>
104           <td class="paramname"> <em>path</em>, </td>
105         </tr>
106         <tr>
107           <td class="paramkey"></td>
108           <td></td>
109           <td class="paramtype">const QString &amp;&nbsp;</td>
110           <td class="paramname"> <em>printOptions</em></td><td>&nbsp;</td>
111         </tr>
112         <tr>
113           <td></td>
114           <td>)</td>
115           <td></td><td></td><td><code> [slot]</code></td>
116         </tr>
117       </table>
118 </div>
119 <div class="memdoc">
120
121 <p>Print sigle file. </p>
122 <ul>
123 <li>path Path to file </li>
124 <li>printOptions cups print options for lp command</li>
125 </ul>
126 <p>When finished, emit <a class="el" href="class_urpo_job.html#ab931a6a72a6f49c8919dcd695197288e" title="Job finished (successed of failed).">finished()</a> signal </p>
127
128 <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>
129
130 </div>
131 </div>
132 <a class="anchor" id="a167ee653ddcb9f5130b9f92fce279050"></a><!-- doxytag: member="PrintJob::startJob" ref="a167ee653ddcb9f5130b9f92fce279050" args="()" -->
133 <div class="memitem">
134 <div class="memproto">
135       <table class="memname">
136         <tr>
137           <td class="memname">void PrintJob::startJob </td>
138           <td>(</td>
139           <td class="paramname"></td>
140           <td>&nbsp;)&nbsp;</td>
141           <td><code> [virtual, slot]</code></td>
142         </tr>
143       </table>
144 </div>
145 <div class="memdoc">
146
147 <p>Do not use, thows execption! </p>
148 <p>This function exits only because of bad class planning. </p>
149 <dl class="note"><dt><b>Note:</b></dt><dd>Do NOT use!</dd></dl>
150 <dl><dt><b>Exceptions:</b></dt><dd>
151   <table border="0" cellspacing="2" cellpadding="0">
152     <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>
153   </table>
154   </dd>
155 </dl>
156
157 <p>Implements <a class="el" href="class_urpo_job.html">UrpoJob</a>.</p>
158
159 <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>
160
161 </div>
162 </div>
163 <hr/>The documentation for this class was generated from the following files:<ul>
164 <li>/holvi/arto/ohjelmointi/urpo-0.0/urpo/<a class="el" href="printjob_8h_source.html">printjob.h</a></li>
165 <li>/holvi/arto/ohjelmointi/urpo-0.0/urpo/<a class="el" href="printjob_8cpp_source.html">printjob.cpp</a></li>
166 </ul>
167 </div>
168 <!--- window showing the filter options -->
169 <div id="MSearchSelectWindow"
170      onmouseover="return searchBox.OnSearchSelectShow()"
171      onmouseout="return searchBox.OnSearchSelectHide()"
172      onkeydown="return searchBox.OnSearchSelectKey(event)">
173 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Enumerator</a></div>
174
175 <!-- iframe showing the search results (closed by default) -->
176 <div id="MSearchResultsWindow">
177 <iframe src="" frameborder="0" 
178         name="MSearchResults" id="MSearchResults">
179 </iframe>
180 </div>
181
182 <hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Jun 21 21:38:16 2010 for Urpo by&nbsp;
183 <a href="http://www.doxygen.org/index.html">
184 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
185 </body>
186 </html>