feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

TaskTree docs: Update docs about TaskInterface::done()'s arg

Browse Source 
Now it's DoneResult, instead of bool.

Change-Id: Ia6eab42b08774d6b51f2bf4435ac083946f5d53d
Reviewed-by: hjk <hjk@qt.io>
This commit is contained in:
Jarek Kobus
2023-11-16 19:55:35 +01:00
parent 659f0f000c
commit 1c8ac2e7d3
1 changed files with 10 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
src/libs/solutions/tasking/tasktree.cpp
View File

@@ -85,11 +85,11 @@ private:
*/ */
/*! /*!
\fn void TaskInterface::done(bool success) \fn void TaskInterface::done(DoneResult result)
Emit this signal from the \c TaskAdapter<Task>'s subclass, when the \c Task is finished. Emit this signal from the \c TaskAdapter<Task>'s subclass, when the \c Task is finished.
Pass \c true as a \a success argument when the task finishes with success; Pass \c DoneResult::Success as a \a result argument when the task finishes with success;
otherwise, when an error occurs, pass \c false. otherwise, when an error occurs, pass \c DoneResult::Error.
*/ */
/*! /*!
@@ -2174,8 +2174,7 @@ bool TaskTreePrivate::invokeDoneHandler(TaskRuntimeNode *node, DoneWith doneWith
To extend a TaskTree with a new task type, implement a simple adapter class To extend a TaskTree with a new task type, implement a simple adapter class
derived from the TaskAdapter class template. The following class is an derived from the TaskAdapter class template. The following class is an
adapter for a single shot timer, which may be considered as a new adapter for a single shot timer, which may be considered as a new asynchronous task:
asynchronous task:
\code \code
class TimerTaskAdapter : public TaskAdapter<QTimer> class TimerTaskAdapter : public TaskAdapter<QTimer>
@@ -2184,7 +2183,7 @@ bool TaskTreePrivate::invokeDoneHandler(TaskRuntimeNode *node, DoneWith doneWith
TimerTaskAdapter() { TimerTaskAdapter() {
task()->setSingleShot(true); task()->setSingleShot(true);
task()->setInterval(1000); task()->setInterval(1000);
connect(task(), &QTimer::timeout, this, [this] { emit done(true); }); connect(task(), &QTimer::timeout, this, [this] { emit done(DoneResult::Success); });
} }
private: private:
void start() final { task()->start(); } void start() final { task()->start(); }
@@ -2201,8 +2200,8 @@ bool TaskTreePrivate::invokeDoneHandler(TaskRuntimeNode *node, DoneWith doneWith
accessible through the TaskAdapter::task() method. The constructor accessible through the TaskAdapter::task() method. The constructor
of TimerTaskAdapter initially configures the QTimer object and connects of TimerTaskAdapter initially configures the QTimer object and connects
to the QTimer::timeout signal. When the signal is triggered, TimerTaskAdapter to the QTimer::timeout signal. When the signal is triggered, TimerTaskAdapter
emits the \c done(true) signal to inform the task tree that the task finished emits the \c done(DoneResult::Success) signal to inform the task tree that the task finished
successfully. If it emits \c done(false), the task finished with an error. successfully. If it emits \c done(DoneResult::Error), the task finished with an error.
The TaskAdapter::start() method starts the timer. The TaskAdapter::start() method starts the timer.
To make QTimer accessible inside TaskTree under the \e TimerTask name, To make QTimer accessible inside TaskTree under the \e TimerTask name,
@@ -2212,14 +2211,10 @@ bool TaskTreePrivate::invokeDoneHandler(TaskRuntimeNode *node, DoneWith doneWith
The new task type is now registered, and you can use it in TaskTree: The new task type is now registered, and you can use it in TaskTree:
\code \code
const auto onTimerSetup = [](QTimer &task) { const auto onSetup = [](QTimer &task) { task.setInterval(2000); };
task.setInterval(2000); const auto onDone = [] { qDebug() << "timer triggered"; };
};
const auto onTimerDone = [](const QTimer &task) {
qDebug() << "timer triggered";
};
const Group root { const Group root {
TimerTask(onTimerSetup, onTimerDone) TimerTask(onSetup, onDone)
}; };
\endcode \endcode