docs: document signals blocked (#186)

This commit is contained in:
Talley Lambert
2023-08-17 09:40:06 -04:00
committed by GitHub
parent 39b6a0596f
commit 41ea4e8907
2 changed files with 21 additions and 1 deletions

View File

@@ -0,0 +1,3 @@
# Signal Utilities
::: superqt.utils.signals_blocked

View File

@@ -7,7 +7,24 @@ if TYPE_CHECKING:
@contextmanager
def signals_blocked(obj: "QObject") -> Iterator[None]:
"""Context manager to temporarily block signals emitted by QObject: `obj`."""
"""Context manager to temporarily block signals emitted by QObject: `obj`.
Parameters
----------
obj : QObject
The QObject whose signals should be blocked.
Examples
--------
```python
from qtpy.QtWidgets import QSpinBox
from superqt import signals_blocked
spinbox = QSpinBox()
with signals_blocked(spinbox):
spinbox.setValue(10)
```
"""
previous = obj.blockSignals(True)
try:
yield