Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > by-pkgid > 98d6b53e11e983e268c3e19f14e091a0 > files > 4182

kdepim-devel-doc-3.5.9-9mdv2008.1.x86_64.rpm

<?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_US" xml:lang="en_US">

<head>
  <title>libkdepim: KPIM::ProgressManager Class Reference (libkdepim)</title>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

  <meta http-equiv="Content-Style-Type" content="text/css" />

  <meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org"  r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org"  r (n 0 s 0 v 0 l 0))' />

  <meta name="trademark" content="KDE e.V." />
  <meta name="description" content="K Desktop Environment Homepage, KDE.org" />
  <meta name="MSSmartTagsPreventParsing" content="true" />
  <meta name="robots" content="all" />

  <link rel="shortcut icon" href="../../favicon.ico" />

<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />



<style type="text/css">
<!--
hr { display: none; }
#content h2 { margin-left: 0px; }
table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; }
td.mdRow { padding: 8px 20px; }
td.md { font-weight: bold; }
td.mdname1 { font-weight: bold; color: #602020; }
td.mdname { font-weight: bold; color: #602020;  }

-->
</style>

</head>

<body>

<div id="nav_header_top" align="right">
  <a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>

  <a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
  <span class="doNotDisplay">::</span>
  <img id="nav_header_logo_right" alt="" align="right" src="../../pimlogo.png" border="0" />

  <div id="nav_header_title" align="left">KDE PIM API Reference</div>


</div>

<div id="nav_header_bottom" align="right">
  <span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
  <div id="nav_header_bottom_left" style="text-align: left;">
/ <a href="../../">API Reference</a>
 / <a href=".">libkdepim</a>
  </div>
</div>


<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
      <td valign="top" class="menuheader" height="0"></td>

  <td id="contentcolumn" valign="top" rowspan="2" >
    <div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
    <h2><a name="content"></a>libkdepim</h2>


<!-- Generated by Doxygen 1.5.5 -->
  <div class="navpath"><a class="el" href="namespaceKPIM.html">KPIM</a>::<a class="el" href="classKPIM_1_1ProgressManager.html">ProgressManager</a>
  </div>
<div class="contents">
<h1>KPIM::ProgressManager Class Reference</h1><!-- doxytag: class="KPIM::ProgressManager" --><!-- doxytag: inherits="QObject" --><code>#include &lt;<a class="el" href="progressmanager_8h-source.html">progressmanager.h</a>&gt;</code>
<p>
Inherits QObject.
<p>

<p>
<a href="classKPIM_1_1ProgressManager-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classKPIM_1_1ProgressManager.html" title="The ProgressManager singleton keeps track of all ongoing transactions and notifies...">ProgressManager</a> singleton keeps track of all ongoing transactions and notifies observers (progress dialogs) when their progress percent value changes, when they are completed (by their owner), and when they are canceled. 
<p>
Each ProgressItem emits those signals individually and the singleton broadcasts them. Use the createProgressItem() statics to acquire an item and then call -&gt;setProgress( int percent ) on it everytime you want to update the item and -&gt;setComplete() when the operation is done. This will delete the item. Connect to the item's <a class="el" href="classKPIM_1_1ProgressManager.html#402059dcac18f09541475435e22eff89">progressItemCanceled()</a> signal to be notified when the user cancels the transaction using one of the observing progress dialogs or by calling item-&gt;cancel() in some other way. The owner is responsible for calling setComplete() on the item, even if it is canceled. Use the standardCancelHandler() slot if that is all you want to do on cancel.<p>
Note that if you request an item with a certain id and there is already one with that id, there will not be a new one created but the existing one will be returned. This is convenient for accessing items that are needed regularly without the to store a pointer to them or to add child items to parents by id. 
<p>Definition at line <a class="el" href="progressmanager_8h-source.html#l00243">243</a> of file <a class="el" href="progressmanager_8h-source.html">progressmanager.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Slots</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ProgressManager.html#7fa9eb3ecf8b653ab06a07b029a4d9eb">slotStandardCancelHandler</a> (KPIM::ProgressItem *item)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ProgressManager.html#69d92194f4ffcbcecba2a1e36cb547f6">slotAbortAll</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ProgressManager.html#0cd0f7ff2de4ef4153a00e96cec9f0f1">progressItemAdded</a> (KPIM::ProgressItem *)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ProgressManager.html#c569977fcff7c46d8795b920995fe39e">progressItemProgress</a> (KPIM::ProgressItem *, unsigned int)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ProgressManager.html#ccc6deda7305e9c3f447936c8b50a661">progressItemCompleted</a> (KPIM::ProgressItem *)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ProgressManager.html#402059dcac18f09541475435e22eff89">progressItemCanceled</a> (KPIM::ProgressItem *)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ProgressManager.html#bc449055a5edeea0259eab0eff4ed54a">progressItemStatus</a> (KPIM::ProgressItem *, const QString &amp;)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ProgressManager.html#449c9e0571d6a812a327b0870aa87a6f">progressItemLabel</a> (KPIM::ProgressItem *, const QString &amp;)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ProgressManager.html#f143002b305842c170f719c089d7002e">progressItemUsesCrypto</a> (KPIM::ProgressItem *, bool)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ProgressManager.html#ce0446470f2af127aba1cae61583d58a">showProgressDialog</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ProgressManager.html#688178e0f978498251cf01188c351a71">isEmpty</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">ProgressItem *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ProgressManager.html#fe6f45ccab730d241acbf07b9d2b3ce5">singleItem</a> () const </td></tr>

<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classKPIM_1_1ProgressManager.html">ProgressManager</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ProgressManager.html#5db2b8e0007b802e2727a6894b56a145">instance</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ProgressManager.html#cd9a5c49c32c04281d0766e2799a05ee">getUniqueID</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static ProgressItem *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ProgressManager.html#025f6962c2fd637e3e761129820c2c88">createProgressItem</a> (const QString &amp;label)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static ProgressItem *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ProgressManager.html#b0960ecf729149e5a6a3be6aa0c0a1c5">createProgressItem</a> (ProgressItem *parent, const QString &amp;id, const QString &amp;label, const QString &amp;status=QString::null, bool canBeCanceled=true, bool usesCrypto=false)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static ProgressItem *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ProgressManager.html#ee0ec1e02224a1a7dafd368caad6f32d">createProgressItem</a> (const QString &amp;parent, const QString &amp;id, const QString &amp;label, const QString &amp;status=QString::null, bool canBeCanceled=true, bool usesCrypto=false)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static ProgressItem *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ProgressManager.html#ba63ca6a74b05a11697b89dfe96b43ba">createProgressItem</a> (const QString &amp;id, const QString &amp;label, const QString &amp;status=QString::null, bool canBeCanceled=true, bool usesCrypto=false)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1ProgressManager.html#034e6c1c92e408c045a44a6dddc74a6c">emitShowProgressDialog</a> ()</td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5db2b8e0007b802e2727a6894b56a145"></a><!-- doxytag: member="KPIM::ProgressManager::instance" ref="5db2b8e0007b802e2727a6894b56a145" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classKPIM_1_1ProgressManager.html">ProgressManager</a> * KPIM::ProgressManager::instance           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The singleton instance of this class. </dd></dl>

<p>Definition at line <a class="el" href="progressmanager_8cpp-source.html#l00135">135</a> of file <a class="el" href="progressmanager_8cpp-source.html">progressmanager.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="cd9a5c49c32c04281d0766e2799a05ee"></a><!-- doxytag: member="KPIM::ProgressManager::getUniqueID" ref="cd9a5c49c32c04281d0766e2799a05ee" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static QString KPIM::ProgressManager::getUniqueID           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Use this to aquire a unique id number which can be used to discern an operation from all others going on at the same time. 
<p>
Use that number as the id string for your progressItem to ensure it is unique. <dl class="return" compact><dt><b>Returns:</b></dt><dd></dd></dl>

<p>Definition at line <a class="el" href="progressmanager_8h-source.html#l00262">262</a> of file <a class="el" href="progressmanager_8h-source.html">progressmanager.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="025f6962c2fd637e3e761129820c2c88"></a><!-- doxytag: member="KPIM::ProgressManager::createProgressItem" ref="025f6962c2fd637e3e761129820c2c88" args="(const QString &amp;label)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static ProgressItem* KPIM::ProgressManager::createProgressItem           </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>label</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Creates a ProgressItem with a unique id and the given label. 
<p>
This is the simplest way to aquire a progress item. It will not have a parent and will be set to be cancellable and not using crypto.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>label</em>&nbsp;</td><td>The text to be displayed by progress handlers. It will be interpreted as rich text, so it might have to be escaped. </td></tr>
  </table>
</dl>

<p>Definition at line <a class="el" href="progressmanager_8h-source.html#l00272">272</a> of file <a class="el" href="progressmanager_8h-source.html">progressmanager.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="b0960ecf729149e5a6a3be6aa0c0a1c5"></a><!-- doxytag: member="KPIM::ProgressManager::createProgressItem" ref="b0960ecf729149e5a6a3be6aa0c0a1c5" args="(ProgressItem *parent, const QString &amp;id, const QString &amp;label, const QString &amp;status=QString::null, bool canBeCanceled=true, bool usesCrypto=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static ProgressItem* KPIM::ProgressManager::createProgressItem           </td>
          <td>(</td>
          <td class="paramtype">ProgressItem *&nbsp;</td>
          <td class="paramname"> <em>parent</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>label</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>status</em> = <code>QString::null</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>canBeCanceled</em> = <code>true</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>usesCrypto</em> = <code>false</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Creates a new progressItem with the given parent, id, label and initial status. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>parent</em>&nbsp;</td><td>Specify an already existing item as the parent of this one. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>Used to identify this operation for cancel and progress info. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>label</em>&nbsp;</td><td>The text to be displayed by progress handlers. It will be interpreted as rich text, so it might have to be escaped. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>status</em>&nbsp;</td><td>Additional text to be displayed for the item. It will be interpreted as rich text, so it might have to be escaped. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>canBeCanceled</em>&nbsp;</td><td>can the user cancel this operation? </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>usesCrypto</em>&nbsp;</td><td>does the operation use secure transports (SSL) Cancelling the parent will cancel the children as well (if they can be cancelled) and ongoing children prevent parents from finishing. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The ProgressItem representing the operation. </dd></dl>

<p>Definition at line <a class="el" href="progressmanager_8h-source.html#l00293">293</a> of file <a class="el" href="progressmanager_8h-source.html">progressmanager.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="ee0ec1e02224a1a7dafd368caad6f32d"></a><!-- doxytag: member="KPIM::ProgressManager::createProgressItem" ref="ee0ec1e02224a1a7dafd368caad6f32d" args="(const QString &amp;parent, const QString &amp;id, const QString &amp;label, const QString &amp;status=QString::null, bool canBeCanceled=true, bool usesCrypto=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static ProgressItem* KPIM::ProgressManager::createProgressItem           </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>parent</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>label</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>status</em> = <code>QString::null</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>canBeCanceled</em> = <code>true</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>usesCrypto</em> = <code>false</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Use this version if you have the id string of the parent and want to add a subjob to it. 
<p>

<p>Definition at line <a class="el" href="progressmanager_8h-source.html#l00307">307</a> of file <a class="el" href="progressmanager_8h-source.html">progressmanager.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="ba63ca6a74b05a11697b89dfe96b43ba"></a><!-- doxytag: member="KPIM::ProgressManager::createProgressItem" ref="ba63ca6a74b05a11697b89dfe96b43ba" args="(const QString &amp;id, const QString &amp;label, const QString &amp;status=QString::null, bool canBeCanceled=true, bool usesCrypto=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static ProgressItem* KPIM::ProgressManager::createProgressItem           </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>label</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>status</em> = <code>QString::null</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>canBeCanceled</em> = <code>true</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>usesCrypto</em> = <code>false</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Version without a parent. 
<p>

<p>Definition at line <a class="el" href="progressmanager_8h-source.html#l00320">320</a> of file <a class="el" href="progressmanager_8h-source.html">progressmanager.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="688178e0f978498251cf01188c351a71"></a><!-- doxytag: member="KPIM::ProgressManager::isEmpty" ref="688178e0f978498251cf01188c351a71" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool KPIM::ProgressManager::isEmpty           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true when there is no more progress item </dd></dl>

<p>Definition at line <a class="el" href="progressmanager_8h-source.html#l00333">333</a> of file <a class="el" href="progressmanager_8h-source.html">progressmanager.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="fe6f45ccab730d241acbf07b9d2b3ce5"></a><!-- doxytag: member="KPIM::ProgressManager::singleItem" ref="fe6f45ccab730d241acbf07b9d2b3ce5" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ProgressItem * KPIM::ProgressManager::singleItem           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the only top level progressitem when there's only one. Returns 0 if there is no item, or more than one top level item. </dd></dl>

<p>Definition at line <a class="el" href="progressmanager_8cpp-source.html#l00210">210</a> of file <a class="el" href="progressmanager_8cpp-source.html">progressmanager.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="034e6c1c92e408c045a44a6dddc74a6c"></a><!-- doxytag: member="KPIM::ProgressManager::emitShowProgressDialog" ref="034e6c1c92e408c045a44a6dddc74a6c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void KPIM::ProgressManager::emitShowProgressDialog           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Ask all listeners to show the progress dialog, because there is something that wants to be shown. 
<p>

<p>Definition at line <a class="el" href="progressmanager_8h-source.html#l00345">345</a> of file <a class="el" href="progressmanager_8h-source.html">progressmanager.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="0cd0f7ff2de4ef4153a00e96cec9f0f1"></a><!-- doxytag: member="KPIM::ProgressManager::progressItemAdded" ref="0cd0f7ff2de4ef4153a00e96cec9f0f1" args="(KPIM::ProgressItem *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void KPIM::ProgressManager::progressItemAdded           </td>
          <td>(</td>
          <td class="paramtype">KPIM::ProgressItem *&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [signal]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd>ProgressItem::progressItemAdded() </dd></dl>

</div>
</div><p>
<a class="anchor" name="c569977fcff7c46d8795b920995fe39e"></a><!-- doxytag: member="KPIM::ProgressManager::progressItemProgress" ref="c569977fcff7c46d8795b920995fe39e" args="(KPIM::ProgressItem *, unsigned int)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void KPIM::ProgressManager::progressItemProgress           </td>
          <td>(</td>
          <td class="paramtype">KPIM::ProgressItem *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&nbsp;</td>
          <td class="paramname"> <em>int</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [signal]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd>ProgressItem::progressItemProgress() </dd></dl>

</div>
</div><p>
<a class="anchor" name="ccc6deda7305e9c3f447936c8b50a661"></a><!-- doxytag: member="KPIM::ProgressManager::progressItemCompleted" ref="ccc6deda7305e9c3f447936c8b50a661" args="(KPIM::ProgressItem *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void KPIM::ProgressManager::progressItemCompleted           </td>
          <td>(</td>
          <td class="paramtype">KPIM::ProgressItem *&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [signal]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd>ProgressItem::progressItemCompleted() </dd></dl>

</div>
</div><p>
<a class="anchor" name="402059dcac18f09541475435e22eff89"></a><!-- doxytag: member="KPIM::ProgressManager::progressItemCanceled" ref="402059dcac18f09541475435e22eff89" args="(KPIM::ProgressItem *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void KPIM::ProgressManager::progressItemCanceled           </td>
          <td>(</td>
          <td class="paramtype">KPIM::ProgressItem *&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [signal]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd>ProgressItem::progressItemCanceled() </dd></dl>

</div>
</div><p>
<a class="anchor" name="bc449055a5edeea0259eab0eff4ed54a"></a><!-- doxytag: member="KPIM::ProgressManager::progressItemStatus" ref="bc449055a5edeea0259eab0eff4ed54a" args="(KPIM::ProgressItem *, const QString &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void KPIM::ProgressManager::progressItemStatus           </td>
          <td>(</td>
          <td class="paramtype">KPIM::ProgressItem *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [signal]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd>ProgressItem::progressItemStatus() </dd></dl>

</div>
</div><p>
<a class="anchor" name="449c9e0571d6a812a327b0870aa87a6f"></a><!-- doxytag: member="KPIM::ProgressManager::progressItemLabel" ref="449c9e0571d6a812a327b0870aa87a6f" args="(KPIM::ProgressItem *, const QString &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void KPIM::ProgressManager::progressItemLabel           </td>
          <td>(</td>
          <td class="paramtype">KPIM::ProgressItem *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [signal]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd>ProgressItem::progressItemLabel() </dd></dl>

</div>
</div><p>
<a class="anchor" name="f143002b305842c170f719c089d7002e"></a><!-- doxytag: member="KPIM::ProgressManager::progressItemUsesCrypto" ref="f143002b305842c170f719c089d7002e" args="(KPIM::ProgressItem *, bool)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void KPIM::ProgressManager::progressItemUsesCrypto           </td>
          <td>(</td>
          <td class="paramtype">KPIM::ProgressItem *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [signal]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd>ProgressItem::progressItemUsesCrypto() </dd></dl>

</div>
</div><p>
<a class="anchor" name="ce0446470f2af127aba1cae61583d58a"></a><!-- doxytag: member="KPIM::ProgressManager::showProgressDialog" ref="ce0446470f2af127aba1cae61583d58a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void KPIM::ProgressManager::showProgressDialog           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [signal]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Emitted when an operation requests the listeners to be shown. 
<p>
Use <a class="el" href="classKPIM_1_1ProgressManager.html#034e6c1c92e408c045a44a6dddc74a6c" title="Ask all listeners to show the progress dialog, because there is something that wants...">emitShowProgressDialog()</a> to trigger it. 
</div>
</div><p>
<a class="anchor" name="7fa9eb3ecf8b653ab06a07b029a4d9eb"></a><!-- doxytag: member="KPIM::ProgressManager::slotStandardCancelHandler" ref="7fa9eb3ecf8b653ab06a07b029a4d9eb" args="(KPIM::ProgressItem *item)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void KPIM::ProgressManager::slotStandardCancelHandler           </td>
          <td>(</td>
          <td class="paramtype">KPIM::ProgressItem *&nbsp;</td>
          <td class="paramname"> <em>item</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [slot]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Calls setCompleted() on the item, to make sure it goes away. 
<p>
Provided for convenience. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>item</em>&nbsp;</td><td>the canceled item. </td></tr>
  </table>
</dl>

<p>Definition at line <a class="el" href="progressmanager_8cpp-source.html#l00205">205</a> of file <a class="el" href="progressmanager_8cpp-source.html">progressmanager.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="69d92194f4ffcbcecba2a1e36cb547f6"></a><!-- doxytag: member="KPIM::ProgressManager::slotAbortAll" ref="69d92194f4ffcbcecba2a1e36cb547f6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void KPIM::ProgressManager::slotAbortAll           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [slot]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Aborts all running jobs. 
<p>
Bound to "Esc" 
<p>Definition at line <a class="el" href="progressmanager_8cpp-source.html#l00225">225</a> of file <a class="el" href="progressmanager_8cpp-source.html">progressmanager.cpp</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="progressmanager_8h-source.html">progressmanager.h</a><li><a class="el" href="progressmanager_8cpp-source.html">progressmanager.cpp</a></ul>
</div>
    </div></div>


      </td>
  </tr>
  <tr>
    <td valign="top" id="leftmenu" width="25%">
      <a name="navigation"></a>
      <div class="menu_box"><h2>libkdepim</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
  <option value="classActionBase.html">actionbase</option>,  <option value="classActionEditWidget.html">actioneditwidget</option>,  <option value="classAlarmClient.html">alarmclient</option>,  <option value="classConditionEditWidget.html">conditioneditwidget</option>,  <option value="classGroupItem.html">groupitem</option>,  <option value="classKABC_1_1ResourceNull.html">kabc::resourcenull</option>,  <option value="classKConfigWizard.html">kconfigwizard</option>,  <option value="classKDateEdit.html">kdateedit</option>,  <option value="classKDatePickerPopup.html">kdatepickerpopup</option>,  <option value="classKIncidenceChooser.html">kincidencechooser</option>,  <option value="classKomposer_1_1Core.html">komposer::core</option>,  <option value="classKomposer_1_1KomposerIface.html">komposer::komposeriface</option>,  <option value="classKParts_1_1InfoExtension.html">kparts::infoextension</option>,  <option value="classKParts_1_1SideBarExtension.html">kparts::sidebarextension</option>,  <option value="classKPartsGenericPart.html">kpartsgenericpart</option>,  <option value="classKPartsWidgetPlugin.html">kpartswidgetplugin</option>,  <option value="classKPIM_1_1BroadcastStatus.html">kpim::broadcaststatus</option>,  <option value="classKPIM_1_1ClickLineEdit.html">kpim::clicklineedit</option>,  <option value="classKPIM_1_1CollectingProcess.html">kpim::collectingprocess</option>,  <option value="classKPIM_1_1ConfigManager.html">kpim::configmanager</option>,  <option value="classKPIM_1_1DiffAlgoDisplay.html">kpim::diffalgodisplay</option>,  <option value="classKPIM_1_1DistributionList.html">kpim::distributionlist</option>,  <option value="classKPIM_1_1KMailCompletion.html">kpim::kmailcompletion</option>,  <option value="classKPIM_1_1KPixmapRegionSelectorDialog.html">kpim::kpixmapregionselectordialog</option>,  <option value="classKPIM_1_1KPixmapRegionSelectorWidget.html">kpim::kpixmapregionselectorwidget</option>,  <option value="classKPIM_1_1LdapClient.html">kpim::ldapclient</option>,  <option value="classKPIM_1_1LdapObject.html">kpim::ldapobject</option>,  <option value="classKPIM_1_1LdapSearch.html">kpim::ldapsearch</option>,  <option value="classKPIM_1_1OverlayWidget.html">kpim::overlaywidget</option>,  <option value="classKPIM_1_1PluginLoader.html">kpim::pluginloader</option>,  <option value="classKPIM_1_1ProgressManager.html">kpim::progressmanager</option>,  <option value="classKPIM_1_1ResourceABC.html">kpim::resourceabc</option>,  <option value="classKPIM_1_1SelectionItem.html">kpim::selectionitem</option>,  <option value="classKPIM_1_1ThreadWeaver_1_1Event.html">kpim::threadweaver::event</option>,  <option value="classKPIM_1_1ThreadWeaver_1_1Job.html">kpim::threadweaver::job</option>,  <option value="classKPIM_1_1ThreadWeaver_1_1Thread.html">kpim::threadweaver::thread</option>,  <option value="classKPIM_1_1ThreadWeaver_1_1Weaver.html">kpim::threadweaver::weaver</option>,  <option value="classKPIM_1_1ThreadWeaver_1_1WeaverExtension.html">kpim::threadweaver::weaverextension</option>,  <option value="classKPIM_1_1ThreadWeaver_1_1WeaverThreadLogger.html">kpim::threadweaver::weaverthreadlogger</option>,  <option value="classKPrefsDialog.html">kprefsdialog</option>,  <option value="classKPrefsWid.html">kprefswid</option>,  <option value="classKPrefsWidBool.html">kprefswidbool</option>,  <option value="classKPrefsWidColor.html">kprefswidcolor</option>,  <option value="classKPrefsWidCombo.html">kprefswidcombo</option>,  <option value="classKPrefsWidDate.html">kprefswiddate</option>,  <option value="classKPrefsWidDuration.html">kprefswidduration</option>,  <option value="classKPrefsWidFont.html">kprefswidfont</option>,  <option value="classKPrefsWidInt.html">kprefswidint</option>,  <option value="classKPrefsWidManager.html">kprefswidmanager</option>,  <option value="classKPrefsWidPath.html">kprefswidpath</option>,  <option value="classKPrefsWidRadios.html">kprefswidradios</option>,  <option value="classKPrefsWidString.html">kprefswidstring</option>,  <option value="classKPrefsWidTime.html">kprefswidtime</option>,  <option value="classKRecentAddress_1_1RecentAddresses.html">krecentaddress::recentaddresses</option>,  <option value="classKRegExp3.html">kregexp3</option>,  <option value="classKResourcePrefs.html">kresourceprefs</option>,  <option value="classKRSqueezedTextLabel.html">krsqueezedtextlabel</option>,  <option value="classKSubscription.html">ksubscription</option>,  <option value="classKTimeEdit.html">ktimeedit</option>,  <option value="classKVCardDrag.html">kvcarddrag</option>,  <option value="classKWidgetLister.html">kwidgetlister</option>,  <option value="classLinkLocator.html">linklocator</option>,  <option value="classQStrictUtf7Codec.html">qstrictutf7codec</option>,  <option value="classQUtf7Codec.html">qutf7codec</option>,  <option value="classRuleEditWidget.html">ruleeditwidget</option>,  <option value="classRuleListWidget.html">rulelistwidget</option>,  <option value="classRuleStack.html">rulestack</option>,  <option value="classScorableGroup.html">scorablegroup</option>,  <option value="classSingleActionWidget.html">singleactionwidget</option>,  <option value="classSingleConditionWidget.html">singleconditionwidget</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../akregator/html/index.html">akregator</a></li><li>&nbsp;&nbsp;<a href="../../akregator/src/html/index.html">src</a></li><li>&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../certmanager/html/index.html">certmanager</a></li><li>&nbsp;&nbsp;<a href="../../certmanager/lib/html/index.html">lib</a></li><li><a href="../../kaddressbook/html/index.html">kaddressbook</a></li><li><a href="../../kalarm/html/index.html">kalarm</a></li><li>&nbsp;&nbsp;<a href="../../kalarm/lib/html/index.html">lib</a></li><li><a href="../../kandy/html/index.html">kandy</a></li><li><a href="../../karm/html/index.html">karm</a></li><li><a href="../../kdgantt/html/index.html">kdgantt</a></li><li><a href="../../kgantt/html/index.html">kgantt</a></li><li><a href="../../kioslaves/html/index.html">kioslaves</a></li><li>&nbsp;&nbsp;<a href="../../kioslaves/imap4/html/index.html">imap4</a></li><li>&nbsp;&nbsp;<a href="../../kioslaves/mbox/html/index.html">mbox</a></li><li><a href="../../kitchensync/html/index.html">kitchensync</a></li><li><a href="../../kmail/html/index.html">kmail</a></li><li><a href="../../knotes/html/index.html">knotes</a></li><li><a href="../../konsolekalendar/html/index.html">konsolekalendar</a></li><li><a href="../../kontact/html/index.html">kontact</a></li><li><a href="../../korganizer/html/index.html">korganizer</a></li><li><a href="../../kpilot/html/index.html">kpilot</a></li><li>&nbsp;&nbsp;<a href="../../kpilot/kpilot/html/index.html">kpilot</a></li><li>&nbsp;&nbsp;<a href="../../kpilot/lib/html/index.html">lib</a></li><li><a href="../../libemailfunctions/html/index.html">libemailfunctions</a></li><li><a href="../../libkcal/html/index.html">libkcal</a></li><li><a href="../../libkdepim/html/index.html">libkdepim</a></li><li><a href="../../libkholidays/html/index.html">libkholidays</a></li><li><a href="../../libkmime/html/index.html">libkmime</a></li><li><a href="../../libkpgp/html/index.html">libkpgp</a></li><li><a href="../../libkpimidentities/html/index.html">libkpimidentities</a></li>
</ul></div></div>


        </td>
</tr>
</table>

<span class="doNotDisplay">
  <a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
  <a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
  <a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>


<div style="height: 8px"></div>

<div id="footer">
  <div id="footer_left">
    Maintained by <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;groo&#116;&#64;kde&#46;or&#x67;">Adriaan de Groot</a>
and
<a href="&#109;a&#105;&#108;&#116;&#111;&#58;w&#105;nter&#64;kde&#46;or&#x67">Allen Winter</a>.
<br/>
    KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" 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 id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>

<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->

</body>
</html>