summaryrefslogtreecommitdiff
path: root/python
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2025-08-15 15:21:34 -0400
committerJordan Wiens <jordan@psifertex.com>2025-08-15 15:21:34 -0400
commitfe064e59aabb8ee362c587a04f081f77619f0313 (patch)
tree90f74823fa48c04a63dbfb7fde6e93bdc98b3223 /python
parent0c572b1343d1e98574b7bc46169947f2dd5a257d (diff)
add note to show_message_box API about escaping
Diffstat (limited to 'python')
-rw-r--r--python/interaction.py2
1 files changed, 2 insertions, 0 deletions
diff --git a/python/interaction.py b/python/interaction.py
index 65b8b2a1..27648e12 100644
--- a/python/interaction.py
+++ b/python/interaction.py
@@ -1520,6 +1520,8 @@ def show_message_box(title, text, buttons=MessageBoxButtonSet.OKButtonSet, icon=
"""
``show_message_box`` Displays a configurable message box in the UI, or prompts on the console as appropriate
+ :note: This uses a standard QDialog which means simple HTML will render as HTML, but links are not clickable and special characters need to be escaped.
+
:param str title: Text title for the message box.
:param str text: Text for the main body of the message box.
:param MessageBoxButtonSet buttons: One of :py:class:`MessageBoxButtonSet`