libkdepim
KPIM::ProgressItem Class Reference
List of all members.Detailed Description
Definition at line 39 of file progressmanager.h.
Signals | |
void | progressItemAdded (KPIM::ProgressItem *) |
void | progressItemProgress (KPIM::ProgressItem *, unsigned int) |
void | progressItemCompleted (KPIM::ProgressItem *) |
void | progressItemCanceled (KPIM::ProgressItem *) |
void | progressItemStatus (KPIM::ProgressItem *, const QString &) |
void | progressItemLabel (KPIM::ProgressItem *, const QString &) |
void | progressItemUsesCrypto (KPIM::ProgressItem *, bool) |
Public Member Functions | |
const QString & | id () const |
ProgressItem * | parent () const |
const QString & | label () const |
void | setLabel (const QString &v) |
const QString & | status () const |
void | setStatus (const QString &v) |
bool | canBeCanceled () const |
bool | usesCrypto () const |
void | setUsesCrypto (bool v) |
unsigned int | progress () const |
void | setProgress (unsigned int v) |
void | setComplete () |
void | reset () |
void | cancel () |
void | setTotalItems (unsigned int v) |
unsigned int | totalItems () const |
void | setCompletedItems (unsigned int v) |
void | incCompletedItems (unsigned int v=1) |
unsigned int | completedItems () const |
void | updateProgress () |
void | addChild (ProgressItem *kiddo) |
void | removeChild (ProgressItem *kiddo) |
bool | canceled () const |
Protected Member Functions | |
ProgressItem (ProgressItem *parent, const QString &id, const QString &label, const QString &status, bool isCancellable, bool usesCrypto) | |
virtual | ~ProgressItem () |
Friends | |
class | ProgressManager |
class | QDict< ProgressItem > |
Member Function Documentation
|
Definition at line 83 of file progressmanager.h. |
|
Definition at line 51 of file progressmanager.h. |
|
Definition at line 61 of file progressmanager.h. |
|
Definition at line 56 of file progressmanager.h. |
|
Definition at line 101 of file progressmanager.h. |
|
Emitted when a new ProgressItem is added.
|
|
Emitted when an item was cancelled. It will _not_ go away immediately, only when the owner sets it complete, which will usually happen. Can be used to visually indicate the cancelled status of an item. Should be used by the owner of the item to make sure it is set completed even if it is cancelled. There is a ProgressManager::slotStandardCancelHandler which simply sets the item completed and can be used if no other work needs to be done on cancel.
|
|
Emitted when a progress item was completed. The item will be deleted afterwards, so slots connected to this are the last chance to work with this item.
|
|
Emitted when the label of an item changed. Should be used by progress dialogs to update the label of an item.
|
|
Emitted when the progress value of an item changes.
|
|
Emitted when the status message of an item changed. Should be used by progress dialogs to update the status message for an item.
|
|
Emitted when the crypto status of an item changed. Should be used by progress dialogs to update the crypto indicator of an item.
|
|
Reset the progress value of this item to 0 and the status string to the empty string.
Definition at line 122 of file progressmanager.h. |
|
Tell the item it has finished. This will emit progressItemCompleted() result in the destruction of the item after all slots connected to this signal have executed. This is the only way to get rid of an item and needs to be called even if the item is cancelled. Don't use the item after this has been called on it. Definition at line 51 of file progressmanager.cpp. |
|
Definition at line 108 of file progressmanager.cpp. |
|
Set the progress (percentage of completion) value of this item.
Definition at line 101 of file progressmanager.cpp. |
|
Set the string to be used for showing this item's current status.
Definition at line 114 of file progressmanager.cpp. |
|
Set whether this item uses crypted communication, so listeners can display a nice crypto icon.
Definition at line 120 of file progressmanager.cpp. |
|
Definition at line 72 of file progressmanager.h. |
|
Recalculate progress according to total/completed items and update.
Definition at line 136 of file progressmanager.h. |
|
Definition at line 89 of file progressmanager.h. |
The documentation for this class was generated from the following files: