~ubuntu-branches/ubuntu/lucid/kdebindings/lucid-updates

Inherits: <a href="../kdecore/KJob.html">KJob</a> → <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a><br />

Namespace: Plasma<br />

<h2>Detailed Description</h2>

<p>ServiceJob plasma/servicejob.h <Plasma/ServiceJob>

</p>

<p>

This class provides jobs for use with Plasma.Service

</p>

<p>

Unlike KJob, you can do the work in start(), since Plasma.Service already

delays the call to start() until the event loop is reached.

</p>

<p>

If the job is quick enough that it is not worth reporting the progress,

you just need to implement start() to do the task, then call emitResult()

at the end of it. If the task does not complete successfully, you should

set a non-zero error code with setError(int) and an error message with

setErrorText(QString).

</p>

<p>

If the job is longer (involving network access, for instance), you should

report the progress at regular intervals. See the KJob documentation for

information on how to do this.

</p>

<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Methods</h2></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#obj151115852">__init__</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> destination, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> operation, QMap<QString,QVariant> parameters, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> parent=0)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#obj176586188">destination</a> (self)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">QMap<QString,QVariant> </td><td class="memItemRight" valign="bottom"><a class="el" href="#obj186824908">parameters</a> (self)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qvariant.html">QVariant</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#obj178041644">result</a> (self)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#obj178042892">setResult</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qvariant.html">QVariant</a> result)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#obj178042060">start</a> (self)</td></tr>

</table>

<hr><h2>Method Documentation</h2><a class="anchor" name="obj151115852"></a>

</tr><tr>

<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>

<td class="paramname"><em>destination</em>, </td>

</tr>

100

<tr>

101

102

103

<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>

104

<td class="paramname"><em>operation</em>, </td>

105

</tr>

106

<tr>

107

108

109

110

<td class="paramname"><em>parameters</em>, </td>

111

</tr>

112

<tr>

113

114

115

<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> </td>

116

<td class="paramname"><em>parent=0</em></td>

117

</tr>

118

<tr>

119

120

121

122

123

124

</tr></table>

125

</div>

126

<div class="memdoc"><p>Default constructor

127

</p>

128

<p>

129

@arg destination the subject that the job is acting on

130

@arg operation the action that the job is performing on the <b>destination</b>

131

@arg parameters the parameters of the <b>action</b>

132

@arg parent the parent object for this service

133

</p></div></div><a class="anchor" name="obj176586188"></a>

134

135

136

137

<td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> destination</td>

138

139

140

141

142

</tr>

143

</table>

144

</div>

145

<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the subject that the job is acting on

146

</dd></dl>

147

</p></div></div><a class="anchor" name="obj181372332"></a>

148

149

150

151

<td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> operationName</td>

152

153

154

155

156

</tr>

157

</table>

158

</div>

159

<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the operation the job is performing on the destination

160

</dd></dl>

161

</p></div></div><a class="anchor" name="obj186824908"></a>

162

163

164

165

<td class="memname">QMap<QString,QVariant> parameters</td>

166

167

168

169

170

</tr>

171

</table>

172

</div>

173

<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the parameters for the operation

174

</dd></dl>

175

</p></div></div><a class="anchor" name="obj178041644"></a>

176

177

178

179

<td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qvariant.html">QVariant</a> result</td>

180

181

182

183

184

</tr>

185

</table>

186

</div>

187

<div class="memdoc"><p>Returns the result of the operation

188

</p>

189

<p>

190

The result will be invalid if the job has not completed yet, or

191

if the job does not have a meaningful result.

192

</p>

193

<p>

194

Note that this should not be used to find out whether the operation

195

was successful. Instead, you should check the value of error().

196

</p>

197

<p>

198

<dl class="return" compact><dt><b>Returns:</b></dt><dd> the result of the operation

199

</dd></dl>

200

</p></div></div><a class="anchor" name="obj178042892"></a>

201

202

203

204

<td class="memname"> setResult</td>

205

206

207

208

</tr><tr>

209

210

211

<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qvariant.html">QVariant</a> </td>

212

<td class="paramname"><em>result</em></td>

213

</tr>

214

<tr>

215

216

217

218

219

220

</tr></table>

221

</div>

222

<div class="memdoc"><p>Sets the result for an operation.

223

</p></div></div><a class="anchor" name="obj178042060"></a>

224

225

226

227

<td class="memname"> start</td>

228

229

230

231

232

</tr>

233

</table>

234

</div>

235

<div class="memdoc"><p>Default implementation of start, which simply sets the results to false.

236

This makes it easy to create a "failure" job.

237

</p></div></div>

238

</div>

239

</div>

240

</div>

241

242

243

244

245

246

<ul>

247

<li><a href="../allclasses.html">Full Index</a></li>

248

</ul>

249

</div>

250

251

252

<h2 id="cp-menu-project">Modules</h2>

253

</div></div>

254

255

<ul>

256

<li><a href="../akonadi/index.html">akonadi</a></li>

257

<li><a href="../dnssd/index.html">dnssd</a></li>

258

<li><a href="../kdecore/index.html">kdecore</a></li>

259

<li><a href="../kdeui/index.html">kdeui</a></li>

260

<li><a href="../khtml/index.html">khtml</a></li>

261

262

<li><a href="../knewstuff/index.html">knewstuff</a></li>

263

<li><a href="../kparts/index.html">kparts</a></li>

264

<li><a href="../kutils/index.html">kutils</a></li>

265

<li><a href="../nepomuk/index.html">nepomuk</a></li>

266

<li><a href="../phonon/index.html">phonon</a></li>

267

<li><a href="../plasma/index.html">plasma</a></li>

268

<li><a href="../polkitqt/index.html">polkitqt</a></li>

269

<li><a href="../solid/index.html">solid</a></li>

270

<li><a href="../soprano/index.html">soprano</a></li>

271

</ul></div></div>

272

273

</div>

274

275

</div>

276

277

</div>

278

279

280

</div>

281

282

This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />

283

KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |

284

<a href="http://www.kde.org/contact/impressum.php">Legal</a>

285

</div></div>

286

</body>

287

</html>

Older »