/usr/include/KF5/libkdepim/progressmanager.h is in libkf5libkdepim-dev 4:16.04.2-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 | /*
progressmanager.h
This file is part of libkdepim.
Copyright (C) 2004 Till Adam <adam@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KDEPIM_PROGRESSMANAGER_H
#define KDEPIM_PROGRESSMANAGER_H
#include "kdepim_export.h"
#include <QObject>
#include <QString>
#include <QMap>
#include <QHash>
#include <QWeakPointer>
namespace Akonadi
{
class AgentInstance;
}
namespace KPIM
{
class ProgressItem;
class ProgressManager;
typedef QMap<ProgressItem *, bool> ProgressItemMap;
class KDEPIM_EXPORT ProgressItem : public QObject
{
Q_OBJECT
friend class ProgressManager;
public:
enum CryptoStatus {
Encrypted,
Unencrypted,
Unknown
};
/**
* @return The id string which uniquely identifies the operation
* represented by this item.
*/
const QString &id() const;
/**
* @return The parent item of this one, if there is one.
*/
ProgressItem *parent() const;
/**
* @return The user visible string to be used to represent this item.
*/
const QString &label() const;
/**
* @param v Set the user visible string identifying this item.
*/
void setLabel(const QString &v);
/**
* @return The string to be used for showing this item's current status.
*/
const QString &status() const;
/**
* Set the string to be used for showing this item's current status.
* @param v The status string.
*/
void setStatus(const QString &v);
/**
* @return Whether this item can be canceled.
*/
bool canBeCanceled() const;
/**
* @param b Set if can be canceled
*/
void setCanBeCanceled(bool b);
/**
* @return Whether this item uses secure communication
* (Account uses ssl, for example.).
*/
CryptoStatus cryptoStatus() const;
/**
* Set whether this item uses crypted communication, so listeners
* can display a nice crypto icon.
* @param v The value.
*/
void setCryptoStatus(ProgressItem::CryptoStatus v);
/**
* @return whether this item uses a busy indicator instead of real progress display
*/
bool usesBusyIndicator() const;
/**
* Sets whether this item uses a busy indicator instead of real progress for its progress bar.
* If it uses a busy indicator, you are still responsible for calling setProgress() from time to
* time to update the busy indicator.
*/
void setUsesBusyIndicator(bool useBusyIndicator);
/**
* @return The current progress value of this item in percent.
*/
unsigned int progress() const;
/**
* Set the progress (percentage of completion) value of this item.
* @param v The percentage value.
*/
void setProgress(unsigned int v);
/**
* Tell the item it has finished. This will Q_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 canceled. Don't use the item
* after this has been called on it.
*/
void setComplete();
/**
* Reset the progress value of this item to 0 and the status string to
* the empty string.
*/
void reset();
void cancel();
// Often needed values for calculating progress.
void setTotalItems(unsigned int v);
unsigned int totalItems() const;
void setCompletedItems(unsigned int v);
void incCompletedItems(unsigned int v = 1);
unsigned int completedItems() const;
/**
* Recalculate progress according to total/completed items and update.
*/
void updateProgress();
void addChild(ProgressItem *kiddo);
void removeChild(ProgressItem *kiddo);
bool canceled() const;
unsigned int typeProgressItem() const;
void setTypeProgressItem(unsigned int);
Q_SIGNALS:
/**
* Emitted when a new ProgressItem is added.
* @param The ProgressItem that was added.
*/
void progressItemAdded(KPIM::ProgressItem *);
/**
* Emitted when the progress value of an item changes.
* @param The item which got a new value.
* @param The value, for convenience.
*/
void progressItemProgress(KPIM::ProgressItem *, unsigned int);
/**
* 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.
* @param The completed item.
*/
void progressItemCompleted(KPIM::ProgressItem *);
/**
* Emitted when an item was canceled. It will _not_ go away immediately,
* only when the owner sets it complete, which will usually happen. Can be
* used to visually indicate the canceled status of an item. Should be used
* by the owner of the item to make sure it is set completed even if it is
* canceled. 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.
* @param The canceled item;
*/
void progressItemCanceled(KPIM::ProgressItem *);
/**
* Emitted when the status message of an item changed. Should be used by
* progress dialogs to update the status message for an item.
* @param The updated item.
* @param The new message.
*/
void progressItemStatus(KPIM::ProgressItem *, const QString &);
/**
* Emitted when the label of an item changed. Should be used by
* progress dialogs to update the label of an item.
* @param The updated item.
* @param The new label.
*/
void progressItemLabel(KPIM::ProgressItem *, const QString &);
/**
* Emitted when the crypto status of an item changed. Should be used by
* progress dialogs to update the crypto indicator of an item.
* @param The updated item.
* @param The new state.
*/
void progressItemCryptoStatus(KPIM::ProgressItem *, KPIM::ProgressItem::CryptoStatus);
/**
* Emitted when the busy indicator state of an item changes. Should be used
* by progress dialogs so that they can adjust the display of the progress bar
* to the new mode.
* @param item The updated item
* @param value True if the item uses a busy indicator now, false otherwise
*/
void progressItemUsesBusyIndicator(KPIM::ProgressItem *item, bool value);
protected:
/* Only to be used by our good friend the ProgressManager */
ProgressItem(ProgressItem *parent, const QString &id, const QString &label,
const QString &status, bool isCancellable, CryptoStatus cryptoStatus);
virtual ~ProgressItem();
private:
QString mId;
QString mLabel;
QString mStatus;
QWeakPointer<ProgressItem>mParent;
bool mCanBeCanceled;
unsigned int mProgress;
ProgressItemMap mChildren;
unsigned int mTotal;
unsigned int mCompleted;
CryptoStatus mCryptoStatus;
unsigned int mType;
bool mWaitingForKids;
bool mCanceled;
bool mUsesBusyIndicator;
bool mCompletedCalled;
};
struct ProgressManagerPrivate;
/**
* The ProgressManager 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.
* Each ProgressItem emits those signals individually and the singleton
* broadcasts them. Use the ::createProgressItem() statics to acquire an item
* and then call ->setProgress( int percent ) on it every time you want to
* update the item and ->setComplete() when the operation is done. This will
* delete the item. Connect to the item's progressItemCanceled() signal to be
* notified when the user cancels the transaction using one of the observing
* progress dialogs or by calling item->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.
*
* 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.
*/
class KDEPIM_EXPORT ProgressManager : public QObject
{
Q_OBJECT
friend struct ProgressManagerPrivate;
public:
virtual ~ProgressManager();
/**
* @return The singleton instance of this class.
*/
static ProgressManager *instance();
/**
* Use this to acquire a unique id number which can be used to discern
* an operation from all others going on at the same time. Use that
* number as the id string for your progressItem to ensure it is unique.
* @return
*/
static QString getUniqueID();
/**
* Creates a ProgressItem with a unique id and the given label.
* This is the simplest way to acquire a progress item. It will not
* have a parent and will be set to be cancellable and not using crypto.
*/
static ProgressItem *createProgressItem(unsigned int progressType, const QString &label);
/**
* Creates a ProgressItem with a unique id and the given label.
* This is the simplest way to acquire a progress item. It will not
* have a parent and will be set to be cancellable and not using crypto.
*/
static ProgressItem *createProgressItem(const QString &label);
/**
* Creates a new progressItem with the given parent, id, label and initial
* status.
*
* @param parent Specify an already existing item as the parent of this one.
* @param id Used to identify this operation for cancel and progress info.
* @param label The text to be displayed by progress handlers
* @param status Additional text to be displayed for the item.
* @param canBeCanceled can the user cancel this operation?
* @param usesCrypto does the operation use secure transports (SSL)
* Cancelling the parent will cancel the children as well (if they can be
* canceled) and ongoing children prevent parents from finishing.
* @return The ProgressItem representing the operation.
*/
static ProgressItem *createProgressItem(ProgressItem *parent,
const QString &id,
const QString &label,
const QString &status = QString(),
bool canBeCanceled = true,
KPIM::ProgressItem::CryptoStatus cryptoStatus = KPIM::ProgressItem::Unencrypted);
/**
* Use this version if you have the id string of the parent and want to
* add a subjob to it.
*/
static ProgressItem *createProgressItem(const QString &parent,
const QString &id,
const QString &label,
const QString &status = QString(),
bool canBeCanceled = true,
KPIM::ProgressItem::CryptoStatus cryptoStatus = KPIM::ProgressItem::Unencrypted);
/**
* Version without a parent.
*/
static ProgressItem *createProgressItem(const QString &id,
const QString &label,
const QString &status = QString(),
bool canBeCanceled = true,
KPIM::ProgressItem::CryptoStatus cryptoStatus = KPIM::ProgressItem::Unencrypted);
/**
* Version for Akonadi agents.
* This connects all the proper signals so that you do not have to
* worry about updating the progress or reacting to progressItemCanceled().
*/
static ProgressItem *createProgressItem(ProgressItem *parent,
const Akonadi::AgentInstance &agent,
const QString &id,
const QString &label,
const QString &status = QString(),
bool canBeCanceled = true,
KPIM::ProgressItem::CryptoStatus cryptoStatus = KPIM::ProgressItem::Unencrypted);
/**
* @return true when there are no more progress items.
*/
bool isEmpty() const;
/**
* @return the only top level progressitem when there's only one.
* Returns 0 if there is no item, or more than one top level item.
* Since this is used to calculate the overall progress, it will also return
* 0 if there is an item which uses a busy indicator, since that will invalidate
* the overall progress.
*/
ProgressItem *singleItem() const;
/**
* Ask all listeners to show the progress dialog, because there is
* something that wants to be shown.
*/
static void emitShowProgressDialog();
Q_SIGNALS:
/** @see ProgressItem::progressItemAdded() */
void progressItemAdded(KPIM::ProgressItem *);
/** @see ProgressItem::progressItemProgress() */
void progressItemProgress(KPIM::ProgressItem *, unsigned int);
/** @see ProgressItem::progressItemCompleted() */
void progressItemCompleted(KPIM::ProgressItem *);
/** @see ProgressItem::progressItemCanceled() */
void progressItemCanceled(KPIM::ProgressItem *);
/** @see ProgressItem::progressItemStatus() */
void progressItemStatus(KPIM::ProgressItem *, const QString &);
/** @see ProgressItem::progressItemLabel() */
void progressItemLabel(KPIM::ProgressItem *, const QString &);
/** @see ProgressItem::progressItemCryptoStatus() */
void progressItemCryptoStatus(KPIM::ProgressItem *, KPIM::ProgressItem::CryptoStatus);
/** @see ProgressItem::progressItemUsesBusyIndicator */
void progressItemUsesBusyIndicator(KPIM::ProgressItem *, bool);
/**
* Emitted when an operation requests the listeners to be shown.
* Use emitShowProgressDialog() to trigger it.
*/
void showProgressDialog();
public Q_SLOTS:
/**
* Calls setCompleted() on the item, to make sure it goes away.
* Provided for convenience.
* @param item the canceled item.
*/
void slotStandardCancelHandler(KPIM::ProgressItem *item);
/**
* Aborts all running jobs. Bound to "Esc"
*/
void slotAbortAll();
private Q_SLOTS:
void slotTransactionCompleted(KPIM::ProgressItem *item);
private:
ProgressManager();
// prevent unsolicited copies
ProgressManager(const ProgressManager &);
virtual ProgressItem *createProgressItemImpl(ProgressItem *parent,
const QString &id,
const QString &label,
const QString &status,
bool cancellable,
ProgressItem::CryptoStatus cryptoStatus, unsigned int progressType = 0);
virtual ProgressItem *createProgressItemImpl(const QString &parent,
const QString &id,
const QString &label,
const QString &status,
bool cancellable,
ProgressItem::CryptoStatus cryptoStatus, unsigned int progressType = 0);
ProgressItem *createProgressItemForAgent(ProgressItem *parent,
const Akonadi::AgentInstance &instance,
const QString &id,
const QString &label,
const QString &status,
bool cancellable,
ProgressItem::CryptoStatus cryptoStatus, unsigned int progressType = 0);
void emitShowProgressDialogImpl();
QHash< QString, ProgressItem * > mTransactions;
static unsigned int uID;
};
}
#endif // __KPIM_PROGRESSMANAGER_H__
|