aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/PySide6/QtAsyncio/index.rst
diff options
context:
space:
mode:
authorAdrian Herrmann <adrian.herrmann@qt.io>2024-03-05 00:30:44 +0100
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2024-03-07 23:38:27 +0000
commitd6214ac026b4f4d9d34c8b9defc91c5a759845ff (patch)
tree31275158fdcc2c04ea0564365a1cefcf3516dbba /sources/pyside6/doc/PySide6/QtAsyncio/index.rst
parent7bc27c4d62af36b74f445e213204cdd89d1fc771 (diff)
QtAsyncio: Add handle_sigint argument to run()
An argument handle_sigint determines whether QtAsyncio should handle SIGINT (Ctrl+C) and shut down the event loop when it is received. The default is False. This can be set to True if you want QtAsyncio to take care of handling SIGINT instead of your program. Task-number: PYSIDE-769 Change-Id: Ie4364025448405f36158a8e997d90ae143961ba8 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit dec0ac7a94c787d100d1ca3f9298b7c3b07712aa) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'sources/pyside6/doc/PySide6/QtAsyncio/index.rst')
-rw-r--r--sources/pyside6/doc/PySide6/QtAsyncio/index.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/sources/pyside6/doc/PySide6/QtAsyncio/index.rst b/sources/pyside6/doc/PySide6/QtAsyncio/index.rst
index 90c0ee670..326f6efcc 100644
--- a/sources/pyside6/doc/PySide6/QtAsyncio/index.rst
+++ b/sources/pyside6/doc/PySide6/QtAsyncio/index.rst
@@ -131,6 +131,11 @@ coroutine has finished, while ``quit_qapp`` determines if the
QCoreApplication should be shut down after asyncio has finished. It is
possible for asyncio to finish while the QCoreApplication is kept alive.
+An argument ``handle_sigint`` determines whether QtAsyncio should handle
+SIGINT (Ctrl+C) and shut down the event loop when it is received. The
+default is ``False``. Set this to ``True`` if you want QtAsyncio to take
+care of handling SIGINT instead of your program.
+
Coroutines explained
^^^^^^^^^^^^^^^^^^^^