summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2017-05-10 01:40:53 -0400
committerJordan Wiens <jordan@psifertex.com>2017-05-10 01:40:53 -0400
commit12d16ae11dd2c0524a36c59c5b025c38edb4135b (patch)
tree29a500c1f1b60aa7bb0ad0d1b64375322bb21844
parenteaeecf37a582894dd614e2ac4e56c35575af95a0 (diff)
add documentation for show_message_box and fix default button parameter
-rw-r--r--python/interaction.py16
1 files changed, 14 insertions, 2 deletions
diff --git a/python/interaction.py b/python/interaction.py
index 6d640d17..b479e922 100644
--- a/python/interaction.py
+++ b/python/interaction.py
@@ -23,7 +23,7 @@ import traceback
# Binary Ninja components
import _binaryninjacore as core
-from enums import FormInputFieldType, MessageBoxIcon, MessageBoxButtonResult
+from enums import FormInputFieldType, MessageBoxIcon, MessageBoxButtonSet, MessageBoxButtonResult
import binaryview
import log
@@ -517,5 +517,17 @@ def get_form_input(fields, title):
return True
-def show_message_box(title, text, buttons = MessageBoxButtonResult.OKButton, icon = MessageBoxIcon.InformationIcon):
+def show_message_box(title, text, buttons = MessageBoxButtonSet.OKButtonSet, icon = MessageBoxIcon.InformationIcon):
+ """
+ ``show_message_box`` Displays a configurable message box in the UI, or prompts on the console as appropriate
+ retrieves a list of all Symbol objects of the provided symbol type in the optionally
+ provided range.
+
+ :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`
+ :param MessageBoxIcon icon: One of :py:class:`MessageBoxIcon`
+ :return: Which button was selected
+ :rtype: MessageBoxButtonResult
+ """
return core.BNShowMessageBox(title, text, buttons, icon)