mlaga97
/
PySimpleGUI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #376 from MikeTheWatchGuy/Dev-latest 

Complete removal of old-style Tabs (ShowTabbedForm), updated readme w…
This commit is contained in:
MikeTheWatchGuy 2018-09-28 16:00:15 -04:00 committed by GitHub
parent b2e8c7b2a3 6cc8ed1ad1
commit 1d28165b24
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 141 additions and 137 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

106
PySimpleGUI.py
View File

@ -1121,10 +1121,7 @@ class Button(Element):
self.ParentForm.LastButtonClicked = self.ButtonText self.ParentForm.LastButtonClicked = self.ButtonText
self.ParentForm.FormRemainedOpen = False self.ParentForm.FormRemainedOpen = False
# if the form is tabbed, must collect all form's results and destroy all forms # if the form is tabbed, must collect all form's results and destroy all forms
if self.ParentForm.IsTabbedForm: self.ParentForm._Close()
self.ParentForm.UberParent._Close()
else:
self.ParentForm._Close()
self.ParentForm.TKroot.quit() self.ParentForm.TKroot.quit()
if self.ParentForm.NonBlocking: if self.ParentForm.NonBlocking:
self.ParentForm.TKroot.destroy() self.ParentForm.TKroot.destroy()
@ -1137,15 +1134,10 @@ class Button(Element):
else: else:
self.ParentForm.LastButtonClicked = self.ButtonText self.ParentForm.LastButtonClicked = self.ButtonText
self.ParentForm.FormRemainedOpen = True self.ParentForm.FormRemainedOpen = True
if self.ParentForm.IsTabbedForm:
self.ParentForm.UberParent.FormStayedOpen = True
self.ParentForm.TKroot.quit() # kick the users out of the mainloop self.ParentForm.TKroot.quit() # kick the users out of the mainloop
elif self.BType == BUTTON_TYPE_CLOSES_WIN_ONLY: # this is a return type button so GET RESULTS and destroy window elif self.BType == BUTTON_TYPE_CLOSES_WIN_ONLY: # this is a return type button so GET RESULTS and destroy window
# if the form is tabbed, must collect all form's results and destroy all forms # if the form is tabbed, must collect all form's results and destroy all forms
if self.ParentForm.IsTabbedForm: self.ParentForm._Close()
self.ParentForm.UberParent._Close()
else:
self.ParentForm._Close()
if self.ParentForm.NonBlocking: if self.ParentForm.NonBlocking:
self.ParentForm.TKroot.destroy() self.ParentForm.TKroot.destroy()
_my_windows.Decrement() _my_windows.Decrement()
@ -2053,7 +2045,7 @@ class Window:
''' '''
Display a user defined for and return the filled in data Display a user defined for and return the filled in data
''' '''
def __init__(self, title, default_element_size=DEFAULT_ELEMENT_SIZE, default_button_element_size = (None, None), auto_size_text=None, auto_size_buttons=None, location=(None, None), button_color=None, font=None, progress_bar_color=(None, None), background_color=None, is_tabbed_form=False, border_depth=None, auto_close=False, auto_close_duration=DEFAULT_AUTOCLOSE_TIME, icon=DEFAULT_WINDOW_ICON, force_toplevel = False, return_keyboard_events=False, use_default_focus=True, text_justification=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False): def __init__(self, title, default_element_size=DEFAULT_ELEMENT_SIZE, default_button_element_size = (None, None), auto_size_text=None, auto_size_buttons=None, location=(None, None), button_color=None, font=None, progress_bar_color=(None, None), background_color=None, border_depth=None, auto_close=False, auto_close_duration=DEFAULT_AUTOCLOSE_TIME, icon=DEFAULT_WINDOW_ICON, force_toplevel = False, return_keyboard_events=False, use_default_focus=True, text_justification=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False):
self.AutoSizeText = auto_size_text if auto_size_text is not None else DEFAULT_AUTOSIZE_TEXT self.AutoSizeText = auto_size_text if auto_size_text is not None else DEFAULT_AUTOSIZE_TEXT
self.AutoSizeButtons = auto_size_buttons if auto_size_buttons is not None else DEFAULT_AUTOSIZE_BUTTONS self.AutoSizeButtons = auto_size_buttons if auto_size_buttons is not None else DEFAULT_AUTOSIZE_BUTTONS
self.Title = title self.Title = title
@ -2063,7 +2055,6 @@ class Window:
self.Location = location self.Location = location
self.ButtonColor = button_color if button_color else DEFAULT_BUTTON_COLOR self.ButtonColor = button_color if button_color else DEFAULT_BUTTON_COLOR
self.BackgroundColor = background_color if background_color else DEFAULT_BACKGROUND_COLOR self.BackgroundColor = background_color if background_color else DEFAULT_BACKGROUND_COLOR
self.IsTabbedForm = is_tabbed_form
self.ParentWindow = None self.ParentWindow = None
self.Font = font if font else DEFAULT_FONT self.Font = font if font else DEFAULT_FONT
self.RadioDict = {} self.RadioDict = {}
@ -3405,17 +3396,14 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form):
tk_row_frame.pack(side=tk.TOP, anchor='nw', padx=DEFAULT_MARGINS[0], expand=True) tk_row_frame.pack(side=tk.TOP, anchor='nw', padx=DEFAULT_MARGINS[0], expand=True)
if form.BackgroundColor is not None and form.BackgroundColor != COLOR_SYSTEM_DEFAULT: if form.BackgroundColor is not None and form.BackgroundColor != COLOR_SYSTEM_DEFAULT:
tk_row_frame.configure(background=form.BackgroundColor) tk_row_frame.configure(background=form.BackgroundColor)
if not toplevel_form.IsTabbedForm: toplevel_form.TKroot.configure(padx=DEFAULT_MARGINS[0], pady=DEFAULT_MARGINS[1])
toplevel_form.TKroot.configure(padx=DEFAULT_MARGINS[0], pady=DEFAULT_MARGINS[1])
else: toplevel_form.ParentWindow.configure(padx=DEFAULT_MARGINS[0], pady=DEFAULT_MARGINS[1])
return return
def ConvertFlexToTK(MyFlexForm): def ConvertFlexToTK(MyFlexForm):
master = MyFlexForm.TKroot master = MyFlexForm.TKroot
# only set title on non-tabbed forms # only set title on non-tabbed forms
if not MyFlexForm.IsTabbedForm: master.title(MyFlexForm.Title)
master.title(MyFlexForm.Title)
InitializeResults(MyFlexForm) InitializeResults(MyFlexForm)
try: try:
if MyFlexForm.NoTitleBar: if MyFlexForm.NoTitleBar:
@ -3424,8 +3412,6 @@ def ConvertFlexToTK(MyFlexForm):
pass pass
PackFormIntoFrame(MyFlexForm, master, MyFlexForm) PackFormIntoFrame(MyFlexForm, master, MyFlexForm)
#....................................... DONE creating and laying out window ..........................# #....................................... DONE creating and laying out window ..........................#
if MyFlexForm.IsTabbedForm:
master = MyFlexForm.ParentWindow
screen_width = master.winfo_screenwidth() # get window info to move to middle of screen screen_width = master.winfo_screenwidth() # get window info to move to middle of screen
screen_height = master.winfo_screenheight() screen_height = master.winfo_screenheight()
if MyFlexForm.Location != (None, None): if MyFlexForm.Location != (None, None):
@ -3451,88 +3437,6 @@ def ConvertFlexToTK(MyFlexForm):
return return
# ----====----====----====----====----==== STARTUP TK ====----====----====----====----====----#
def ShowTabbedForm(title, *args, auto_close=False, auto_close_duration=DEFAULT_AUTOCLOSE_TIME, fav_icon=DEFAULT_WINDOW_ICON, no_titlebar=False):
# takes as input (form, rows, tab name) for each tab
global _my_windows
uber = UberForm()
root = tk.Tk()
uber.TKroot = root
if title is not None:
root.title(title)
try:
root.attributes('-alpha', 0) # hide window while building it. makes for smoother 'paint'
except:
pass
_my_windows.Increment()
if not len(args):
print('******************* SHOW TABBED FORMS ERROR .... no arguments')
return
if DEFAULT_BACKGROUND_COLOR:
framestyle = ttk.Style()
try:
framestyle.theme_create('framestyle', parent='alt',
settings={'TFrame':
{'configure':
{'background': DEFAULT_BACKGROUND_COLOR,
}}})
except: pass
# ATTENTION: this applies the new style 'combostyle' to all ttk.Combobox
# framestyle.theme_use('framestyle')
tab_control = ttk.Notebook(root)
for num,x in enumerate(args):
form, rows, tab_name = x
form.AddRows(rows)
form.UseDictionary = True
if DEFAULT_BACKGROUND_COLOR:
framestyle.theme_use('framestyle')
tab = ttk.Frame(tab_control) # Create tab 1
# s.configure("my.Frame.TFrame", background=DEFAULT_BACKGROUND_COLOR)
tab_control.add(tab, text=tab_name) # Add tab 1
# tab_control.configure(text='new text')
tab_control.grid(row=0, sticky=tk.W)
form.TKTabControl = tab_control
form.TKroot = tab
form.IsTabbedForm = True
form.ParentWindow = root
ConvertFlexToTK(form)
form.UberParent = uber
uber.AddForm(form)
uber.FormReturnValues.append(form.ReturnValues)
# dangerous?? or clever? use the final form as a callback for autoclose
id = root.after(auto_close_duration * 1000, form._AutoCloseAlarmCallback) if auto_close else 0
icon = fav_icon if not _my_windows.user_defined_icon else _my_windows.user_defined_icon
try: uber.TKroot.iconbitmap(icon)
except: pass
try:
if no_titlebar:
uber.TKroot.wm_overrideredirect(True)
except:
pass
try:
root.attributes('-alpha', 255) # hide window while building it. makes for smoother 'paint'
except:
pass
root.mainloop()
if uber.FormStayedOpen:
FormReturnValues = []
for form in uber.FormList:
BuildResults(form, False, form)
FormReturnValues.append(form.ReturnValues)
uber.FormReturnValues = FormReturnValues
# if self.LastKeyboardEvent is not None or self.LastButtonClicked is not None:
# return BuildResults(self, False, self)
if id: root.after_cancel(id)
uber.TKrootDestroyed = True
return uber.FormReturnValues
# ----====----====----====----====----==== STARTUP TK ====----====----====----====----====----# # ----====----====----====----====----==== STARTUP TK ====----====----====----====----====----#
def StartupTK(my_flex_form): def StartupTK(my_flex_form):

