Updated screenshots
Fresh screenshots so that the flatter buttons are in the readme. Changed all SG. to sg.
This commit is contained in:
MikeTheWatchGuy
parent
71a60dd809
commit
089c6124b8
278
readme.md
278
readme.md
|
|
@ -1,4 +1,5 @@
|
|||
|
||||
|
||||
|
||||
|
||||
[](http://pepy.tech/project/pysimplegui) since Jul 11, 2018
|
||||
|
|
@ -31,7 +32,7 @@ In addition to a primary GUI, you can add a Progress Meter to your code with ONE
|
|||
|
||||
EasyProgressMeter('My meter title', current_value, max value)
|
||||
|
||||
|
||||
|
||||
|
||||
You can build an async media player GUI with custom buttons in 30 lines of code.
|
||||
|
||||
|
|
@ -83,29 +84,29 @@ An example of many widgets used on a single form. A little further down you'll
|
|||
|
||||
Here is the code that produced the above screenshot.
|
||||
|
||||
import PySimpleGUI as SG
|
||||
import PySimpleGUI as sg
|
||||
|
||||
with SG.FlexForm('Everything bagel', auto_size_text=True, default_element_size=(40, 1)) as form:
|
||||
with sg.FlexForm('Everything bagel', auto_size_text=True, default_element_size=(40, 1)) as form:
|
||||
layout = [
|
||||
[SG.Text('All graphic widgets in one form!', size=(30, 1), font=("Helvetica", 25), text_color='blue')],
|
||||
[SG.Text('Here is some text.... and a place to enter text')],
|
||||
[SG.InputText()],
|
||||
[SG.Checkbox('My first checkbox!'), SG.Checkbox('My second checkbox!', default=True)],
|
||||
[SG.Radio('My first Radio! ', "RADIO1", default=True), SG.Radio('My second Radio!', "RADIO1")],
|
||||
[SG.Multiline(default_text='This is the default Text shoulsd you decide not to type anything',
|
||||
[sg.Text('All graphic widgets in one form!', size=(30, 1), font=("Helvetica", 25), text_color='blue')],
|
||||
[sg.Text('Here is some text.... and a place to enter text')],
|
||||
[sg.InputText()],
|
||||
[sg.Checkbox('My first checkbox!'), sg.Checkbox('My second checkbox!', default=True)],
|
||||
[sg.Radio('My first Radio! ', "RADIO1", default=True), sg.Radio('My second Radio!', "RADIO1")],
|
||||
[sg.Multiline(default_text='This is the default Text shoulsd you decide not to type anything',
|
||||
scale=(2, 10))],
|
||||
[SG.InputCombo(['Combobox 1', 'Combobox 2'], size=(20, 3)),
|
||||
SG.Slider(range=(1, 100), orientation='h', size=(35, 20), default_value=85)],
|
||||
[SG.Listbox(values=['Listbox 1', 'Listbox 2', 'Listbox 3'], size=(30, 6)),
|
||||
SG.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=25),
|
||||
SG.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=75),
|
||||
SG.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=10)],
|
||||
[SG.Text('_' * 100, size=(70, 1))],
|
||||
[SG.Text('Choose Source and Destination Folders', size=(35, 1))],
|
||||
[SG.Text('Source Folder', size=(15, 1), auto_size_text=False, justification='right'), SG.InputText('Source'), SG.FolderBrowse()],
|
||||
[SG.Text('Destination Folder', size=(15, 1), auto_size_text=False, justification='right'), SG.InputText('Dest'),
|
||||
SG.FolderBrowse()],
|
||||
[SG.Submit(), SG.Cancel(), SG.SimpleButton('Customized', button_color=('white', 'green'))]
|
||||
[sg.InputCombo(['Combobox 1', 'Combobox 2'], size=(20, 3)),
|
||||
sg.Slider(range=(1, 100), orientation='h', size=(35, 20), default_value=85)],
|
||||
[sg.Listbox(values=['Listbox 1', 'Listbox 2', 'Listbox 3'], size=(30, 6)),
|
||||
sg.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=25),
|
||||
sg.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=75),
|
||||
sg.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=10)],
|
||||
[sg.Text('_' * 100, size=(70, 1))],
|
||||
[sg.Text('Choose Source and Destination Folders', size=(35, 1))],
|
||||
[sg.Text('Source Folder', size=(15, 1), auto_size_text=False, justification='right'), sg.InputText('Source'), sg.FolderBrowse()],
|
||||
[sg.Text('Destination Folder', size=(15, 1), auto_size_text=False, justification='right'), sg.InputText('Dest'),
|
||||
sg.FolderBrowse()],
|
||||
[sg.Submit(), sg.Cancel(), sg.SimpleButton('Customized', button_color=('white', 'green'))]
|
||||
]
|
||||
|
||||
button, values = form.LayoutAndRead(layout)
|
||||
|
|
@ -145,17 +146,19 @@ Simply download the file - PySimpleGUI.py and import it into your code
|
|||
Python 3
|
||||
tkinter
|
||||
|
||||
Should run on all Python platforms that have tkinter running on them. Has been thoroughly tested on Windows. While not tested elsewhere, should work on Linux, Mac, Pi, etc.
|
||||
Runs on all Python platforms that have tkinter running on them. Thoroughly tested on Windows. Runs on Windows, Mac, Linux, Raspberry Pi. Even runs on `pypy3`.
|
||||
|
||||
### Using
|
||||
|
||||
To use in your code, simply import....
|
||||
`import PySimpleGUI as SG`
|
||||
`import PySimpleGUI as sg`
|
||||
|
||||
Then use either "high level" API calls or build your own forms.
|
||||
|
||||
SG.MsgBox('This is my first message box')
|
||||
|
||||
sg.MsgBox('This is my first message box')
|
||||
|
||||
|
||||
|
||||
|
||||
Yes, it's just that easy to have a window appear on the screen using Python. With PySimpleGUI, making a custom form appear isn't much more difficult. The goal is to get you running on your GUI within ***minutes***, not hours nor days.
|
||||
|
||||
|
|
@ -177,11 +180,12 @@ PySimpleGUI can be broken down into 2 types of API's:
|
|||
|
||||
The "High Level" API calls that *output* values take a variable number of arguments so that they match a "print" statement as much as possible. The idea is to make it simple for the programmer to output as many items as desired and in any format. The user need not convert the variables to be output into the strings. The PySimpleGUI functions do that for the user.
|
||||
|
||||
SG.MsgBox('Variable number of parameters example', var1, var2, "etc")
|
||||
sg.MsgBox('Variable number of parameters example', var1, var2, "etc")
|
||||
|
||||
Each new item begins on a new line in the Message Box
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Optional Parameters to a Function Call
|
||||
|
|
@ -201,11 +205,10 @@ Here is the function definition for the MsgBox function. The details aren't impo
|
|||
|
||||
If the caller wanted to change the button color to be black on yellow, the call would look something like this:
|
||||
|
||||
SG.MsgBox('This box has a custom button color',
|
||||
button_color=('black', 'yellow'))
|
||||
sg.MsgBox('This box has a custom button color', button_color=('black', 'yellow'))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
|
@ -216,53 +219,64 @@ The classic "input a value, print result" example.
|
|||
Often command line programs simply take some value as input on the command line, do something with it and then display the results. Moving from the command line to a GUI is very simple.
|
||||
This code prompts user to input a line of text and then displays that text in a messages box:
|
||||
|
||||
import PySimpleGUI_local as SG
|
||||
|
||||
rc = SG.GetTextBox('Title', 'Please input something')
|
||||
SG.MsgBox('Results', 'The value returned from GetTextBox', rc)
|
||||
import PySimpleGUI as sg
|
||||
|
||||
|
||||
rc = sg.GetTextBox('Title', 'Please input something')
|
||||
sg.MsgBox('Results', 'The value returned from GetTextBox', rc)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Message Boxes
|
||||
In addition to MsgBox, you'll find a several API calls that are shortcuts to common messages boxes. You can achieve similar results by calling MsgBox with the correct parameters.
|
||||
|
||||
The differences tend to be the number and types of buttons. Here are the calls and the windows that are created.
|
||||
|
||||
import PySimpleGUI as SG
|
||||
import PySimpleGUI as sg
|
||||
|
||||
`SG.MsgBoxOK('This is an OK MsgBox')`
|
||||
`sg.MsgBoxOK('This is an OK MsgBox')`
|
||||
|
||||
|
||||
|
||||
|
||||
SG.MsgBoxOKCancel('This is an OK Cancel MsgBox')
|
||||
|
||||
|
||||
sg.MsgBoxOKCancel('This is an OK Cancel MsgBox')
|
||||
|
||||
SG.MsgBoxCancel('This is a Cancel MsgBox')
|
||||
|
||||
|
||||
|
||||
SG.MsgBoxYesNo('This is a Yes No MsgBox')
|
||||
|
||||
sg.MsgBoxCancel('This is a Cancel MsgBox')
|
||||
|
||||
SG.MsgBoxError('This is an error MsgBox')
|
||||
|
||||
|
||||
|
||||
SG.MsgBoxAutoClose('This is an autoclose MsgBox')
|
||||
sg.MsgBoxYesNo('This is a Yes No MsgBox')
|
||||
|
||||
|
||||
|
||||
|
||||
SG.ScrolledTextBox(my_text, height=10)
|
||||
|
||||
|
||||
sg.MsgBoxError('This is an error MsgBox')
|
||||
|
||||
Take a moment to look at that last one. It's such a simple API call and yet the result is awesome. Rather than seeing text scrolling past on your display, you can capture that text and present it in a scrolled interface. It's handy enough of an API call that it can also be called using the name `sprint` which is easier to remember than `ScrollectTextBox`. Your code could contain a line like:
|
||||
|
||||
|
||||
sg.MsgBoxAutoClose('This is an autoclose MsgBox')
|
||||
|
||||
|
||||
|
||||
sg.ScrolledTextBox(my_text, height=10)
|
||||
|
||||
|
||||
|
||||
|
||||
Take a moment to look at that last one. It's such a simple API call and yet the result is awesome. Rather than seeing your printed text scrolling past on your display, you can capture that text and present it in a scrolled interface. It's handy enough of an API call that it can also be called using the name `sprint` which is easier to remember than `ScrollectTextBox`. Your code could contain a line like:
|
||||
|
||||
sprint(f'My variables values include x={x}', f'y={y}')
|
||||
|
||||
This becomes a debug print of sorts that will route to a scrolled window.
|
||||
|
||||
See also the `EasyPrint` and `Print` functions.
|
||||
|
||||
#### High Level User Input
|
||||
|
||||
There are 3 very basic user input high-level function calls. It's expected that for most applications, a custom input form will be created. If you need only 1 value, then perhaps one of these high level functions will work.
|
||||
|
|
@ -270,23 +284,22 @@ There are 3 very basic user input high-level function calls. It's expected that
|
|||
- GetFileBox
|
||||
- GetFolderBox
|
||||
|
||||
`submit_clicked, value = SG.GetTextBox('Title', 'Please enter anything')`
|
||||
`submit_clicked, value = sg.GetTextBox('Title', 'Please enter anything')`
|
||||
|
||||
|
||||
|
||||
|
||||
submit_clicked, value = SG.GetFileBox('Title', 'Choose a file')
|
||||
submit_clicked, value = sg.GetFileBox('Title', 'Choose a file')
|
||||
|
||||
|
||||
|
||||
|
||||
submit_clicked, value = SG.GetPathBox('Title', 'Choose a folder')
|
||||
submit_clicked, value = sg.GetPathBox('Title', 'Choose a folder')
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Progress Meter!
|
||||
We all have loops in our code. 'Isn't it joyful waiting, watching a counter scrolling past in a text window? How about one line of code to get a progress meter, that contains statistics about your code?
|
||||
|
||||
|
||||
|
||||
|
||||
EasyProgressMeter(title,
|
||||
current_value,
|
||||
|
|
@ -302,38 +315,36 @@ We all have loops in our code. 'Isn't it joyful waiting, watching a counter scr
|
|||
Here's the one-line Progress Meter in action!
|
||||
|
||||
for i in range(1,10000):
|
||||
SG.EasyProgressMeter('My Meter', i+1, 10000, 'Optional message')
|
||||
sg.EasyProgressMeter('My Meter', i+1, 10000, 'Optional message')
|
||||
|
||||
That line of code resulted in this window popping up and updating.
|
||||
|
||||
|
||||
|
||||
|
||||
A meter AND fun statistics to watch while your machine grinds away, all for the price of 1 line of code.
|
||||
With a little trickery you can provide a way to break out of your loop using the Progress Meter form. The cancel button results in a `False` return value from `EasyProgressMeter`. It normally returns `True`.
|
||||
|
||||
if not SG.EasyProgressMeter('My Meter', i+1, 10000, 'Optional message'):
|
||||
break
|
||||
|
||||
***Be sure and add one to your loop counter*** so that your counter goes from 1 to the max value. If you do not add one, your counter will never hit the max value. Instead it will go from 0 to max-1.
|
||||
|
||||
#### Debug Output
|
||||
Another call in the 'Easy' families of APIs is `EasyPrint`. It will output to a debug window. If the debug window isn't open, then the first call will open it. No need to do anything but stick a 'print' call in your code. You can even replace your 'print' calls with calls to EasyPrint by simply sticking the statement
|
||||
|
||||
print = SG.EasyPrint
|
||||
print = sg.EasyPrint
|
||||
|
||||
at the top of your code.
|
||||
There are a number of names for the same EasyPrint function. `Print` is one of the better ones to use as it's easy to remember. It is simply `print` with a capital P.
|
||||
|
||||
import PySimpleGUI as SG
|
||||
import PySimpleGUI as sg
|
||||
|
||||
for i in range(100):
|
||||
SG.Print(i)
|
||||
sg.Print(i)
|
||||
|
||||
|
||||
Or if you didn't want to change your code:
|
||||
|
||||
import PySimpleGUI as SG
|
||||
import PySimpleGUI as sg
|
||||
|
||||
print=SG.Print
|
||||
print=sg.Print
|
||||
for i in range(100):
|
||||
print(i)
|
||||
|
||||
|
|
@ -450,16 +461,16 @@ Turning back to our example. This GUI roughly looks like this:
|
|||
|
||||
Going through each line of code in the above form will help explain how to use this design patter. Copy, modify and run it!
|
||||
|
||||
with SG.FlexForm('SHA-1 & 256 Hash', auto_size_text=True) as form:
|
||||
with sg.FlexForm('SHA-1 & 256 Hash', auto_size_text=True) as form:
|
||||
This creates a new form, storing it in the variable `form`.
|
||||
|
||||
form_rows = [[SG.Text('SHA-1 and SHA-256 Hashes for the file')],
|
||||
form_rows = [[sg.Text('SHA-1 and SHA-256 Hashes for the file')],
|
||||
The next few rows of code lay out the rows of elements in the window to be displayed. The variable `form_rows` holds our entire GUI window. The first row of this form has a Text element. These simply display text on the form.
|
||||
|
||||
[SG.InputText(), SG.FileBrowse()],
|
||||
[sg.InputText(), sg.FileBrowse()],
|
||||
Now we're on the second row of the form. On this row there are 2 elements. The first is an `Input` field. It's a place the user can enter `strings`. The second element is a `File Browse Button`. A file or folder browse button will always fill in the text field to it's left unless otherwise specified. In this example, the File Browse Button will interact with the `InputText` field to its left.
|
||||
|
||||
[SG.Submit(), SG.Cancel()]]
|
||||
[sg.Submit(), sg.Cancel()]]
|
||||
|
||||
The last line of the `form_rows` variable assignment contains a Submit and a Cancel Button. These are buttons that will cause a form to return its value to the caller.
|
||||
|
||||
|
|
@ -498,27 +509,27 @@ If you have a SINGLE value being returned, it is written this way:
|
|||
## All Widgets / Elements
|
||||
This code utilizes as many of the elements in one form as possible.
|
||||
|
||||
with SG.FlexForm('Everything bagel', auto_size_text=True, default_element_size=(40, 1)) as form:
|
||||
with sg.FlexForm('Everything bagel', auto_size_text=True, default_element_size=(40, 1)) as form:
|
||||
layout = [
|
||||
[SG.Text('All graphic widgets in one form!', size=(30, 1), font=("Helvetica", 25), text_color='blue')],
|
||||
[SG.Text('Here is some text.... and a place to enter text')],
|
||||
[SG.InputText()],
|
||||
[SG.Checkbox('My first checkbox!'), SG.Checkbox('My second checkbox!', default=True)],
|
||||
[SG.Radio('My first Radio! ', "RADIO1", default=True), SG.Radio('My second Radio!', "RADIO1")],
|
||||
[SG.Multiline(default_text='This is the default Text shoulsd you decide not to type anything',
|
||||
[sg.Text('All graphic widgets in one form!', size=(30, 1), font=("Helvetica", 25), text_color='blue')],
|
||||
[sg.Text('Here is some text.... and a place to enter text')],
|
||||
[sg.InputText()],
|
||||
[sg.Checkbox('My first checkbox!'), sg.Checkbox('My second checkbox!', default=True)],
|
||||
[sg.Radio('My first Radio! ', "RADIO1", default=True), sg.Radio('My second Radio!', "RADIO1")],
|
||||
[sg.Multiline(default_text='This is the default Text shoulsd you decide not to type anything',
|
||||
scale=(2, 10))],
|
||||
[SG.InputCombo(['Combobox 1', 'Combobox 2'], size=(20, 3)),
|
||||
SG.Slider(range=(1, 100), orientation='h', size=(35, 20), default_value=85)],
|
||||
[SG.Listbox(values=['Listbox 1', 'Listbox 2', 'Listbox 3'], size=(30, 6)),
|
||||
SG.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=25),
|
||||
SG.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=75),
|
||||
SG.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=10)],
|
||||
[SG.Text('_' * 100, size=(70, 1))],
|
||||
[SG.Text('Choose Source and Destination Folders', size=(35, 1))],
|
||||
[SG.Text('Source Folder', size=(15, 1), auto_size_text=False, justification='right'), SG.InputText('Source'), SG.FolderBrowse()],
|
||||
[SG.Text('Destination Folder', size=(15, 1), auto_size_text=False, justification='right'), SG.InputText('Dest'),
|
||||
SG.FolderBrowse()],
|
||||
[SG.Submit(), SG.Cancel(), SG.SimpleButton('Customized', button_color=('white', 'green'))]
|
||||
[sg.InputCombo(['Combobox 1', 'Combobox 2'], size=(20, 3)),
|
||||
sg.Slider(range=(1, 100), orientation='h', size=(35, 20), default_value=85)],
|
||||
[sg.Listbox(values=['Listbox 1', 'Listbox 2', 'Listbox 3'], size=(30, 6)),
|
||||
sg.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=25),
|
||||
sg.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=75),
|
||||
sg.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=10)],
|
||||
[sg.Text('_' * 100, size=(70, 1))],
|
||||
[sg.Text('Choose Source and Destination Folders', size=(35, 1))],
|
||||
[sg.Text('Source Folder', size=(15, 1), auto_size_text=False, justification='right'), sg.InputText('Source'), sg.FolderBrowse()],
|
||||
[sg.Text('Destination Folder', size=(15, 1), auto_size_text=False, justification='right'), sg.InputText('Dest'),
|
||||
sg.FolderBrowse()],
|
||||
[sg.Submit(), sg.Cancel(), sg.SimpleButton('Customized', button_color=('white', 'green'))]
|
||||
]
|
||||
|
||||
button, values = form.LayoutAndRead(layout)
|
||||
|
|
@ -647,7 +658,7 @@ Building a form is simply making lists of Elements. Each list is a row in the o
|
|||
The code is a crude representation of the GUI, laid out in text.
|
||||
#### Text Element
|
||||
|
||||
layout = [[SG.Text('This is what a Text Element looks like')]]
|
||||
layout = [[sg.Text('This is what a Text Element looks like')]]
|
||||
|
||||
|
||||
|
||||
|
|
@ -698,7 +709,7 @@ The shorthand functions for `Text` are `Txt` and `T`
|
|||
|
||||
#### Multiline Text Element
|
||||
|
||||
layout = [[SG.Multiline('This is what a Multi-line Text Element looks like', size=(45,5))]]
|
||||
layout = [[sg.Multiline('This is what a Multi-line Text Element looks like', size=(45,5))]]
|
||||
|
||||
This Element doubles as both an input and output Element. The `DefaultText` optional parameter is used to indicate what to output to the window.
|
||||
|
||||
|
|
@ -734,7 +745,7 @@ Output re-routes `Stdout` to a scrolled text box. It's used with Async forms.
|
|||
|
||||
#### Text Input Element
|
||||
|
||||
layout = [[SG.InputText('Default text')]]
|
||||
layout = [[sg.InputText('Default text')]]
|
||||
|
||||
|
||||
def InputText(default_text = '',
|
||||
|
|
@ -756,7 +767,7 @@ Shorthand functions that are equivalent to `InputText` are `Input` and `In`
|
|||
#### Combo Element
|
||||
Also known as a drop-down list. Only required parameter is the list of choices. The return value is a string matching what's visible on the GUI.
|
||||
|
||||
layout = [[SG.InputCombo(['choice 1', 'choice 2'])]]
|
||||
layout = [[sg.InputCombo(['choice 1', 'choice 2'])]]
|
||||
|
||||
|
||||
|
||||
|
|
@ -774,7 +785,7 @@ Also known as a drop-down list. Only required parameter is the list of choices.
|
|||
#### Listbox Element
|
||||
The standard listbox like you'll find in most GUIs. Note that the return values from this element will be a ***list of results, not a single result***. This is because the user can select more than 1 item from the list (if you set the right mode).
|
||||
|
||||
layout = [[SG.Listbox(values=['Listbox 1', 'Listbox 2', 'Listbox 3'], size=(30, 6))]]
|
||||
layout = [[sg.Listbox(values=['Listbox 1', 'Listbox 2', 'Listbox 3'], size=(30, 6))]]
|
||||
|
||||
|
||||
|
||||
|
|
@ -809,7 +820,7 @@ The `select_mode` option can be a string or a constant value defined as a variab
|
|||
#### Slider Element
|
||||
Sliders have a couple of slider-specific settings as well as appearance settings. Examples include the `orientation` and `range` settings.
|
||||
|
||||
layout = [[SG.Slider(range=(1,500), default_value=222, size=(20,15), orientation='horizontal', font=('Helvetica', 12))]]
|
||||
layout = [[sg.Slider(range=(1,500), default_value=222, size=(20,15), orientation='horizontal', font=('Helvetica', 12))]]
|
||||
|
||||
|
||||
|
||||
|
|
@ -841,7 +852,7 @@ Sliders have a couple of slider-specific settings as well as appearance settings
|
|||
#### Radio Button Element
|
||||
Creates one radio button that is assigned to a group of radio buttons. Only 1 of the buttons in the group can be selected at any one time.
|
||||
|
||||
layout = [[SG.Radio('My first Radio!', "RADIO1", default=True), SG.Radio('My second radio!', "RADIO1")]]
|
||||
layout = [[sg.Radio('My first Radio!', "RADIO1", default=True), sg.Radio('My second radio!', "RADIO1")]]
|
||||
|
||||
|
||||
|
||||
|
|
@ -867,7 +878,7 @@ Creates one radio button that is assigned to a group of radio buttons. Only 1 o
|
|||
#### Checkbox Element
|
||||
Checkbox elements are like Radio Button elements. They return a bool indicating whether or not they are checked.
|
||||
|
||||
layout = [[SG.Checkbox('My first Checkbox!', default=True), SG.Checkbox('My second Checkbox!')]]
|
||||
layout = [[sg.Checkbox('My first Checkbox!', default=True), sg.Checkbox('My second Checkbox!')]]
|
||||
|
||||
|
||||
|
||||
|
|
@ -891,7 +902,7 @@ Checkbox elements are like Radio Button elements. They return a bool indicating
|
|||
#### Spin Element
|
||||
An up/down spinner control. The valid values are passed in as a list.
|
||||
|
||||
layout = [[SG.Spin([i for i in range(1,11)], initial_value=1), SG.Text('Volume level')]]
|
||||
layout = [[sg.Spin([i for i in range(1,11)], initial_value=1), sg.Text('Volume level')]]
|
||||
|
||||
|
||||
|
||||
|
|
@ -951,7 +962,7 @@ Pre-made buttons include:
|
|||
FileBrowse
|
||||
FolderBrowse
|
||||
.
|
||||
layout = [[SG.OK(), SG.Cancel()]]
|
||||
layout = [[sg.OK(), sg.Cancel()]]
|
||||
|
||||
|
||||
|
||||
|
|
@ -969,14 +980,14 @@ The `InputText` element is located at (1,0)... row 1, column 0. The `Browse` bu
|
|||
Target = (-1,0)
|
||||
The code for the entire form could be:
|
||||
|
||||
layout = [[SG.T('Source Folder')],
|
||||
[SG.In()],
|
||||
[SG.FolderBrowse(Target=(-1,0)), SG.OK()]]
|
||||
layout = [[sg.T('Source Folder')],
|
||||
[sg.In()],
|
||||
[sg.FolderBrowse(Target=(-1,0)), sg.OK()]]
|
||||
|
||||
**Custom Buttons**
|
||||
Not all buttons are created equal. A button that closes a form is different that a button that returns from the form without closing it. If you want to define your own button, you will generally do this with the Button Element `SimpleButton`, which closes the form when clicked.
|
||||
|
||||
layout = [[SG.SimpleButton('My Button')]]
|
||||
layout = [[sg.SimpleButton('My Button')]]
|
||||
|
||||
|
||||
|
||||
|
|
@ -1052,20 +1063,19 @@ The `FileBrowse` button has an additional setting named `file_types`. This vari
|
|||
|
||||
This code produces a form where the Browse button only shows files of type .TXT
|
||||
|
||||
layout = [[SG.In() ,SG.FileBrowse(file_types=(("Text Files", "*.txt"),))]]
|
||||
layout = [[sg.In() ,sg.FileBrowse(file_types=(("Text Files", "*.txt"),))]]
|
||||
|
||||
***The ENTER key***
|
||||
The ENTER key is an important part of data entry for forms. There's a long tradition of the enter key being used to quickly submit forms. PySimpleGUI implements this by tying the ENTER key to the first button that closes or reads a form. If there are more than 1 button on a form, the FIRST button that is of type Close Form or Read Form is used. First is determined by scanning the form, top to bottom and left to right.
|
||||
|
||||
|
||||
---
|
||||
---
|
||||
#### ProgressBar
|
||||
The `ProgressBar` element is used to build custom Progress Bar forms. It is HIGHLY recommended that you use the functions that provide a complete progress meter solution for you. Progress Meters are not easy to work with because the forms have to be non-blocking and they are tricky to debug.
|
||||
|
||||
The **easiest** way to get progress meters into your code is to use the `EasyProgessMeter` API. This consists of a pair of functions, `EasyProgessMeter` and `EasyProgressMeterCancel`. You can easily cancel any progress meter by calling it with the current value = max value. This will mark the meter as expired and close the window.
|
||||
You've already seen EasyProgressMeter calls presented earlier in this readme.
|
||||
|
||||
SG.EasyProgressMeter('My Meter', i+1, 1000, 'Optional message')
|
||||
sg.EasyProgressMeter('My Meter', i+1, 1000, 'Optional message')
|
||||
|
||||
The return value for `EasyProgressMeter` is:
|
||||
`True` if meter updated correctly
|
||||
|
|
@ -1091,10 +1101,10 @@ Then to update the bar within your loop
|
|||
*args):
|
||||
Putting it all together you get this design pattern
|
||||
|
||||
my_meter = SG.ProgressMeter('Meter Title', 100000, orentation='Vert')
|
||||
my_meter = sg.ProgressMeter('Meter Title', 100000, orentation='Vert')
|
||||
|
||||
for i in range(0, 100000):
|
||||
SG.ProgressMeterUpdate(my_meter, i+1, 'Some variable', 'Another variable')
|
||||
sg.ProgressMeterUpdate(my_meter, i+1, 'Some variable', 'Another variable')
|
||||
|
||||
|
||||
The final way of using a Progress Meter with PySimpleGUI is to build a custom form with a `ProgressBar` Element in the form. You will need to run your form as a non-blocking form. When you are ready to update your progress bar, you call the `UpdateBar` method for the `ProgressBar` element itself.
|
||||
|
|
@ -1108,13 +1118,13 @@ The Output Element is a re-direction of Stdout. Anything "printed" will be disp
|
|||
|
||||
Here's a complete solution for a chat-window using an Async form with an Output Element
|
||||
|
||||
import PySimpleGUI as SG
|
||||
import PySimpleGUI as sg
|
||||
# Blocking form that doesn't close
|
||||
def ChatBot():
|
||||
with SG.FlexForm('Chat Window', auto_size_text=True, default_element_size=(30, 2)) as form:
|
||||
layout = [[(SG.Text('This is where standard out is being routed', size=[40, 1]))],
|
||||
[SG.Output(size=(80, 20))],
|
||||
[SG.Multiline(size=(70, 5), enter_submits=True), SG.ReadFormButton('SEND', button_color=(SG.YELLOWS[0], SG.BLUES[0])), SG.SimpleButton('EXIT', button_color=(SG.YELLOWS[0], SG.GREENS[0]))]]
|
||||
with sg.FlexForm('Chat Window', auto_size_text=True, default_element_size=(30, 2)) as form:
|
||||
layout = [[(sg.Text('This is where standard out is being routed', size=[40, 1]))],
|
||||
[sg.Output(size=(80, 20))],
|
||||
[sg.Multiline(size=(70, 5), enter_submits=True), sg.ReadFormButton('SEND', button_color=(sg.YELLOWS[0], sg.BLUES[0])), sg.SimpleButton('EXIT', button_color=(sg.YELLOWS[0], sg.GREENS[0]))]]
|
||||
# notice this is NOT the usual LayoutAndRead call because you don't yet want to read the form
|
||||
# if you call LayoutAndRead from here, then you will miss the first button click
|
||||
form.Layout(layout)
|
||||
|
|
@ -1178,14 +1188,14 @@ This call sets all of the different color options.
|
|||
Let's have some fun customizing! Make PySimpleGUI look the way you want it to look. You can set the global settings using the function `PySimpleGUI.SetOptions`. Each option has an optional parameter that's used to set it.
|
||||
|
||||
SetOptions(icon=None
|
||||
button_color=(None,None)
|
||||
element_size=(None,None),
|
||||
margins=(None,None),
|
||||
element_padding=(None,None)
|
||||
auto_size_text=None
|
||||
auto_size_buttons=None
|
||||
font=None
|
||||
border_width=None
|
||||
button_color=(None,None)
|
||||
element_size=(None,None),
|
||||
margins=(None,None),
|
||||
element_padding=(None,None)
|
||||
auto_size_text=None
|
||||
auto_size_buttons=None
|
||||
font=None
|
||||
border_width=None
|
||||
slider_border_width=None
|
||||
slider_relief=None
|
||||
slider_orientation=None
|
||||
|
|
@ -1268,9 +1278,9 @@ The basic flow and functions you will be calling are:
|
|||
Setup
|
||||
|
||||
|
||||
form = FlexForm()
|
||||
form_rows = .....
|
||||
form.LayoutAndRead(form_rows, non_blocking=True)
|
||||
form = FlexForm()
|
||||
form_rows = .....
|
||||
form.LayoutAndRead(form_rows, non_blocking=True)
|
||||
|
||||
|
||||
Periodic refresh
|
||||
|
|
@ -1344,10 +1354,6 @@ Use the example programs as a starting basis for your GUI. Copy, paste, modify
|
|||
## Fun Stuff
|
||||
Here are some things to try if you're bored or want to further customize
|
||||
|
||||
**Colors - Random and predefined**
|
||||
To set a button or text to a random color, use the string `'random'` as the color value. You can also call `PySimpleGUI.GetRandomColor`.
|
||||
To get a random color pair call `PySimpleGUI.GetRandomColorPair`. This returns a tuple containing a random color and that color's compliment.
|
||||
|
||||
**Debug Output**
|
||||
Be sure and check out the EasyPrint (Print) function described in the high-level API section. Leave your code the way it is, route your stdout and stderror to a scrolling window.
|
||||
|
||||
|
|
@ -1411,7 +1417,8 @@ A MikeTheWatchGuy production... entirely responsible for this code.... unless it
|
|||
| 2.4.0 | July 24, 2018 - Button images. Fixes so can run on Raspberry Pi
|
||||
| 2.5.0 | July 26, 2018 - Colors. Listbox scrollbar. tkinter Progress Bar instead of homegrown.
|
||||
| 2.6.0 | July 27, 2018 - auto_size_button setting. License changed to LGPL 3+
|
||||
| 2.6.5 | Aug XX, 2018 - window_location default setting
|
||||
| 2.7.0 | July 30, 2018 - realtime buttons, window_location default setting
|
||||
|
||||
|
||||
### Release Notes
|
||||
2.3 - Sliders, Listbox's and Image elements (oh my!)
|
||||
|
|
@ -1424,6 +1431,9 @@ New debug printing capability. `sg.Print`
|
|||
|
||||
Listboxes are still without scrollwheels. The mouse can drag to see more items. The mouse scrollwheel will also scroll the list and will `page up` and `page down` keys.
|
||||
|
||||
2.7 Is the "feature complete" release. Pretty much all features are done and in the code
|
||||
|
||||
|
||||
### Upcoming
|
||||
Make suggestions people! Future release features
|
||||
|
||||
|
|
@ -1494,5 +1504,3 @@ For Python questions, I simply start my query with 'Python'. Let's say you forg
|
|||
In the hands of a competent programmer, this tool is **amazing**. It's a must-try kind of program that has completely changed my programming process. I'm not afraid of asking for help! You just have to be smart about using what you find.
|
||||
|
||||
The PySimpleGUI window that the results are shown in is an 'input' field which means you can copy and paste the results right into your code.
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue