incendium.vision.gui.input

Description

Open up a popup input dialog box.

This dialog box will show a prompt message, and allow the user to type in a string. When the user is done, they can press "OK" or "Cancel". If OK is pressed, this function will return with the value that they typed in. If Cancel is pressed, this function will return the value None.

Syntax

incendium.vision.gui.input(message, [title])

Args:

• message (str): The message to display. This will be translated to the selected Locale. Will accept html formatting.
• title (str): A title for the input box. This will be translated to the selected Locale. Optional. Defaults to "Input".

Returns:

• str: The string value that was entered in the input box.

Recommendations

None.

Code Examples

from __future__ import print_function

from incendium.vision import gui

comments = gui.input("Comments")

print(comments)