aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/PySide6
diff options
context:
space:
mode:
authorAdrian Herrmann <adrian.herrmann@qt.io>2024-03-05 00:30:44 +0100
committerAdrian Herrmann <adrian.herrmann@qt.io>2024-03-07 23:37:00 +0100
commitdec0ac7a94c787d100d1ca3f9298b7c3b07712aa (patch)
tree9f939af14a3b2393723f7fc1b2d9dbdc3dec9c5e /sources/pyside6/doc/PySide6
parent25e993273f7fc7445e5ccd1f446fe484a9c51d02 (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. Pick-to: 6.6 Task-number: PYSIDE-769 Change-Id: Ie4364025448405f36158a8e997d90ae143961ba8 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside6/doc/PySide6')
-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
^^^^^^^^^^^^^^^^^^^^