vcs.maemo.org Git - urpo/blob - www/apidoc/html/urpojob_8h_source.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: /holvi/arto/ohjelmointi/urpo-0.0/urpo/urpojob.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
  22       <li class="current"><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="files.html"><span>File&nbsp;List</span></a></li>
  41     </ul>
  42   </div>
  43 <h1>/holvi/arto/ohjelmointi/urpo-0.0/urpo/urpojob.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/**************************************************************************</span>
  44 <a name="l00002"></a>00002 <span class="comment"></span>
  45 <a name="l00003"></a>00003 <span class="comment">    URPO</span>
  46 <a name="l00004"></a>00004 <span class="comment"></span>
  47 <a name="l00005"></a>00005 <span class="comment">    Unix Remote Printing Operation</span>
  48 <a name="l00006"></a>00006 <span class="comment">    Copyright (c) Arto Hyvättinen 2010</span>
  49 <a name="l00007"></a>00007 <span class="comment"></span>
  50 <a name="l00008"></a>00008 <span class="comment">    This file is part of URPO.</span>
  51 <a name="l00009"></a>00009 <span class="comment"></span>
  52 <a name="l00010"></a>00010 <span class="comment">    URPO is free software: you can redistribute it and/or modify</span>
  53 <a name="l00011"></a>00011 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
  54 <a name="l00012"></a>00012 <span class="comment">    the Free Software Foundation, either version 3 of the License, or</span>
  55 <a name="l00013"></a>00013 <span class="comment">    (at your option) any later version.</span>
  56 <a name="l00014"></a>00014 <span class="comment"></span>
  57 <a name="l00015"></a>00015 <span class="comment">    URPO is distributed in the hope that it will be useful,</span>
  58 <a name="l00016"></a>00016 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  59 <a name="l00017"></a>00017 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
  60 <a name="l00018"></a>00018 <span class="comment">    GNU General Public License for more details.</span>
  61 <a name="l00019"></a>00019 <span class="comment"></span>
  62 <a name="l00020"></a>00020 <span class="comment"></span>
  63 <a name="l00021"></a>00021 <span class="comment">**************************************************************************/</span>
  64 <a name="l00022"></a>00022
  65 <a name="l00023"></a>00023 <span class="preprocessor">#ifndef URPOJOB_H</span>
  66 <a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define URPOJOB_H</span>
  67 <a name="l00025"></a>00025 <span class="preprocessor"></span>
  68 <a name="l00026"></a>00026 <span class="preprocessor">#include &lt;QObject&gt;</span>
  69 <a name="l00027"></a>00027
  70 <a name="l00028"></a>00028 <span class="preprocessor">#include &quot;urpoprocess.h&quot;</span>
  71 <a name="l00029"></a>00029 <span class="keyword">class </span><a class="code" href="class_urpo_connection.html" title="Information about ssh connection (abstract).">UrpoConnection</a>;
  72 <a name="l00030"></a>00030
  73 <a name="l00040"></a><a class="code" href="class_urpo_job.html">00040</a> <span class="keyword">class </span><a class="code" href="class_urpo_job.html" title="Base class for jobs (abstract).">UrpoJob</a> : <span class="keyword">public</span> QObject
  74 <a name="l00041"></a>00041 {
  75 <a name="l00042"></a>00042     Q_OBJECT
  76 <a name="l00043"></a>00043 <span class="keyword">public</span>:
  77 <a name="l00044"></a>00044     <span class="keyword">explicit</span> <a class="code" href="class_urpo_job.html" title="Base class for jobs (abstract).">UrpoJob</a>(<a class="code" href="class_urpo_connection.html" title="Information about ssh connection (abstract).">UrpoConnection</a>* connection);
  78 <a name="l00045"></a>00045
  79 <a name="l00046"></a>00046
  80 <a name="l00047"></a>00047     <span class="keyword">enum</span> JobStatus {
  81 <a name="l00048"></a>00048         Ready,
  82 <a name="l00049"></a>00049         Running,
  83 <a name="l00050"></a>00050         Successed,
  84 <a name="l00051"></a>00051         Failed,
  85 <a name="l00052"></a>00052         Cancelled
  86 <a name="l00053"></a>00053     };
  87 <a name="l00054"></a>00054
  88 <a name="l00059"></a><a class="code" href="class_urpo_job.html#af07522b7d875bfc36a694f07d580fc8b">00059</a>     JobStatus <a class="code" href="class_urpo_job.html#af07522b7d875bfc36a694f07d580fc8b" title="Job status.">getStatus</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> status_; }
  89 <a name="l00060"></a>00060
  90 <a name="l00061"></a>00061 signals:
  91 <a name="l00062"></a>00062     <span class="keywordtype">void</span> debugMessage(QString message);
  92 <a name="l00066"></a>00066     <span class="keywordtype">void</span> <a class="code" href="class_urpo_job.html#ab931a6a72a6f49c8919dcd695197288e" title="Job finished (successed of failed).">finished</a>(<span class="keywordtype">bool</span> successed, QString errorStr = QString());
  93 <a name="l00067"></a>00067
  94 <a name="l00068"></a>00068 <span class="keyword">public</span> slots:
  95 <a name="l00070"></a><a class="code" href="class_urpo_job.html#ae4549ace1bc2331462d22281b8cbdf0f">00070</a>     <span class="keywordtype">void</span> <a class="code" href="class_urpo_job.html#ae4549ace1bc2331462d22281b8cbdf0f" title="Start job.">start</a>() { startJob(); }
  96 <a name="l00072"></a><a class="code" href="class_urpo_job.html#a652109c42b7d8493a335d07ade7a0b0b">00072</a>     <span class="keywordtype">void</span> <a class="code" href="class_urpo_job.html#a652109c42b7d8493a335d07ade7a0b0b" title="Cancel job.">cancel</a>() { cancelJob(); }
  97 <a name="l00073"></a>00073
  98 <a name="l00074"></a>00074
  99 <a name="l00075"></a>00075 <span class="keyword">protected</span>:
 100 <a name="l00076"></a>00076     <span class="keyword">virtual</span> <span class="keywordtype">void</span> startJob() = 0;
 101 <a name="l00077"></a>00077     <span class="keyword">virtual</span> <span class="keywordtype">void</span> cancelJob() = 0;
 102 <a name="l00080"></a>00080     <span class="keywordtype">void</span> <a class="code" href="class_urpo_job.html#adca3f19275978d0514229c26871e8a19" title="Finish job.">finish</a>(JobStatus status);
 103 <a name="l00084"></a>00084     <span class="keywordtype">void</span> <a class="code" href="class_urpo_job.html#a79d4688e55e26b373e103cb7238df9b6" title="Finish failed job.">fail</a>(QString errorString);
 104 <a name="l00086"></a><a class="code" href="class_urpo_job.html#a5c06ededd10c78ca736df20e1df1e269">00086</a>     <a class="code" href="class_urpo_connection.html" title="Information about ssh connection (abstract).">UrpoConnection</a>* <a class="code" href="class_urpo_job.html#a5c06ededd10c78ca736df20e1df1e269" title="Get connection pointer.">getConnection</a>() { <span class="keywordflow">return</span> connection_; }
 105 <a name="l00087"></a>00087
 106 <a name="l00095"></a>00095     <span class="keywordtype">void</span> <a class="code" href="class_urpo_job.html#a6105276a7d9c7431aa5f24d374e33f84" title="Send debug message.">sendDebugMessage</a>(QString message);
 107 <a name="l00096"></a>00096
 108 <a name="l00098"></a>00098     <a class="code" href="class_urpo_process.html" title="Process running ssh/scp command.">UrpoProcess</a>* <a class="code" href="class_urpo_job.html#ab54ee3b2ba06bfc71c310c746a846c48" title="Create new UrpoProcess.">newProcess</a>();
 109 <a name="l00099"></a>00099
 110 <a name="l00101"></a><a class="code" href="class_urpo_job.html#a89534d211decc6ab45de2b468045eef1">00101</a>     <span class="keywordtype">void</span> <a class="code" href="class_urpo_job.html#a89534d211decc6ab45de2b468045eef1" title="Set job status.">setStatus</a>(JobStatus status) { status_ = status; }
 111 <a name="l00102"></a>00102
 112 <a name="l00103"></a>00103 <span class="keyword">private</span>:
 113 <a name="l00104"></a>00104     <a class="code" href="class_urpo_connection.html" title="Information about ssh connection (abstract).">UrpoConnection</a>* connection_;
 114 <a name="l00105"></a>00105     JobStatus status_;
 115 <a name="l00106"></a>00106
 116 <a name="l00107"></a>00107 };
 117 <a name="l00108"></a>00108
 118 <a name="l00109"></a>00109 <span class="preprocessor">#endif // URPOJOB_H</span>
 119 </pre></div></div>
 120 <!--- window showing the filter options -->
 121 <div id="MSearchSelectWindow"
 122      onmouseover="return searchBox.OnSearchSelectShow()"
 123      onmouseout="return searchBox.OnSearchSelectHide()"
 124      onkeydown="return searchBox.OnSearchSelectKey(event)">
 125 <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>
 126
 127 <!-- iframe showing the search results (closed by default) -->
 128 <div id="MSearchResultsWindow">
 129 <iframe src="" frameborder="0"
 130         name="MSearchResults" id="MSearchResults">
 131 </iframe>
 132 </div>
 133
 134 <hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Jun 21 21:38:16 2010 for Urpo by&nbsp;
 135 <a href="http://www.doxygen.org/index.html">
 136 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 137 </body>
 138 </html>