Core: Adapt documentation to recent refactoring.

ProgressManager and ActionManager are no longer retrieved via ICore,
and most accesses do not go via the instance anymore.

Change-Id: Ib0c3033270051aaadfb25e0b2b0eaf7bdec63a1d
Reviewed-by: hjk <hjk121@nokiamail.com>
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
This commit is contained in:
Christian Kandeler
2013-10-23 12:53:10 +02:00
committed by Eike Ziller
parent 60710f6c05
commit 6448d26ad7
2 changed files with 7 additions and 12 deletions

View File

@@ -72,7 +72,7 @@ using namespace Core::Internal;
The progress indicator also allows the user to cancel the task.
You get the single instance of this class via the
Core::ICore::progressManager() function.
ProgressManager::instance() function.
\section1 Registering a task
The ProgressManager API uses QtConcurrent as the basis for defining
@@ -149,9 +149,8 @@ using namespace Core::Internal;
in a different thread, looks like this:
\code
QFuture<void> task = QtConcurrent::run(&ILocatorFilter::refresh, filters);
Core::FutureProgress *progress = Core::ICore::instance()
->progressManager()->addTask(task, tr("Indexing"),
Locator::Constants::TASK_INDEX);
Core::FutureProgress *progress = Core::ProgressManager::addTask(task, tr("Indexing"),
Locator::Constants::TASK_INDEX);
\endcode
First, we tell QtConcurrent to start a thread which calls all the filters'
refresh function. After that we register the returned QFuture object
@@ -166,9 +165,7 @@ using namespace Core::Internal;
// We are already running in a different thread here
QFutureInterface<void> *progressObject = new QFutureInterface<void>;
progressObject->setProgressRange(0, MAX);
Core::ICore::progressManager()->addTask(
progressObject->future(),
tr("DoIt"), MYTASKTYPE);
Core::ProgressManager::addTask(progressObject->future(), tr("DoIt"), MYTASKTYPE);
progressObject->reportStarted();
// Do something
...