A Python 3 based framework for creating simple and intuitive graphical menu interfaces.
Requires Colorama: https://github.com/tartley/colorama
Abstraction: Menu is an object. It can contain buttons, input fields, and text. Buttons can occupy the body of the menu, as well as the footer of the menu. Typically the footer is reserved for options like "Okay", "Back", "Help". Input fields can only occupy the body of the menu. They come in the form of text input and boolean input. Type checking should be done outside of the framework by code that you write. Large bodies of text in menus cannot coexist with inputs.
Menus can contain a number of different elements. This one contains three buttons. Each button is linked to a specific function in the program. Pressing enter while a button is selected will execute the aforementioned function. In this case, the functions displayed here will each create a new menu instance and display it on top of the current one.
The framework will display a scrollbar if the number of elements is too large. In this example, I am scrolling down through a list of buttons. In the bottom right-hand corner there is a counter which displays the number of the button that is currently selected (index + 1), as well as the total number of buttons.
The same goes for inputs.
Here I am scrolling through some word-wrapped text. The framework uses a custom algorithm to make sure that all words fit nicely within the boundaries of the menu.
Here is an example of how input can be taken. There are three input fields displayed here. Two of which are standard string inputs - the final one is actually a boolean input. Pressing space while the checkbox is selected will toggle it between true and false.
Here the user input is being displayed in a separate menu.
A simple quit prompt.
The framework also supports "popup" style menus. You can see that the quit prompt is now being displayed on top of the previous menu instead of in a completely new frame.
Supported operating systems: Windows
Note: The msvcrt library is the only thing that is preventing this from being able to run on other operating systems.
Main features:
- Can take user input in the form of strings as well as boolean checkboxes.
- Can display information in the form of text boxes (With word-wrapping and scrolling functionality)
- Menus can contain many different buttons and inputs simultaneously. Scrolling functionality will be used if the number of elements is too large.
- Input is asynchronous (ie the program doesn't halt when an input is being taken)
- Menus are resized dynamically depending on the number and scale of the elements within them.
- Buttons are linked to existing functions within the program.
- Menus can be stacked. If one is closed then the previous one is started up again.
Navigation:
- Left & Right Arrow Keys: Select horizontal options.
- Up & Down Arrow Keys: Select vertical options.
- Enter: Activates the selected button.
- Space: Toggle checkboxes.
- Tab: Selects the next button/input.
- F5: Redraws the current menu.
- Escape: Closes the current menu.
- Any option highlighted in blue is currently selected.