<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <head> <title>KStatusBarJobTracker</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Style-Type" content="text/css" /> <link rel="stylesheet" type="text/css" href="../common/doxygen.css" /> <link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" /> </head> <body> <div id="container"> <div id="header"> <div id="header_top"> <div> <div> <img alt ="" src="../common/top-kde.jpg"/> KDE 4.9 PyKDE API Reference </div> </div> </div> <div id="header_bottom"> <div id="location"> <ul> <li>KDE's Python API</li> </ul> </div> <div id="menu"> <ul> <li><a href="../modules.html">Overview</a></li> <li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li> <li><a href="http://kde.org/family/">Sitemap</a></li> <li><a href="http://kde.org/contact/">Contact Us</a></li> </ul> </div> </div> </div> <div id="body_wrapper"> <div id="body"> <div id="right"> <div class="content"> <div id="main"> <div class="clearer"> </div> <h1>KStatusBarJobTracker Class Reference</h1> <code>from PyKDE4.kdeui import *</code> <p> Inherits: <a href="../kdeui/KAbstractWidgetJobTracker.html">KAbstractWidgetJobTracker</a> → <a href="../kdecore/KJobTrackerInterface.html">KJobTrackerInterface</a> → QObject<br /> <h2>Detailed Description</h2> <p>This class implements a job tracker with a widget suited for embedding in a status bar. </p> <table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#StatusBarMode">StatusBarMode</a> </td><td class="memItemRight" valign="bottom">{ NoInformation, LabelOnly, ProgressOnly }</td></tr> <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="#KStatusBarJobTracker">__init__</a> (self, QWidget parent=0, bool button=1)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#description">description</a> (self, <a href="../kdecore/KJob.html">KJob</a> job, QString title, (QString,QString) field1, (QString,QString) field2)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#percent">percent</a> (self, <a href="../kdecore/KJob.html">KJob</a> job, long percent)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#registerJob">registerJob</a> (self, <a href="../kdecore/KJob.html">KJob</a> job)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setStatusBarMode">setStatusBarMode</a> (self, <a href="../kdeui/KStatusBarJobTracker.html">KStatusBarJobTracker.StatusBarModes</a> statusBarMode)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#slotClean">slotClean</a> (self, <a href="../kdecore/KJob.html">KJob</a> job)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#speed">speed</a> (self, <a href="../kdecore/KJob.html">KJob</a> job, long value)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#totalAmount">totalAmount</a> (self, <a href="../kdecore/KJob.html">KJob</a> job, <a href="../kdecore/KJob.html#Unit">KJob.Unit</a> unit, long amount)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#unregisterJob">unregisterJob</a> (self, <a href="../kdecore/KJob.html">KJob</a> job)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QWidget </td><td class="memItemRight" valign="bottom"><a class="el" href="#widget">widget</a> (self, <a href="../kdecore/KJob.html">KJob</a> job)</td></tr> </table> <hr><h2>Method Documentation</h2><a class="anchor" name="KStatusBarJobTracker"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">__init__</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">QWidget </td> <td class="paramname"><em>parent=0</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>button=1</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Creates a new KStatusBarJobTracker </p> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>parent</em> </td><td> the parent of this object and of the widget displaying the job progresses <tr><td></td><td valign="top"><em>button</em> </td><td> true to display a stop button allowing to kill the job, false otherwise </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="description"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> description</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kdecore/KJob.html">KJob</a> </td> <td class="paramname"><em>job</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QString </td> <td class="paramname"><em>title</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">(QString,QString) </td> <td class="paramname"><em>field1</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">(QString,QString) </td> <td class="paramname"><em>field2</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>The following slots are inherited from KJobTrackerInterface. </p></div></div><a class="anchor" name="percent"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> percent</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kdecore/KJob.html">KJob</a> </td> <td class="paramname"><em>job</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">long </td> <td class="paramname"><em>percent</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"></div></div><a class="anchor" name="registerJob"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> registerJob</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kdecore/KJob.html">KJob</a> </td> <td class="paramname"><em>job</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Register a new job in this tracker. </p> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>job</em> </td><td> the job to register </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="setStatusBarMode"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setStatusBarMode</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kdeui/KStatusBarJobTracker.html">KStatusBarJobTracker.StatusBarModes</a> </td> <td class="paramname"><em>statusBarMode</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Sets the mode of the status bar. </p> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>statusBarMode</em> </td><td> what information the status bar will show (see StatusBarMode). LabelOnly by default </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="slotClean"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> slotClean</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kdecore/KJob.html">KJob</a> </td> <td class="paramname"><em>job</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"></div></div><a class="anchor" name="speed"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> speed</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kdecore/KJob.html">KJob</a> </td> <td class="paramname"><em>job</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">long </td> <td class="paramname"><em>value</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"></div></div><a class="anchor" name="totalAmount"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> totalAmount</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kdecore/KJob.html">KJob</a> </td> <td class="paramname"><em>job</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kdecore/KJob.html#Unit">KJob.Unit</a> </td> <td class="paramname"><em>unit</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">long </td> <td class="paramname"><em>amount</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"></div></div><a class="anchor" name="unregisterJob"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> unregisterJob</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kdecore/KJob.html">KJob</a> </td> <td class="paramname"><em>job</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Unregister a job from this tracker. </p> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>job</em> </td><td> the job to unregister </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="widget"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QWidget widget</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kdecore/KJob.html">KJob</a> </td> <td class="paramname"><em>job</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>The widget associated to this tracker. </p> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the widget displaying the job progresses </dd></dl> </p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="StatusBarMode"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">StatusBarMode</td> </tr> </table> </div> <div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>NoInformation</em> = 0x0000</td><td><tr><td valign="top"><em>LabelOnly</em> = 0x0001</td><td><tr><td valign="top"><em>ProgressOnly</em> = 0x0002</td><td></table> </dl> </div></div><p> </div> </div> </div> <div id="left"> <div class="menu_box"> <div class="nav_list"> <ul> <li><a href="../allclasses.html">Full Index</a></li> </ul> </div> <a name="cp-menu" /><div class="menutitle"><div> <h2 id="cp-menu-project">Modules</h2> </div></div> <div class="nav_list"> <ul><li><a href="../akonadi/index.html">akonadi</a></li> <li><a href="../dnssd/index.html">dnssd</a></li> <li><a href="../kdecore/index.html">kdecore</a></li> <li><a href="../kdeui/index.html">kdeui</a></li> <li><a href="../khtml/index.html">khtml</a></li> <li><a href="../kio/index.html">kio</a></li> <li><a href="../knewstuff/index.html">knewstuff</a></li> <li><a href="../kparts/index.html">kparts</a></li> <li><a href="../kutils/index.html">kutils</a></li> <li><a href="../nepomuk/index.html">nepomuk</a></li> <li><a href="../phonon/index.html">phonon</a></li> <li><a href="../plasma/index.html">plasma</a></li> <li><a href="../polkitqt/index.html">polkitqt</a></li> <li><a href="../solid/index.html">solid</a></li> <li><a href="../soprano/index.html">soprano</a></li> </ul></div></div> </div> </div> <div class="clearer"/> </div> <div id="end_body"></div> </div> <div id="footer"><div id="footer_text"> This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br /> 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> | <a href="http://www.kde.org/contact/impressum.php">Legal</a> </div></div> </body> </html>