Quick Start
STEP 1: Getting started
Select "New Screen" to start a new project. Or, select "Open Screen" and skip this step.
If creating a new screen, see here for an explanation of the window properties that need to be configured before creating the file.
After you click create, select where you want to save your save file in the file explorer window. You should see an empty screen in front of you. This is your GUI!
Move around the screen by using the arrow keys, and zoom in and out by scrolling forwards and backwards. Alternatively, you can use the page up/down keys or a touch screen.
STEP 2: Creating
Create your GUI using the provided widgets in the ribbon. This follows a three step process:
SELECT your widget from the ribbon.
DRAW your widget on the grid. Click once to anchor a point on the screen, and move your mouse to where you want it to stretch to. Click once more to finish drawing.
EDIT your widget's properties. Click on your widget to bring up a panel of properties on the right. Edit those properties, and click "Apply" to edit its properties.
To navigate around the screen, move your viewpoint around using the arrow keys. To zoom in and out, either scroll in and out, or use the page up and page down keys.
If at any time a property of the GUI needs to be edited, such as the size of the grid, select "GUI Properties" in the ribbon, and edit the properties that appear in the panel. WARNING - reducing the size of the GUI will delete all widgets that exceed the boundaries of the new grid size.
STEP 3: Code
Your design is automatically converted into Python code (Python 3). If you want to do this manually, click on the "Convert" button in the top of the screen
Open the main Python file you designated as the parent script in the GUI properties, or create a new .py file with the same name as the parent script in GUI properties. A parent script named "main" should have a file named "main.py".
NOTE: This file needs to be in the same directory as your exported GUI file, else it will not be found by Python.
Import: Every GUI file you import needs an import statement at the top of your Python file.
from <gui name> import <gui name>
For a GUI file named gui, this would look like from gui import gui
One of these is needed for every GUI file. If you have multiple screens, you will have multiple of these
Run: For the main window only, write the following to launch the screen. The run statement must be the final line of the file.
<gui name>.run()
For a GUI file named gui, this would look like gui.run()
In total, for a GUI called 'gui', the code will look like the following:
