docstrings

This commit is contained in:
Will McGugan
2023-02-23 13:53:36 +00:00
parent f723f3771f
commit 4cf7492a28
2 changed files with 16 additions and 0 deletions

View File

@@ -152,6 +152,14 @@ class MessagePump(metaclass=MessagePumpMeta):
self._parent = None
def check_message_enabled(self, message: Message) -> bool:
"""Check if a given message is enabled (allowed to be sent).
Args:
message: A message object
Returns:
`True` if the message will be sent, or `False` if it is disabled.
"""
message_type = type(message)
if self._prevent_events and message_type in self._prevent_events[-1]:
return False

View File

@@ -2489,6 +2489,14 @@ class Widget(DOMNode):
self.app.capture_mouse(None)
def check_message_enabled(self, message: Message) -> bool:
"""Check if a given message is enabled (allowed to be sent).
Args:
message: A message object
Returns:
`True` if the message will be sent, or `False` if it is disabled.
"""
# Do the normal checking and get out if that fails.
if not super().check_message_enabled(message):
return False