86
docs/index.md
View File

@ -4,9 +4,11 @@
![pysimplegui_logo](https://user-images.githubusercontent.com/13696193/43165867-fe02e3b2-8f62-11e8-9fd0-cc7c86b11772.png) ![pysimplegui_logo](https://user-images.githubusercontent.com/13696193/43165867-fe02e3b2-8f62-11e8-9fd0-cc7c86b11772.png)
[![Downloads](http://pepy.tech/badge/pysimplegui)](http://pepy.tech/project/pysimplegui) ![Documentation Status](https://readthedocs.org/projects/pysimplegui/badge/?version=latest) [![Downloads](http://pepy.tech/badge/pysimplegui)](http://pepy.tech/project/pysimplegui)
[![Downloads ](https://pepy.tech/badge/pysimplegui27)](https://pepy.tech/project/pysimplegui27)
![Documentation Status](https://readthedocs.org/projects/pysimplegui/badge/?version=latest)
![Awesome Meter](https://img.shields.io/badge/Awesome_meter-100-yellow.svg) ![Awesome Meter](https://img.shields.io/badge/Awesome_meter-100-yellow.svg)
![Python Version](https://img.shields.io/badge/Python-3-yellow.svg) ![Python Version](https://img.shields.io/badge/Python-2.7-yellow.svg) ![Python Version](https://img.shields.io/badge/Python-2.7_3.x-yellow.svg)
@ -18,7 +20,7 @@
## Now supports both Python 2.7 & 3 ## Now supports both Python 2.7 & 3
![Python Version](https://img.shields.io/badge/PySimpleGUI_For_Python_3_Version-3.8.2-red.svg?longCache=true&style=for-the-badge) ![Python Version](https://img.shields.io/badge/PySimpleGUI_For_Python_3_Version-3.8.3-red.svg?longCache=true&style=for-the-badge)
![Python Version](https://img.shields.io/badge/PySimpleGUI_For_Python_2.7_Version-1.0.4-blue.svg?longCache=true&style=for-the-badge) ![Python Version](https://img.shields.io/badge/PySimpleGUI_For_Python_2.7_Version-1.0.4-blue.svg?longCache=true&style=for-the-badge)
@ -37,7 +39,7 @@ Super-simple GUI to use... Powerfully customizable.
Home of the 1-line custom GUI and 1-line progress meter Home of the 1-line custom GUI and 1-line progress meter
#### Note regarding Python versions #### Note regarding Python versions
As of 9/25/2018 **both Python 3 and Python 2.7 are supported**! The Python 3 version is named PySimpleGUI. The Python 2.7 version is named PySimpleGUI27. They are installed separately and the imports are different. See instructions in Installation section for more info. As of 9/25/2018 **both Python 3 and Python 2.7 are supported**! The Python 3 version is named `PySimpleGUI`. The Python 2.7 version is `PySimpleGUI27`. They are installed separately and the imports are different. See instructions in Installation section for more info.
------------------------------------------------------------------------ ------------------------------------------------------------------------
@ -68,7 +70,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) ![get filename](https://user-images.githubusercontent.com/13696193/44960039-f1018880-aec5-11e8-8a43-3d7f8ff93b67.jpg)
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. 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, run within minutes. This is the process PySimpleGUI was designed to facilitate.
![borderless grayed buttons](https://user-images.githubusercontent.com/13696193/45168664-d848e980-b1c9-11e8-886e-63279ae4017f.jpg) ![borderless grayed buttons](https://user-images.githubusercontent.com/13696193/45168664-d848e980-b1c9-11e8-886e-63279ae4017f.jpg)
@ -1029,16 +1031,16 @@ This is the definition of the Window object:
button_color=None,Font=None, button_color=None,Font=None,
progress_bar_color=(None,None), progress_bar_color=(None,None),
background_color=None background_color=None
is_tabbed_form=False,
border_depth=None, border_depth=None,
auto_close=False, auto_close=False,
auto_close_duration=DEFAULT_AUTOCLOSE_TIME, auto_close_duration=DEFAULT_AUTOCLOSE_TIME,
icon=DEFAULT_WINDOW_ICON, icon=DEFAULT_WINDOW_ICON,
force_toplevel=False
return_keyboard_events=False, return_keyboard_events=False,
use_default_focus=True, use_default_focus=True,
text_justification=None, text_justification=None,
no_titlebar=False, no_titlebar=False,
grab_anywhere=True grab_anywhere=False
keep_on_top=False): keep_on_top=False):
@ -1053,11 +1055,11 @@ Parameter Descriptions. You will find these same parameters specified for each
button_color - Default color for buttons (foreground, background). Can be text or hex button_color - Default color for buttons (foreground, background). Can be text or hex
progress_bar_color - Foreground and background colors for progress bars progress_bar_color - Foreground and background colors for progress bars
background_color - Color of the window background background_color - Color of the window background
is_tabbed_form - Bool. If True then window is a tabbed window
border_depth - Amount of 'bezel' to put on input boxes, buttons, etc. border_depth - Amount of 'bezel' to put on input boxes, buttons, etc.
auto_close - Bool. If True window will autoclose auto_close - Bool. If True window will autoclose
auto_close_duration - Duration in seconds before window closes auto_close_duration - Duration in seconds before window closes
icon - .ICO file that will appear on the Task Bar and end of Title Bar icon - .ICO file that will appear on the Task Bar and end of Title Bar
force_top_level - Bool. If set causes a tk.Tk window to be used as primary window rather than tk.TopLevel. Used to get around Matplotlib problem
return_keyboard_events - if True key presses are returned as buttons 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 use_default_focus - if True and no focus set, then automatically set a focus
text_justification - Justification to use for Text Elements in this window text_justification - Justification to use for Text Elements in this window
@ -1102,6 +1104,24 @@ It is turned off for non-blocking because there is a warning message printed out
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. 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.
### Window Methods (things you can do with a Window object)
There are a few methods (functions) that you will see in this document that act on Windows. The ones you will primarily be calling are:
window.Layout(layout) - Turns your definition of the Window into Window
window.Finalize() - creates the tkinter objects for the Window. Normally you do not call this
window.Read() - Read the Windows values and get the button / key that caused the Read to return
window.ReadNonBlocking() - Same as Read but will return right away
window.Refresh() - Use if updating elements and want to show the updates prior to the nex Read
window.Fill(values_dict) - Fill each Element with entry from the dictionary passed in
window.SaveToDisk(filename) - Save the Window's values to disk
window.LoadFromDisk(filename) - Load the Window's values from disk
window.CloseNonBlocking() - When done, for good, reading a non-blocking window
window.Disable() - Use to disable the window inpurt when opening another window on top of the primnary Window
window.Enable() - Re-enable a Disabled window
window.FindElement(key) - Returns the element that has a matching key value
## Elements ## Elements
"Elements" are the building blocks used to create windows. 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.
@ -1130,6 +1150,7 @@ To keep a window on top of all other windows on the screen, set keep_on_top = Tr
Graph Graph
Image Image
Table Table
Tab, TabGroup
Async/Non-Blocking Windows Async/Non-Blocking Windows
Tabbed windows Tabbed windows
Persistent Windows Persistent Windows
@ -1269,7 +1290,7 @@ Output re-routes `Stdout` to a scrolled text box. It's used with Async windows.
do_not_clear=False, do_not_clear=False,
key=None, key=None,
focus=False focus=False
)
. .
default_text - Text initially shown in the input box default_text - Text initially shown in the input box
@ -1299,19 +1320,29 @@ Also known as a drop-down list. Only required parameter is the list of choices.
![combobox](https://user-images.githubusercontent.com/13696193/44959860-b565bf00-aec3-11e8-82fe-dbe41252458b.jpg) ![combobox](https://user-images.githubusercontent.com/13696193/44959860-b565bf00-aec3-11e8-82fe-dbe41252458b.jpg)
InputCombo(values, , InputCombo(values, ,
size=(None, None), default_value=None
auto_size_text=None, size=(None, None)
background_color = None, auto_size_text=None
text_color = None, background_color=None
key = None) text_color=None
change_submits=False
disabled=False
key=None
pad=None
tooltip=None
. .
values - Choices to be displayed. List of strings values - Choices to be displayed. List of strings
default_value - which value should be initially chosen
size - (width, height) of element in characters size - (width, height) of element in characters
auto_size_text - Bool. True if size should fit the text length auto_size_text - Bool. True if size should fit the text length
background_color - color to use for the input field background background_color - color to use for the input field background
text_color - color to use for the typed text text_color - color to use for the typed text
key = Dictionary key to use for return values change_submits - Bool. If set causes Read to immediately return if the selected value changes
disabled - Bool. If set will disable changes
key - Dictionary key to use for return values
pad - (x,y) Amount of padding to put around element in pixels
tooltip - Text string. If set, hovering over field will popup the text
#### Listbox Element #### Listbox Element
The standard listbox like you'll find in most GUIs. Note that the return values from this element will be a ***list of results, not a single result***. This is because the user can select more than 1 item from the list (if you set the right mode). The standard listbox like you'll find in most GUIs. Note that the return values from this element will be a ***list of results, not a single result***. This is because the user can select more than 1 item from the list (if you set the right mode).
@ -1382,6 +1413,7 @@ Sliders have a couple of slider-specific settings as well as appearance settings
size=(None, None), size=(None, None),
font=None, font=None,
background_color = None, background_color = None,
change_submits = False,
text_color = None, text_color = None,
key = None) ): key = None) ):
. .
@ -1401,6 +1433,7 @@ Sliders have a couple of slider-specific settings as well as appearance settings
auto_size_text - Bool. True if size should fit the text auto_size_text - Bool. True if size should fit the text
background_color - color to use for the input field background background_color - color to use for the input field background
text_color - color to use for the typed text text_color - color to use for the typed text
change_submits - causes window read to immediately return if the checkbox value changes
key = Dictionary key to use for return values key = Dictionary key to use for return values
#### Radio Button Element #### Radio Button Element
@ -1450,6 +1483,7 @@ Checkbox elements are like Radio Button elements. They return a bool indicating
font=None, font=None,
background_color = None, background_color = None,
text_color = None, text_color = None,
change_submits = False
key = None): key = None):
. .
@ -1460,6 +1494,7 @@ Checkbox elements are like Radio Button elements. They return a bool indicating
font- Font type and size for text display font- Font type and size for text display
background_color - color to use for the background background_color - color to use for the background
text_color - color to use for the typed text text_color - color to use for the typed text
change_submits - causes window read to immediately return if the checkbox value changes
key = Dictionary key to use for return values key = Dictionary key to use for return values
@ -1488,6 +1523,7 @@ An up/down spinner control. The valid values are passed in as a list.
font - Font type and size for text display font - Font type and size for text display
background_color - color to use for the background background_color - color to use for the background
text_color - color to use for the typed text text_color - color to use for the typed text
change_submits - causes window read to immediately return if the spinner value changes
key = Dictionary key to use for return values key = Dictionary key to use for return values
### Button Element ### Button Element
@ -2095,6 +2131,7 @@ The definition of a TabGroup is
font=None font=None
pad=None pad=None
border_width=None border_width=None
change_submits = False
key=None key=None
tooltip=None) tooltip=None)
@ -2107,6 +2144,7 @@ The definition of a Tab Element is
size=(None, None),font=None, size=(None, None),font=None,
pad=None pad=None
border_width=None border_width=None
change_submits=False
key=None key=None
tooltip=None) tooltip=None)
@ -2838,8 +2876,19 @@ It's official. There is a 2.7 version of PySimpleGUI!
* `DrawText` added to Graph Elements * `DrawText` added to Graph Elements
* Removed `Window.UpdateElements` * Removed `Window.UpdateElements`
* `Window.grab_anywere` defaults to False * `Window.grab_anywere` defaults to False
*
#### 3.8.3
* Listbox, Slider, Combobox, Checkbox, Spin, Tab Group - if change_submits is set, will return the Element's key rather than ''
* Added change_submits capability to Checkbox, Tab Group
* Combobox - Can set value to an Index into the Values table rather than the Value itself
* Warnings added to Drawing routines for Graph element (rather than crashing)
* Window - can "force top level" window to be used rather than a normal window. Means that instead of calling Tk to get a window, will call TopLevel to get the window
* Window Disable / Enable - Disables events (button clicks, etc) for a Window. Use this when you open a second window and want to disable the first window from doing anything. This will simulate a 'dialog box'
* Tab Group returns a value with Window is Read. Return value is the string of the selected tab
* Turned off grab_anywhere for Popups
* New parameter, default_extension, for PopupGetFile
* Keyboard shortcuts for menu items. Can hold ALT key to select items in men
* Removed old-style Tabs - Risky change because it hit fundamental window packing and creation. Will also break any old code using this style tab (sorry folks this is how progress happens)
### Upcoming ### Upcoming
@ -2902,8 +2951,9 @@ GNU Lesser General Public License (LGPL 3) +
* [Bryan Oakley](https://stackoverflow.com/users/7432/bryan-oakley) for the code that enables the `grab_anywhere` feature. * [Bryan Oakley](https://stackoverflow.com/users/7432/bryan-oakley) for the code that enables the `grab_anywhere` feature.
* [Otherion](https://github.com/Otherion) for help with Tables, being a sounding board for new features, naming functions, ..., all around great help * [Otherion](https://github.com/Otherion) for help with Tables, being a sounding board for new features, naming functions, ..., all around great help
* [agjunyent](https://github.com/agjunyent) figured out how to properly make tabs and wrote prototype code that demonstrated how to do it * [agjunyent](https://github.com/agjunyent) figured out how to properly make tabs and wrote prototype code that demonstrated how to do it
* [jfongattw](https://github.com/jfongattw) huge suggestion... dictionaries. turned out to be one of the most critical constructs in PySimpleGUI * [jfongattw](https://github.com/jfongattw) huge suggestion... dictionaries. turned out to be
* one of the most critical constructs in PySimpleGUI
* [venim](https://github.com/venim) code to doing Alt-Selections in menus, updating Combobox using index, request to disable windows (a really good idea), checkbox and tab submits on change, returning keys for elements that have change_submits set, ...
## How Do I ## How Do I

86
readme.md
View File

@ -4,9 +4,11 @@
![pysimplegui_logo](https://user-images.githubusercontent.com/13696193/43165867-fe02e3b2-8f62-11e8-9fd0-cc7c86b11772.png) ![pysimplegui_logo](https://user-images.githubusercontent.com/13696193/43165867-fe02e3b2-8f62-11e8-9fd0-cc7c86b11772.png)
[![Downloads](http://pepy.tech/badge/pysimplegui)](http://pepy.tech/project/pysimplegui) ![Documentation Status](https://readthedocs.org/projects/pysimplegui/badge/?version=latest) [![Downloads](http://pepy.tech/badge/pysimplegui)](http://pepy.tech/project/pysimplegui)
[![Downloads ](https://pepy.tech/badge/pysimplegui27)](https://pepy.tech/project/pysimplegui27)
![Documentation Status](https://readthedocs.org/projects/pysimplegui/badge/?version=latest)
![Awesome Meter](https://img.shields.io/badge/Awesome_meter-100-yellow.svg) ![Awesome Meter](https://img.shields.io/badge/Awesome_meter-100-yellow.svg)
![Python Version](https://img.shields.io/badge/Python-3-yellow.svg) ![Python Version](https://img.shields.io/badge/Python-2.7-yellow.svg) ![Python Version](https://img.shields.io/badge/Python-2.7_3.x-yellow.svg)
@ -18,7 +20,7 @@
## Now supports both Python 2.7 & 3 ## Now supports both Python 2.7 & 3
![Python Version](https://img.shields.io/badge/PySimpleGUI_For_Python_3_Version-3.8.2-red.svg?longCache=true&style=for-the-badge) ![Python Version](https://img.shields.io/badge/PySimpleGUI_For_Python_3_Version-3.8.3-red.svg?longCache=true&style=for-the-badge)
![Python Version](https://img.shields.io/badge/PySimpleGUI_For_Python_2.7_Version-1.0.4-blue.svg?longCache=true&style=for-the-badge) ![Python Version](https://img.shields.io/badge/PySimpleGUI_For_Python_2.7_Version-1.0.4-blue.svg?longCache=true&style=for-the-badge)
@ -37,7 +39,7 @@ Super-simple GUI to use... Powerfully customizable.
Home of the 1-line custom GUI and 1-line progress meter Home of the 1-line custom GUI and 1-line progress meter
#### Note regarding Python versions #### Note regarding Python versions
As of 9/25/2018 **both Python 3 and Python 2.7 are supported**! The Python 3 version is named PySimpleGUI. The Python 2.7 version is named PySimpleGUI27. They are installed separately and the imports are different. See instructions in Installation section for more info. As of 9/25/2018 **both Python 3 and Python 2.7 are supported**! The Python 3 version is named `PySimpleGUI`. The Python 2.7 version is `PySimpleGUI27`. They are installed separately and the imports are different. See instructions in Installation section for more info.
------------------------------------------------------------------------ ------------------------------------------------------------------------
@ -68,7 +70,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) ![get filename](https://user-images.githubusercontent.com/13696193/44960039-f1018880-aec5-11e8-8a43-3d7f8ff93b67.jpg)
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. 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, run within minutes. This is the process PySimpleGUI was designed to facilitate.
![borderless grayed buttons](https://user-images.githubusercontent.com/13696193/45168664-d848e980-b1c9-11e8-886e-63279ae4017f.jpg) ![borderless grayed buttons](https://user-images.githubusercontent.com/13696193/45168664-d848e980-b1c9-11e8-886e-63279ae4017f.jpg)
@ -1029,16 +1031,16 @@ This is the definition of the Window object:
button_color=None,Font=None, button_color=None,Font=None,
progress_bar_color=(None,None), progress_bar_color=(None,None),
background_color=None background_color=None
is_tabbed_form=False,
border_depth=None, border_depth=None,
auto_close=False, auto_close=False,
auto_close_duration=DEFAULT_AUTOCLOSE_TIME, auto_close_duration=DEFAULT_AUTOCLOSE_TIME,
icon=DEFAULT_WINDOW_ICON, icon=DEFAULT_WINDOW_ICON,
force_toplevel=False
return_keyboard_events=False, return_keyboard_events=False,
use_default_focus=True, use_default_focus=True,
text_justification=None, text_justification=None,
no_titlebar=False, no_titlebar=False,
grab_anywhere=True grab_anywhere=False
keep_on_top=False): keep_on_top=False):
@ -1053,11 +1055,11 @@ Parameter Descriptions. You will find these same parameters specified for each
button_color - Default color for buttons (foreground, background). Can be text or hex button_color - Default color for buttons (foreground, background). Can be text or hex
progress_bar_color - Foreground and background colors for progress bars progress_bar_color - Foreground and background colors for progress bars
background_color - Color of the window background background_color - Color of the window background
is_tabbed_form - Bool. If True then window is a tabbed window
border_depth - Amount of 'bezel' to put on input boxes, buttons, etc. border_depth - Amount of 'bezel' to put on input boxes, buttons, etc.
auto_close - Bool. If True window will autoclose auto_close - Bool. If True window will autoclose
auto_close_duration - Duration in seconds before window closes auto_close_duration - Duration in seconds before window closes
icon - .ICO file that will appear on the Task Bar and end of Title Bar icon - .ICO file that will appear on the Task Bar and end of Title Bar
force_top_level - Bool. If set causes a tk.Tk window to be used as primary window rather than tk.TopLevel. Used to get around Matplotlib problem
return_keyboard_events - if True key presses are returned as buttons 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 use_default_focus - if True and no focus set, then automatically set a focus
text_justification - Justification to use for Text Elements in this window text_justification - Justification to use for Text Elements in this window
@ -1102,6 +1104,24 @@ It is turned off for non-blocking because there is a warning message printed out
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. 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.
### Window Methods (things you can do with a Window object)
There are a few methods (functions) that you will see in this document that act on Windows. The ones you will primarily be calling are:
window.Layout(layout) - Turns your definition of the Window into Window
window.Finalize() - creates the tkinter objects for the Window. Normally you do not call this
window.Read() - Read the Windows values and get the button / key that caused the Read to return
window.ReadNonBlocking() - Same as Read but will return right away
window.Refresh() - Use if updating elements and want to show the updates prior to the nex Read
window.Fill(values_dict) - Fill each Element with entry from the dictionary passed in
window.SaveToDisk(filename) - Save the Window's values to disk
window.LoadFromDisk(filename) - Load the Window's values from disk
window.CloseNonBlocking() - When done, for good, reading a non-blocking window
window.Disable() - Use to disable the window inpurt when opening another window on top of the primnary Window
window.Enable() - Re-enable a Disabled window
window.FindElement(key) - Returns the element that has a matching key value
## Elements ## Elements
"Elements" are the building blocks used to create windows. 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.
@ -1130,6 +1150,7 @@ To keep a window on top of all other windows on the screen, set keep_on_top = Tr
Graph Graph
Image Image
Table Table
Tab, TabGroup
Async/Non-Blocking Windows Async/Non-Blocking Windows
Tabbed windows Tabbed windows
Persistent Windows Persistent Windows
@ -1269,7 +1290,7 @@ Output re-routes `Stdout` to a scrolled text box. It's used with Async windows.
do_not_clear=False, do_not_clear=False,
key=None, key=None,
focus=False focus=False
)
. .
default_text - Text initially shown in the input box default_text - Text initially shown in the input box
@ -1299,19 +1320,29 @@ Also known as a drop-down list. Only required parameter is the list of choices.
![combobox](https://user-images.githubusercontent.com/13696193/44959860-b565bf00-aec3-11e8-82fe-dbe41252458b.jpg) ![combobox](https://user-images.githubusercontent.com/13696193/44959860-b565bf00-aec3-11e8-82fe-dbe41252458b.jpg)
InputCombo(values, , InputCombo(values, ,
size=(None, None), default_value=None
auto_size_text=None, size=(None, None)
background_color = None, auto_size_text=None
text_color = None, background_color=None
key = None) text_color=None
change_submits=False
disabled=False
key=None
pad=None
tooltip=None
. .
values - Choices to be displayed. List of strings values - Choices to be displayed. List of strings
default_value - which value should be initially chosen
size - (width, height) of element in characters size - (width, height) of element in characters
auto_size_text - Bool. True if size should fit the text length auto_size_text - Bool. True if size should fit the text length
background_color - color to use for the input field background background_color - color to use for the input field background
text_color - color to use for the typed text text_color - color to use for the typed text
key = Dictionary key to use for return values change_submits - Bool. If set causes Read to immediately return if the selected value changes
disabled - Bool. If set will disable changes
key - Dictionary key to use for return values
pad - (x,y) Amount of padding to put around element in pixels
tooltip - Text string. If set, hovering over field will popup the text
#### Listbox Element #### Listbox Element
The standard listbox like you'll find in most GUIs. Note that the return values from this element will be a ***list of results, not a single result***. This is because the user can select more than 1 item from the list (if you set the right mode). The standard listbox like you'll find in most GUIs. Note that the return values from this element will be a ***list of results, not a single result***. This is because the user can select more than 1 item from the list (if you set the right mode).
@ -1382,6 +1413,7 @@ Sliders have a couple of slider-specific settings as well as appearance settings
size=(None, None), size=(None, None),
font=None, font=None,
background_color = None, background_color = None,
change_submits = False,
text_color = None, text_color = None,
key = None) ): key = None) ):
. .
@ -1401,6 +1433,7 @@ Sliders have a couple of slider-specific settings as well as appearance settings
auto_size_text - Bool. True if size should fit the text auto_size_text - Bool. True if size should fit the text
background_color - color to use for the input field background background_color - color to use for the input field background
text_color - color to use for the typed text text_color - color to use for the typed text
change_submits - causes window read to immediately return if the checkbox value changes
key = Dictionary key to use for return values key = Dictionary key to use for return values
#### Radio Button Element #### Radio Button Element
@ -1450,6 +1483,7 @@ Checkbox elements are like Radio Button elements. They return a bool indicating
font=None, font=None,
background_color = None, background_color = None,
text_color = None, text_color = None,
change_submits = False
key = None): key = None):
. .
@ -1460,6 +1494,7 @@ Checkbox elements are like Radio Button elements. They return a bool indicating
font- Font type and size for text display font- Font type and size for text display
background_color - color to use for the background background_color - color to use for the background
text_color - color to use for the typed text text_color - color to use for the typed text
change_submits - causes window read to immediately return if the checkbox value changes
key = Dictionary key to use for return values key = Dictionary key to use for return values
@ -1488,6 +1523,7 @@ An up/down spinner control. The valid values are passed in as a list.
font - Font type and size for text display font - Font type and size for text display
background_color - color to use for the background background_color - color to use for the background
text_color - color to use for the typed text text_color - color to use for the typed text
change_submits - causes window read to immediately return if the spinner value changes
key = Dictionary key to use for return values key = Dictionary key to use for return values
### Button Element ### Button Element
@ -2095,6 +2131,7 @@ The definition of a TabGroup is
font=None font=None
pad=None pad=None
border_width=None border_width=None
change_submits = False
key=None key=None
tooltip=None) tooltip=None)
@ -2107,6 +2144,7 @@ The definition of a Tab Element is
size=(None, None),font=None, size=(None, None),font=None,
pad=None pad=None
border_width=None border_width=None
change_submits=False
key=None key=None
tooltip=None) tooltip=None)
@ -2838,8 +2876,19 @@ It's official. There is a 2.7 version of PySimpleGUI!
* `DrawText` added to Graph Elements * `DrawText` added to Graph Elements
* Removed `Window.UpdateElements` * Removed `Window.UpdateElements`
* `Window.grab_anywere` defaults to False * `Window.grab_anywere` defaults to False
*
#### 3.8.3
* Listbox, Slider, Combobox, Checkbox, Spin, Tab Group - if change_submits is set, will return the Element's key rather than ''
* Added change_submits capability to Checkbox, Tab Group
* Combobox - Can set value to an Index into the Values table rather than the Value itself
* Warnings added to Drawing routines for Graph element (rather than crashing)
* Window - can "force top level" window to be used rather than a normal window. Means that instead of calling Tk to get a window, will call TopLevel to get the window
* Window Disable / Enable - Disables events (button clicks, etc) for a Window. Use this when you open a second window and want to disable the first window from doing anything. This will simulate a 'dialog box'
* Tab Group returns a value with Window is Read. Return value is the string of the selected tab
* Turned off grab_anywhere for Popups
* New parameter, default_extension, for PopupGetFile
* Keyboard shortcuts for menu items. Can hold ALT key to select items in men
* Removed old-style Tabs - Risky change because it hit fundamental window packing and creation. Will also break any old code using this style tab (sorry folks this is how progress happens)
### Upcoming ### Upcoming
@ -2902,8 +2951,9 @@ GNU Lesser General Public License (LGPL 3) +
* [Bryan Oakley](https://stackoverflow.com/users/7432/bryan-oakley) for the code that enables the `grab_anywhere` feature. * [Bryan Oakley](https://stackoverflow.com/users/7432/bryan-oakley) for the code that enables the `grab_anywhere` feature.
* [Otherion](https://github.com/Otherion) for help with Tables, being a sounding board for new features, naming functions, ..., all around great help * [Otherion](https://github.com/Otherion) for help with Tables, being a sounding board for new features, naming functions, ..., all around great help
* [agjunyent](https://github.com/agjunyent) figured out how to properly make tabs and wrote prototype code that demonstrated how to do it * [agjunyent](https://github.com/agjunyent) figured out how to properly make tabs and wrote prototype code that demonstrated how to do it
* [jfongattw](https://github.com/jfongattw) huge suggestion... dictionaries. turned out to be one of the most critical constructs in PySimpleGUI * [jfongattw](https://github.com/jfongattw) huge suggestion... dictionaries. turned out to be
* one of the most critical constructs in PySimpleGUI
* [venim](https://github.com/venim) code to doing Alt-Selections in menus, updating Combobox using index, request to disable windows (a really good idea), checkbox and tab submits on change, returning keys for elements that have change_submits set, ...
## How Do I ## How Do I