From 982b0ccaade447a7ee49f8ab144ab534823f9e05 Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Thu, 6 Feb 2020 11:14:51 -0500 Subject: correct get_form_input documentation for return value --- python/interaction.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'python/interaction.py') diff --git a/python/interaction.py b/python/interaction.py index 43004e2f..7f677e32 100644 --- a/python/interaction.py +++ b/python/interaction.py @@ -1227,12 +1227,12 @@ def get_form_input(fields, title): - OpenFileNameField - Prompt for file to open - SaveFileNameField - Prompt for file to save to - DirectoryNameField - Prompt for directory name - This API is flexible and works both in the UI via a pop-up dialog and on the command-line. Note that more complicated APIs should consider usin the included pyside2 functionality in the `binaryninjaui` module. + This API is flexible and works both in the UI via a pop-up dialog and on the command-line. Note that more complicated APIs should consider usin the included pyside2 functionality in the `binaryninjaui` module. Returns true or false depending on whether the user submitted responses or cancelled the dialog. :param fields: A list containing these classes, strings or None :type fields: list(str) or list(None) or list(LabelField) or list(SeparatorField) or list(TextLineField) or list(MultilineTextField) or list(IntegerField) or list(AddressField) or list(ChoiceField) or list(OpenFileNameField) or list(SaveFileNameField) or list(DirectoryNameField) :param str title: The title of the pop-up dialog - :rtype: None + :rtype: bool :Example: >>> int_f = IntegerField("Specify Integer") -- cgit v1.3.1