From 5891ee00b905edfc7d4a64e19016274ec32d369c Mon Sep 17 00:00:00 2001 From: MikeTheWatchGuy Date: Sun, 23 Sep 2018 21:36:40 -0400 Subject: [PATCH] STILL trying to get the docs right! --- docs/index.md | 548 +++++++++++++++++++++++++------------------------- readme.md | 548 +++++++++++++++++++++++++------------------------- 2 files changed, 546 insertions(+), 550 deletions(-) diff --git a/docs/index.md b/docs/index.md index 69009ef3..812257a8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,6 @@ - + + ![pysimplegui_logo](https://user-images.githubusercontent.com/13696193/43165867-fe02e3b2-8f62-11e8-9fd0-cc7c86b11772.png) @@ -8,7 +9,7 @@ # PySimpleGUI -![Python Version](https://img.shields.io/badge/PySimpleGUI_Version-3.6.1-red.svg?longCache=true&style=for-the-badge) +![Python Version](https://img.shields.io/badge/PySimpleGUI_Version-3.6.2-red.svg?longCache=true&style=for-the-badge) [Announcements of Latest Developments](https://github.com/MikeTheWatchGuy/PySimpleGUI/issues/142) @@ -54,7 +55,7 @@ Or how about a ***custom GUI*** in 1 line of code? ![get filename](https://user-images.githubusercontent.com/13696193/44960039-f1018880-aec5-11e8-8a43-3d7f8ff93b67.jpg) - Build beautiful customized forms that fit your specific problem. Let PySimpleGUI solve your GUI problem while you solve your real problems. Look through the Cookbook, find a matching recipe, copy, paste and be up and running with a GUI in minutes. This is the process PySimpleGUI was designed to work within. + Build beautiful customized windows that fit your specific problem. Let PySimpleGUI solve your GUI problem while you solve your real problems. Look through the Cookbook, find a matching recipe, copy, paste and be up and running with a GUI in minutes. This is the process PySimpleGUI was designed to work within. ![borderless grayed buttons](https://user-images.githubusercontent.com/13696193/45168664-d848e980-b1c9-11e8-886e-63279ae4017f.jpg) @@ -95,7 +96,7 @@ Combining PySimpleGUI with PyInstaller creates something truly remarkable and sp ## Background I was frustrated by having to deal with the dos prompt when I had a powerful Windows machine right in front of me. Why is it SO difficult to do even the simplest of input/output to a window in Python?? -There are a number of 'easy to use' Python GUIs, but they were too limited for my requirements. PySimpleGUI aims for the same simplicity found in packages like `EasyGUI`and `WxSimpleGUI` , both really handy but limited, and adds the ability to define your own layouts. This ability to make your own forms using a large palette of widgets is but one difference between the existing "simple" packages and `PySimpleGUI`. +There are a number of 'easy to use' Python GUIs, but they were too limited for my requirements. PySimpleGUI aims for the same simplicity found in packages like `EasyGUI`and `WxSimpleGUI` , both really handy but limited, and adds the ability to define your own layouts. This ability to make your own windows using a large palette of widgets is but one difference between the existing "simple" packages and `PySimpleGUI`. With a simple GUI, it becomes practical to "associate" .py files with the python interpreter on Windows. Double click a py file and up pops a GUI window, a more pleasant experience than opening a dos Window and typing a command line. @@ -121,7 +122,7 @@ While simple to use, PySimpleGUI has significant depth to be explored by more ad Folder Browse SaveAs Non-closing return - Close form + Close window Realtime Calendar chooser Color chooser @@ -137,7 +138,7 @@ While simple to use, PySimpleGUI has significant depth to be explored by more ad Scroll-able Output Images Progress Bar Async/Non-Blocking Windows - Tabbed forms + Tabbed windows Persistent Windows Redirect Python Output/Errors to scrolling window 'Higher level' APIs (e.g. MessageBox, YesNobox, ...) @@ -148,15 +149,15 @@ While simple to use, PySimpleGUI has significant depth to be explored by more ad Return values as dictionary Set focus Bind return key to buttons - Group widgets into a column and place into form anywhere + Group widgets into a column and place into window anywhere Scrollable columns Keyboard low-level key capture Mouse scroll-wheel support Get Listbox values as they are selected Get slider, spinner, combo as they are changed - Update elements in a live form - Bulk form-fill operation - Save / Load form to/from disk + Update elements in a live window + Bulk window-fill operation + Save / Load window to/from disk Borderless (no titlebar) windows Always on top windows Menus @@ -165,7 +166,7 @@ While simple to use, PySimpleGUI has significant depth to be explored by more ad No async programming required (no callbacks to worry about) -An example of many widgets used on a single form. A little further down you'll find the 21 lines of code required to create this complex form. Try it if you don't believe it. Install PySimpleGUI then : +An example of many widgets used on a single window. A little further down you'll find the 21 lines of code required to create this complex window. Try it if you don't believe it. Install PySimpleGUI then : >Start Python, copy and paste the code below into the >>> prompt and hit enter. This will pop up... > @@ -176,7 +177,7 @@ An example of many widgets used on a single form. A little further down you'll import PySimpleGUI as sg - layout = [[sg.Text('All graphic widgets in one form!', size=(30, 1), font=("Helvetica", 25), text_color='blue')], + layout = [[sg.Text('All graphic widgets in one window!', 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)], @@ -211,8 +212,8 @@ An example of many widgets used on a single form. A little further down you'll Be Pythonic... Attempted to use language constructs in a natural way and to exploit some of Python's interesting features. Python's lists and optional parameters make PySimpleGUI work smoothly. - - Forms are represented as Python lists. - - A form is a list of rows + - windows are represented as Python lists. + - A window is a list of rows - A row is a list of elements - Return values are a list of button presses and input values. - Return values can also be represented as a dictionary @@ -281,21 +282,21 @@ If you wish to create an EXE from your PySimpleGUI application, you will need to To use in your code, simply import.... `import PySimpleGUI as sg` -Then use either "high level" API calls or build your own forms. +Then use either "high level" API calls or build your own windows. sg.Popup('This is my first Popup') ![first popup](https://user-images.githubusercontent.com/13696193/44957300-c7813680-ae9e-11e8-9a8c-c70198db7907.jpg) -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. +Yes, it's just that easy to have a window appear on the screen using Python. With PySimpleGUI, making a custom window appear isn't much more difficult. The goal is to get you running on your GUI within ***minutes***, not hours nor days. --- ## APIs PySimpleGUI can be broken down into 2 types of API's: * High Level single call functions (The `Popup` calls) - * Custom form functions + * Custom window functions ### Python Language Features @@ -319,7 +320,7 @@ Each new item begins on a new line in the Popup #### Optional Parameters to a Function Call -This feature of the Python language is utilized ***heavily*** as a method of customizing forms and form Elements. Rather than requiring the programmer to specify every possible option for a widget, instead only the options the caller wants to override are specified. +This feature of the Python language is utilized ***heavily*** as a method of customizing windows and window Elements. Rather than requiring the programmer to specify every possible option for a widget, instead only the options the caller wants to override are specified. Here is the function definition for the Popup function. The details aren't important. What is important is seeing that there is a long list of potential tweaks that a caller can make. However, they don't *have* to be specified on each and every call. @@ -343,7 +344,7 @@ If the caller wanted to change the button color to be black on yellow, the call #### Dictionaries Dictionaries are used by more advanced PySimpleGUI users. You'll know that dictionaries are being used if you see a `key` parameter on any Element. Dictionaries are used in 2 ways: -1. To identify values when a form is read +1. To identify values when a window is read 2. To identify Elements so that they can be "updated" --- @@ -356,7 +357,7 @@ Dictionaries are used by more advanced PySimpleGUI users. You'll know that dict Think of the `Popup` call as the GUI equivalent of a `print` statement. It's your way of displaying results to a user in the windowed world. Each call to Popup will create a new Popup window. -`Popup` calls are normally blocking. your program will stop executing until the user has closed the Popup window. A non-blocking form of Popup discussed in the async section. +`Popup` calls are normally blocking. your program will stop executing until the user has closed the Popup window. A non-blocking window of Popup discussed in the async section. Just like a print statement, you can pass any number of arguments you wish. They will all be turned into strings and displayed in the popup window. @@ -441,7 +442,7 @@ There are Popup calls for single-item inputs. These follow the pattern of `Popup - `PopupGetFile` - get a filename - `PopupGetFolder` - get a folder name -Rather than make a custom form to get one data value, call the Popup input function to get the item from the user. +Rather than make a custom window to get one data value, call the Popup input function to get the item from the user. import PySimpleGUI as sg @@ -491,7 +492,7 @@ That line of code resulted in this window popping up and updating. ![preogress meter](https://user-images.githubusercontent.com/13696193/43667625-d47da702-9746-11e8-91e6-e5177883abae.jpg) 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 `OneLineProgressMeter`. It normally returns `True`. +With a little trickery you can provide a way to break out of your loop using the Progress Meter window. The cancel button results in a `False` return value from `OneLineProgressMeter`. It normally returns `True`. ***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. @@ -524,20 +525,20 @@ A word of caution. There are known problems when multiple PySimpleGUI windows a You can change the size of the debug window using the `SetOptions` call with the `debug_win_size` parameter. --- -# Custom Form API Calls (Your First Form) +# Custom window API Calls (Your First window) This is the FUN part of the programming of this GUI. In order to really get the most out of the API, you should be using an IDE that supports auto complete or will show you the definition of the function. This will make customizing go smoother. -This first section on custom forms is for your typical, blocking, non-persistant form. By this I mean, when you "show" the form, the function will not return until the user has clicked a button or closed the window. When this happens, the form's window will be automatically closed. +This first section on custom windows is for your typical, blocking, non-persistant window. By this I mean, when you "show" the window, the function will not return until the user has clicked a button or closed the window. When this happens, the window will be automatically closed. -Two other types of forms exist. -1. Persistent form - rather than closing on button clicks, the show form function returns and the form continues to be visible. This is good for applications like a chat window. -2. Asynchronous form - the trickiest of the lot. Great care must be exercised. Examples are an MP3 player or status dashboard. Async forms are updated (refreshed) on a periodic basis. +Two other types of windows exist. +1. Persistent window - rather than closing on button clicks, the show window function returns and the window continues to be visible. This is good for applications like a chat window. +2. Asynchronous window - the trickiest of the lot. Great care must be exercised. Examples are an MP3 player or status dashboard. Async windows are updated (refreshed) on a periodic basis. It's both not enjoyable nor helpful to immediately jump into tweaking each and every little thing available to you. -## The Form Designer -The good news to newcomers to GUI programming is that PySimpleGUI has a form designer. Better yet, the form designer requires no training and everyone knows how to use it. +## The window Designer +The good news to newcomers to GUI programming is that PySimpleGUI has a window designer. Better yet, the window designer requires no training and everyone knows how to use it. ![gui0_1](https://user-images.githubusercontent.com/13696193/44159598-e2257400-a085-11e8-9b02-343e72cc75c3.JPG) @@ -595,12 +596,12 @@ Finally we can put it all together into a program that will display our window. sg.Popup(button, number) ### Example 2 - Get a filename -Let's say you've got a utility you've written that operates on some input file and you're ready to use a GUI to enter than filename rather than the command line. Follow the same steps as the previous example - draw your form on paper, break it up into rows, label the elements. +Let's say you've got a utility you've written that operates on some input file and you're ready to use a GUI to enter than filename rather than the command line. Follow the same steps as the previous example - draw your window on paper, break it up into rows, label the elements. ![gui4_1](https://user-images.githubusercontent.com/13696193/44160132-6a584900-a087-11e8-862f-7d791a67ee5d.JPG) ![gui5_1](https://user-images.githubusercontent.com/13696193/44160133-6af0df80-a087-11e8-9dec-bb4d4c59393d.JPG) -Writing the code for this one is just as straightforward. There is one tricky thing, that browse for a file button. Thankfully PySimpleGUI takes care of associating it with the input field next to it. As a result, the code looks almost exactly like the form on the paper. +Writing the code for this one is just as straightforward. There is one tricky thing, that browse for a file button. Thankfully PySimpleGUI takes care of associating it with the input field next to it. As a result, the code looks almost exactly like the window on the paper. import PySimpleGUI as sg @@ -613,57 +614,57 @@ Writing the code for this one is just as straightforward. There is one tricky t sg.Popup(button, number) -Read on for detailed instructions on the calls that show the form and return your results. +Read on for detailed instructions on the calls that show the window and return your results. # Copy these design patterns! -All of your PySimpleGUI programs will utilize one of these 3 design patterns depending on the type of form you're implementing. +All of your PySimpleGUI programs will utilize one of these 3 design patterns depending on the type of window you're implementing. -## Pattern 1 - Single read forms +## Pattern 1 - Single read windows -This is the most basic design pattern. Use this for forms that are shown to the user 1 time. The input values are gathered and returned to the program +This is the most basic design pattern. Use this for windows that are shown to the user 1 time. The input values are gathered and returned to the program - form_rows = [[sg.Text('SHA-1 and SHA-256 Hashes for the file')], + window_rows = [[sg.Text('SHA-1 and SHA-256 Hashes for the file')], [sg.InputText(), sg.FileBrowse()], [sg.Submit(), sg.Cancel()]] - form = sg.Window('SHA-1 & 256 Hash') + window = sg.Window('SHA-1 & 256 Hash') - button, (source_filename,) = form.LayoutAndRead(form_rows) + button, (source_filename,) = window.LayoutAndRead(window_rows) ---- -## Pattern 2 - Single-read form "chained" +## Pattern 2 - Single-read window "chained" -Python has a ***beautiful*** way of compacting code known as "chaining". You take the output from one function and feed it as input to the next. Notice in the first example how a form is first obtained by calling Window and then that form is then read. It's possible to combine the creation of the form with the read. This design pattern does exactly that, chain together the form creation and the form reading. +Python has a ***beautiful*** way of compacting code known as "chaining". You take the output from one function and feed it as input to the next. Notice in the first example how a window is first obtained by calling Window and then that window is then read. It's possible to combine the creation of the window with the read. This design pattern does exactly that, chain together the window creation and the window reading. - form_rows = [[sg.Text('SHA-1 and SHA-256 Hashes for the file')], + window_rows = [[sg.Text('SHA-1 and SHA-256 Hashes for the file')], [sg.InputText(), sg.FileBrowse()], [sg.Submit(), sg.Cancel()]] - button, (source_filename,) = sg.Window('SHA-1 & 256 Hash').LayoutAndRead(form_rows) + button, (source_filename,) = sg.Window('SHA-1 & 256 Hash').LayoutAndRead(window_rows) -## Pattern 3 - Persistent form (multiple reads) +## Pattern 3 - Persistent window (multiple reads) -Some of the more advanced programs operate with the form remaining visible on the screen. Input values are collected, but rather than closing the form, it is kept visible acting as a way to both output information to the user and gather input data. +Some of the more advanced programs operate with the window remaining visible on the screen. Input values are collected, but rather than closing the window, it is kept visible acting as a way to both output information to the user and gather input data. -This is done by splitting the LayoutAndRead call apart into a Layout call and a Read call. Note how chaining is again used. In this case a form is created by calling Window which is then passed on to the Layout method. The Layout method returns the form value so that it can be stored and used later in the program to Read the form. +This is done by splitting the LayoutAndRead call apart into a Layout call and a Read call. Note how chaining is again used. In this case a window is created by calling Window which is then passed on to the Layout method. The Layout method returns the window value so that it can be stored and used later in the program to Read the window. import PySimpleGUI as sg - layout = [[sg.Text('Persistent form')], + layout = [[sg.Text('Persistent window')], [sg.RButton('Turn LED On')], [sg.RButton('Turn LED Off')], [sg.Exit()]] - form = sg.Window('Raspberry Pi GUI').Layout(layout) + window = sg.Window('Raspberry Pi GUI').Layout(layout) while True: - button, values = form.Read() + button, values = window.Read() if button is None: break @@ -672,7 +673,7 @@ This is done by splitting the LayoutAndRead call apart into a Layout call and a Why is Python such a great teaching language and yet no GUI framework exists that lends itself to the basic building blocks of Python, the list or dictionary? PySimpleGUI set out to be a Pythonic solution to the GUI problem. Whether it achieved this goal is debatable, but it was an attempt just the same. -The key to custom forms in PySimpleGUI is to view forms as ROWS of Elements. Each row is specified as a list of these Elements. Put the rows together and you've got a form or window. +The key to custom windows in PySimpleGUI is to view windows as ROWS of Elements. Each row is specified as a list of these Elements. Put the rows together and you've got a window. Let's dissect this little program @@ -683,15 +684,15 @@ The key to custom forms in PySimpleGUI is to view forms as ROWS of Elements. E [sg.Text('Source for Files ', size=(15, 1)), sg.InputText(), sg.FolderBrowse()], [sg.Submit(), sg.Cancel()]] - form = sg.Window('Rename Files or Folders') + window = sg.Window('Rename Files or Folders') - button, (folder_path, file_path) = form.LayoutAndRead(layout) + button, (folder_path, file_path) = window.LayoutAndRead(layout) ![snap0131](https://user-images.githubusercontent.com/13696193/43417007-df6d8408-9407-11e8-9986-30f0415f08a5.jpg) -Let's agree the form has 4 rows. +Let's agree the window has 4 rows. The first row only has **text** that reads `Rename files or folders` @@ -706,15 +707,15 @@ Now let's look at how those 2 rows and the other two row from Python code: See how the source code mirrors the layout? You simply make lists for each row, then submit that table to PySimpleGUI to show and get values from. -And what about those return values? Most people simply want to show a form, get the input values and do something with them. So why break up the code into button callbacks, etc, when I simply want my form's input values to be given to me. +And what about those return values? Most people simply want to show a window, get the input values and do something with them. So why break up the code into button callbacks, etc, when I simply want my window's input values to be given to me. -For return values the form is scanned from top to bottom, left to right. Each field that's an input field will occupy a spot in the return values. +For return values the window is scanned from top to bottom, left to right. Each field that's an input field will occupy a spot in the return values. -In our example form, there are 2 fields, so the return values from this form will be a list with 2 values in it. +In our example window, there are 2 fields, so the return values from this window will be a list with 2 values in it. - button, (folder_path, file_path) = form.LayoutAndRead(layout) + button, (folder_path, file_path) = window.LayoutAndRead(layout) -In the statement that shows and reads the form, the two input fields are directly assigned to the caller's variables `folder_path` and `file_path`, ready to use. No parsing no callbacks. +In the statement that shows and reads the window, the two input fields are directly assigned to the caller's variables `folder_path` and `file_path`, ready to use. No parsing no callbacks. Isn't this what almost every Python programmer looking for a GUI wants?? Something easy to work with to get the values and move on to the rest of the program, where the real action is taking place. Why write pages of GUI code when the same layout can be achieved with PySimpleGUI in 3 or 4 lines of code. 4 lines or 40? I chose 4. @@ -727,54 +728,54 @@ Isn't this what almost every Python programmer looking for a GUI wants?? Someth By default return values are a list of values, one entry for each input field. - Return information from Window, SG's primary form builder interface, is in this format: + Return information from Window, SG's primary window builder interface, is in this format: button, (value1, value2, ...) Each of the Elements that are Input Elements will have a value in the list of return values. You can unpack your GUI directly into the variables you want to use. - button, (filename, folder1, folder2, should_overwrite) = form.LayoutAndRead(form_rows) + button, (filename, folder1, folder2, should_overwrite) = window.LayoutAndRead(window_rows) Or, you can unpack the return results separately. - button, values = form.LayoutAndRead(form_rows) + button, values = window.LayoutAndRead(window_rows) filename, folder1, folder2, should_overwrite = values If you have a SINGLE value being returned, it is written this way: - button, (value1,) = form.LayoutAndRead(form_rows) + button, (value1,) = window.LayoutAndRead(window_rows) Another way of parsing the return values is to store the list of values into a variable representing the list of values and then index each individual value. This is not the preferred way of doing it. - button, value_list = form.LayoutAndRead(form_rows) + button, value_list = window.LayoutAndRead(window_rows) value1 = value_list[0] value2 = value_list[1] ... ### Return values as a dictionary -For forms longer than 3 or 4 fields you will want to use a dictionary to help you organize your return values. In almost all (if not all) of the demo programs you'll find the return values being passed as a dictionary. It is not a difficult concept to grasp, the syntax is easy to understand, and it makes for very readable code. +For windows longer than 3 or 4 fields you will want to use a dictionary to help you organize your return values. In almost all (if not all) of the demo programs you'll find the return values being passed as a dictionary. It is not a difficult concept to grasp, the syntax is easy to understand, and it makes for very readable code. -The most common form read statement you'll encounter looks something like this: +The most common window read statement you'll encounter looks something like this: - button, values = form.LayoutAndRead(layout) + button, values = window.LayoutAndRead(layout) or - button, values = form.Read() + button, values = window.Read() All of your return values will be stored in the variable `values`. When using the dictionary return values, the `values` variable is a dictionary. To use a dictionary, you will need to: * Mark each input element you wish to be in the dictionary with the keyword `key`. -If **any** element in the form has a `key`, then **all** of the return values are returned via a dictionary. If some elements do not have a key, then they are numbered starting at zero. +If **any** element in the window has a `key`, then **all** of the return values are returned via a dictionary. If some elements do not have a key, then they are numbered starting at zero. -Let's take a look at your first dictionary-based form. +Let's take a look at your first dictionary-based window. import PySimpleGUI as sg - form = sg.Window('Simple data entry form') + window = sg.Window('Simple data entry window') layout = [ [sg.Text('Please enter your Name, Address, Phone')], [sg.Text('Name', size=(15, 1)), sg.InputText('1', key='name')], @@ -783,7 +784,7 @@ Let's take a look at your first dictionary-based form. [sg.Submit(), sg.Cancel()] ] - button, values = form.LayoutAndRead(layout) + button, values = window.LayoutAndRead(layout) sg.Popup(button, values, values['name'], values['address'], values['phone']) @@ -791,7 +792,7 @@ To get the value of an input field, you use whatever value used as the `key` val values['name'] -You will find the key field used quite heavily in most PySimpleGUI forms unless the form is very simple. +You will find the key field used quite heavily in most PySimpleGUI windows unless the window is very simple. ### Button Return Values @@ -800,20 +801,20 @@ The button value from a Read call will be one of 3 values: 2. The Button's key 3. None -If a button has a key set for it when it's created, then that key will be returned. If no key is set, then the button text is returned. If no button was clicked, but the form returned anyway, the button value is None. +If a button has a key set for it when it's created, then that key will be returned. If no key is set, then the button text is returned. If no button was clicked, but the window returned anyway, the button value is None. None is returned when the user clicks the X to close a window. -If your form has an event loop where it is read over and over, remember to give your user an "out". You should always check for a None value and it's a good practice to provide an Exit button of some kind. Thus design patterns often resemble this Event Loop: +If your window has an event loop where it is read over and over, remember to give your user an "out". You should always check for a None value and it's a good practice to provide an Exit button of some kind. Thus design patterns often resemble this Event Loop: while True: - button, values= form.Read() + button, values= window.Read() if button is None or button == 'Quit': break ## The Event Loop / Callback Functions -All GUIs have one thing in common, an "event loop" or some kind. If your program shows a single form, collects the data and then executes the primary code of the program then you likely don't need an event loop. +All GUIs have one thing in common, an "event loop" or some kind. If your program shows a single window, collects the data and then executes the primary code of the program then you likely don't need an event loop. Event Loops are used in programs where the window ***stays open*** after button presses. The program processes button clicks and user input in a loop called the event loop. You often hear the term event loop when discussing embedded systems or on a Raspberry Pi. @@ -831,11 +832,11 @@ This little program has a typical Event Loop [sg.RButton('Turn LED Off')], [sg.Exit()]] - form = sg.Window('Raspberry Pi).Layout(layout) + window = sg.Window('Raspberry Pi).Layout(layout) # ---- Event Loop ---- # while True: - button, values = form.Read() + button, values = window.Read() # ---- Process Button Clicks ---- # if button is None or button == 'Exit': @@ -850,7 +851,7 @@ This little program has a typical Event Loop -In the Event Loop we are reading the form and then doing a series of button compares to determine what to do based on the button that was clicks (value of `button` variable) +In the Event Loop we are reading the window and then doing a series of button compares to determine what to do based on the button that was clicks (value of `button` variable) The way buttons are presented to the caller in PySimpleGUI is ***not*** how *most* GUI frameworks handle button clicks. Most GUI frameworks, including tkinter, use ***callback*** functions, a function you define would be called when a button is clicked. This requires you to write code where data is shared. @@ -864,7 +865,7 @@ Whether or not this is a "proper" design for GUI programs can be debated. It's ## All Widgets / Elements -This code utilizes as many of the elements in one form as possible. +This code utilizes as many of the elements in one window as possible. import PySimpleGUI as sg @@ -883,7 +884,7 @@ This code utilizes as many of the elements in one form as possible. layout = [ [sg.Menu(menu_def, tearoff=True)], - [sg.Text('All graphic widgets in one form!', size=(30, 1), justification='center', font=("Helvetica", 25), relief=sg.RELIEF_RIDGE)], + [sg.Text('All graphic widgets in one window!', size=(30, 1), justification='center', font=("Helvetica", 25), relief=sg.RELIEF_RIDGE)], [sg.Text('Here is some text.... and a place to enter text')], [sg.InputText('This is my text')], [sg.Frame(layout=[ @@ -904,52 +905,52 @@ This code utilizes as many of the elements in one form as possible. [sg.Text('Choose A Folder', size=(35, 1))], [sg.Text('Your Folder', size=(15, 1), auto_size_text=False, justification='right'), sg.InputText('Default Folder'), sg.FolderBrowse()], - [sg.Submit(tooltip='Click to submit this form'), sg.Cancel()] + [sg.Submit(tooltip='Click to submit this window'), sg.Cancel()] ] - form = sg.Window('Everything bagel', default_element_size=(40, 1), grab_anywhere=False).Layout(layout) + window = sg.Window('Everything bagel', default_element_size=(40, 1), grab_anywhere=False).Layout(layout) - button, values = form.Read() + button, values = window.Read() sg.Popup('Title', - 'The results of the form.', + 'The results of the window.', 'The button clicked was "{}"'.format(button), 'The values are', values) -This is a somewhat complex form with quite a bit of custom sizing to make things line up well. This is code you only have to write once. When looking at the code, remember that what you're seeing is a list of lists. Each row contains a list of Graphical Elements that are used to create the form. +This is a somewhat complex window with quite a bit of custom sizing to make things line up well. This is code you only have to write once. When looking at the code, remember that what you're seeing is a list of lists. Each row contains a list of Graphical Elements that are used to create the window. ![everything bagel](https://user-images.githubusercontent.com/13696193/45914128-87163800-be0e-11e8-9a83-7ee5960e88b9.jpg) -Clicking the Submit button caused the form call to return. The call to Popup resulted in this dialog box. +Clicking the Submit button caused the window call to return. The call to Popup resulted in this dialog box. ![everything bagel reseults](https://user-images.githubusercontent.com/13696193/45914129-87aece80-be0e-11e8-8aae-9a483a9ad4a6.jpg) -**`Note, button value can be None`**. The value for `button` will be the text that is displayed on the button element when it was created. If the user closed the form using something other than a button, then `button` will be `None`. +**`Note, button value can be None`**. The value for `button` will be the text that is displayed on the button element when it was created. If the user closed the window using something other than a button, then `button` will be `None`. -You can see in the Popup that the values returned are a list. Each input field in the form generates one item in the return values list. All input fields return a `string` except for Check Boxes and Radio Buttons. These return `bool`. +You can see in the Popup that the values returned are a list. Each input field in the window generates one item in the return values list. All input fields return a `string` except for Check Boxes and Radio Buttons. These return `bool`. --- -# Building Custom Forms +# Building Custom windows You will find it much easier to write code using PySimpleGUI if you use an IDE such as PyCharm. The features that show you documentation about the API call you are making will help you determine which settings you want to change, if any. In PyCharm, two commands are particularly helpful. Control-Q (when cursor is on function name) brings up a box with the function definition Control-P (when cursor inside function call "()") shows a list of parameters and their default values -## Synchronous Forms -The most common use of PySimpleGUI is to display and collect information from the user. The most straightforward way to do this is using a "blocking" GUI call. Execution is "blocked" while waiting for the user to close the GUI form/dialog box. -You've already seen a number of examples above that use blocking forms. Anytime you see a context manager used (see the `with` statement) it's most likely a blocking form. You can examine the show calls to be sure. If the form is a non-blocking form, it must indicate that in the call to `form.show`. +## Synchronous windows +The most common use of PySimpleGUI is to display and collect information from the user. The most straightforward way to do this is using a "blocking" GUI call. Execution is "blocked" while waiting for the user to close the GUI window/dialog box. +You've already seen a number of examples above that use blocking windows. Anytime you see a context manager used (see the `with` statement) it's most likely a blocking window. You can examine the show calls to be sure. If the window is a non-blocking window, it must indicate that in the call to `window.show`. -NON-BLOCKING form call: +NON-BLOCKING window call: - form.Show(non_blocking=True) + window.Show(non_blocking=True) -### Beginning a Form -The first step is to create the form object using the desired form customization. +### Beginning a window +The first step is to create the window object using the desired window customization. - with Window('Everything bagel', auto_size_text=True, default_element_size=(30,1)) as form: + with Window('Everything bagel', auto_size_text=True, default_element_size=(30,1)) as window: This is the definition of the Window object: @@ -976,39 +977,39 @@ This is the definition of the Window object: keep_on_top=False): -Parameter Descriptions. You will find these same parameters specified for each `Element` and some of them in `Row` specifications. The `Element` specified value will take precedence over the `Row` and `Form` values. +Parameter Descriptions. You will find these same parameters specified for each `Element` and some of them in `Row` specifications. The `Element` specified value will take precedence over the `Row` and `window` values. - default_element_size - Size of elements in form in characters (width, height) - default_button_element_size - Size of buttons on this form + default_element_size - Size of elements in window in characters (width, height) + default_button_element_size - Size of buttons on this window auto_size_text - Bool. True if elements should size themselves according to contents. Defaults to True auto_size_buttons - Bool. True if button elements should size themselves according to their text label location - (x,y) Location to place window in pixels - font - Font name and size for elements of the form + font - Font name and size for elements of the window button_color - Default color for buttons (foreground, background). Can be text or hex progress_bar_color - Foreground and background colors for progress bars background_color - Color of the window background - is_tabbed_form - Bool. If True then form is a tabbed form + is_tabbed_form - Bool. If True then window is a tabbed window border_depth - Amount of 'bezel' to put on input boxes, buttons, etc. - auto_close - Bool. If True form will autoclose - auto_close_duration - Duration in seconds before form closes + auto_close - Bool. If True window will autoclose + auto_close_duration - Duration in seconds before window closes icon - .ICO file that will appear on the Task Bar and end of Title Bar return_keyboard_events - if True key presses are returned as buttons use_default_focus - if True and no focus set, then automatically set a focus - text_justification - Justification to use for Text Elements in this form + text_justification - Justification to use for Text Elements in this window no_titlebar - Create window without a titlebar grab_anywhere - Grab any location on the window to move the window keep_on_top - if True then window will always stop on top of other windows on the screen. Great for floating toolbars. #### Window Location -PySimpleGUI computes the exact center of your window and centers the window on the screen. If you want to locate your window elsewhere, such as the system default of (0,0), if you have 2 ways of doing this. The first is when the form is created. Use the `location` parameter to set where the window. The second way of doing this is to use the `SetOptions` call which will set the default window location for all windows in the future. +PySimpleGUI computes the exact center of your window and centers the window on the screen. If you want to locate your window elsewhere, such as the system default of (0,0), if you have 2 ways of doing this. The first is when the window is created. Use the `location` parameter to set where the window. The second way of doing this is to use the `SetOptions` call which will set the default window location for all windows in the future. #### Sizes Note several variables that deal with "size". Element sizes are measured in characters. A Text Element with a size of 20,1 has a size of 20 characters wide by 1 character tall. The default Element size for PySimpleGUI is `(45,1)`. -Sizes can be set at the element level, or in this case, the size variables apply to all elements in the form. Setting `size=(20,1)` in the form creation call will set all elements in the form to that size. +Sizes can be set at the element level, or in this case, the size variables apply to all elements in the window. Setting `size=(20,1)` in the window creation call will set all elements in the window to that size. There are a couple of widgets where one of the size values is in pixels rather than characters. This is true for Progress Meters and Sliders. The second parameter is the 'height' in pixels. @@ -1028,17 +1029,17 @@ Windows without a titlebar can be used to easily create a floating launcher. #### Grab Anywhere -This is a feature unique to PySimpleGUI. The default is ENABLED.... unless the form is a non-blocking form. +This is a feature unique to PySimpleGUI. The default is ENABLED.... unless the window is a non-blocking window. -It is turned off for non-blocking because there is a warning message printed out if the user closes a non-blocking form using a button with grab_anywhere enabled. There is no harm in these messages, but it may be distressing to the user. Should you wish to enable for a non-blocking form, simply get grab_anywhere = True when you create the form. +It is turned off for non-blocking because there is a warning message printed out if the user closes a non-blocking window using a button with grab_anywhere enabled. There is no harm in these messages, but it may be distressing to the user. Should you wish to enable for a non-blocking window, simply get grab_anywhere = True when you create the window. #### Always on top -To keep a window on top of all other windows on the screen, set keep_on_top = True when the form is created. This feature makes for floating toolbars that are very helpful and always visible on your desktop. +To keep a window on top of all other windows on the screen, set keep_on_top = True when the window is created. This feature makes for floating toolbars that are very helpful and always visible on your desktop. ## Elements -"Elements" are the building blocks used to create forms. Some GUI APIs use the term "Widget" to describe these graphic elements. +"Elements" are the building blocks used to create windows. Some GUI APIs use the term "Widget" to describe these graphic elements. Text Single Line Input @@ -1047,8 +1048,8 @@ To keep a window on top of all other windows on the screen, set keep_on_top = Tr Folder Browse Calendar picker Date Chooser - Read form - Close form + Read window + Close window Realtime Checkboxes Radio Buttons @@ -1065,7 +1066,7 @@ To keep a window on top of all other windows on the screen, set keep_on_top = Tr Image Table Async/Non-Blocking Windows - Tabbed forms + Tabbed windows Persistent Windows Redirect Python Output/Errors to scrolling Window "Higher level" APIs (e.g. MessageBox, YesNobox, ...) @@ -1076,14 +1077,14 @@ key tooltip #### Tooltip -Tooltips are text boxes that popup next to an element if you hold your mouse over the top of it. If you want to be extra kind to your form's user, then you can create tooltips for them by setting the parameter `tooltip` to some text string. You will need to supply your own line breaks / text wrapping. If you don't want to manually add them, then take a look at the standard library package `textwrap`. +Tooltips are text boxes that popup next to an element if you hold your mouse over the top of it. If you want to be extra kind to your window's user, then you can create tooltips for them by setting the parameter `tooltip` to some text string. You will need to supply your own line breaks / text wrapping. If you don't want to manually add them, then take a look at the standard library package `textwrap`. Tooltips are one of those "polish" items that really dress-up a GUI and show's a level of sophistication. Go ahead, impress people, throw some tooltips into your GUI. ### Output Elements -Building a form is simply making lists of Elements. Each list is a row in the overall GUI dialog box. The definition looks something like this: +Building a window is simply making lists of Elements. Each list is a row in the overall GUI dialog box. The definition looks something like this: layout = [ [row 1 element, row 1 element], [row 2 element, row 2 element, row 2 element] ] @@ -1168,14 +1169,14 @@ This Element doubles as both an input and output Element. The `DefaultText` opt . default_text - Text to display in the text box - enter_submits - Bool. If True, pressing Enter key submits form + enter_submits - Bool. If True, pressing Enter key submits window size - Element's size auto_size_text - Bool. Change width to match size of text #### Output Element -Output re-routes `Stdout` to a scrolled text box. It's used with Async forms. More on this later. +Output re-routes `Stdout` to a scrolled text box. It's used with Async windows. More on this later. - form.AddRow(gg.Output(size=(100,20))) + window.AddRow(gg.Output(size=(100,20))) ![output](https://user-images.githubusercontent.com/13696193/44959863-b72f8280-aec3-11e8-8caa-7bc743149953.jpg) @@ -1185,7 +1186,7 @@ Output re-routes `Stdout` to a scrolled text box. It's used with Async forms. size - Size of element (width, height) in characters ### Input Elements - These make up the majority of the form definition. Optional variables at the Element level override the Form level values (e.g. `size` is specified in the Element). All input Elements create an entry in the list of return values. A Text Input Element creates a string in the list of items returned. + These make up the majority of the window definition. Optional variables at the Element level override the window level values (e.g. `size` is specified in the Element). All input Elements create an entry in the list of return values. A Text Input Element creates a string in the list of items returned. #### Text Input Element @@ -1212,7 +1213,7 @@ Output re-routes `Stdout` to a scrolled text box. It's used with Async forms. password_char - Character that will be used to replace each entered character. Setting to a value indicates this field is a password entry field background_color - color to use for the input field background text_color - color to use for the typed text - do_not_clear - Bool. Normally forms clear when read, turn off clearing with this flag. + do_not_clear - Bool. Normally windows clear when read, turn off clearing with this flag. key = Dictionary key to use for return values focus = Bool. True if this field should capture the focus (moves cursor to this field) @@ -1284,7 +1285,7 @@ The standard listbox like you'll find in most GUIs. Note that the return values 'extended' 'multiple' 'single' - change_submits - if True, the form read will return with a button value of '' + change_submits - if True, the window read will return with a button value of '' bind_return_key - if the focus is on the listbox and the user presses return key, or if the user double clicks an item, then the read will return size - (width, height) of element in characters auto_size_text - Bool. True if size should fit the text length @@ -1297,7 +1298,7 @@ The standard listbox like you'll find in most GUIs. Note that the return values The `select_mode` option can be a string or a constant value defined as a variable. Generally speaking strings are used for these kinds of options. -ListBoxes can cause a form to return from a Read call. If the flag change_submits is set, then when a user makes a selection, the Read immediately returns. +ListBoxes can cause a window to return from a Read call. If the flag change_submits is set, then when a user makes a selection, the Read immediately returns. Another way ListBoxes can cause Reads to return is if the flag bind_return_key is set. If True, then if the user presses the return key while an entry is selected, then the Read returns. Also, if this flag is set, if the user double-clicks an entry it will return from the Read. #### Slider Element @@ -1426,7 +1427,7 @@ An up/down spinner control. The valid values are passed in as a list. ### Button Element -Buttons are the most important element of all! They cause the majority of the action to happen. After all, it's a button press that will get you out of a form, whether it be Submit or Cancel, one way or another a button is involved in all forms. The only exception is to this is when the user closes the window using the "X" in the upper corner which means no button was involved. +Buttons are the most important element of all! They cause the majority of the action to happen. After all, it's a button press that will get you out of a window, whether it be Submit or Cancel, one way or another a button is involved in all windows. The only exception is to this is when the user closes the window using the "X" in the upper corner which means no button was involved. The Types of buttons include: * Folder Browse @@ -1434,16 +1435,16 @@ The Types of buttons include: * Files Browse * File SaveAs * File Save -* Close Form (normal button) -* Read Form +* Close window (normal button) +* Read window * Realtime * Calendar Chooser * Color Chooser - Close Form - Normal buttons like Submit, Cancel, Yes, No, etc, are "Close Form" buttons. They cause the input values to be read and then the form is ***closed***, returning the values to the caller. + Close window - Normal buttons like Submit, Cancel, Yes, No, etc, are "Close window" buttons. They cause the input values to be read and then the window is ***closed***, returning the values to the caller. -Folder Browse - When clicked a folder browse dialog box is opened. The results of the Folder Browse dialog box are written into one of the input fields of the form. +Folder Browse - When clicked a folder browse dialog box is opened. The results of the Folder Browse dialog box are written into one of the input fields of the window. File Browse - Same as the Folder Browse except rather than choosing a folder, a single file is chosen. @@ -1451,18 +1452,18 @@ Calendar Chooser - Opens a graphical calendar to select a date. Color Chooser - Opens a color chooser dialog -Read Form - This is a form button that will read a snapshot of all of the input fields, but does not close the form after it's clicked. +Read window - This is a window button that will read a snapshot of all of the input fields, but does not close the window after it's clicked. -Realtime - This is another async form button. Normal button clicks occur after a button's click is released. Realtime buttons report a click the entire time the button is held down. +Realtime - This is another async window button. Normal button clicks occur after a button's click is released. Realtime buttons report a click the entire time the button is held down. -Most programs will use a combination of shortcut button calls (Submit, Cancel, etc), plain buttons that close the form, and ReadForm buttons that keep the window open but returns control back to the caller. +Most programs will use a combination of shortcut button calls (Submit, Cancel, etc), plain buttons that close the window, and ReadForm buttons that keep the window open but returns control back to the caller. Sometimes there are multiple names for the same function. This is simply to make the job of the programmer quicker and easier. -The 3 primary forms of PySimpleGUI buttons and their names are: +The 3 primary windows of PySimpleGUI buttons and their names are: 1. `Button` = `SimpleButton` - 2. `ReadFormButton` = `ReadButton` = `RFButton` = `RButton` + 2. `ReadButton` = `RButton` = `ReadFormButton` (old style... use ReadButton instead) 3. `RealtimeButton` You will find the long-form in the older programs. @@ -1536,7 +1537,7 @@ These Pre-made buttons are some of the most important elements of all because th #### Button targets -The `FileBrowse`, `FolderBrowse`, `FileSaveAs` , `FilesSaveAs`, `CalendarButton`, `ColorChooserButton` buttons all fill-in values into another element located on the form. The target can be a Text Element or an InputText Element. The location of the element is specified by the `target` variable in the function call. +The `FileBrowse`, `FolderBrowse`, `FileSaveAs` , `FilesSaveAs`, `CalendarButton`, `ColorChooserButton` buttons all fill-in values into another element located on the window. The target can be a Text Element or an InputText Element. The location of the element is specified by the `target` variable in the function call. The Target comes in two forms. 1. Key @@ -1552,7 +1553,7 @@ The default value for `target` is `(ThisRow, -1)`. `ThisRow` is a special valu If a value of `(None, None)` is chosen for the target, then the button itself will hold the information. Later the button can be queried for the value by using the button's key. -Let's examine this form as an example: +Let's examine this window as an example: ![file browse](https://user-images.githubusercontent.com/13696193/44959944-d1b62b80-aec4-11e8-8a68-9d79d37b2c81.jpg) @@ -1563,7 +1564,7 @@ The `InputText` element is located at (1,0)... row 1, column 0. The `Browse` bu Target = (1,0) Target = (-1,0) -The code for the entire form could be: +The code for the entire window could be: layout = [[sg.T('Source Folder')], [sg.In()], @@ -1606,13 +1607,13 @@ These buttons pop up a standard color chooser window. The result is returned as **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 `Button`, which closes the form when clicked. +Not all buttons are created equal. A button that closes a window is different that a button that returns from the window without closing it. If you want to define your own button, you will generally do this with the Button Element `Button`, which closes the window when clicked. layout = [[sg.Button('My Button')]] ![button](https://user-images.githubusercontent.com/13696193/44959862-b696ec00-aec3-11e8-9e88-4b9af0338a03.jpg) -All buttons can have their text changed by changing the `button_text` variable in the button call. It is this text that is returned when a form is read. This text will be what tells you which button is called so make it unique. Most of the convenience buttons (Submit, Cancel, Yes, etc) are all Buttons. Some that are not are `FileBrowse` , `FolderBrowse`, `FileSaveAs`. They clearly do not close the form. Instead they bring up a file or folder browser dialog box. +All buttons can have their text changed by changing the `button_text` variable in the button call. It is this text that is returned when a window is read. This text will be what tells you which button is called so make it unique. Most of the convenience buttons (Submit, Cancel, Yes, etc) are all Buttons. Some that are not are `FileBrowse` , `FolderBrowse`, `FileSaveAs`. They clearly do not close the window. Instead they bring up a file or folder browser dialog box. **Button Images** Now this is an exciting feature not found in many simplified packages.... images on buttons! You can make a pretty spiffy user interface with the help of a few button images. @@ -1631,11 +1632,11 @@ Three parameters are used for button images. image_size - Size of image file in pixels image_subsample - Amount to divide the size by. 2 means your image will be 1/2 the size. 3 means 1/3 -Here's an example form made with button images. +Here's an example window made with button images. ![media file player](https://user-images.githubusercontent.com/13696193/43161977-9ee7cace-8f57-11e8-8ff8-3ea24b69dab9.jpg) -You'll find the source code in the file Demo Media Player. Here is what the button calls look like to create media player form +You'll find the source code in the file Demo Media Player. Here is what the button calls look like to create media player window sg.RButton('Pause', button_color=sg.TRANSPARENT_BUTTON, image_filename=image_pause, image_size=(50, 50), image_subsample=2, border_width=0) @@ -1649,13 +1650,13 @@ This is one you'll have to experiment with at this point. Not up for an exhaust ![robot remote](https://user-images.githubusercontent.com/13696193/44959958-ff9b7000-aec4-11e8-99ea-7450926409be.jpg) -This form has 2 button types. There's the normal "Simple Button" (Quit) and 4 "Realtime Buttons". +This window has 2 button types. There's the normal "Simple Button" (Quit) and 4 "Realtime Buttons". -Here is the code to make, show and get results from this form: +Here is the code to make, show and get results from this window: - form = sg.Window('Robotics Remote Control', auto_size_text=True) + window = sg.Window('Robotics Remote Control', auto_size_text=True) - form_rows = [[sg.Text('Robotics Remote Control')], + window_rows = [[sg.Text('Robotics Remote Control')], [sg.T(' '*10), sg.RealtimeButton('Forward')], [ sg.RealtimeButton('Left'), sg.T(' '*15), sg.RealtimeButton('Right')], [sg.T(' '*10), sg.RealtimeButton('Reverse')], @@ -1663,39 +1664,39 @@ Here is the code to make, show and get results from this form: [sg.Quit(button_color=('black', 'orange'))] ] - form.LayoutAndRead(form_rows, non_blocking=True) + window.LayoutAndRead(window_rows, non_blocking=True) -Somewhere later in your code will be your main event loop. This is where you do your polling of devices, do input/output, etc. It's here that you will read your form's buttons. +Somewhere later in your code will be your main event loop. This is where you do your polling of devices, do input/output, etc. It's here that you will read your window's buttons. while (True): # This is the code that reads and updates your window - button, values = form.ReadNonBlocking() + button, values = window.ReadNonBlocking() if button is not None: sg.Print(button) if button == 'Quit' or values is None: break time.sleep(.01) -This loop will read button values and print them. When one of the Realtime buttons is clicked, the call to `form.ReadNonBlocking` will return a button name matching the name on the button that was depressed. It will continue to return values as long as the button remains depressed. Once released, the ReadNonBlocking will return None for buttons until a button is again clicked. +This loop will read button values and print them. When one of the Realtime buttons is clicked, the call to `window.ReadNonBlocking` will return a button name matching the name on the button that was depressed. It will continue to return values as long as the button remains depressed. Once released, the ReadNonBlocking will return None for buttons until a button is again clicked. **File Types** The `FileBrowse` & `SaveAs` buttons have an additional setting named `file_types`. This variable is used to filter the files shown in the file dialog box. The default value for this setting is FileTypes=(("ALL Files", "*.*"),) -This code produces a form where the Browse button only shows files of type .TXT +This code produces a window where the Browse button only shows files of type .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. + The ENTER key is an important part of data entry for windows. There's a long tradition of the enter key being used to quickly submit windows. PySimpleGUI implements this by tying the ENTER key to the first button that closes or reads a window. -The Enter Key can be "bound" to a particular button so that when the key is pressed, it causes the form to return as if the button was clicked. This is done using the `bind_return_key` parameter in the button calls. -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. +The Enter Key can be "bound" to a particular button so that when the key is pressed, it causes the window to return as if the button was clicked. This is done using the `bind_return_key` parameter in the button calls. +If there are more than 1 button on a window, the FIRST button that is of type Close window or Read window is used. First is determined by scanning the window, 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 OneLineProgressMeter that provides 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 `ProgressBar` element is used to build custom Progress Bar windows. It is HIGHLY recommended that you use OneLineProgressMeter that provides a complete progress meter solution for you. Progress Meters are not easy to work with because the windows 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 `OneLineProgressMeter` API. This consists of a pair of functions, `OneLineProgressMeter` and `OneLineProgressMeterCancel`. 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 OneLineProgressMeter calls presented earlier in this readme. @@ -1704,33 +1705,33 @@ You've already seen OneLineProgressMeter calls presented earlier in this readme. The return value for `OneLineProgressMeter` is: `True` if meter updated correctly -`False` if user clicked the Cancel button, closed the form, or vale reached the max value. +`False` if user clicked the Cancel button, closed the window, or vale reached the max value. -#### Progress Mater in Your Form -Another 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. +#### Progress Mater in Your window +Another way of using a Progress Meter with PySimpleGUI is to build a custom window with a `ProgressBar` Element in the window. You will need to run your window as a non-blocking window. When you are ready to update your progress bar, you call the `UpdateBar` method for the `ProgressBar` element itself. ![progress custom](https://user-images.githubusercontent.com/13696193/45243969-c3508100-b2c3-11e8-82bc-927d0307e093.jpg) import PySimpleGUI as sg - # layout the form + # layout the window layout = [[sg.Text('A custom progress meter')], [sg.ProgressBar(10000, orientation='h', size=(20, 20), key='progressbar')], [sg.Cancel()]] - # create the form` - form = sg.Window('Custom Progress Meter').Layout(layout) - progress_bar = form.FindElement('progressbar') + # create the window` + window = sg.Window('Custom Progress Meter').Layout(layout) + progress_bar = window.FindElement('progressbar') # loop that would normally do something useful for i in range(10000): # check to see if the cancel button was clicked and exit loop if clicked - button, values = form.ReadNonBlocking() + button, values = window.ReadNonBlocking() if button == 'Cancel' or values == None: break # update bar with loop value +1 so that bar eventually reaches the maximum progress_bar.UpdateBar(i + 1) # done with loop... need to destroy the window as it's still open - form.CloseNonBlockingForm()) + window.CloseNonBlocking()) #### Output @@ -1738,11 +1739,11 @@ The Output Element is a re-direction of Stdout. Anything "printed" will be disp Output(size=(None, None)) -Here's a complete solution for a chat-window using an Async form with an Output Element +Here's a complete solution for a chat-window using an Async window with an Output Element import PySimpleGUI as sg - # Blocking form that doesn't close + # Blocking window that doesn't close def ChatBot(): layout = [[(sg.Text('This is where standard out is being routed', size=[40, 1]))], [sg.Output(size=(80, 20))], @@ -1750,11 +1751,11 @@ Here's a complete solution for a chat-window using an Async form with an Output sg.RButton('SEND', button_color=(sg.YELLOWS[0], sg.BLUES[0])), sg.Button('EXIT', button_color=(sg.YELLOWS[0], sg.GREENS[0]))]] - form = sg.Window('Chat Window', default_element_size=(30, 2)).Layout(layout) + window = sg.Window('Chat Window', default_element_size=(30, 2)).Layout(layout) # ---===--- Loop taking in user input and using it to query HowDoI web oracle --- # while True: - button, value = form.Read() + button, value = window.Read() if button == 'SEND': print(value) else: @@ -1764,9 +1765,9 @@ Here's a complete solution for a chat-window using an Async form with an Output ------------------- ## Columns -Starting in version 2.9 you'll be able to do more complex layouts by using the Column Element. Think of a Column as a form within a form. And, yes, you can have a Column within a Column if you want. +Starting in version 2.9 you'll be able to do more complex layouts by using the Column Element. Think of a Column as a window within a window. And, yes, you can have a Column within a Column if you want. -Columns are specified in exactly the same way as a form is, as a list of lists. +Columns are specified in exactly the same way as a window is, as a list of lists. def Column(layout - the list of rows that define the layout background_color - color of background @@ -1787,11 +1788,11 @@ This code produced the above window. import PySimpleGUI as sg # Demo of how columns work - # Form has on row 1 a vertical slider followed by a COLUMN with 7 rows + # window has on row 1 a vertical slider followed by a COLUMN with 7 rows # Prior to the Column element, this layout was not possible - # Columns layouts look identical to form layouts, they are a list of lists of elements. + # Columns layouts look identical to window layouts, they are a list of lists of elements. - form = sg.Window('Columns') # blank form + window = sg.Window('Columns') # blank window # Column layout col = [[sg.Text('col Row 1')], @@ -1806,18 +1807,18 @@ This code produced the above window. [sg.In('Last input')], [sg.OK()]] - # Display the form and get values + # Display the window and get values # If you're willing to not use the "context manager" design pattern, then it's possible - # to collapse the form display and read down to a single line of code. - button, values = sg.Window('Compact 1-line form with column').LayoutAndRead(layout) + # to collapse the window display and read down to a single line of code. + button, values = sg.Window('Compact 1-line window with column').LayoutAndRead(layout) sg.Popup(button, values, line_width=200) -The Column Element has 1 required parameter and 1 optional (the layout and the background color). Setting the background color has the same effect as setting the form's background color, except it only affects the column rectangle. +The Column Element has 1 required parameter and 1 optional (the layout and the background color). Setting the background color has the same effect as setting the window's background color, except it only affects the column rectangle. Column(layout, background_color=None) -The default background color for Columns is the same as the default window background color. If you change the look and feel of the form, the column background will match the form background automatically. +The default background color for Columns is the same as the default window background color. If you change the look and feel of the window, the column background will match the window background automatically. @@ -1841,7 +1842,7 @@ Frames work exactly the same way as Columns. You create layout that is then use -This code creates a form with a Frame and 2 buttons. +This code creates a window with a Frame and 2 buttons. frame_layout = [ [sg.T('Text inside of a frame')], @@ -1852,14 +1853,14 @@ This code creates a form with a Frame and 2 buttons. [sg.Submit(), sg.Cancel()] ] - form = sg.Window('Frame with buttons', font=("Helvetica", 12)).Layout(layout) + window = sg.Window('Frame with buttons', font=("Helvetica", 12)).Layout(layout) ![frame element](https://user-images.githubusercontent.com/13696193/45889173-c2245700-bd8d-11e8-8f73-1e5f1be3ddb1.jpg) -Notice how the Frame layout looks identical to a form layout. A Form works exactly the same way as a Column and a Frame. They all are "container elements". Elements that contain other elements. +Notice how the Frame layout looks identical to a window layout. A window works exactly the same way as a Column and a Frame. They all are "container elements". Elements that contain other elements. *These container Elements can be nested as deep as you want.* That's a pretty spiffy feature, right? Took a lot of work so be appreciative. Recursive code isn't trivial. @@ -1881,29 +1882,29 @@ One such integration is with Matploplib and Pyplot. There is a Demo program wri The order of operations to obtain a tkinter Canvas Widget is: figure_x, figure_y, figure_w, figure_h = fig.bbox.bounds - # define the form layout + # define the window layout layout = [[sg.Text('Plot test')], [sg.Canvas(size=(figure_w, figure_h), key='canvas')], [sg.OK(pad=((figure_w / 2, 0), 3), size=(4, 2))]] - # create the form and show it without the plot - form = sg.Window('Demo Application - Embedding Matplotlib In PySimpleGUI').Layout(layout).Finalize() + # create the window and show it without the plot + window = sg.Window('Demo Application - Embedding Matplotlib In PySimpleGUI').Layout(layout).Finalize() # add the plot to the window - fig_photo = draw_figure(form.FindElement('canvas').TKCanvas, fig) + fig_photo = draw_figure(window.FindElement('canvas').TKCanvas, fig) # show it all again and get buttons - button, values = form.Read() + button, values = window.Read() To get a tkinter Canvas Widget from PySimpleGUI, follow these steps: -* Add Canvas Element to your form -* Layout your form -* Call `form.Finalize()` - this is a critical step you must not forget +* Add Canvas Element to your window +* Layout your window +* Call `window.Finalize()` - this is a critical step you must not forget * Find the Canvas Element by looking up using key * Your Canvas Widget Object will be the found_element.TKCanvas * Draw on your canvas to your heart's content -* Call `form.Read()` - Nothing will appear on your canvas until you call Read +* Call `window.Read()` - Nothing will appear on your canvas until you call Read See `Demo_Matplotlib.py` for a Recipe you can copy. @@ -1970,16 +1971,16 @@ Let me say up front that the Table Element has Beta status. The reason is that s -## Tabbed Forms -Tabbed forms are shown using the `ShowTabbedForm` call. The call has the format +## Tabbed windows +Tabbed windows are shown using the `ShowTabbedForm` call. The call has the format results = ShowTabbedForm('Title for the form', (form,layout,'Tab 1 label'), (form2,layout2, 'Tab 2 label'), ...) -Each of the tabs of the form is in fact a form. The same steps are taken to create the form as before. A `Window` is created, then rows are filled with Elements, and finally the form is shown. When calling `ShowTabbedForm`, each form is passed in as a tuple. The tuple has the format: `(the form, the rows, a string shown on the tab)` +Each of the tabs of the form is in fact a window. The same steps are taken to create the form as before. A `Window` is created, then rows are filled with Elements, and finally the form is shown. When calling `ShowTabbedForm`, each form is passed in as a tuple. The tuple has the format: `(the form, the rows, a string shown on the tab)` -Results are returned as a list of lists. For each form you'll get a list that's in the same format as a normal form. A single tab's values would be: +Results are returned as a list of lists. For each form you'll get a list that's in the same format as a normal window. A single tab's values would be: (button, (values)) @@ -1990,7 +1991,7 @@ Recall that values is a list as well. Multiple tabs in the form would return li ## Colors ## Starting in version 2.5 you can change the background colors for the window and the Elements. -Your forms can go from this: +Your windows can go from this: ![snap0155](https://user-images.githubusercontent.com/13696193/43273879-a9fdc10a-90cb-11e8-8c20-4f6a244ebe2f.jpg) @@ -2002,9 +2003,9 @@ to this... with one function call... -While you can do it on an element by element or form level basis, the easiest way, by far, is a call to `SetOptions`. +While you can do it on an element by element or window level basis, the easiest way, by far, is a call to `SetOptions`. -Be aware that once you change these options they are changed for the rest of your program's execution. All of your forms will have that look and feel, until you change it to something else (which could be the system default colors. +Be aware that once you change these options they are changed for the rest of your program's execution. All of your windows will have that look and feel, until you change it to something else (which could be the system default colors. This call sets all of the different color options. @@ -2089,41 +2090,41 @@ Explanation of parameters tooltip_time - time in milliseconds to wait before showing a tooltip. Default is 400ms -These settings apply to all forms `SetOptions`. The Row options and Element options will take precedence over these settings. Settings can be thought of as levels of settings with the Form-level being the highest and the Element-level the lowest. Thus the levels are: +These settings apply to all windows `SetOptions`. The Row options and Element options will take precedence over these settings. Settings can be thought of as levels of settings with the window-level being the highest and the Element-level the lowest. Thus the levels are: - - Form level + - window level - Row level - Element level Each lower level overrides the settings of the higher level. Once settings have been changed, they remain changed for the duration of the program (unless changed again). -## Persistent Forms (Window stays open after button click) +## Persistent windows (Window stays open after button click) -There are 2 ways to keep a window open after the user has clicked a button. One way is to use non-blocking forms (see the next section). The other way is to use buttons that 'read' the form instead of 'close' the form when clicked. The typical buttons you find in forms, including the shortcut buttons, close the form. These include OK, Cancel, Submit, etc. The Button Element also closes the form. +There are 2 ways to keep a window open after the user has clicked a button. One way is to use non-blocking windows (see the next section). The other way is to use buttons that 'read' the window instead of 'close' the window when clicked. The typical buttons you find in windows, including the shortcut buttons, close the window. These include OK, Cancel, Submit, etc. The Button Element also closes the window. -The `RButton` Element creates a button that when clicked will return control to the user, but will leave the form open and visible. This button is also used in Non-Blocking forms. The difference is in which call is made to read the form. The `Read` call will block, the `ReadNonBlocking` will not block. +The `RButton` Element creates a button that when clicked will return control to the user, but will leave the window open and visible. This button is also used in Non-Blocking windows. The difference is in which call is made to read the window. The `Read` call will block, the `ReadNonBlocking` will not block. -## Asynchronous (Non-Blocking) Forms +## Asynchronous (Non-Blocking) windows So you want to be a wizard do ya? Well go boldly! -Use async forms sparingly. It's possible to have a form that appears to be async, but it is not. **Please** try to find other methods before going to async forms. The reason for this plea is that async forms poll tkinter over and over. If you do not have a sleep in your loop, you will eat up 100% of the CPU time. +Use async windows sparingly. It's possible to have a window that appears to be async, but it is not. **Please** try to find other methods before going to async windows. The reason for this plea is that async windows poll tkinter over and over. If you do not have a sleep in your loop, you will eat up 100% of the CPU time. -When to use a non-blocking form: +When to use a non-blocking window: * A media file player like an MP3 player * A status dashboard that's periodically updated * Progress Meters - when you want to make your own progress meters * Output using print to a scrolled text element. Good for debugging. -If your application doesn't follow the basic design pattern at one of those, then it shouldn't be executed as a non-blocking form. +If your application doesn't follow the basic design pattern at one of those, then it shouldn't be executed as a non-blocking window. ### Instead of ReadNonBlocking --- Use `change_submits = True` or return_keyboard_events = True Any time you are thinking "I want an X Element to cause a Y Element to do something", then you want to use the `change_submits` option. -***Instead of polling, try options that cause the form to return to you.*** By using non-blocking forms, you are *polling*. You can indeed create your application by polling. It will work. But you're going to be maxing out your processor and may even take longer to react to an event than if you used another technique. +***Instead of polling, try options that cause the window to return to you.*** By using non-blocking windows, you are *polling*. You can indeed create your application by polling. It will work. But you're going to be maxing out your processor and may even take longer to react to an event than if you used another technique. **Examples** @@ -2136,93 +2137,93 @@ One example is you have an input field that changes as you press buttons on an o ### Periodically Calling`ReadNonBlocking` -Periodically "refreshing" the visible GUI. The longer you wait between updates to your GUI the more sluggish your forms will feel. It is up to you to make these calls or your GUI will freeze. +Periodically "refreshing" the visible GUI. The longer you wait between updates to your GUI the more sluggish your windows will feel. It is up to you to make these calls or your GUI will freeze. -There are 2 methods of interacting with non-blocking forms. -1. Read the form just as you would a normal form -2. "Refresh" the form's values without reading the form. It's a quick operation meant to show the user the latest values +There are 2 methods of interacting with non-blocking windows. +1. Read the window just as you would a normal window +2. "Refresh" the window's values without reading the window. It's a quick operation meant to show the user the latest values - With asynchronous forms the form is shown, user input is read, but your code keeps right on chugging. YOUR responsibility is to call `PySimpleGUI.ReadNonBlocking` on a periodic basis. Once a second or more will produce a reasonably snappy GUI. + With asynchronous windows the window is shown, user input is read, but your code keeps right on chugging. YOUR responsibility is to call `PySimpleGUI.ReadNonBlocking` on a periodic basis. Once a second or more will produce a reasonably snappy GUI. - #### Exiting a Non-Blocking Form + #### Exiting a Non-Blocking window -It's important to always provide a "way out" for your user. Make sure you have provided a button or some other mechanism to exit. Also be sure to check for closed forms in your code. It is possible for a form to look closed, but continue running your event loop. +It's important to always provide a "way out" for your user. Make sure you have provided a button or some other mechanism to exit. Also be sure to check for closed windows in your code. It is possible for a window to look closed, but continue running your event loop. -Typically when reading a form you check `if Button is None` to determine if a form was closed. With NonBlocking forms, buttons will be None unless a button or a key was returned. The way you determine if a window was closed in a non-blocking form is to check **both** the button and the values are None. Since button is normally None, you only need to test for `value is None` in your code. +Typically when reading a window you check `if Button is None` to determine if a window was closed. With NonBlocking windows, buttons will be None unless a button or a key was returned. The way you determine if a window was closed in a non-blocking window is to check **both** the button and the values are None. Since button is normally None, you only need to test for `value is None` in your code. -The proper code to check if the user has exited the form will be a polling-loop that looks something like this: +The proper code to check if the user has exited the window will be a polling-loop that looks something like this: while True: - button, values = form.ReadNonBlocking() + button, values = window.ReadNonBlocking() if values is None or button == 'Quit': break -We're going to build an app that does the latter. It's going to update our form with a running clock. +We're going to build an app that does the latter. It's going to update our window with a running clock. The basic flow and functions you will be calling are: Setup - form = Window() - form_rows = ..... - form.LayoutAndRead(form_rows, non_blocking=True) + window = Window() + window_rows = ..... + window.LayoutAndRead(window_rows, non_blocking=True) Periodic refresh - form.ReadNonBlocking() or form.Refresh() + window.ReadNonBlocking() or window.Refresh() -If you need to close the form +If you need to close the window - form.CloseNonBlockingForm() + window.CloseNonBlocking() -Rather than the usual `form.LayoutAndRead()` call, we're manually adding the rows (doing the layout) and then showing the form. After the form is shown, you simply call `form.ReadNonBlocking()` every now and then. +Rather than the usual `window.LayoutAndRead()` call, we're manually adding the rows (doing the layout) and then showing the window. After the window is shown, you simply call `window.ReadNonBlocking()` every now and then. -When you are ready to close the form (assuming the form wasn't closed by the user or a button click) you simply call `form.CloseNonBlockingForm()` +When you are ready to close the window (assuming the window wasn't closed by the user or a button click) you simply call `window.CloseNonBlocking()` **Example - Running timer that updates** -See the sample code on the GitHub named Demo Media Player for another example of Async Forms. We're going to make a form and update one of the elements of that form every .01 seconds. Here's the entire code to do that. +See the sample code on the GitHub named Demo Media Player for another example of Async windows. We're going to make a window and update one of the elements of that window every .01 seconds. Here's the entire code to do that. import PySimpleGUI as sg import time - # form that doesn't block - # Make a form, but don't use context manager - form = sg.Window('Running Timer', auto_size_text=True) + # window that doesn't block + # Make a window, but don't use context manager + window = sg.Window('Running Timer', auto_size_text=True) # Create the layout - form_rows = [[sg.Text('Non-blocking GUI with updates')], + window_rows = [[sg.Text('Non-blocking GUI with updates')], [sg.Text('', size=(8, 2), font=('Helvetica', 20), key='output') ], [sg.Button('Quit')]] - # Layout the rows of the form and perform a read. Indicate the form is non-blocking! - form.LayoutAndRead(form_rows, non_blocking=True) + # Layout the rows of the window and perform a read. Indicate the window is non-blocking! + window.LayoutAndRead(window_rows, non_blocking=True) # # Some place later in your code... - # You need to perform a ReadNonBlocking on your form every now and then or + # You need to perform a ReadNonBlocking on your window every now and then or # else it won't refresh # for i in range(1, 1000): - form.FindElement('output').Update('{:02d}:{:02d}.{:02d}'.format(*divmod(int(i / 100), 60), i % 100)) - button, values = form.ReadNonBlocking() + window.FindElement('output').Update('{:02d}:{:02d}.{:02d}'.format(*divmod(int(i / 100), 60), i % 100)) + button, values = window.ReadNonBlocking() if values is None or button == 'Quit': break time.sleep(.01) else: - form.CloseNonBlockingForm() + window.CloseNonBlocking() -What we have here is the same sequence of function calls as in the description. Get a form, add rows to it, show the form, and then refresh it every now and then. +What we have here is the same sequence of function calls as in the description. Get a window, add rows to it, show the window, and then refresh it every now and then. -The new thing in this example is the call use of the Update method for the Text Element. The first thing we do inside the loop is "update" the text element that we made earlier. This changes the value of the text field on the form. The new value will be displayed when `form.ReadNonBlocking()` is called. if you want to have the form reflect your changes immediately, call `form.Refresh()`. +The new thing in this example is the call use of the Update method for the Text Element. The first thing we do inside the loop is "update" the text element that we made earlier. This changes the value of the text field on the window. The new value will be displayed when `window.ReadNonBlocking()` is called. if you want to have the window reflect your changes immediately, call `window.Refresh()`. -Note the `else` statement on the for loop. This is needed because we're about to exit the loop while the form is still open. The user has not closed the form using the X nor a button so it's up to the caller to close the form using `CloseNonBlockingForm`. +Note the `else` statement on the for loop. This is needed because we're about to exit the loop while the window is still open. The user has not closed the window using the X nor a button so it's up to the caller to close the window using `CloseNonBlocking`. -## Updating Elements (changing elements in active form) +## Updating Elements (changing elements in active window) -Persistent forms remain open and thus continue to interact with the user after the Read has returned. Often the program wishes to communicate results (output information) or change an Element's values (such as populating a List Element). +Persistent windows remain open and thus continue to interact with the user after the Read has returned. Often the program wishes to communicate results (output information) or change an Element's values (such as populating a List Element). The way this is done is via an Update method that is available for nearly all of the Elements. Here is an example of a program that uses a persistent window that is updated. @@ -2235,7 +2236,7 @@ In some programs these updates happen in response to another Element. This prog - # Testing async form, see if can have a slider + # Testing async window, see if can have a slider # that adjusts the size of text displayed import PySimpleGUI as sg @@ -2246,10 +2247,10 @@ In some programs these updates happen in response to another Element. This prog sg.Text("Aa", size=(2, 1), font="Helvetica " + str(fontSize), key='text')]] sz = fontSize - form = sg.Window("Font size selector", grab_anywhere=False).Layout(layout) + window = sg.Window("Font size selector", grab_anywhere=False).Layout(layout) # Event Loop while True: - button, values= form.Read() + button, values= window.Read() if button is None: break sz_spin = int(values['spin']) @@ -2258,9 +2259,9 @@ In some programs these updates happen in response to another Element. This prog if sz != fontSize: fontSize = sz font = "Helvetica " + str(fontSize) - form.FindElement('text').Update(font=font) - form.FindElement('slider').Update(sz) - form.FindElement('spin').Update(sz) + window.FindElement('text').Update(font=font) + window.FindElement('slider').Update(sz) + window.FindElement('spin').Update(sz) print("Done.") @@ -2270,18 +2271,18 @@ For example, `values['slider']` is the value of the Slider Element. This program changes all 3 elements if either the Slider or the Spinner changes. This is done with these statements: - form.FindElement('text').Update(font=font) - form.FindElement('slider').Update(sz) - form.FindElement('spin').Update(sz) + window.FindElement('text').Update(font=font) + window.FindElement('slider').Update(sz) + window.FindElement('spin').Update(sz) -Remember this design pattern because you will use it OFTEN if you use persistent forms. +Remember this design pattern because you will use it OFTEN if you use persistent windows. -It works as follows. The call to `form.FindElement` returns the Element object represented by they provided `key`. This element is then updated by calling it's `Update` method. This is another example of Python's "chaining" feature. We could write this code using the long-form: +It works as follows. The call to `window.FindElement` returns the Element object represented by they provided `key`. This element is then updated by calling it's `Update` method. This is another example of Python's "chaining" feature. We could write this code using the long-form: - text_element = form.FindElement('text') + text_element = window.FindElement('text') text_element.Update(font=font) -The takeaway from this exercise is that keys are key in PySimpleGUI's design. They are used to both read the values of the form and also to identify elements. As already mentioned, they are used as targets in Button calls. +The takeaway from this exercise is that keys are key in PySimpleGUI's design. They are used to both read the values of the window and also to identify elements. As already mentioned, they are used as targets in Button calls. @@ -2303,16 +2304,16 @@ Key Sym is a string such as 'Control_L'. The Key Code is a numeric representati # Recipe for getting keys, one at a time as they are released # If want to use the space bar, then be sure and disable the "default focus" - with sg.Window("Keyboard Test", return_keyboard_events=True, use_default_focus=False) as form: + with sg.Window("Keyboard Test", return_keyboard_events=True, use_default_focus=False) as window: text_elem = sg.Text("", size=(18,1)) layout = [[sg.Text("Press a key or scroll mouse")], [text_elem], [sg.Button("OK")]] - form.Layout(layout) + window.Layout(layout) # ---===--- Loop taking in user input --- # while True: - button, value = form.ReadNonBlocking() + button, value = window.ReadNonBlocking() if button == "OK" or (button is None and value is None): print(button, "exiting") @@ -2327,14 +2328,14 @@ Use realtime keyboard capture by calling import PySimpleGUI as sg - with sg.Window("Realtime Keyboard Test", return_keyboard_events=True, use_default_focus=False) as form: + with sg.Window("Realtime Keyboard Test", return_keyboard_events=True, use_default_focus=False) as window: layout = [[sg.Text("Hold down a key")], [sg.Button("OK")]] - form.Layout(layout) + window.Layout(layout) while True: - button, value = form.ReadNonBlocking() + button, value = window.ReadNonBlocking() if button == "OK": print(button, value, "exiting") @@ -2346,7 +2347,7 @@ Use realtime keyboard capture by calling ## Menus -Beginning in version 3.01 you can add a menubar to your form/window. You specify the menus in much the same way as you do form layouts, with lists. Menu selections are returned as button clicks, so be aware of your overall naming conventions. If you have an Exit button and also an Exit menu option, then you won't be able to tell the difference when your form.Read returns. Hopefully will not be a problem. +Beginning in version 3.01 you can add a menubar to your window. You specify the menus in much the same way as you do window layouts, with lists. Menu selections are returned as button clicks, so be aware of your overall naming conventions. If you have an Exit button and also an Exit menu option, then you won't be able to tell the difference when your window.Read returns. Hopefully will not be a problem. This definition: @@ -2367,7 +2368,7 @@ They menu_def layout produced this window: This is a somewhat advanced topic... -Typically you perform Element updates in response to events from other Elements. An example is that when you click a button some text on the form changes to red. You can change the Element's attributes, or at least some of them, and the Element's value. +Typically you perform Element updates in response to events from other Elements. An example is that when you click a button some text on the window changes to red. You can change the Element's attributes, or at least some of them, and the Element's value. In some source code examples you will find an older techique for updating elements that did not involve keys. If you see a technique in the code that does not use keys, then know that there is a version using keys that is easier. @@ -2378,7 +2379,7 @@ We have an InputText field that we want to update. When the Element was created To update or change the value for that Input Element, we use this construct: - form.FindElement('input').Update('new text') + window.FindElement('input').Update('new text') Using the '.' makes the code shorter. The FindElement call returns an Element. We then call that Element's Update function. @@ -2401,22 +2402,22 @@ Use the example programs as a starting basis for your GUI. Copy, paste, modify | Source File| Description | |--|--| -|**Demo_All_Widgets.py**| Nearly all of the Elements shown in a single form +|**Demo_All_Widgets.py**| Nearly all of the Elements shown in a single window |**Demo_Borderless_Window.py**| Create clean looking windows with no border |**Demo_Button_States.py**| One way of implementing disabling of buttons |**Demo_Calendar.py** | Demo of the Calendar Chooser button -|**Demo_Canvas.py** | Form with a Canvas Element that is updated outside of the form +|**Demo_Canvas.py** | window with a Canvas Element that is updated outside of the window |**Demo_Chat.py** | A chat window with scrollable history |**Demo_Chatterbot.py** | Front-end to Chatterbot Machine Learning project |**Demo_Color.py** | How to interact with color using RGB hex values and named colors -|**Demo_Columns.py** | Using the Column Element to create more complex forms +|**Demo_Columns.py** | Using the Column Element to create more complex windows |**Demo_Compare_Files.py** | Using a simple GUI front-end to create a compare 2-files utility |**Demo_Cookbook_Browser.py** | Source code browser for all Recipes in Cookbook |**Demo_Dictionary.py** | Specifying and using return values in dictionary format -**Demo_DOC_Viewer_PIL.py** | Display a PDF, HTML, ebook file, etc in your form -|**Demo_DisplayHash1and256.py** | Using high level API and custom form to implement a simple display hash code utility +**Demo_DOC_Viewer_PIL.py** | Display a PDF, HTML, ebook file, etc in your window +|**Demo_DisplayHash1and256.py** | Using high level API and custom window to implement a simple display hash code utility |**Demo_DuplicateFileFinder.py** | High level API used to get a folder that is used by utility that finds duplicate files. Uses progress meter to show progress. 2 lines of code required to add GUI and meter -|**Demo_Fill_Form.py** | How to perform a bulk-fill for a form. Saving and loading a form from disk +|**Demo_Fill_Form.py** | How to perform a bulk-fill for a window. Saving and loading a window from disk |**Demo Font Sizer.py** | Demonstrates Elements updating other Elements |**Demo_Func_Callback_Simulator.py** | For the Raspberry Pi crowd. Event loop that simulates traditional GUI callback functions should you already have an architecture that uses them |**Demo_GoodColors.py** | Using some of the pre-defined PySimpleGUI individual colors @@ -2429,9 +2430,9 @@ Use the example programs as a starting basis for your GUI. Copy, paste, modify |**Demo_Matplotlib_Animated.py** | Animated Matplotlib line graph |**Demo_Matplotlib_Animated_Scatter.py** | Animated Matplotlib scatter graph |**Demo_Matplotlib_Browser.py** | Browse Matplotlib gallery -|**Demo_Media_Player.py** | Non-blocking form with a media player layout. Demonstrates button graphics, Update method +|**Demo_Media_Player.py** | Non-blocking window with a media player layout. Demonstrates button graphics, Update method |**Demo_MIDI_Player.py** | GUI wrapper for Mido MIDI package. Functional MIDI player that controls attached MIDI devices -|**Demo_NonBlocking_Form.py** | a basic async form +|**Demo_NonBlocking_Form.py** | a basic async window |**Demo_OpenCV.py** | Integrated with OpenCV |**Demo_Password_Login** | Password protection using SHA1 |**Demo_PDF_Viewer.py** | Submitted by a user! Previews PDF documents. Uses keyboard input & mouse scrollwheel to navigate @@ -2444,7 +2445,7 @@ Use the example programs as a starting basis for your GUI. Copy, paste, modify |**Demo_Script_Parameters.py** | Add a 1-line GUI to the front of your previously command-line only scripts |**Demo_Tabbed_Form.py** | Using the Tab feature |**Demo_Table_Simulation.py** | Use input fields to display and edit tables -|**Demo_Timer.py** | Simple non-blocking form +|**Demo_Timer.py** | Simple non-blocking window ## Packages Used In Demos @@ -2553,7 +2554,7 @@ While not an "issue" this is a ***stern warning*** **Progress Meters** - the visual graphic portion of the meter may be off. May return to the native tkinter progress meter solution in the future. Right now a "custom" progress meter is used. On the bright side, the statistics shown are extremely accurate and can tell you something about the performance of your code. If you are running 2 or more progress meters at the same time using `OneLineProgressMeter`, you need to close the meter by using the "Cancel" button rather than the X -**Async Forms** - these include the 'easy' forms (`OneLineProgressMeter` and EasyPrint/Print). If you start overlapping having Async forms open with normal forms then things get a littler squirrelly. Still tracking down the issues and am making it more solid every day possible. You'll know there's an issue when you see blank form. +**Async windows** - these include the 'easy' windows (`OneLineProgressMeter` and EasyPrint/Print). If you start overlapping having Async windows open with normal windows then things get a littler squirrelly. Still tracking down the issues and am making it more solid every day possible. You'll know there's an issue when you see blank window. **EasyPrint** - EasyPrint is a new feature that's pretty awesome. You print and the output goes to a window, with a scroll bar, that you can copy and paste from. Being a new feature, it's got some potential problems. There are known interaction problems with other GUI windows. For example, closing a Print window can also close other windows you have open. For now, don't close your debug print window until other windows are closed too. @@ -2681,9 +2682,6 @@ OneLineProgressMeter function added which gives you not only a one-line solution * Renamed FlexForm to Window * Removed LookAndFeel capability from Mac platform. -#### 3.6.1 -* Forgot Readme update in 3.6.0 - ### Upcoming Make suggestions people! Future release features diff --git a/readme.md b/readme.md index 69009ef3..812257a8 100644 --- a/readme.md +++ b/readme.md @@ -1,5 +1,6 @@ - + + ![pysimplegui_logo](https://user-images.githubusercontent.com/13696193/43165867-fe02e3b2-8f62-11e8-9fd0-cc7c86b11772.png) @@ -8,7 +9,7 @@ # PySimpleGUI -![Python Version](https://img.shields.io/badge/PySimpleGUI_Version-3.6.1-red.svg?longCache=true&style=for-the-badge) +![Python Version](https://img.shields.io/badge/PySimpleGUI_Version-3.6.2-red.svg?longCache=true&style=for-the-badge) [Announcements of Latest Developments](https://github.com/MikeTheWatchGuy/PySimpleGUI/issues/142) @@ -54,7 +55,7 @@ Or how about a ***custom GUI*** in 1 line of code? ![get filename](https://user-images.githubusercontent.com/13696193/44960039-f1018880-aec5-11e8-8a43-3d7f8ff93b67.jpg) - Build beautiful customized forms that fit your specific problem. Let PySimpleGUI solve your GUI problem while you solve your real problems. Look through the Cookbook, find a matching recipe, copy, paste and be up and running with a GUI in minutes. This is the process PySimpleGUI was designed to work within. + Build beautiful customized windows that fit your specific problem. Let PySimpleGUI solve your GUI problem while you solve your real problems. Look through the Cookbook, find a matching recipe, copy, paste and be up and running with a GUI in minutes. This is the process PySimpleGUI was designed to work within. ![borderless grayed buttons](https://user-images.githubusercontent.com/13696193/45168664-d848e980-b1c9-11e8-886e-63279ae4017f.jpg) @@ -95,7 +96,7 @@ Combining PySimpleGUI with PyInstaller creates something truly remarkable and sp ## Background I was frustrated by having to deal with the dos prompt when I had a powerful Windows machine right in front of me. Why is it SO difficult to do even the simplest of input/output to a window in Python?? -There are a number of 'easy to use' Python GUIs, but they were too limited for my requirements. PySimpleGUI aims for the same simplicity found in packages like `EasyGUI`and `WxSimpleGUI` , both really handy but limited, and adds the ability to define your own layouts. This ability to make your own forms using a large palette of widgets is but one difference between the existing "simple" packages and `PySimpleGUI`. +There are a number of 'easy to use' Python GUIs, but they were too limited for my requirements. PySimpleGUI aims for the same simplicity found in packages like `EasyGUI`and `WxSimpleGUI` , both really handy but limited, and adds the ability to define your own layouts. This ability to make your own windows using a large palette of widgets is but one difference between the existing "simple" packages and `PySimpleGUI`. With a simple GUI, it becomes practical to "associate" .py files with the python interpreter on Windows. Double click a py file and up pops a GUI window, a more pleasant experience than opening a dos Window and typing a command line. @@ -121,7 +122,7 @@ While simple to use, PySimpleGUI has significant depth to be explored by more ad Folder Browse SaveAs Non-closing return - Close form + Close window Realtime Calendar chooser Color chooser @@ -137,7 +138,7 @@ While simple to use, PySimpleGUI has significant depth to be explored by more ad Scroll-able Output Images Progress Bar Async/Non-Blocking Windows - Tabbed forms + Tabbed windows Persistent Windows Redirect Python Output/Errors to scrolling window 'Higher level' APIs (e.g. MessageBox, YesNobox, ...) @@ -148,15 +149,15 @@ While simple to use, PySimpleGUI has significant depth to be explored by more ad Return values as dictionary Set focus Bind return key to buttons - Group widgets into a column and place into form anywhere + Group widgets into a column and place into window anywhere Scrollable columns Keyboard low-level key capture Mouse scroll-wheel support Get Listbox values as they are selected Get slider, spinner, combo as they are changed - Update elements in a live form - Bulk form-fill operation - Save / Load form to/from disk + Update elements in a live window + Bulk window-fill operation + Save / Load window to/from disk Borderless (no titlebar) windows Always on top windows Menus @@ -165,7 +166,7 @@ While simple to use, PySimpleGUI has significant depth to be explored by more ad No async programming required (no callbacks to worry about) -An example of many widgets used on a single form. A little further down you'll find the 21 lines of code required to create this complex form. Try it if you don't believe it. Install PySimpleGUI then : +An example of many widgets used on a single window. A little further down you'll find the 21 lines of code required to create this complex window. Try it if you don't believe it. Install PySimpleGUI then : >Start Python, copy and paste the code below into the >>> prompt and hit enter. This will pop up... > @@ -176,7 +177,7 @@ An example of many widgets used on a single form. A little further down you'll import PySimpleGUI as sg - layout = [[sg.Text('All graphic widgets in one form!', size=(30, 1), font=("Helvetica", 25), text_color='blue')], + layout = [[sg.Text('All graphic widgets in one window!', 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)], @@ -211,8 +212,8 @@ An example of many widgets used on a single form. A little further down you'll Be Pythonic... Attempted to use language constructs in a natural way and to exploit some of Python's interesting features. Python's lists and optional parameters make PySimpleGUI work smoothly. - - Forms are represented as Python lists. - - A form is a list of rows + - windows are represented as Python lists. + - A window is a list of rows - A row is a list of elements - Return values are a list of button presses and input values. - Return values can also be represented as a dictionary @@ -281,21 +282,21 @@ If you wish to create an EXE from your PySimpleGUI application, you will need to To use in your code, simply import.... `import PySimpleGUI as sg` -Then use either "high level" API calls or build your own forms. +Then use either "high level" API calls or build your own windows. sg.Popup('This is my first Popup') ![first popup](https://user-images.githubusercontent.com/13696193/44957300-c7813680-ae9e-11e8-9a8c-c70198db7907.jpg) -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. +Yes, it's just that easy to have a window appear on the screen using Python. With PySimpleGUI, making a custom window appear isn't much more difficult. The goal is to get you running on your GUI within ***minutes***, not hours nor days. --- ## APIs PySimpleGUI can be broken down into 2 types of API's: * High Level single call functions (The `Popup` calls) - * Custom form functions + * Custom window functions ### Python Language Features @@ -319,7 +320,7 @@ Each new item begins on a new line in the Popup #### Optional Parameters to a Function Call -This feature of the Python language is utilized ***heavily*** as a method of customizing forms and form Elements. Rather than requiring the programmer to specify every possible option for a widget, instead only the options the caller wants to override are specified. +This feature of the Python language is utilized ***heavily*** as a method of customizing windows and window Elements. Rather than requiring the programmer to specify every possible option for a widget, instead only the options the caller wants to override are specified. Here is the function definition for the Popup function. The details aren't important. What is important is seeing that there is a long list of potential tweaks that a caller can make. However, they don't *have* to be specified on each and every call. @@ -343,7 +344,7 @@ If the caller wanted to change the button color to be black on yellow, the call #### Dictionaries Dictionaries are used by more advanced PySimpleGUI users. You'll know that dictionaries are being used if you see a `key` parameter on any Element. Dictionaries are used in 2 ways: -1. To identify values when a form is read +1. To identify values when a window is read 2. To identify Elements so that they can be "updated" --- @@ -356,7 +357,7 @@ Dictionaries are used by more advanced PySimpleGUI users. You'll know that dict Think of the `Popup` call as the GUI equivalent of a `print` statement. It's your way of displaying results to a user in the windowed world. Each call to Popup will create a new Popup window. -`Popup` calls are normally blocking. your program will stop executing until the user has closed the Popup window. A non-blocking form of Popup discussed in the async section. +`Popup` calls are normally blocking. your program will stop executing until the user has closed the Popup window. A non-blocking window of Popup discussed in the async section. Just like a print statement, you can pass any number of arguments you wish. They will all be turned into strings and displayed in the popup window. @@ -441,7 +442,7 @@ There are Popup calls for single-item inputs. These follow the pattern of `Popup - `PopupGetFile` - get a filename - `PopupGetFolder` - get a folder name -Rather than make a custom form to get one data value, call the Popup input function to get the item from the user. +Rather than make a custom window to get one data value, call the Popup input function to get the item from the user. import PySimpleGUI as sg @@ -491,7 +492,7 @@ That line of code resulted in this window popping up and updating. ![preogress meter](https://user-images.githubusercontent.com/13696193/43667625-d47da702-9746-11e8-91e6-e5177883abae.jpg) 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 `OneLineProgressMeter`. It normally returns `True`. +With a little trickery you can provide a way to break out of your loop using the Progress Meter window. The cancel button results in a `False` return value from `OneLineProgressMeter`. It normally returns `True`. ***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. @@ -524,20 +525,20 @@ A word of caution. There are known problems when multiple PySimpleGUI windows a You can change the size of the debug window using the `SetOptions` call with the `debug_win_size` parameter. --- -# Custom Form API Calls (Your First Form) +# Custom window API Calls (Your First window) This is the FUN part of the programming of this GUI. In order to really get the most out of the API, you should be using an IDE that supports auto complete or will show you the definition of the function. This will make customizing go smoother. -This first section on custom forms is for your typical, blocking, non-persistant form. By this I mean, when you "show" the form, the function will not return until the user has clicked a button or closed the window. When this happens, the form's window will be automatically closed. +This first section on custom windows is for your typical, blocking, non-persistant window. By this I mean, when you "show" the window, the function will not return until the user has clicked a button or closed the window. When this happens, the window will be automatically closed. -Two other types of forms exist. -1. Persistent form - rather than closing on button clicks, the show form function returns and the form continues to be visible. This is good for applications like a chat window. -2. Asynchronous form - the trickiest of the lot. Great care must be exercised. Examples are an MP3 player or status dashboard. Async forms are updated (refreshed) on a periodic basis. +Two other types of windows exist. +1. Persistent window - rather than closing on button clicks, the show window function returns and the window continues to be visible. This is good for applications like a chat window. +2. Asynchronous window - the trickiest of the lot. Great care must be exercised. Examples are an MP3 player or status dashboard. Async windows are updated (refreshed) on a periodic basis. It's both not enjoyable nor helpful to immediately jump into tweaking each and every little thing available to you. -## The Form Designer -The good news to newcomers to GUI programming is that PySimpleGUI has a form designer. Better yet, the form designer requires no training and everyone knows how to use it. +## The window Designer +The good news to newcomers to GUI programming is that PySimpleGUI has a window designer. Better yet, the window designer requires no training and everyone knows how to use it. ![gui0_1](https://user-images.githubusercontent.com/13696193/44159598-e2257400-a085-11e8-9b02-343e72cc75c3.JPG) @@ -595,12 +596,12 @@ Finally we can put it all together into a program that will display our window. sg.Popup(button, number) ### Example 2 - Get a filename -Let's say you've got a utility you've written that operates on some input file and you're ready to use a GUI to enter than filename rather than the command line. Follow the same steps as the previous example - draw your form on paper, break it up into rows, label the elements. +Let's say you've got a utility you've written that operates on some input file and you're ready to use a GUI to enter than filename rather than the command line. Follow the same steps as the previous example - draw your window on paper, break it up into rows, label the elements. ![gui4_1](https://user-images.githubusercontent.com/13696193/44160132-6a584900-a087-11e8-862f-7d791a67ee5d.JPG) ![gui5_1](https://user-images.githubusercontent.com/13696193/44160133-6af0df80-a087-11e8-9dec-bb4d4c59393d.JPG) -Writing the code for this one is just as straightforward. There is one tricky thing, that browse for a file button. Thankfully PySimpleGUI takes care of associating it with the input field next to it. As a result, the code looks almost exactly like the form on the paper. +Writing the code for this one is just as straightforward. There is one tricky thing, that browse for a file button. Thankfully PySimpleGUI takes care of associating it with the input field next to it. As a result, the code looks almost exactly like the window on the paper. import PySimpleGUI as sg @@ -613,57 +614,57 @@ Writing the code for this one is just as straightforward. There is one tricky t sg.Popup(button, number) -Read on for detailed instructions on the calls that show the form and return your results. +Read on for detailed instructions on the calls that show the window and return your results. # Copy these design patterns! -All of your PySimpleGUI programs will utilize one of these 3 design patterns depending on the type of form you're implementing. +All of your PySimpleGUI programs will utilize one of these 3 design patterns depending on the type of window you're implementing. -## Pattern 1 - Single read forms +## Pattern 1 - Single read windows -This is the most basic design pattern. Use this for forms that are shown to the user 1 time. The input values are gathered and returned to the program +This is the most basic design pattern. Use this for windows that are shown to the user 1 time. The input values are gathered and returned to the program - form_rows = [[sg.Text('SHA-1 and SHA-256 Hashes for the file')], + window_rows = [[sg.Text('SHA-1 and SHA-256 Hashes for the file')], [sg.InputText(), sg.FileBrowse()], [sg.Submit(), sg.Cancel()]] - form = sg.Window('SHA-1 & 256 Hash') + window = sg.Window('SHA-1 & 256 Hash') - button, (source_filename,) = form.LayoutAndRead(form_rows) + button, (source_filename,) = window.LayoutAndRead(window_rows) ---- -## Pattern 2 - Single-read form "chained" +## Pattern 2 - Single-read window "chained" -Python has a ***beautiful*** way of compacting code known as "chaining". You take the output from one function and feed it as input to the next. Notice in the first example how a form is first obtained by calling Window and then that form is then read. It's possible to combine the creation of the form with the read. This design pattern does exactly that, chain together the form creation and the form reading. +Python has a ***beautiful*** way of compacting code known as "chaining". You take the output from one function and feed it as input to the next. Notice in the first example how a window is first obtained by calling Window and then that window is then read. It's possible to combine the creation of the window with the read. This design pattern does exactly that, chain together the window creation and the window reading. - form_rows = [[sg.Text('SHA-1 and SHA-256 Hashes for the file')], + window_rows = [[sg.Text('SHA-1 and SHA-256 Hashes for the file')], [sg.InputText(), sg.FileBrowse()], [sg.Submit(), sg.Cancel()]] - button, (source_filename,) = sg.Window('SHA-1 & 256 Hash').LayoutAndRead(form_rows) + button, (source_filename,) = sg.Window('SHA-1 & 256 Hash').LayoutAndRead(window_rows) -## Pattern 3 - Persistent form (multiple reads) +## Pattern 3 - Persistent window (multiple reads) -Some of the more advanced programs operate with the form remaining visible on the screen. Input values are collected, but rather than closing the form, it is kept visible acting as a way to both output information to the user and gather input data. +Some of the more advanced programs operate with the window remaining visible on the screen. Input values are collected, but rather than closing the window, it is kept visible acting as a way to both output information to the user and gather input data. -This is done by splitting the LayoutAndRead call apart into a Layout call and a Read call. Note how chaining is again used. In this case a form is created by calling Window which is then passed on to the Layout method. The Layout method returns the form value so that it can be stored and used later in the program to Read the form. +This is done by splitting the LayoutAndRead call apart into a Layout call and a Read call. Note how chaining is again used. In this case a window is created by calling Window which is then passed on to the Layout method. The Layout method returns the window value so that it can be stored and used later in the program to Read the window. import PySimpleGUI as sg - layout = [[sg.Text('Persistent form')], + layout = [[sg.Text('Persistent window')], [sg.RButton('Turn LED On')], [sg.RButton('Turn LED Off')], [sg.Exit()]] - form = sg.Window('Raspberry Pi GUI').Layout(layout) + window = sg.Window('Raspberry Pi GUI').Layout(layout) while True: - button, values = form.Read() + button, values = window.Read() if button is None: break @@ -672,7 +673,7 @@ This is done by splitting the LayoutAndRead call apart into a Layout call and a Why is Python such a great teaching language and yet no GUI framework exists that lends itself to the basic building blocks of Python, the list or dictionary? PySimpleGUI set out to be a Pythonic solution to the GUI problem. Whether it achieved this goal is debatable, but it was an attempt just the same. -The key to custom forms in PySimpleGUI is to view forms as ROWS of Elements. Each row is specified as a list of these Elements. Put the rows together and you've got a form or window. +The key to custom windows in PySimpleGUI is to view windows as ROWS of Elements. Each row is specified as a list of these Elements. Put the rows together and you've got a window. Let's dissect this little program @@ -683,15 +684,15 @@ The key to custom forms in PySimpleGUI is to view forms as ROWS of Elements. E [sg.Text('Source for Files ', size=(15, 1)), sg.InputText(), sg.FolderBrowse()], [sg.Submit(), sg.Cancel()]] - form = sg.Window('Rename Files or Folders') + window = sg.Window('Rename Files or Folders') - button, (folder_path, file_path) = form.LayoutAndRead(layout) + button, (folder_path, file_path) = window.LayoutAndRead(layout) ![snap0131](https://user-images.githubusercontent.com/13696193/43417007-df6d8408-9407-11e8-9986-30f0415f08a5.jpg) -Let's agree the form has 4 rows. +Let's agree the window has 4 rows. The first row only has **text** that reads `Rename files or folders` @@ -706,15 +707,15 @@ Now let's look at how those 2 rows and the other two row from Python code: See how the source code mirrors the layout? You simply make lists for each row, then submit that table to PySimpleGUI to show and get values from. -And what about those return values? Most people simply want to show a form, get the input values and do something with them. So why break up the code into button callbacks, etc, when I simply want my form's input values to be given to me. +And what about those return values? Most people simply want to show a window, get the input values and do something with them. So why break up the code into button callbacks, etc, when I simply want my window's input values to be given to me. -For return values the form is scanned from top to bottom, left to right. Each field that's an input field will occupy a spot in the return values. +For return values the window is scanned from top to bottom, left to right. Each field that's an input field will occupy a spot in the return values. -In our example form, there are 2 fields, so the return values from this form will be a list with 2 values in it. +In our example window, there are 2 fields, so the return values from this window will be a list with 2 values in it. - button, (folder_path, file_path) = form.LayoutAndRead(layout) + button, (folder_path, file_path) = window.LayoutAndRead(layout) -In the statement that shows and reads the form, the two input fields are directly assigned to the caller's variables `folder_path` and `file_path`, ready to use. No parsing no callbacks. +In the statement that shows and reads the window, the two input fields are directly assigned to the caller's variables `folder_path` and `file_path`, ready to use. No parsing no callbacks. Isn't this what almost every Python programmer looking for a GUI wants?? Something easy to work with to get the values and move on to the rest of the program, where the real action is taking place. Why write pages of GUI code when the same layout can be achieved with PySimpleGUI in 3 or 4 lines of code. 4 lines or 40? I chose 4. @@ -727,54 +728,54 @@ Isn't this what almost every Python programmer looking for a GUI wants?? Someth By default return values are a list of values, one entry for each input field. - Return information from Window, SG's primary form builder interface, is in this format: + Return information from Window, SG's primary window builder interface, is in this format: button, (value1, value2, ...) Each of the Elements that are Input Elements will have a value in the list of return values. You can unpack your GUI directly into the variables you want to use. - button, (filename, folder1, folder2, should_overwrite) = form.LayoutAndRead(form_rows) + button, (filename, folder1, folder2, should_overwrite) = window.LayoutAndRead(window_rows) Or, you can unpack the return results separately. - button, values = form.LayoutAndRead(form_rows) + button, values = window.LayoutAndRead(window_rows) filename, folder1, folder2, should_overwrite = values If you have a SINGLE value being returned, it is written this way: - button, (value1,) = form.LayoutAndRead(form_rows) + button, (value1,) = window.LayoutAndRead(window_rows) Another way of parsing the return values is to store the list of values into a variable representing the list of values and then index each individual value. This is not the preferred way of doing it. - button, value_list = form.LayoutAndRead(form_rows) + button, value_list = window.LayoutAndRead(window_rows) value1 = value_list[0] value2 = value_list[1] ... ### Return values as a dictionary -For forms longer than 3 or 4 fields you will want to use a dictionary to help you organize your return values. In almost all (if not all) of the demo programs you'll find the return values being passed as a dictionary. It is not a difficult concept to grasp, the syntax is easy to understand, and it makes for very readable code. +For windows longer than 3 or 4 fields you will want to use a dictionary to help you organize your return values. In almost all (if not all) of the demo programs you'll find the return values being passed as a dictionary. It is not a difficult concept to grasp, the syntax is easy to understand, and it makes for very readable code. -The most common form read statement you'll encounter looks something like this: +The most common window read statement you'll encounter looks something like this: - button, values = form.LayoutAndRead(layout) + button, values = window.LayoutAndRead(layout) or - button, values = form.Read() + button, values = window.Read() All of your return values will be stored in the variable `values`. When using the dictionary return values, the `values` variable is a dictionary. To use a dictionary, you will need to: * Mark each input element you wish to be in the dictionary with the keyword `key`. -If **any** element in the form has a `key`, then **all** of the return values are returned via a dictionary. If some elements do not have a key, then they are numbered starting at zero. +If **any** element in the window has a `key`, then **all** of the return values are returned via a dictionary. If some elements do not have a key, then they are numbered starting at zero. -Let's take a look at your first dictionary-based form. +Let's take a look at your first dictionary-based window. import PySimpleGUI as sg - form = sg.Window('Simple data entry form') + window = sg.Window('Simple data entry window') layout = [ [sg.Text('Please enter your Name, Address, Phone')], [sg.Text('Name', size=(15, 1)), sg.InputText('1', key='name')], @@ -783,7 +784,7 @@ Let's take a look at your first dictionary-based form. [sg.Submit(), sg.Cancel()] ] - button, values = form.LayoutAndRead(layout) + button, values = window.LayoutAndRead(layout) sg.Popup(button, values, values['name'], values['address'], values['phone']) @@ -791,7 +792,7 @@ To get the value of an input field, you use whatever value used as the `key` val values['name'] -You will find the key field used quite heavily in most PySimpleGUI forms unless the form is very simple. +You will find the key field used quite heavily in most PySimpleGUI windows unless the window is very simple. ### Button Return Values @@ -800,20 +801,20 @@ The button value from a Read call will be one of 3 values: 2. The Button's key 3. None -If a button has a key set for it when it's created, then that key will be returned. If no key is set, then the button text is returned. If no button was clicked, but the form returned anyway, the button value is None. +If a button has a key set for it when it's created, then that key will be returned. If no key is set, then the button text is returned. If no button was clicked, but the window returned anyway, the button value is None. None is returned when the user clicks the X to close a window. -If your form has an event loop where it is read over and over, remember to give your user an "out". You should always check for a None value and it's a good practice to provide an Exit button of some kind. Thus design patterns often resemble this Event Loop: +If your window has an event loop where it is read over and over, remember to give your user an "out". You should always check for a None value and it's a good practice to provide an Exit button of some kind. Thus design patterns often resemble this Event Loop: while True: - button, values= form.Read() + button, values= window.Read() if button is None or button == 'Quit': break ## The Event Loop / Callback Functions -All GUIs have one thing in common, an "event loop" or some kind. If your program shows a single form, collects the data and then executes the primary code of the program then you likely don't need an event loop. +All GUIs have one thing in common, an "event loop" or some kind. If your program shows a single window, collects the data and then executes the primary code of the program then you likely don't need an event loop. Event Loops are used in programs where the window ***stays open*** after button presses. The program processes button clicks and user input in a loop called the event loop. You often hear the term event loop when discussing embedded systems or on a Raspberry Pi. @@ -831,11 +832,11 @@ This little program has a typical Event Loop [sg.RButton('Turn LED Off')], [sg.Exit()]] - form = sg.Window('Raspberry Pi).Layout(layout) + window = sg.Window('Raspberry Pi).Layout(layout) # ---- Event Loop ---- # while True: - button, values = form.Read() + button, values = window.Read() # ---- Process Button Clicks ---- # if button is None or button == 'Exit': @@ -850,7 +851,7 @@ This little program has a typical Event Loop -In the Event Loop we are reading the form and then doing a series of button compares to determine what to do based on the button that was clicks (value of `button` variable) +In the Event Loop we are reading the window and then doing a series of button compares to determine what to do based on the button that was clicks (value of `button` variable) The way buttons are presented to the caller in PySimpleGUI is ***not*** how *most* GUI frameworks handle button clicks. Most GUI frameworks, including tkinter, use ***callback*** functions, a function you define would be called when a button is clicked. This requires you to write code where data is shared. @@ -864,7 +865,7 @@ Whether or not this is a "proper" design for GUI programs can be debated. It's ## All Widgets / Elements -This code utilizes as many of the elements in one form as possible. +This code utilizes as many of the elements in one window as possible. import PySimpleGUI as sg @@ -883,7 +884,7 @@ This code utilizes as many of the elements in one form as possible. layout = [ [sg.Menu(menu_def, tearoff=True)], - [sg.Text('All graphic widgets in one form!', size=(30, 1), justification='center', font=("Helvetica", 25), relief=sg.RELIEF_RIDGE)], + [sg.Text('All graphic widgets in one window!', size=(30, 1), justification='center', font=("Helvetica", 25), relief=sg.RELIEF_RIDGE)], [sg.Text('Here is some text.... and a place to enter text')], [sg.InputText('This is my text')], [sg.Frame(layout=[ @@ -904,52 +905,52 @@ This code utilizes as many of the elements in one form as possible. [sg.Text('Choose A Folder', size=(35, 1))], [sg.Text('Your Folder', size=(15, 1), auto_size_text=False, justification='right'), sg.InputText('Default Folder'), sg.FolderBrowse()], - [sg.Submit(tooltip='Click to submit this form'), sg.Cancel()] + [sg.Submit(tooltip='Click to submit this window'), sg.Cancel()] ] - form = sg.Window('Everything bagel', default_element_size=(40, 1), grab_anywhere=False).Layout(layout) + window = sg.Window('Everything bagel', default_element_size=(40, 1), grab_anywhere=False).Layout(layout) - button, values = form.Read() + button, values = window.Read() sg.Popup('Title', - 'The results of the form.', + 'The results of the window.', 'The button clicked was "{}"'.format(button), 'The values are', values) -This is a somewhat complex form with quite a bit of custom sizing to make things line up well. This is code you only have to write once. When looking at the code, remember that what you're seeing is a list of lists. Each row contains a list of Graphical Elements that are used to create the form. +This is a somewhat complex window with quite a bit of custom sizing to make things line up well. This is code you only have to write once. When looking at the code, remember that what you're seeing is a list of lists. Each row contains a list of Graphical Elements that are used to create the window. ![everything bagel](https://user-images.githubusercontent.com/13696193/45914128-87163800-be0e-11e8-9a83-7ee5960e88b9.jpg) -Clicking the Submit button caused the form call to return. The call to Popup resulted in this dialog box. +Clicking the Submit button caused the window call to return. The call to Popup resulted in this dialog box. ![everything bagel reseults](https://user-images.githubusercontent.com/13696193/45914129-87aece80-be0e-11e8-8aae-9a483a9ad4a6.jpg) -**`Note, button value can be None`**. The value for `button` will be the text that is displayed on the button element when it was created. If the user closed the form using something other than a button, then `button` will be `None`. +**`Note, button value can be None`**. The value for `button` will be the text that is displayed on the button element when it was created. If the user closed the window using something other than a button, then `button` will be `None`. -You can see in the Popup that the values returned are a list. Each input field in the form generates one item in the return values list. All input fields return a `string` except for Check Boxes and Radio Buttons. These return `bool`. +You can see in the Popup that the values returned are a list. Each input field in the window generates one item in the return values list. All input fields return a `string` except for Check Boxes and Radio Buttons. These return `bool`. --- -# Building Custom Forms +# Building Custom windows You will find it much easier to write code using PySimpleGUI if you use an IDE such as PyCharm. The features that show you documentation about the API call you are making will help you determine which settings you want to change, if any. In PyCharm, two commands are particularly helpful. Control-Q (when cursor is on function name) brings up a box with the function definition Control-P (when cursor inside function call "()") shows a list of parameters and their default values -## Synchronous Forms -The most common use of PySimpleGUI is to display and collect information from the user. The most straightforward way to do this is using a "blocking" GUI call. Execution is "blocked" while waiting for the user to close the GUI form/dialog box. -You've already seen a number of examples above that use blocking forms. Anytime you see a context manager used (see the `with` statement) it's most likely a blocking form. You can examine the show calls to be sure. If the form is a non-blocking form, it must indicate that in the call to `form.show`. +## Synchronous windows +The most common use of PySimpleGUI is to display and collect information from the user. The most straightforward way to do this is using a "blocking" GUI call. Execution is "blocked" while waiting for the user to close the GUI window/dialog box. +You've already seen a number of examples above that use blocking windows. Anytime you see a context manager used (see the `with` statement) it's most likely a blocking window. You can examine the show calls to be sure. If the window is a non-blocking window, it must indicate that in the call to `window.show`. -NON-BLOCKING form call: +NON-BLOCKING window call: - form.Show(non_blocking=True) + window.Show(non_blocking=True) -### Beginning a Form -The first step is to create the form object using the desired form customization. +### Beginning a window +The first step is to create the window object using the desired window customization. - with Window('Everything bagel', auto_size_text=True, default_element_size=(30,1)) as form: + with Window('Everything bagel', auto_size_text=True, default_element_size=(30,1)) as window: This is the definition of the Window object: @@ -976,39 +977,39 @@ This is the definition of the Window object: keep_on_top=False): -Parameter Descriptions. You will find these same parameters specified for each `Element` and some of them in `Row` specifications. The `Element` specified value will take precedence over the `Row` and `Form` values. +Parameter Descriptions. You will find these same parameters specified for each `Element` and some of them in `Row` specifications. The `Element` specified value will take precedence over the `Row` and `window` values. - default_element_size - Size of elements in form in characters (width, height) - default_button_element_size - Size of buttons on this form + default_element_size - Size of elements in window in characters (width, height) + default_button_element_size - Size of buttons on this window auto_size_text - Bool. True if elements should size themselves according to contents. Defaults to True auto_size_buttons - Bool. True if button elements should size themselves according to their text label location - (x,y) Location to place window in pixels - font - Font name and size for elements of the form + font - Font name and size for elements of the window button_color - Default color for buttons (foreground, background). Can be text or hex progress_bar_color - Foreground and background colors for progress bars background_color - Color of the window background - is_tabbed_form - Bool. If True then form is a tabbed form + is_tabbed_form - Bool. If True then window is a tabbed window border_depth - Amount of 'bezel' to put on input boxes, buttons, etc. - auto_close - Bool. If True form will autoclose - auto_close_duration - Duration in seconds before form closes + auto_close - Bool. If True window will autoclose + auto_close_duration - Duration in seconds before window closes icon - .ICO file that will appear on the Task Bar and end of Title Bar return_keyboard_events - if True key presses are returned as buttons use_default_focus - if True and no focus set, then automatically set a focus - text_justification - Justification to use for Text Elements in this form + text_justification - Justification to use for Text Elements in this window no_titlebar - Create window without a titlebar grab_anywhere - Grab any location on the window to move the window keep_on_top - if True then window will always stop on top of other windows on the screen. Great for floating toolbars. #### Window Location -PySimpleGUI computes the exact center of your window and centers the window on the screen. If you want to locate your window elsewhere, such as the system default of (0,0), if you have 2 ways of doing this. The first is when the form is created. Use the `location` parameter to set where the window. The second way of doing this is to use the `SetOptions` call which will set the default window location for all windows in the future. +PySimpleGUI computes the exact center of your window and centers the window on the screen. If you want to locate your window elsewhere, such as the system default of (0,0), if you have 2 ways of doing this. The first is when the window is created. Use the `location` parameter to set where the window. The second way of doing this is to use the `SetOptions` call which will set the default window location for all windows in the future. #### Sizes Note several variables that deal with "size". Element sizes are measured in characters. A Text Element with a size of 20,1 has a size of 20 characters wide by 1 character tall. The default Element size for PySimpleGUI is `(45,1)`. -Sizes can be set at the element level, or in this case, the size variables apply to all elements in the form. Setting `size=(20,1)` in the form creation call will set all elements in the form to that size. +Sizes can be set at the element level, or in this case, the size variables apply to all elements in the window. Setting `size=(20,1)` in the window creation call will set all elements in the window to that size. There are a couple of widgets where one of the size values is in pixels rather than characters. This is true for Progress Meters and Sliders. The second parameter is the 'height' in pixels. @@ -1028,17 +1029,17 @@ Windows without a titlebar can be used to easily create a floating launcher. #### Grab Anywhere -This is a feature unique to PySimpleGUI. The default is ENABLED.... unless the form is a non-blocking form. +This is a feature unique to PySimpleGUI. The default is ENABLED.... unless the window is a non-blocking window. -It is turned off for non-blocking because there is a warning message printed out if the user closes a non-blocking form using a button with grab_anywhere enabled. There is no harm in these messages, but it may be distressing to the user. Should you wish to enable for a non-blocking form, simply get grab_anywhere = True when you create the form. +It is turned off for non-blocking because there is a warning message printed out if the user closes a non-blocking window using a button with grab_anywhere enabled. There is no harm in these messages, but it may be distressing to the user. Should you wish to enable for a non-blocking window, simply get grab_anywhere = True when you create the window. #### Always on top -To keep a window on top of all other windows on the screen, set keep_on_top = True when the form is created. This feature makes for floating toolbars that are very helpful and always visible on your desktop. +To keep a window on top of all other windows on the screen, set keep_on_top = True when the window is created. This feature makes for floating toolbars that are very helpful and always visible on your desktop. ## Elements -"Elements" are the building blocks used to create forms. Some GUI APIs use the term "Widget" to describe these graphic elements. +"Elements" are the building blocks used to create windows. Some GUI APIs use the term "Widget" to describe these graphic elements. Text Single Line Input @@ -1047,8 +1048,8 @@ To keep a window on top of all other windows on the screen, set keep_on_top = Tr Folder Browse Calendar picker Date Chooser - Read form - Close form + Read window + Close window Realtime Checkboxes Radio Buttons @@ -1065,7 +1066,7 @@ To keep a window on top of all other windows on the screen, set keep_on_top = Tr Image Table Async/Non-Blocking Windows - Tabbed forms + Tabbed windows Persistent Windows Redirect Python Output/Errors to scrolling Window "Higher level" APIs (e.g. MessageBox, YesNobox, ...) @@ -1076,14 +1077,14 @@ key tooltip #### Tooltip -Tooltips are text boxes that popup next to an element if you hold your mouse over the top of it. If you want to be extra kind to your form's user, then you can create tooltips for them by setting the parameter `tooltip` to some text string. You will need to supply your own line breaks / text wrapping. If you don't want to manually add them, then take a look at the standard library package `textwrap`. +Tooltips are text boxes that popup next to an element if you hold your mouse over the top of it. If you want to be extra kind to your window's user, then you can create tooltips for them by setting the parameter `tooltip` to some text string. You will need to supply your own line breaks / text wrapping. If you don't want to manually add them, then take a look at the standard library package `textwrap`. Tooltips are one of those "polish" items that really dress-up a GUI and show's a level of sophistication. Go ahead, impress people, throw some tooltips into your GUI. ### Output Elements -Building a form is simply making lists of Elements. Each list is a row in the overall GUI dialog box. The definition looks something like this: +Building a window is simply making lists of Elements. Each list is a row in the overall GUI dialog box. The definition looks something like this: layout = [ [row 1 element, row 1 element], [row 2 element, row 2 element, row 2 element] ] @@ -1168,14 +1169,14 @@ This Element doubles as both an input and output Element. The `DefaultText` opt . default_text - Text to display in the text box - enter_submits - Bool. If True, pressing Enter key submits form + enter_submits - Bool. If True, pressing Enter key submits window size - Element's size auto_size_text - Bool. Change width to match size of text #### Output Element -Output re-routes `Stdout` to a scrolled text box. It's used with Async forms. More on this later. +Output re-routes `Stdout` to a scrolled text box. It's used with Async windows. More on this later. - form.AddRow(gg.Output(size=(100,20))) + window.AddRow(gg.Output(size=(100,20))) ![output](https://user-images.githubusercontent.com/13696193/44959863-b72f8280-aec3-11e8-8caa-7bc743149953.jpg) @@ -1185,7 +1186,7 @@ Output re-routes `Stdout` to a scrolled text box. It's used with Async forms. size - Size of element (width, height) in characters ### Input Elements - These make up the majority of the form definition. Optional variables at the Element level override the Form level values (e.g. `size` is specified in the Element). All input Elements create an entry in the list of return values. A Text Input Element creates a string in the list of items returned. + These make up the majority of the window definition. Optional variables at the Element level override the window level values (e.g. `size` is specified in the Element). All input Elements create an entry in the list of return values. A Text Input Element creates a string in the list of items returned. #### Text Input Element @@ -1212,7 +1213,7 @@ Output re-routes `Stdout` to a scrolled text box. It's used with Async forms. password_char - Character that will be used to replace each entered character. Setting to a value indicates this field is a password entry field background_color - color to use for the input field background text_color - color to use for the typed text - do_not_clear - Bool. Normally forms clear when read, turn off clearing with this flag. + do_not_clear - Bool. Normally windows clear when read, turn off clearing with this flag. key = Dictionary key to use for return values focus = Bool. True if this field should capture the focus (moves cursor to this field) @@ -1284,7 +1285,7 @@ The standard listbox like you'll find in most GUIs. Note that the return values 'extended' 'multiple' 'single' - change_submits - if True, the form read will return with a button value of '' + change_submits - if True, the window read will return with a button value of '' bind_return_key - if the focus is on the listbox and the user presses return key, or if the user double clicks an item, then the read will return size - (width, height) of element in characters auto_size_text - Bool. True if size should fit the text length @@ -1297,7 +1298,7 @@ The standard listbox like you'll find in most GUIs. Note that the return values The `select_mode` option can be a string or a constant value defined as a variable. Generally speaking strings are used for these kinds of options. -ListBoxes can cause a form to return from a Read call. If the flag change_submits is set, then when a user makes a selection, the Read immediately returns. +ListBoxes can cause a window to return from a Read call. If the flag change_submits is set, then when a user makes a selection, the Read immediately returns. Another way ListBoxes can cause Reads to return is if the flag bind_return_key is set. If True, then if the user presses the return key while an entry is selected, then the Read returns. Also, if this flag is set, if the user double-clicks an entry it will return from the Read. #### Slider Element @@ -1426,7 +1427,7 @@ An up/down spinner control. The valid values are passed in as a list. ### Button Element -Buttons are the most important element of all! They cause the majority of the action to happen. After all, it's a button press that will get you out of a form, whether it be Submit or Cancel, one way or another a button is involved in all forms. The only exception is to this is when the user closes the window using the "X" in the upper corner which means no button was involved. +Buttons are the most important element of all! They cause the majority of the action to happen. After all, it's a button press that will get you out of a window, whether it be Submit or Cancel, one way or another a button is involved in all windows. The only exception is to this is when the user closes the window using the "X" in the upper corner which means no button was involved. The Types of buttons include: * Folder Browse @@ -1434,16 +1435,16 @@ The Types of buttons include: * Files Browse * File SaveAs * File Save -* Close Form (normal button) -* Read Form +* Close window (normal button) +* Read window * Realtime * Calendar Chooser * Color Chooser - Close Form - Normal buttons like Submit, Cancel, Yes, No, etc, are "Close Form" buttons. They cause the input values to be read and then the form is ***closed***, returning the values to the caller. + Close window - Normal buttons like Submit, Cancel, Yes, No, etc, are "Close window" buttons. They cause the input values to be read and then the window is ***closed***, returning the values to the caller. -Folder Browse - When clicked a folder browse dialog box is opened. The results of the Folder Browse dialog box are written into one of the input fields of the form. +Folder Browse - When clicked a folder browse dialog box is opened. The results of the Folder Browse dialog box are written into one of the input fields of the window. File Browse - Same as the Folder Browse except rather than choosing a folder, a single file is chosen. @@ -1451,18 +1452,18 @@ Calendar Chooser - Opens a graphical calendar to select a date. Color Chooser - Opens a color chooser dialog -Read Form - This is a form button that will read a snapshot of all of the input fields, but does not close the form after it's clicked. +Read window - This is a window button that will read a snapshot of all of the input fields, but does not close the window after it's clicked. -Realtime - This is another async form button. Normal button clicks occur after a button's click is released. Realtime buttons report a click the entire time the button is held down. +Realtime - This is another async window button. Normal button clicks occur after a button's click is released. Realtime buttons report a click the entire time the button is held down. -Most programs will use a combination of shortcut button calls (Submit, Cancel, etc), plain buttons that close the form, and ReadForm buttons that keep the window open but returns control back to the caller. +Most programs will use a combination of shortcut button calls (Submit, Cancel, etc), plain buttons that close the window, and ReadForm buttons that keep the window open but returns control back to the caller. Sometimes there are multiple names for the same function. This is simply to make the job of the programmer quicker and easier. -The 3 primary forms of PySimpleGUI buttons and their names are: +The 3 primary windows of PySimpleGUI buttons and their names are: 1. `Button` = `SimpleButton` - 2. `ReadFormButton` = `ReadButton` = `RFButton` = `RButton` + 2. `ReadButton` = `RButton` = `ReadFormButton` (old style... use ReadButton instead) 3. `RealtimeButton` You will find the long-form in the older programs. @@ -1536,7 +1537,7 @@ These Pre-made buttons are some of the most important elements of all because th #### Button targets -The `FileBrowse`, `FolderBrowse`, `FileSaveAs` , `FilesSaveAs`, `CalendarButton`, `ColorChooserButton` buttons all fill-in values into another element located on the form. The target can be a Text Element or an InputText Element. The location of the element is specified by the `target` variable in the function call. +The `FileBrowse`, `FolderBrowse`, `FileSaveAs` , `FilesSaveAs`, `CalendarButton`, `ColorChooserButton` buttons all fill-in values into another element located on the window. The target can be a Text Element or an InputText Element. The location of the element is specified by the `target` variable in the function call. The Target comes in two forms. 1. Key @@ -1552,7 +1553,7 @@ The default value for `target` is `(ThisRow, -1)`. `ThisRow` is a special valu If a value of `(None, None)` is chosen for the target, then the button itself will hold the information. Later the button can be queried for the value by using the button's key. -Let's examine this form as an example: +Let's examine this window as an example: ![file browse](https://user-images.githubusercontent.com/13696193/44959944-d1b62b80-aec4-11e8-8a68-9d79d37b2c81.jpg) @@ -1563,7 +1564,7 @@ The `InputText` element is located at (1,0)... row 1, column 0. The `Browse` bu Target = (1,0) Target = (-1,0) -The code for the entire form could be: +The code for the entire window could be: layout = [[sg.T('Source Folder')], [sg.In()], @@ -1606,13 +1607,13 @@ These buttons pop up a standard color chooser window. The result is returned as **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 `Button`, which closes the form when clicked. +Not all buttons are created equal. A button that closes a window is different that a button that returns from the window without closing it. If you want to define your own button, you will generally do this with the Button Element `Button`, which closes the window when clicked. layout = [[sg.Button('My Button')]] ![button](https://user-images.githubusercontent.com/13696193/44959862-b696ec00-aec3-11e8-9e88-4b9af0338a03.jpg) -All buttons can have their text changed by changing the `button_text` variable in the button call. It is this text that is returned when a form is read. This text will be what tells you which button is called so make it unique. Most of the convenience buttons (Submit, Cancel, Yes, etc) are all Buttons. Some that are not are `FileBrowse` , `FolderBrowse`, `FileSaveAs`. They clearly do not close the form. Instead they bring up a file or folder browser dialog box. +All buttons can have their text changed by changing the `button_text` variable in the button call. It is this text that is returned when a window is read. This text will be what tells you which button is called so make it unique. Most of the convenience buttons (Submit, Cancel, Yes, etc) are all Buttons. Some that are not are `FileBrowse` , `FolderBrowse`, `FileSaveAs`. They clearly do not close the window. Instead they bring up a file or folder browser dialog box. **Button Images** Now this is an exciting feature not found in many simplified packages.... images on buttons! You can make a pretty spiffy user interface with the help of a few button images. @@ -1631,11 +1632,11 @@ Three parameters are used for button images. image_size - Size of image file in pixels image_subsample - Amount to divide the size by. 2 means your image will be 1/2 the size. 3 means 1/3 -Here's an example form made with button images. +Here's an example window made with button images. ![media file player](https://user-images.githubusercontent.com/13696193/43161977-9ee7cace-8f57-11e8-8ff8-3ea24b69dab9.jpg) -You'll find the source code in the file Demo Media Player. Here is what the button calls look like to create media player form +You'll find the source code in the file Demo Media Player. Here is what the button calls look like to create media player window sg.RButton('Pause', button_color=sg.TRANSPARENT_BUTTON, image_filename=image_pause, image_size=(50, 50), image_subsample=2, border_width=0) @@ -1649,13 +1650,13 @@ This is one you'll have to experiment with at this point. Not up for an exhaust ![robot remote](https://user-images.githubusercontent.com/13696193/44959958-ff9b7000-aec4-11e8-99ea-7450926409be.jpg) -This form has 2 button types. There's the normal "Simple Button" (Quit) and 4 "Realtime Buttons". +This window has 2 button types. There's the normal "Simple Button" (Quit) and 4 "Realtime Buttons". -Here is the code to make, show and get results from this form: +Here is the code to make, show and get results from this window: - form = sg.Window('Robotics Remote Control', auto_size_text=True) + window = sg.Window('Robotics Remote Control', auto_size_text=True) - form_rows = [[sg.Text('Robotics Remote Control')], + window_rows = [[sg.Text('Robotics Remote Control')], [sg.T(' '*10), sg.RealtimeButton('Forward')], [ sg.RealtimeButton('Left'), sg.T(' '*15), sg.RealtimeButton('Right')], [sg.T(' '*10), sg.RealtimeButton('Reverse')], @@ -1663,39 +1664,39 @@ Here is the code to make, show and get results from this form: [sg.Quit(button_color=('black', 'orange'))] ] - form.LayoutAndRead(form_rows, non_blocking=True) + window.LayoutAndRead(window_rows, non_blocking=True) -Somewhere later in your code will be your main event loop. This is where you do your polling of devices, do input/output, etc. It's here that you will read your form's buttons. +Somewhere later in your code will be your main event loop. This is where you do your polling of devices, do input/output, etc. It's here that you will read your window's buttons. while (True): # This is the code that reads and updates your window - button, values = form.ReadNonBlocking() + button, values = window.ReadNonBlocking() if button is not None: sg.Print(button) if button == 'Quit' or values is None: break time.sleep(.01) -This loop will read button values and print them. When one of the Realtime buttons is clicked, the call to `form.ReadNonBlocking` will return a button name matching the name on the button that was depressed. It will continue to return values as long as the button remains depressed. Once released, the ReadNonBlocking will return None for buttons until a button is again clicked. +This loop will read button values and print them. When one of the Realtime buttons is clicked, the call to `window.ReadNonBlocking` will return a button name matching the name on the button that was depressed. It will continue to return values as long as the button remains depressed. Once released, the ReadNonBlocking will return None for buttons until a button is again clicked. **File Types** The `FileBrowse` & `SaveAs` buttons have an additional setting named `file_types`. This variable is used to filter the files shown in the file dialog box. The default value for this setting is FileTypes=(("ALL Files", "*.*"),) -This code produces a form where the Browse button only shows files of type .TXT +This code produces a window where the Browse button only shows files of type .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. + The ENTER key is an important part of data entry for windows. There's a long tradition of the enter key being used to quickly submit windows. PySimpleGUI implements this by tying the ENTER key to the first button that closes or reads a window. -The Enter Key can be "bound" to a particular button so that when the key is pressed, it causes the form to return as if the button was clicked. This is done using the `bind_return_key` parameter in the button calls. -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. +The Enter Key can be "bound" to a particular button so that when the key is pressed, it causes the window to return as if the button was clicked. This is done using the `bind_return_key` parameter in the button calls. +If there are more than 1 button on a window, the FIRST button that is of type Close window or Read window is used. First is determined by scanning the window, 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 OneLineProgressMeter that provides 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 `ProgressBar` element is used to build custom Progress Bar windows. It is HIGHLY recommended that you use OneLineProgressMeter that provides a complete progress meter solution for you. Progress Meters are not easy to work with because the windows 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 `OneLineProgressMeter` API. This consists of a pair of functions, `OneLineProgressMeter` and `OneLineProgressMeterCancel`. 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 OneLineProgressMeter calls presented earlier in this readme. @@ -1704,33 +1705,33 @@ You've already seen OneLineProgressMeter calls presented earlier in this readme. The return value for `OneLineProgressMeter` is: `True` if meter updated correctly -`False` if user clicked the Cancel button, closed the form, or vale reached the max value. +`False` if user clicked the Cancel button, closed the window, or vale reached the max value. -#### Progress Mater in Your Form -Another 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. +#### Progress Mater in Your window +Another way of using a Progress Meter with PySimpleGUI is to build a custom window with a `ProgressBar` Element in the window. You will need to run your window as a non-blocking window. When you are ready to update your progress bar, you call the `UpdateBar` method for the `ProgressBar` element itself. ![progress custom](https://user-images.githubusercontent.com/13696193/45243969-c3508100-b2c3-11e8-82bc-927d0307e093.jpg) import PySimpleGUI as sg - # layout the form + # layout the window layout = [[sg.Text('A custom progress meter')], [sg.ProgressBar(10000, orientation='h', size=(20, 20), key='progressbar')], [sg.Cancel()]] - # create the form` - form = sg.Window('Custom Progress Meter').Layout(layout) - progress_bar = form.FindElement('progressbar') + # create the window` + window = sg.Window('Custom Progress Meter').Layout(layout) + progress_bar = window.FindElement('progressbar') # loop that would normally do something useful for i in range(10000): # check to see if the cancel button was clicked and exit loop if clicked - button, values = form.ReadNonBlocking() + button, values = window.ReadNonBlocking() if button == 'Cancel' or values == None: break # update bar with loop value +1 so that bar eventually reaches the maximum progress_bar.UpdateBar(i + 1) # done with loop... need to destroy the window as it's still open - form.CloseNonBlockingForm()) + window.CloseNonBlocking()) #### Output @@ -1738,11 +1739,11 @@ The Output Element is a re-direction of Stdout. Anything "printed" will be disp Output(size=(None, None)) -Here's a complete solution for a chat-window using an Async form with an Output Element +Here's a complete solution for a chat-window using an Async window with an Output Element import PySimpleGUI as sg - # Blocking form that doesn't close + # Blocking window that doesn't close def ChatBot(): layout = [[(sg.Text('This is where standard out is being routed', size=[40, 1]))], [sg.Output(size=(80, 20))], @@ -1750,11 +1751,11 @@ Here's a complete solution for a chat-window using an Async form with an Output sg.RButton('SEND', button_color=(sg.YELLOWS[0], sg.BLUES[0])), sg.Button('EXIT', button_color=(sg.YELLOWS[0], sg.GREENS[0]))]] - form = sg.Window('Chat Window', default_element_size=(30, 2)).Layout(layout) + window = sg.Window('Chat Window', default_element_size=(30, 2)).Layout(layout) # ---===--- Loop taking in user input and using it to query HowDoI web oracle --- # while True: - button, value = form.Read() + button, value = window.Read() if button == 'SEND': print(value) else: @@ -1764,9 +1765,9 @@ Here's a complete solution for a chat-window using an Async form with an Output ------------------- ## Columns -Starting in version 2.9 you'll be able to do more complex layouts by using the Column Element. Think of a Column as a form within a form. And, yes, you can have a Column within a Column if you want. +Starting in version 2.9 you'll be able to do more complex layouts by using the Column Element. Think of a Column as a window within a window. And, yes, you can have a Column within a Column if you want. -Columns are specified in exactly the same way as a form is, as a list of lists. +Columns are specified in exactly the same way as a window is, as a list of lists. def Column(layout - the list of rows that define the layout background_color - color of background @@ -1787,11 +1788,11 @@ This code produced the above window. import PySimpleGUI as sg # Demo of how columns work - # Form has on row 1 a vertical slider followed by a COLUMN with 7 rows + # window has on row 1 a vertical slider followed by a COLUMN with 7 rows # Prior to the Column element, this layout was not possible - # Columns layouts look identical to form layouts, they are a list of lists of elements. + # Columns layouts look identical to window layouts, they are a list of lists of elements. - form = sg.Window('Columns') # blank form + window = sg.Window('Columns') # blank window # Column layout col = [[sg.Text('col Row 1')], @@ -1806,18 +1807,18 @@ This code produced the above window. [sg.In('Last input')], [sg.OK()]] - # Display the form and get values + # Display the window and get values # If you're willing to not use the "context manager" design pattern, then it's possible - # to collapse the form display and read down to a single line of code. - button, values = sg.Window('Compact 1-line form with column').LayoutAndRead(layout) + # to collapse the window display and read down to a single line of code. + button, values = sg.Window('Compact 1-line window with column').LayoutAndRead(layout) sg.Popup(button, values, line_width=200) -The Column Element has 1 required parameter and 1 optional (the layout and the background color). Setting the background color has the same effect as setting the form's background color, except it only affects the column rectangle. +The Column Element has 1 required parameter and 1 optional (the layout and the background color). Setting the background color has the same effect as setting the window's background color, except it only affects the column rectangle. Column(layout, background_color=None) -The default background color for Columns is the same as the default window background color. If you change the look and feel of the form, the column background will match the form background automatically. +The default background color for Columns is the same as the default window background color. If you change the look and feel of the window, the column background will match the window background automatically. @@ -1841,7 +1842,7 @@ Frames work exactly the same way as Columns. You create layout that is then use -This code creates a form with a Frame and 2 buttons. +This code creates a window with a Frame and 2 buttons. frame_layout = [ [sg.T('Text inside of a frame')], @@ -1852,14 +1853,14 @@ This code creates a form with a Frame and 2 buttons. [sg.Submit(), sg.Cancel()] ] - form = sg.Window('Frame with buttons', font=("Helvetica", 12)).Layout(layout) + window = sg.Window('Frame with buttons', font=("Helvetica", 12)).Layout(layout) ![frame element](https://user-images.githubusercontent.com/13696193/45889173-c2245700-bd8d-11e8-8f73-1e5f1be3ddb1.jpg) -Notice how the Frame layout looks identical to a form layout. A Form works exactly the same way as a Column and a Frame. They all are "container elements". Elements that contain other elements. +Notice how the Frame layout looks identical to a window layout. A window works exactly the same way as a Column and a Frame. They all are "container elements". Elements that contain other elements. *These container Elements can be nested as deep as you want.* That's a pretty spiffy feature, right? Took a lot of work so be appreciative. Recursive code isn't trivial. @@ -1881,29 +1882,29 @@ One such integration is with Matploplib and Pyplot. There is a Demo program wri The order of operations to obtain a tkinter Canvas Widget is: figure_x, figure_y, figure_w, figure_h = fig.bbox.bounds - # define the form layout + # define the window layout layout = [[sg.Text('Plot test')], [sg.Canvas(size=(figure_w, figure_h), key='canvas')], [sg.OK(pad=((figure_w / 2, 0), 3), size=(4, 2))]] - # create the form and show it without the plot - form = sg.Window('Demo Application - Embedding Matplotlib In PySimpleGUI').Layout(layout).Finalize() + # create the window and show it without the plot + window = sg.Window('Demo Application - Embedding Matplotlib In PySimpleGUI').Layout(layout).Finalize() # add the plot to the window - fig_photo = draw_figure(form.FindElement('canvas').TKCanvas, fig) + fig_photo = draw_figure(window.FindElement('canvas').TKCanvas, fig) # show it all again and get buttons - button, values = form.Read() + button, values = window.Read() To get a tkinter Canvas Widget from PySimpleGUI, follow these steps: -* Add Canvas Element to your form -* Layout your form -* Call `form.Finalize()` - this is a critical step you must not forget +* Add Canvas Element to your window +* Layout your window +* Call `window.Finalize()` - this is a critical step you must not forget * Find the Canvas Element by looking up using key * Your Canvas Widget Object will be the found_element.TKCanvas * Draw on your canvas to your heart's content -* Call `form.Read()` - Nothing will appear on your canvas until you call Read +* Call `window.Read()` - Nothing will appear on your canvas until you call Read See `Demo_Matplotlib.py` for a Recipe you can copy. @@ -1970,16 +1971,16 @@ Let me say up front that the Table Element has Beta status. The reason is that s -## Tabbed Forms -Tabbed forms are shown using the `ShowTabbedForm` call. The call has the format +## Tabbed windows +Tabbed windows are shown using the `ShowTabbedForm` call. The call has the format results = ShowTabbedForm('Title for the form', (form,layout,'Tab 1 label'), (form2,layout2, 'Tab 2 label'), ...) -Each of the tabs of the form is in fact a form. The same steps are taken to create the form as before. A `Window` is created, then rows are filled with Elements, and finally the form is shown. When calling `ShowTabbedForm`, each form is passed in as a tuple. The tuple has the format: `(the form, the rows, a string shown on the tab)` +Each of the tabs of the form is in fact a window. The same steps are taken to create the form as before. A `Window` is created, then rows are filled with Elements, and finally the form is shown. When calling `ShowTabbedForm`, each form is passed in as a tuple. The tuple has the format: `(the form, the rows, a string shown on the tab)` -Results are returned as a list of lists. For each form you'll get a list that's in the same format as a normal form. A single tab's values would be: +Results are returned as a list of lists. For each form you'll get a list that's in the same format as a normal window. A single tab's values would be: (button, (values)) @@ -1990,7 +1991,7 @@ Recall that values is a list as well. Multiple tabs in the form would return li ## Colors ## Starting in version 2.5 you can change the background colors for the window and the Elements. -Your forms can go from this: +Your windows can go from this: ![snap0155](https://user-images.githubusercontent.com/13696193/43273879-a9fdc10a-90cb-11e8-8c20-4f6a244ebe2f.jpg) @@ -2002,9 +2003,9 @@ to this... with one function call... -While you can do it on an element by element or form level basis, the easiest way, by far, is a call to `SetOptions`. +While you can do it on an element by element or window level basis, the easiest way, by far, is a call to `SetOptions`. -Be aware that once you change these options they are changed for the rest of your program's execution. All of your forms will have that look and feel, until you change it to something else (which could be the system default colors. +Be aware that once you change these options they are changed for the rest of your program's execution. All of your windows will have that look and feel, until you change it to something else (which could be the system default colors. This call sets all of the different color options. @@ -2089,41 +2090,41 @@ Explanation of parameters tooltip_time - time in milliseconds to wait before showing a tooltip. Default is 400ms -These settings apply to all forms `SetOptions`. The Row options and Element options will take precedence over these settings. Settings can be thought of as levels of settings with the Form-level being the highest and the Element-level the lowest. Thus the levels are: +These settings apply to all windows `SetOptions`. The Row options and Element options will take precedence over these settings. Settings can be thought of as levels of settings with the window-level being the highest and the Element-level the lowest. Thus the levels are: - - Form level + - window level - Row level - Element level Each lower level overrides the settings of the higher level. Once settings have been changed, they remain changed for the duration of the program (unless changed again). -## Persistent Forms (Window stays open after button click) +## Persistent windows (Window stays open after button click) -There are 2 ways to keep a window open after the user has clicked a button. One way is to use non-blocking forms (see the next section). The other way is to use buttons that 'read' the form instead of 'close' the form when clicked. The typical buttons you find in forms, including the shortcut buttons, close the form. These include OK, Cancel, Submit, etc. The Button Element also closes the form. +There are 2 ways to keep a window open after the user has clicked a button. One way is to use non-blocking windows (see the next section). The other way is to use buttons that 'read' the window instead of 'close' the window when clicked. The typical buttons you find in windows, including the shortcut buttons, close the window. These include OK, Cancel, Submit, etc. The Button Element also closes the window. -The `RButton` Element creates a button that when clicked will return control to the user, but will leave the form open and visible. This button is also used in Non-Blocking forms. The difference is in which call is made to read the form. The `Read` call will block, the `ReadNonBlocking` will not block. +The `RButton` Element creates a button that when clicked will return control to the user, but will leave the window open and visible. This button is also used in Non-Blocking windows. The difference is in which call is made to read the window. The `Read` call will block, the `ReadNonBlocking` will not block. -## Asynchronous (Non-Blocking) Forms +## Asynchronous (Non-Blocking) windows So you want to be a wizard do ya? Well go boldly! -Use async forms sparingly. It's possible to have a form that appears to be async, but it is not. **Please** try to find other methods before going to async forms. The reason for this plea is that async forms poll tkinter over and over. If you do not have a sleep in your loop, you will eat up 100% of the CPU time. +Use async windows sparingly. It's possible to have a window that appears to be async, but it is not. **Please** try to find other methods before going to async windows. The reason for this plea is that async windows poll tkinter over and over. If you do not have a sleep in your loop, you will eat up 100% of the CPU time. -When to use a non-blocking form: +When to use a non-blocking window: * A media file player like an MP3 player * A status dashboard that's periodically updated * Progress Meters - when you want to make your own progress meters * Output using print to a scrolled text element. Good for debugging. -If your application doesn't follow the basic design pattern at one of those, then it shouldn't be executed as a non-blocking form. +If your application doesn't follow the basic design pattern at one of those, then it shouldn't be executed as a non-blocking window. ### Instead of ReadNonBlocking --- Use `change_submits = True` or return_keyboard_events = True Any time you are thinking "I want an X Element to cause a Y Element to do something", then you want to use the `change_submits` option. -***Instead of polling, try options that cause the form to return to you.*** By using non-blocking forms, you are *polling*. You can indeed create your application by polling. It will work. But you're going to be maxing out your processor and may even take longer to react to an event than if you used another technique. +***Instead of polling, try options that cause the window to return to you.*** By using non-blocking windows, you are *polling*. You can indeed create your application by polling. It will work. But you're going to be maxing out your processor and may even take longer to react to an event than if you used another technique. **Examples** @@ -2136,93 +2137,93 @@ One example is you have an input field that changes as you press buttons on an o ### Periodically Calling`ReadNonBlocking` -Periodically "refreshing" the visible GUI. The longer you wait between updates to your GUI the more sluggish your forms will feel. It is up to you to make these calls or your GUI will freeze. +Periodically "refreshing" the visible GUI. The longer you wait between updates to your GUI the more sluggish your windows will feel. It is up to you to make these calls or your GUI will freeze. -There are 2 methods of interacting with non-blocking forms. -1. Read the form just as you would a normal form -2. "Refresh" the form's values without reading the form. It's a quick operation meant to show the user the latest values +There are 2 methods of interacting with non-blocking windows. +1. Read the window just as you would a normal window +2. "Refresh" the window's values without reading the window. It's a quick operation meant to show the user the latest values - With asynchronous forms the form is shown, user input is read, but your code keeps right on chugging. YOUR responsibility is to call `PySimpleGUI.ReadNonBlocking` on a periodic basis. Once a second or more will produce a reasonably snappy GUI. + With asynchronous windows the window is shown, user input is read, but your code keeps right on chugging. YOUR responsibility is to call `PySimpleGUI.ReadNonBlocking` on a periodic basis. Once a second or more will produce a reasonably snappy GUI. - #### Exiting a Non-Blocking Form + #### Exiting a Non-Blocking window -It's important to always provide a "way out" for your user. Make sure you have provided a button or some other mechanism to exit. Also be sure to check for closed forms in your code. It is possible for a form to look closed, but continue running your event loop. +It's important to always provide a "way out" for your user. Make sure you have provided a button or some other mechanism to exit. Also be sure to check for closed windows in your code. It is possible for a window to look closed, but continue running your event loop. -Typically when reading a form you check `if Button is None` to determine if a form was closed. With NonBlocking forms, buttons will be None unless a button or a key was returned. The way you determine if a window was closed in a non-blocking form is to check **both** the button and the values are None. Since button is normally None, you only need to test for `value is None` in your code. +Typically when reading a window you check `if Button is None` to determine if a window was closed. With NonBlocking windows, buttons will be None unless a button or a key was returned. The way you determine if a window was closed in a non-blocking window is to check **both** the button and the values are None. Since button is normally None, you only need to test for `value is None` in your code. -The proper code to check if the user has exited the form will be a polling-loop that looks something like this: +The proper code to check if the user has exited the window will be a polling-loop that looks something like this: while True: - button, values = form.ReadNonBlocking() + button, values = window.ReadNonBlocking() if values is None or button == 'Quit': break -We're going to build an app that does the latter. It's going to update our form with a running clock. +We're going to build an app that does the latter. It's going to update our window with a running clock. The basic flow and functions you will be calling are: Setup - form = Window() - form_rows = ..... - form.LayoutAndRead(form_rows, non_blocking=True) + window = Window() + window_rows = ..... + window.LayoutAndRead(window_rows, non_blocking=True) Periodic refresh - form.ReadNonBlocking() or form.Refresh() + window.ReadNonBlocking() or window.Refresh() -If you need to close the form +If you need to close the window - form.CloseNonBlockingForm() + window.CloseNonBlocking() -Rather than the usual `form.LayoutAndRead()` call, we're manually adding the rows (doing the layout) and then showing the form. After the form is shown, you simply call `form.ReadNonBlocking()` every now and then. +Rather than the usual `window.LayoutAndRead()` call, we're manually adding the rows (doing the layout) and then showing the window. After the window is shown, you simply call `window.ReadNonBlocking()` every now and then. -When you are ready to close the form (assuming the form wasn't closed by the user or a button click) you simply call `form.CloseNonBlockingForm()` +When you are ready to close the window (assuming the window wasn't closed by the user or a button click) you simply call `window.CloseNonBlocking()` **Example - Running timer that updates** -See the sample code on the GitHub named Demo Media Player for another example of Async Forms. We're going to make a form and update one of the elements of that form every .01 seconds. Here's the entire code to do that. +See the sample code on the GitHub named Demo Media Player for another example of Async windows. We're going to make a window and update one of the elements of that window every .01 seconds. Here's the entire code to do that. import PySimpleGUI as sg import time - # form that doesn't block - # Make a form, but don't use context manager - form = sg.Window('Running Timer', auto_size_text=True) + # window that doesn't block + # Make a window, but don't use context manager + window = sg.Window('Running Timer', auto_size_text=True) # Create the layout - form_rows = [[sg.Text('Non-blocking GUI with updates')], + window_rows = [[sg.Text('Non-blocking GUI with updates')], [sg.Text('', size=(8, 2), font=('Helvetica', 20), key='output') ], [sg.Button('Quit')]] - # Layout the rows of the form and perform a read. Indicate the form is non-blocking! - form.LayoutAndRead(form_rows, non_blocking=True) + # Layout the rows of the window and perform a read. Indicate the window is non-blocking! + window.LayoutAndRead(window_rows, non_blocking=True) # # Some place later in your code... - # You need to perform a ReadNonBlocking on your form every now and then or + # You need to perform a ReadNonBlocking on your window every now and then or # else it won't refresh # for i in range(1, 1000): - form.FindElement('output').Update('{:02d}:{:02d}.{:02d}'.format(*divmod(int(i / 100), 60), i % 100)) - button, values = form.ReadNonBlocking() + window.FindElement('output').Update('{:02d}:{:02d}.{:02d}'.format(*divmod(int(i / 100), 60), i % 100)) + button, values = window.ReadNonBlocking() if values is None or button == 'Quit': break time.sleep(.01) else: - form.CloseNonBlockingForm() + window.CloseNonBlocking() -What we have here is the same sequence of function calls as in the description. Get a form, add rows to it, show the form, and then refresh it every now and then. +What we have here is the same sequence of function calls as in the description. Get a window, add rows to it, show the window, and then refresh it every now and then. -The new thing in this example is the call use of the Update method for the Text Element. The first thing we do inside the loop is "update" the text element that we made earlier. This changes the value of the text field on the form. The new value will be displayed when `form.ReadNonBlocking()` is called. if you want to have the form reflect your changes immediately, call `form.Refresh()`. +The new thing in this example is the call use of the Update method for the Text Element. The first thing we do inside the loop is "update" the text element that we made earlier. This changes the value of the text field on the window. The new value will be displayed when `window.ReadNonBlocking()` is called. if you want to have the window reflect your changes immediately, call `window.Refresh()`. -Note the `else` statement on the for loop. This is needed because we're about to exit the loop while the form is still open. The user has not closed the form using the X nor a button so it's up to the caller to close the form using `CloseNonBlockingForm`. +Note the `else` statement on the for loop. This is needed because we're about to exit the loop while the window is still open. The user has not closed the window using the X nor a button so it's up to the caller to close the window using `CloseNonBlocking`. -## Updating Elements (changing elements in active form) +## Updating Elements (changing elements in active window) -Persistent forms remain open and thus continue to interact with the user after the Read has returned. Often the program wishes to communicate results (output information) or change an Element's values (such as populating a List Element). +Persistent windows remain open and thus continue to interact with the user after the Read has returned. Often the program wishes to communicate results (output information) or change an Element's values (such as populating a List Element). The way this is done is via an Update method that is available for nearly all of the Elements. Here is an example of a program that uses a persistent window that is updated. @@ -2235,7 +2236,7 @@ In some programs these updates happen in response to another Element. This prog - # Testing async form, see if can have a slider + # Testing async window, see if can have a slider # that adjusts the size of text displayed import PySimpleGUI as sg @@ -2246,10 +2247,10 @@ In some programs these updates happen in response to another Element. This prog sg.Text("Aa", size=(2, 1), font="Helvetica " + str(fontSize), key='text')]] sz = fontSize - form = sg.Window("Font size selector", grab_anywhere=False).Layout(layout) + window = sg.Window("Font size selector", grab_anywhere=False).Layout(layout) # Event Loop while True: - button, values= form.Read() + button, values= window.Read() if button is None: break sz_spin = int(values['spin']) @@ -2258,9 +2259,9 @@ In some programs these updates happen in response to another Element. This prog if sz != fontSize: fontSize = sz font = "Helvetica " + str(fontSize) - form.FindElement('text').Update(font=font) - form.FindElement('slider').Update(sz) - form.FindElement('spin').Update(sz) + window.FindElement('text').Update(font=font) + window.FindElement('slider').Update(sz) + window.FindElement('spin').Update(sz) print("Done.") @@ -2270,18 +2271,18 @@ For example, `values['slider']` is the value of the Slider Element. This program changes all 3 elements if either the Slider or the Spinner changes. This is done with these statements: - form.FindElement('text').Update(font=font) - form.FindElement('slider').Update(sz) - form.FindElement('spin').Update(sz) + window.FindElement('text').Update(font=font) + window.FindElement('slider').Update(sz) + window.FindElement('spin').Update(sz) -Remember this design pattern because you will use it OFTEN if you use persistent forms. +Remember this design pattern because you will use it OFTEN if you use persistent windows. -It works as follows. The call to `form.FindElement` returns the Element object represented by they provided `key`. This element is then updated by calling it's `Update` method. This is another example of Python's "chaining" feature. We could write this code using the long-form: +It works as follows. The call to `window.FindElement` returns the Element object represented by they provided `key`. This element is then updated by calling it's `Update` method. This is another example of Python's "chaining" feature. We could write this code using the long-form: - text_element = form.FindElement('text') + text_element = window.FindElement('text') text_element.Update(font=font) -The takeaway from this exercise is that keys are key in PySimpleGUI's design. They are used to both read the values of the form and also to identify elements. As already mentioned, they are used as targets in Button calls. +The takeaway from this exercise is that keys are key in PySimpleGUI's design. They are used to both read the values of the window and also to identify elements. As already mentioned, they are used as targets in Button calls. @@ -2303,16 +2304,16 @@ Key Sym is a string such as 'Control_L'. The Key Code is a numeric representati # Recipe for getting keys, one at a time as they are released # If want to use the space bar, then be sure and disable the "default focus" - with sg.Window("Keyboard Test", return_keyboard_events=True, use_default_focus=False) as form: + with sg.Window("Keyboard Test", return_keyboard_events=True, use_default_focus=False) as window: text_elem = sg.Text("", size=(18,1)) layout = [[sg.Text("Press a key or scroll mouse")], [text_elem], [sg.Button("OK")]] - form.Layout(layout) + window.Layout(layout) # ---===--- Loop taking in user input --- # while True: - button, value = form.ReadNonBlocking() + button, value = window.ReadNonBlocking() if button == "OK" or (button is None and value is None): print(button, "exiting") @@ -2327,14 +2328,14 @@ Use realtime keyboard capture by calling import PySimpleGUI as sg - with sg.Window("Realtime Keyboard Test", return_keyboard_events=True, use_default_focus=False) as form: + with sg.Window("Realtime Keyboard Test", return_keyboard_events=True, use_default_focus=False) as window: layout = [[sg.Text("Hold down a key")], [sg.Button("OK")]] - form.Layout(layout) + window.Layout(layout) while True: - button, value = form.ReadNonBlocking() + button, value = window.ReadNonBlocking() if button == "OK": print(button, value, "exiting") @@ -2346,7 +2347,7 @@ Use realtime keyboard capture by calling ## Menus -Beginning in version 3.01 you can add a menubar to your form/window. You specify the menus in much the same way as you do form layouts, with lists. Menu selections are returned as button clicks, so be aware of your overall naming conventions. If you have an Exit button and also an Exit menu option, then you won't be able to tell the difference when your form.Read returns. Hopefully will not be a problem. +Beginning in version 3.01 you can add a menubar to your window. You specify the menus in much the same way as you do window layouts, with lists. Menu selections are returned as button clicks, so be aware of your overall naming conventions. If you have an Exit button and also an Exit menu option, then you won't be able to tell the difference when your window.Read returns. Hopefully will not be a problem. This definition: @@ -2367,7 +2368,7 @@ They menu_def layout produced this window: This is a somewhat advanced topic... -Typically you perform Element updates in response to events from other Elements. An example is that when you click a button some text on the form changes to red. You can change the Element's attributes, or at least some of them, and the Element's value. +Typically you perform Element updates in response to events from other Elements. An example is that when you click a button some text on the window changes to red. You can change the Element's attributes, or at least some of them, and the Element's value. In some source code examples you will find an older techique for updating elements that did not involve keys. If you see a technique in the code that does not use keys, then know that there is a version using keys that is easier. @@ -2378,7 +2379,7 @@ We have an InputText field that we want to update. When the Element was created To update or change the value for that Input Element, we use this construct: - form.FindElement('input').Update('new text') + window.FindElement('input').Update('new text') Using the '.' makes the code shorter. The FindElement call returns an Element. We then call that Element's Update function. @@ -2401,22 +2402,22 @@ Use the example programs as a starting basis for your GUI. Copy, paste, modify | Source File| Description | |--|--| -|**Demo_All_Widgets.py**| Nearly all of the Elements shown in a single form +|**Demo_All_Widgets.py**| Nearly all of the Elements shown in a single window |**Demo_Borderless_Window.py**| Create clean looking windows with no border |**Demo_Button_States.py**| One way of implementing disabling of buttons |**Demo_Calendar.py** | Demo of the Calendar Chooser button -|**Demo_Canvas.py** | Form with a Canvas Element that is updated outside of the form +|**Demo_Canvas.py** | window with a Canvas Element that is updated outside of the window |**Demo_Chat.py** | A chat window with scrollable history |**Demo_Chatterbot.py** | Front-end to Chatterbot Machine Learning project |**Demo_Color.py** | How to interact with color using RGB hex values and named colors -|**Demo_Columns.py** | Using the Column Element to create more complex forms +|**Demo_Columns.py** | Using the Column Element to create more complex windows |**Demo_Compare_Files.py** | Using a simple GUI front-end to create a compare 2-files utility |**Demo_Cookbook_Browser.py** | Source code browser for all Recipes in Cookbook |**Demo_Dictionary.py** | Specifying and using return values in dictionary format -**Demo_DOC_Viewer_PIL.py** | Display a PDF, HTML, ebook file, etc in your form -|**Demo_DisplayHash1and256.py** | Using high level API and custom form to implement a simple display hash code utility +**Demo_DOC_Viewer_PIL.py** | Display a PDF, HTML, ebook file, etc in your window +|**Demo_DisplayHash1and256.py** | Using high level API and custom window to implement a simple display hash code utility |**Demo_DuplicateFileFinder.py** | High level API used to get a folder that is used by utility that finds duplicate files. Uses progress meter to show progress. 2 lines of code required to add GUI and meter -|**Demo_Fill_Form.py** | How to perform a bulk-fill for a form. Saving and loading a form from disk +|**Demo_Fill_Form.py** | How to perform a bulk-fill for a window. Saving and loading a window from disk |**Demo Font Sizer.py** | Demonstrates Elements updating other Elements |**Demo_Func_Callback_Simulator.py** | For the Raspberry Pi crowd. Event loop that simulates traditional GUI callback functions should you already have an architecture that uses them |**Demo_GoodColors.py** | Using some of the pre-defined PySimpleGUI individual colors @@ -2429,9 +2430,9 @@ Use the example programs as a starting basis for your GUI. Copy, paste, modify |**Demo_Matplotlib_Animated.py** | Animated Matplotlib line graph |**Demo_Matplotlib_Animated_Scatter.py** | Animated Matplotlib scatter graph |**Demo_Matplotlib_Browser.py** | Browse Matplotlib gallery -|**Demo_Media_Player.py** | Non-blocking form with a media player layout. Demonstrates button graphics, Update method +|**Demo_Media_Player.py** | Non-blocking window with a media player layout. Demonstrates button graphics, Update method |**Demo_MIDI_Player.py** | GUI wrapper for Mido MIDI package. Functional MIDI player that controls attached MIDI devices -|**Demo_NonBlocking_Form.py** | a basic async form +|**Demo_NonBlocking_Form.py** | a basic async window |**Demo_OpenCV.py** | Integrated with OpenCV |**Demo_Password_Login** | Password protection using SHA1 |**Demo_PDF_Viewer.py** | Submitted by a user! Previews PDF documents. Uses keyboard input & mouse scrollwheel to navigate @@ -2444,7 +2445,7 @@ Use the example programs as a starting basis for your GUI. Copy, paste, modify |**Demo_Script_Parameters.py** | Add a 1-line GUI to the front of your previously command-line only scripts |**Demo_Tabbed_Form.py** | Using the Tab feature |**Demo_Table_Simulation.py** | Use input fields to display and edit tables -|**Demo_Timer.py** | Simple non-blocking form +|**Demo_Timer.py** | Simple non-blocking window ## Packages Used In Demos @@ -2553,7 +2554,7 @@ While not an "issue" this is a ***stern warning*** **Progress Meters** - the visual graphic portion of the meter may be off. May return to the native tkinter progress meter solution in the future. Right now a "custom" progress meter is used. On the bright side, the statistics shown are extremely accurate and can tell you something about the performance of your code. If you are running 2 or more progress meters at the same time using `OneLineProgressMeter`, you need to close the meter by using the "Cancel" button rather than the X -**Async Forms** - these include the 'easy' forms (`OneLineProgressMeter` and EasyPrint/Print). If you start overlapping having Async forms open with normal forms then things get a littler squirrelly. Still tracking down the issues and am making it more solid every day possible. You'll know there's an issue when you see blank form. +**Async windows** - these include the 'easy' windows (`OneLineProgressMeter` and EasyPrint/Print). If you start overlapping having Async windows open with normal windows then things get a littler squirrelly. Still tracking down the issues and am making it more solid every day possible. You'll know there's an issue when you see blank window. **EasyPrint** - EasyPrint is a new feature that's pretty awesome. You print and the output goes to a window, with a scroll bar, that you can copy and paste from. Being a new feature, it's got some potential problems. There are known interaction problems with other GUI windows. For example, closing a Print window can also close other windows you have open. For now, don't close your debug print window until other windows are closed too. @@ -2681,9 +2682,6 @@ OneLineProgressMeter function added which gives you not only a one-line solution * Renamed FlexForm to Window * Removed LookAndFeel capability from Mac platform. -#### 3.6.1 -* Forgot Readme update in 3.6.0 - ### Upcoming Make suggestions people! Future release features