From 32df7cf264a82426dcadba85ff123b0e1e51f6e9 Mon Sep 17 00:00:00 2001 From: MikeTheWatchGuy <13696193+MikeTheWatchGuy@users.noreply.github.com> Date: Mon, 17 Jun 2019 12:46:17 -0400 Subject: [PATCH 1/3] Revert "Release 4.0" --- PySimpleGUI.py | 3643 ++++++++++++++---------------------------------- 1 file changed, 1043 insertions(+), 2600 deletions(-) diff --git a/PySimpleGUI.py b/PySimpleGUI.py index 8a36a33e..a2264e3f 100644 --- a/PySimpleGUI.py +++ b/PySimpleGUI.py @@ -42,14 +42,12 @@ g_time_delta = 0 def TimerStart(): - """ """ global g_time_start g_time_start = time.time() def TimerStop(): - """ """ global g_time_delta, g_time_end g_time_end = time.time() @@ -245,7 +243,7 @@ BUTTON_TYPE_COLOR_CHOOSER = 40 BUTTON_TYPE_SHOW_DEBUGGER = 50 # ------------------------- Element types ------------------------- # - +# class ElementType(Enum): ELEM_TYPE_TEXT = 'text' ELEM_TYPE_INPUT_TEXT = 'input' ELEM_TYPE_INPUT_COMBO = 'combo' @@ -292,17 +290,12 @@ POPUP_BUTTONS_NO_BUTTONS = 5 # ------------------------------------------------------------------------- # class ToolTip: - """Create a tooltip for a given widget + """ Create a tooltip for a given widget + (inspired by https://stackoverflow.com/a/36221216) """ + def __init__(self, widget, text, timeout=DEFAULT_TOOLTIP_TIME): - """ - - :param widget: - :param text: - :param timeout: (Default value = DEFAULT_TOOLTIP_TIME) - - """ self.widget = widget self.text = text self.timeout = timeout @@ -315,37 +308,24 @@ class ToolTip: self.widget.bind("", self.leave) def enter(self, event=None): - """ - - :param event: (Default value = None) - - """ self.x = event.x self.y = event.y self.schedule() def leave(self, event=None): - """ - - :param event: (Default value = None) - - """ self.unschedule() self.hidetip() def schedule(self): - """ """ self.unschedule() self.id = self.widget.after(self.timeout, self.showtip) def unschedule(self): - """ """ if self.id: self.widget.after_cancel(self.id) self.id = None def showtip(self): - """ """ if self.tipwindow: return x = self.widget.winfo_rootx() + self.x + DEFAULT_TOOLTIP_OFFSET[0] @@ -360,7 +340,6 @@ class ToolTip: label.pack() def hidetip(self): - """ """ if self.tipwindow: self.tipwindow.destroy() self.tipwindow = None @@ -377,26 +356,24 @@ class ToolTip: # Element CLASS # # ------------------------------------------------------------------------- # class Element(): - """The base class for all Elements. + ''' + The base class for all Elements. Holds the basic description of an Element like size and colors - - - """ + ''' def __init__(self, type, size=(None, None), auto_size_text=None, font=None, background_color=None, text_color=None, key=None, pad=None, tooltip=None, visible=True): - """ - - :param type: - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_text: True if size should fit the text length (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: element's text color (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ + ''' + Element + :param type: + :param size: + :param auto_size_text: + :param font: + :param background_color: + :param text_color: + :param key: + :param pad: + :param tooltip: + :param visible: + ''' self.Size = size self.Type = type self.AutoSizeText = auto_size_text @@ -423,20 +400,10 @@ class Element(): self.Widget = None # Set when creating window. Has the main tkinter widget for element def _RightClickMenuCallback(self, event): - """ - - :param event: - - """ self.TKRightClickMenu.tk_popup(event.x_root, event.y_root, 0) self.TKRightClickMenu.grab_release() def _MenuItemChosenCallback(self, item_chosen): # TEXT Menu item callback - """ - - :param item_chosen: - - """ # print('IN MENU ITEM CALLBACK', item_chosen) self.MenuItemChosen = item_chosen.replace('&', '') self.ParentForm.LastButtonClicked = self.MenuItemChosen @@ -445,11 +412,6 @@ class Element(): self.ParentForm.TKroot.quit() # kick the users out of the mainloop def _FindReturnKeyBoundButton(self, form): - """ - - :param form: - - """ for row in form.Rows: for element in row: if element.Type == ELEM_TYPE_BUTTON: @@ -478,11 +440,6 @@ class Element(): return None def _TextClickedHandler(self, event): - """ - - :param event: - - """ if self.Key is not None: self.ParentForm.LastButtonClicked = self.Key else: @@ -492,22 +449,12 @@ class Element(): self.ParentForm.TKroot.quit() # kick the users out of the mainloop def _ReturnKeyHandler(self, event): - """ - - :param event: - - """ MyForm = self.ParentForm button_element = self._FindReturnKeyBoundButton(MyForm) if button_element is not None: button_element.ButtonCallBack() def _ListboxSelectHandler(self, event): - """ - - :param event: - - """ # first, get the results table built # modify the Results table in the parent FlexForm object if self.Key is not None: @@ -519,11 +466,6 @@ class Element(): self.ParentForm.TKroot.quit() # kick the users out of the mainloop def _ComboboxSelectHandler(self, event): - """ - - :param event: - - """ # first, get the results table built # modify the Results table in the parent FlexForm object if self.Key is not None: @@ -535,7 +477,6 @@ class Element(): self.ParentForm.TKroot.quit() # kick the users out of the mainloop def _RadioHandler(self): - """ """ if self.Key is not None: self.ParentForm.LastButtonClicked = self.Key else: @@ -545,7 +486,6 @@ class Element(): self.ParentForm.TKroot.quit() def _CheckboxHandler(self): - """ """ if self.Key is not None: self.ParentForm.LastButtonClicked = self.Key else: @@ -555,11 +495,6 @@ class Element(): self.ParentForm.TKroot.quit() def _TabGroupSelectHandler(self, event): - """ - - :param event: - - """ if self.Key is not None: self.ParentForm.LastButtonClicked = self.Key else: @@ -569,11 +504,6 @@ class Element(): self.ParentForm.TKroot.quit() def _KeyboardHandler(self, event): - """ - - :param event: - - """ if self.Key is not None: self.ParentForm.LastButtonClicked = self.Key else: @@ -583,11 +513,6 @@ class Element(): self.ParentForm.TKroot.quit() def _ClickHandler(self, event): - """ - - :param event: - - """ if self.Key is not None: self.ParentForm.LastButtonClicked = self.Key else: @@ -597,15 +522,9 @@ class Element(): self.ParentForm.TKroot.quit() def SetTooltip(self, tooltip_text): - """ - - :param tooltip_text: - - """ self.TooltipObject = ToolTip(self.Widget, text=tooltip_text, timeout=DEFAULT_TOOLTIP_TIME) def __del__(self): - """ """ try: self.TKStringVar.__del__() except: @@ -628,31 +547,33 @@ class Element(): # Input Class # # ---------------------------------------------------------------------- # class InputText(Element): - """Shows a single line of input.""" + ''' + Shows a single line of input. + ''' def __init__(self, default_text='', size=(None, None), disabled=False, password_char='', - justification=None, background_color=None, text_color=None, font=None, tooltip=None, + justification=None, background_color=None, text_color=None, font=None, tooltip=None, change_submits=False, enable_events=False, do_not_clear=True, key=None, focus=False, pad=None, right_click_menu=None, visible=True): - """ - - :param default_text: (Default value = '') - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param disabled: set disable state for element (Default value = False) - :param password_char: Passwork character if this is a password field (Default value = '') - :param justification: justification for data display (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param change_submits: If True, pressing Enter key submits window- DEPRICATED DO NOT USE! (Default value = False) - :param enable_events: Turns on the element specific events. Use this instead of change_submits (Default value = False) - :param do_not_clear: see docx (Default value = True) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param right_click_menu: see "Right Click Menus" (Default value = None) - :param visible: set visibility state of the element (Default value = True) - """ + ''' + InputText Element - A single line of input + :param default_text: + :param size: + :param disabled: + :param password_char: + :param justification: + :param background_color: + :param text_color: + :param font: + :param tooltip: + :param change_submits: - DEPRICATED DO NOT USE! + :param enable_events: - Use this instead of change_submits + :param do_not_clear: + :param key: + :param focus: + :param pad: + :param right_click_menu: + :param visible: + ''' self.DefaultText = default_text self.PasswordCharacter = password_char bg = background_color if background_color is not None else DEFAULT_INPUT_ELEMENTS_COLOR @@ -668,15 +589,15 @@ class InputText(Element): font=font, tooltip=tooltip, visible=visible) def Update(self, value=None, disabled=None, select=None, visible=None): - """ - - :param value: (Default value = None) - :param disabled: disable or enable state of the element (Default value = None) - :param select: (Default value = None) - :param visible: change visibility of element (Default value = None) - - """ - #NOTE - Read or Finalize must be called on Window prior to Update call + ''' + InputText Element Update + NOTE - Read or Finalize must be called on Window prior to Update call + :param value: + :param disabled: + :param select: + :param visible: + :return: None + ''' if disabled is True: self.TKEntry['state'] = 'readonly' elif disabled is False: @@ -695,7 +616,6 @@ class InputText(Element): self.TKEntry.pack() def Get(self): - """ """ try: text = self.TKStringVar.get() except: @@ -703,14 +623,12 @@ class InputText(Element): return text def SetFocus(self): - """ """ try: self.TKEntry.focus_set() except: pass def __del__(self): - """ """ super().__del__() @@ -724,29 +642,30 @@ I = InputText # Combo # # ---------------------------------------------------------------------- # class Combo(Element): - """ComboBox Element""" + ''' + ComboBox Element + ''' def __init__(self, values, default_value=None, size=(None, None), auto_size_text=None, background_color=None, text_color=None, change_submits=False, enable_events=False, disabled=False, key=None, pad=None, tooltip=None, readonly=False, font=None, visible=True): - """Combo Element - Combo Box, Drop Down Menu, ... - - :param values: - :param default_value: (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_text: True if size should fit the text length (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param change_submits: If True, pressing Enter key submits window (Default value = False) - :param enable_events: Turns on the element specific events.(Default value = False) - :param disabled: set disable state for element (Default value = False) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param readonly: make element readonly (Default value = False) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ + ''' + Combo Element - Combo Box, Drop Down Menu, ... + :param values: + :param default_value: + :param size: + :param auto_size_text: + :param background_color: + :param text_color: + :param change_submits: + :param enable_events: + :param disabled: + :param key: + :param pad: + :param tooltip: + :param readonly: + :param font: + :param visible: + ''' self.Values = values self.DefaultValue = default_value self.ChangeSubmits = change_submits or enable_events @@ -761,16 +680,18 @@ class Combo(Element): text_color=fg, key=key, pad=pad, tooltip=tooltip, font=font or DEFAULT_FONT, visible=visible) def Update(self, value=None, values=None, set_to_index=None, disabled=None, readonly=None, font=None, visible=None): - """ - :param value: (Default value = None) - :param values: (Default value = None) - :param set_to_index: (Default value = None) - :param disabled: disable or enable state of the element (Default value = None) - :param readonly: make element readonly (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param visible: change visibility of element (Default value = None) - - """ + ''' + Update for Combo Element + Also known as: InputCombo, DropDown, Drop + :param value: + :param values: + :param set_to_index: + :param disabled: + :param readonly: + :param font: + :param visible: + :return: None + ''' if values is not None: try: self.TKCombo['values'] = values @@ -809,7 +730,6 @@ class Combo(Element): self.TKCombo.pack() def __del__(self): - """ """ try: self.TKCombo.__del__() except: @@ -827,30 +747,29 @@ Drop = InputCombo # Option Menu # # ---------------------------------------------------------------------- # class OptionMenu(Element): - """Option Menu is an Element available ONLY on the tkinter port of PySimpleGUI. It's is a widget that is unique + ''' + Option Menu is an Element available ONLY on the tkinter port of PySimpleGUI. It's is a widget that is unique to tkinter. However, it looks much like a ComboBox. Instead of an arrow to click to pull down the list of choices, another little graphic is shown on the widget to indicate where you click. After clicking to activate, it looks like a Combo Box that you scroll to select a choice. - - - """ + ''' def __init__(self, values, default_value=None, size=(None, None), disabled=False, auto_size_text=None, background_color=None, text_color=None, key=None, pad=None, tooltip=None, visible=True): - """Option Menu Element - - :param values: - :param default_value: (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param disabled: set disable state for element (Default value = False) - :param auto_size_text: True if size should fit the text length (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ + ''' + Option Menu Element + Also known as: InputOptionMenu + :param values: + :param default_value: + :param size: + :param disabled: + :param auto_size_text: + :param background_color: + :param text_color: + :param key: + :param pad: + :param tooltip: + :param visible: + ''' self.Values = values self.DefaultValue = default_value self.TKOptionMenu = None # type: tk.OptionMenu @@ -862,14 +781,14 @@ class OptionMenu(Element): text_color=fg, key=key, pad=pad, tooltip=tooltip, visible=visible) def Update(self, value=None, values=None, disabled=None, visible=None): - """OptionMenu Element Update - - :param value: (Default value = None) - :param values: (Default value = None) - :param disabled: disable or enable state of the element (Default value = None) - :param visible: change visibility of element (Default value = None) - - """ + ''' + OptionMenu Element Update + :param value: + :param values: + :param disabled: + :param visible: + :return: None + ''' if values is not None: self.Values = values self.TKOptionMenu['menu'].delete(0, 'end') @@ -898,7 +817,6 @@ class OptionMenu(Element): self.TKOptionMenu.pack() def __del__(self): - """ """ try: self.TKOptionMenu.__del__() except: @@ -914,36 +832,34 @@ InputOptionMenu = OptionMenu # Listbox # # ---------------------------------------------------------------------- # class Listbox(Element): - """A List Box. Provide a list of values for the user to choose one or more of. Returns a list of selected rows + ''' + A List Box. Provide a list of values for the user to choose one or more of. Returns a list of selected rows when a window.Read() is executed. - - - """ + ''' def __init__(self, values, default_values=None, select_mode=None, change_submits=False, enable_events=False, bind_return_key=False, size=(None, None), disabled=False, auto_size_text=None, font=None, background_color=None, text_color=None, key=None, pad=None, tooltip=None, right_click_menu=None, visible=True): - """Listbox Element - - :param values: - :param default_values: (Default value = None) - :param select_mode: (Default value = None) - :param change_submits: If True, pressing Enter key submits window (Default value = False) - :param enable_events: Turns on the element specific events.(Default value = False) - :param bind_return_key: (Default value = False) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param disabled: set disable state for element (Default value = False) - :param auto_size_text: True if size should fit the text length (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param right_click_menu: see "Right Click Menus" (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ + ''' + Listbox Element + :param values: + :param default_values: + :param select_mode: + :param change_submits: + :param enable_events: + :param bind_return_key: + :param size: + :param disabled: + :param auto_size_text: + :param font: + :param background_color: + :param text_color: + :param key: + :param pad: + :param tooltip: + :param right_click_menu: + :param visible: + ''' self.Values = values self.DefaultValues = default_values self.TKListbox = None @@ -969,15 +885,14 @@ class Listbox(Element): background_color=bg, text_color=fg, key=key, pad=pad, tooltip=tooltip, visible=visible) def Update(self, values=None, disabled=None, set_to_index=None, visible=None): - """ + ''' - :param values: (Default value = None) - :param disabled: disable or enable state of the element (Default value = None) - :param set_to_index: (Default value = None) - :param visible: change visibility of element (Default value = None) - - """ - + :param values: + :param disabled: + :param set_to_index: + :param visible: + :return: None + ''' if disabled == True: self.TKListbox.configure(state='disabled') elif disabled == False: @@ -1002,11 +917,6 @@ class Listbox(Element): self.vsb.pack() def SetValue(self, values): - """ - - :param values: - - """ for index, item in enumerate(self.Values): try: if item in values: @@ -1018,18 +928,15 @@ class Listbox(Element): self.DefaultValues = values def GetListValues(self): - """ """ return self.Values def SetFocus(self): - """ """ try: self.TKListbox.focus_set() except: pass def __del__(self): - """ """ try: self.TKListBox.__del__() except: @@ -1041,34 +948,31 @@ class Listbox(Element): # Radio # # ---------------------------------------------------------------------- # class Radio(Element): - """Radio Button Element - Used in a group of other Radio Elements to provide user with ability to select only + ''' + Radio Button Element - Used in a group of other Radio Elements to provide user with ability to select only 1 choice in a list of choices. - - - """ + ''' def __init__(self, text, group_id, default=False, disabled=False, size=(None, None), auto_size_text=None, background_color=None, text_color=None, font=None, key=None, pad=None, tooltip=None, change_submits=False, enable_events=False, visible=True): - """ + ''' - :param text: - :param group_id: - :param default: (Default value = False) - :param disabled: set disable state for element (Default value = False) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_text: True if size should fit the text length (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param change_submits: If True, pressing Enter key submits window (Default value = False) - :param enable_events: Turns on the element specific events.(Default value = False) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param text: + :param group_id: + :param default: + :param disabled: + :param size: + :param auto_size_text: + :param background_color: + :param text_color: + :param font: + :param key: + :param pad: + :param tooltip: + :param change_submits: + :param enable_events: + :param visible: + ''' self.InitialState = default self.Text = text self.TKRadio = None @@ -1083,14 +987,13 @@ class Radio(Element): tooltip=tooltip, visible=visible) def Update(self, value=None, disabled=None, visible=None): - """ + ''' - :param value: (Default value = None) - :param disabled: disable or enable state of the element (Default value = None) - :param visible: change visibility of element (Default value = None) - - """ - + :param value: + :param disabled: + :param visible: + :return: + ''' if value is not None: try: self.TKIntVar.set(self.EncodedRadioValue) @@ -1107,11 +1010,9 @@ class Radio(Element): self.TKRadio.pack() def ResetGroup(self): - """ """ self.TKIntVar.set(0) def __del__(self): - """ """ try: self.TKRadio.__del__() except: @@ -1127,30 +1028,29 @@ class Radio(Element): # Doc strings # Note - The renaming of the member function to have _ if internal only has NOT yet been done! class Checkbox(Element): - """ """ - + ''' + + ''' def __init__(self, text, default=False, size=(None, None), auto_size_text=None, font=None, background_color=None, text_color=None, change_submits=False, enable_events=False, disabled=False, key=None, pad=None, tooltip=None, visible=True): - """ + ''' - :param text: - :param default: (Default value = False) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_text: True if size should fit the text length (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param change_submits: If True, pressing Enter key submits window (Default value = False) - :param enable_events: Turns on the element specific events.(Default value = False) - :param disabled: set disable state for element (Default value = False) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param text: + :param default: + :param size: + :param auto_size_text: + :param font: + :param background_color: + :param text_color: + :param change_submits: + :param enable_events: + :param disabled: + :param key: + :param pad: + :param tooltip: + :param visible: + ''' self.Text = text self.InitialState = default self.Value = None @@ -1164,18 +1064,16 @@ class Checkbox(Element): tooltip=tooltip, visible=visible) def Get(self): - """ """ return self.TKIntVar.get() def Update(self, value=None, disabled=None, visible=None): - """ + ''' - :param value: (Default value = None) - :param disabled: disable or enable state of the element (Default value = None) - :param visible: change visibility of element (Default value = None) - - """ - + :param value: + :param disabled: + :param visible: + :return: + ''' if value is not None: try: self.TKIntVar.set(value) @@ -1192,7 +1090,6 @@ class Checkbox(Element): self.TKCheckbutton.pack() def __del__(self): - """ """ super().__del__() @@ -1207,30 +1104,29 @@ Check = Checkbox # ---------------------------------------------------------------------- # class Spin(Element): - """ """ - + ''' + + ''' def __init__(self, values, initial_value=None, disabled=False, change_submits=False, enable_events=False, size=(None, None), auto_size_text=None, font=None, background_color=None, text_color=None, key=None, pad=None, tooltip=None, visible=True): - """ + ''' - :param values: - :param initial_value: (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param change_submits: If True, pressing Enter key submits window (Default value = False) - :param enable_events: Turns on the element specific events.(Default value = False) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_text: True if size should fit the text length (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param values: + :param initial_value: + :param disabled: + :param change_submits: + :param enable_events: + :param size: + :param auto_size_text: + :param font: + :param background_color: + :param text_color: + :param key: + :param pad: + :param tooltip: + :param visible: + ''' self.Values = values self.DefaultValue = initial_value self.ChangeSubmits = change_submits or enable_events @@ -1244,15 +1140,14 @@ class Spin(Element): return def Update(self, value=None, values=None, disabled=None, visible=None): - """ + ''' - :param value: (Default value = None) - :param values: (Default value = None) - :param disabled: disable or enable state of the element (Default value = None) - :param visible: change visibility of element (Default value = None) - - """ - + :param value: + :param values: + :param disabled: + :param visible: + :return: + ''' if values != None: old_value = self.TKStringVar.get() self.Values = values @@ -1274,11 +1169,6 @@ class Spin(Element): self.TKSpinBox.pack() def SpinChangedHandler(self, event): - """ - - :param event: - - """ # first, get the results table built # modify the Results table in the parent FlexForm object if self.Key is not None: @@ -1290,11 +1180,9 @@ class Spin(Element): self.ParentForm.TKroot.quit() # kick the users out of the mainloop def Get(self): - """ """ return self.TKStringVar.get() def __del__(self): - """ """ try: self.TKSpinBox.__del__() except: @@ -1306,36 +1194,35 @@ class Spin(Element): # Multiline # # ---------------------------------------------------------------------- # class Multiline(Element): - """ """ - + ''' + + ''' def __init__(self, default_text='', enter_submits=False, disabled=False, autoscroll=False, border_width=None, size=(None, None), auto_size_text=None, background_color=None, text_color=None, change_submits=False, enable_events=False, do_not_clear=True, key=None, focus=False, font=None, pad=None, tooltip=None, right_click_menu=None, visible=True): - """ + ''' - :param default_text: (Default value = '') - :param enter_submits: (Default value = False) - :param disabled: set disable state for element (Default value = False) - :param autoscroll: (Default value = False) - :param border_width: (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_text: True if size should fit the text length (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param change_submits: If True, pressing Enter key submits window (Default value = False) - :param enable_events: Turns on the element specific events.(Default value = False) - :param do_not_clear: see docx (Default value = True) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param focus: if focus should be set to this (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param right_click_menu: see "Right Click Menus" (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param default_text: + :param enter_submits: + :param disabled: + :param autoscroll: + :param border_width: + :param size: + :param auto_size_text: + :param background_color: + :param text_color: + :param change_submits: + :param enable_events: + :param do_not_clear: + :param key: + :param focus: + :param font: + :param pad: + :param tooltip: + :param right_click_menu: + :param visible: + ''' self.DefaultText = default_text self.EnterSubmits = enter_submits @@ -1355,19 +1242,18 @@ class Multiline(Element): def Update(self, value=None, disabled=None, append=False, font=None, text_color=None, background_color=None, visible=None, autoscroll=None): - """ + ''' - :param value: (Default value = None) - :param disabled: disable or enable state of the element (Default value = None) - :param append: (Default value = False) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param text_color: color of the text (Default value = None) - :param background_color: color of background (Default value = None) - :param visible: change visibility of element (Default value = None) - :param autoscroll: (Default value = None) - - """ - + :param value: + :param disabled: + :param append: + :param font: + :param text_color: + :param background_color: + :param visible: + :param autoscroll: + :return: + ''' if autoscroll is not None: self.Autoscroll = autoscroll if value is not None: @@ -1400,18 +1286,15 @@ class Multiline(Element): self.TKText.pack() def Get(self): - """ """ return self.TKText.get(1.0, tk.END) def SetFocus(self): - """ """ try: self.TKText.focus_set() except: pass def __del__(self): - """ """ super().__del__() @@ -1419,31 +1302,30 @@ class Multiline(Element): # Text # # ---------------------------------------------------------------------- # class Text(Element): - """ """ - + ''' + + ''' def __init__(self, text, size=(None, None), auto_size_text=None, click_submits=False, enable_events=False, relief=None, font=None, text_color=None, background_color=None, justification=None, pad=None, key=None, right_click_menu=None, tooltip=None, visible=True): - """ + ''' - :param text: - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_text: True if size should fit the text length (Default value = None) - :param click_submits: (Default value = False) - :param enable_events: Turns on the element specific events.(Default value = False) - :param relief: (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param text_color: color of the text (Default value = None) - :param background_color: color of background (Default value = None) - :param justification: justification for data display (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param right_click_menu: see "Right Click Menus" (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param text: + :param size: + :param auto_size_text: + :param click_submits: + :param enable_events: + :param relief: + :param font: + :param text_color: + :param background_color: + :param justification: + :param pad: + :param key: + :param right_click_menu: + :param tooltip: + :param visible: + ''' self.DisplayText = str(text) self.TextColor = text_color if text_color else DEFAULT_TEXT_COLOR self.Justification = justification @@ -1461,16 +1343,15 @@ class Text(Element): return def Update(self, value=None, background_color=None, text_color=None, font=None, visible=None): - """ + ''' - :param value: (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param visible: change visibility of element (Default value = None) - - """ - + :param value: + :param background_color: + :param text_color: + :param font: + :param visible: + :return: + ''' if value is not None: self.DisplayText = value stringvar = self.TKStringVar @@ -1487,7 +1368,6 @@ class Text(Element): self.TKText.pack() def __del__(self): - """ """ super().__del__() @@ -1500,30 +1380,29 @@ T = Text # StatusBar # # ---------------------------------------------------------------------- # class StatusBar(Element): - """ """ - + ''' + + ''' def __init__(self, text, size=(None, None), auto_size_text=None, click_submits=None, enable_events=False, relief=RELIEF_SUNKEN, font=None, text_color=None, background_color=None, justification=None, pad=None, key=None, tooltip=None, visible=True): - """ + ''' - :param text: - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_text: True if size should fit the text length (Default value = None) - :param click_submits: (Default value = None) - :param enable_events: Turns on the element specific events.(Default value = False) - :param relief: (Default value = RELIEF_SUNKEN) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param text_color: color of the text (Default value = None) - :param background_color: color of background (Default value = None) - :param justification: justification for data display (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param text: + :param size: + :param auto_size_text: + :param click_submits: + :param enable_events: + :param relief: + :param font: + :param text_color: + :param background_color: + :param justification: + :param pad: + :param key: + :param tooltip: + :param visible: + ''' self.DisplayText = text self.TextColor = text_color if text_color else DEFAULT_TEXT_COLOR self.Justification = justification @@ -1539,16 +1418,15 @@ class StatusBar(Element): return def Update(self, value=None, background_color=None, text_color=None, font=None, visible=None): - """ + ''' - :param value: (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param visible: change visibility of element (Default value = None) - - """ - + :param value: + :param background_color: + :param text_color: + :param font: + :param visible: + :return: + ''' if value is not None: self.DisplayText = value stringvar = self.TKStringVar @@ -1565,7 +1443,6 @@ class StatusBar(Element): self.TKText.pack() def __del__(self): - """ """ super().__del__() @@ -1575,24 +1452,9 @@ class StatusBar(Element): # ---------------------------------------------------------------------- # class TKProgressBar(): - """ """ def __init__(self, root, max, length=400, width=DEFAULT_PROGRESS_BAR_SIZE[1], style=DEFAULT_PROGRESS_BAR_STYLE, relief=DEFAULT_PROGRESS_BAR_RELIEF, border_width=DEFAULT_PROGRESS_BAR_BORDER_WIDTH, orientation='horizontal', BarColor=(None, None), key=None): - """ - - :param root: - :param max: - :param length: (Default value = 400) - :param width: (Default value = DEFAULT_PROGRESS_BAR_SIZE[1]) - :param style: (Default value = DEFAULT_PROGRESS_BAR_STYLE) - :param relief: (Default value = DEFAULT_PROGRESS_BAR_RELIEF) - :param border_width: (Default value = DEFAULT_PROGRESS_BAR_BORDER_WIDTH) - :param orientation: (Default value = 'horizontal') - :param BarColor: (Default value = (None, None)) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ self.Length = length self.Width = width @@ -1628,12 +1490,6 @@ class TKProgressBar(): length=length, orient=tk.VERTICAL, mode='determinate') def Update(self, count=None, max=None): - """ - - :param count: (Default value = None) - :param max: (Default value = None) - - """ if max is not None: self.Max = max try: @@ -1649,7 +1505,6 @@ class TKProgressBar(): return True def __del__(self): - """ """ try: self.TKProgressBarForReal.__del__() except: @@ -1663,20 +1518,7 @@ class TKProgressBar(): # Scroll bar will span the length of the frame # # ---------------------------------------------------------------------- # class TKOutput(tk.Frame): - """ """ def __init__(self, parent, width, height, bd, background_color=None, text_color=None, font=None, pad=None): - """ - - :param parent: - :param width: - :param height: - :param bd: - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - - """ self.frame = tk.Frame(parent) tk.Frame.__init__(self, self.frame) self.output = tk.Text(self.frame, width=width, height=height, bd=bd, font=font) @@ -1698,11 +1540,6 @@ class TKOutput(tk.Frame): self.pack() def write(self, txt): - """ - - :param txt: - - """ try: self.output.insert(tk.END, str(txt)) self.output.see(tk.END) @@ -1710,17 +1547,14 @@ class TKOutput(tk.Frame): pass def Close(self): - """ """ sys.stdout = self.previous_stdout sys.stderr = self.previous_stderr def flush(self): - """ """ sys.stdout = self.previous_stdout sys.stderr = self.previous_stderr def __del__(self): - """ """ sys.stdout = self.previous_stdout sys.stderr = self.previous_stderr @@ -1730,24 +1564,23 @@ class TKOutput(tk.Frame): # Routes stdout, stderr to a scrolled window # # ---------------------------------------------------------------------- # class Output(Element): - """ """ - + ''' + + ''' def __init__(self, size=(None, None), background_color=None, text_color=None, pad=None, font=None, tooltip=None, key=None, right_click_menu=None, visible=True): - """ + ''' - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param right_click_menu: see "Right Click Menus" (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param size: + :param background_color: + :param text_color: + :param pad: + :param font: + :param tooltip: + :param key: + :param right_click_menu: + :param visible: + ''' self._TKOut = None bg = background_color if background_color else DEFAULT_INPUT_ELEMENTS_COLOR fg = text_color if text_color is not None else DEFAULT_INPUT_TEXT_COLOR @@ -1758,20 +1591,18 @@ class Output(Element): @property def TKOut(self): - """ """ if self._TKOut is None: print('*** Did you forget to call Finalize()? Your code should look something like: ***') print('*** form = sg.Window("My Form").Layout(layout).Finalize() ***') return self._TKOut def Update(self, value=None, visible=None): - """ + ''' - :param value: (Default value = None) - :param visible: change visibility of element (Default value = None) - - """ - + :param value: + :param visible: + :return: + ''' if value is not None: self._TKOut.output.delete('1.0', tk.END) self._TKOut.output.insert(tk.END, value) @@ -1781,7 +1612,6 @@ class Output(Element): self._TKOut.frame.pack() def __del__(self): - """ """ try: self._TKOut.__del__() except: @@ -1793,41 +1623,40 @@ class Output(Element): # Button Class # # ---------------------------------------------------------------------- # class Button(Element): - """ """ - + ''' + + ''' def __init__(self, button_text='', button_type=BUTTON_TYPE_READ_FORM, target=(None, None), tooltip=None, file_types=(("ALL Files", "*.*"),), initial_folder=None, disabled=False, change_submits=False, enable_events=False, image_filename=None, image_data=None, image_size=(None, None), image_subsample=None, border_width=None, size=(None, None), auto_size_button=None, button_color=None, font=None, bind_return_key=False, focus=False, pad=None, key=None, visible=True): - """ + ''' - :param button_text: (Default value = '') - :param button_type: (Default value = BUTTON_TYPE_READ_FORM) - :param target: - :param tooltip: text, that will appear the you hover on (Default value = None) - :param file_types: (Default value = (("ALL Files", "*.*"),)) - :param initial_folder: (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param change_submits: If True, pressing Enter key submits window (Default value = False) - :param enable_events: Turns on the element specific events.(Default value = False) - :param image_filename: (Default value = None) - :param image_data: (Default value = None) - :param image_size: (Default value = (None) - :param image_subsample: (Default value = None) - :param border_width: (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param bind_return_key: (Default value = False) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param button_text: + :param button_type: + :param target: + :param tooltip: + :param file_types: + :param initial_folder: + :param disabled: + :param change_submits: + :param enable_events: + :param image_filename: + :param image_data: + :param image_size: + :param image_subsample: + :param border_width: + :param size: + :param auto_size_button: + :param button_color: + :param font: + :param bind_return_key: + :param focus: + :param pad: + :param key: + :param visible: + ''' self.AutoSizeButton = auto_size_button self.BType = button_type self.FileTypes = file_types @@ -1857,21 +1686,11 @@ class Button(Element): # Realtime button release callback def ButtonReleaseCallBack(self, parm): - """ - - :param parm: - - """ self.LastButtonClickedWasRealtime = False self.ParentForm.LastButtonClicked = None # Realtime button callback def ButtonPressCallBack(self, parm): - """ - - :param parm: - - """ self.ParentForm.LastButtonClickedWasRealtime = True if self.Key is not None: self.ParentForm.LastButtonClicked = self.Key @@ -1882,7 +1701,6 @@ class Button(Element): # ------- Button Callback ------- # def ButtonCallBack(self): - """ """ # global _my_windows # print('Button callback') @@ -2009,7 +1827,7 @@ class Button(Element): pass elif self.BType == BUTTON_TYPE_SHOW_DEBUGGER: if self.ParentForm.DebuggerEnabled: - _Debugger.debugger._build_floating_window() + Debugger.debugger._build_floating_window() # show_debugger_window() if should_submit_window: @@ -2022,19 +1840,18 @@ class Button(Element): def Update(self, text=None, button_color=(None, None), disabled=None, image_data=None, image_filename=None, visible=None, image_subsample=None, image_size=None): - """ + ''' - :param text: (Default value = None) - :param button_color: (Default value = (None) - :param disabled: disable or enable state of the element (Default value = None) - :param image_data: (Default value = None) - :param image_filename: (Default value = None) - :param visible: change visibility of element (Default value = None) - :param image_subsample: (Default value = None) - :param image_size: (Default value = None) - - """ - + :param text: + :param button_color: + :param disabled: + :param image_data: + :param image_filename: + :param visible: + :param image_subsample: + :param image_size: + :return: + ''' try: if text is not None: self.TKButton.configure(text=text) @@ -2077,21 +1894,18 @@ class Button(Element): self.TKButton.pack() def GetText(self): - """ """ return self.ButtonText def SetFocus(self): - """ """ try: self.TKButton.focus_set() except: pass def Click(self): - """Generates a click of the button as if the user clicked the button + """ + Generates a click of the button as if the user clicked the button :return: - - """ try: self.TKButton.invoke() @@ -2099,7 +1913,6 @@ class Button(Element): print('Exception clicking button') def __del__(self): - """ """ try: self.TKButton.__del__() except: @@ -2117,34 +1930,33 @@ Butt = Button # ButtonMenu Class # # ---------------------------------------------------------------------- # class ButtonMenu(Element): - """ """ - + ''' + + ''' def __init__(self, button_text, menu_def, tooltip=None, disabled=False, image_filename=None, image_data=None, image_size=(None, None), image_subsample=None, border_width=None, size=(None, None), auto_size_button=None, button_color=None, font=None, pad=None, key=None, tearoff=False, visible=True): - """ + ''' - :param button_text: - :param menu_def: - :param tooltip: text, that will appear the you hover on (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param image_filename: (Default value = None) - :param image_data: (Default value = None) - :param image_size: (Default value = (None, None)) - :param image_subsample: (Default value = None) - :param border_width: (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param tearoff: (Default value = False) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param button_text: + :param menu_def: + :param tooltip: + :param disabled: + :param image_filename: + :param image_data: + :param image_size: + :param image_subsample: + :param border_width: + :param size: + :param auto_size_button: + :param button_color: + :param font: + :param pad: + :param key: + :param tearoff: + :param visible: + ''' self.MenuDefinition = menu_def self.AutoSizeButton = auto_size_button self.ButtonText = button_text @@ -2169,11 +1981,6 @@ class ButtonMenu(Element): return def _MenuItemChosenCallback(self, item_chosen): # ButtonMenu Menu Item Chosen Callback - """ - - :param item_chosen: - - """ # print('IN MENU ITEM CALLBACK', item_chosen) self.MenuItemChosen = item_chosen.replace('&', '') self.ParentForm.LastButtonClicked = self.Key @@ -2182,13 +1989,12 @@ class ButtonMenu(Element): self.ParentForm.TKroot.quit() # kick the users out of the mainloop def Update(self, menu_definition, visible=None): - """ + ''' - :param menu_definition: - :param visible: change visibility of element (Default value = None) - - """ - + :param menu_definition: + :param visible: + :return: + ''' self.MenuDefinition = menu_definition if menu_definition is not None: self.TKMenu = tk.Menu(self.TKButtonMenu, tearoff=self.Tearoff) # create the menubar @@ -2200,7 +2006,6 @@ class ButtonMenu(Element): self.TKButtonMenu.pack() def __del__(self): - """ """ try: self.TKButton.__del__() except: @@ -2212,25 +2017,22 @@ class ButtonMenu(Element): # ProgreessBar # # ---------------------------------------------------------------------- # class ProgressBar(Element): - """ """ def __init__(self, max_value, orientation=None, size=(None, None), auto_size_text=None, bar_color=(None, None), style=None, border_width=None, relief=None, key=None, pad=None, visible=True): - """ + ''' - :param max_value: - :param orientation: (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_text: True if size should fit the text length (Default value = None) - :param bar_color: (Default value = (None) - :param style: (Default value = None) - :param border_width: (Default value = None) - :param relief: (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param max_value: + :param orientation: + :param size: + :param auto_size_text: + :param bar_color: + :param style: + :param border_width: + :param relief: + :param key: + :param pad: + :param visible: + ''' self.MaxValue = max_value self.TKProgressBar = None self.Cancelled = False @@ -2246,13 +2048,12 @@ class ProgressBar(Element): # returns False if update failed def UpdateBar(self, current_count, max=None): - """ + ''' - :param current_count: - :param max: (Default value = None) - - """ - + :param current_count: + :param max: + :return: + ''' if self.ParentForm.TKrootDestroyed: return False self.TKProgressBar.Update(current_count, max=max) @@ -2265,19 +2066,17 @@ class ProgressBar(Element): return True def Update(self, visible=None): - """ + ''' - :param visible: change visibility of element (Default value = None) - - """ - + :param visible: + :return: + ''' if visible is False: self.TKProgressBar.TKProgressBarForReal.pack_forget() elif visible is True: self.TKProgressBar.TKProgressBarForReal.pack() def __del__(self): - """ """ try: self.TKProgressBar.__del__() except: @@ -2289,25 +2088,24 @@ class ProgressBar(Element): # Image # # ---------------------------------------------------------------------- # class Image(Element): - """ """ - + ''' + + ''' def __init__(self, filename=None, data=None, background_color=None, size=(None, None), pad=None, key=None, tooltip=None, right_click_menu=None, visible=True, enable_events=False): - """ + ''' - :param filename: (Default value = None) - :param data: (Default value = None) - :param background_color: color of background (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param right_click_menu: see "Right Click Menus" (Default value = None) - :param visible: set visibility state of the element (Default value = True) - :param enable_events: Turns on the element specific events.(Default value = False) - - """ - + :param filename: + :param data: + :param background_color: + :param size: + :param pad: + :param key: + :param tooltip: + :param right_click_menu: + :param visible: + :param enable_events: + ''' self.Filename = filename self.Data = data self.tktext_label = None @@ -2327,15 +2125,14 @@ class Image(Element): return def Update(self, filename=None, data=None, size=(None, None), visible=None): - """ + ''' - :param filename: (Default value = None) - :param data: (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param visible: change visibility of element (Default value = None) - - """ - + :param filename: + :param data: + :param size: + :param visible: + :return: + ''' if filename is not None: image = tk.PhotoImage(file=filename) elif data is not None: @@ -2358,13 +2155,12 @@ class Image(Element): self.tktext_label.pack() def UpdateAnimation(self, source, time_between_frames=0): - """ + ''' - :param source: - :param time_between_frames: (Default value = 0) - - """ - + :param source: + :param time_between_frames: + :return: + ''' if self.Source != source: self.AnimatedFrames = None self.Source = source @@ -2405,7 +2201,6 @@ class Image(Element): pass def __del__(self): - """ """ super().__del__() @@ -2413,23 +2208,22 @@ class Image(Element): # Canvas # # ---------------------------------------------------------------------- # class Canvas(Element): - """ """ - + ''' + + ''' def __init__(self, canvas=None, background_color=None, size=(None, None), pad=None, key=None, tooltip=None, right_click_menu=None, visible=True): - """ + ''' - :param canvas: (Default value = None) - :param background_color: color of background (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param right_click_menu: see "Right Click Menus" (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param canvas: + :param background_color: + :param size: + :param pad: + :param key: + :param tooltip: + :param right_click_menu: + :param visible: + ''' self.BackgroundColor = background_color if background_color is not None else DEFAULT_BACKGROUND_COLOR self._TKCanvas = canvas self.RightClickMenu = right_click_menu @@ -2440,14 +2234,12 @@ class Canvas(Element): @property def TKCanvas(self): - """ """ if self._TKCanvas is None: print('*** Did you forget to call Finalize()? Your code should look something like: ***') print('*** form = sg.Window("My Form").Layout(layout).Finalize() ***') return self._TKCanvas def __del__(self): - """ """ super().__del__() @@ -2455,28 +2247,27 @@ class Canvas(Element): # Graph # # ---------------------------------------------------------------------- # class Graph(Element): - """ """ - + ''' + + ''' def __init__(self, canvas_size, graph_bottom_left, graph_top_right, background_color=None, pad=None, change_submits=False, drag_submits=False, enable_events=False, key=None, tooltip=None, right_click_menu=None, visible=True): - """ + ''' - :param canvas_size: - :param graph_bottom_left: - :param graph_top_right: - :param background_color: color of background (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param change_submits: If True, pressing Enter key submits window (Default value = False) - :param drag_submits: (Default value = False) - :param enable_events: Turns on the element specific events.(Default value = False) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param right_click_menu: see "Right Click Menus" (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param canvas_size: + :param graph_bottom_left: + :param graph_top_right: + :param background_color: + :param pad: + :param change_submits: + :param drag_submits: + :param enable_events: + :param key: + :param tooltip: + :param right_click_menu: + :param visible: + ''' self.CanvasSize = canvas_size self.BottomLeft = graph_bottom_left self.TopRight = graph_top_right @@ -2494,12 +2285,6 @@ class Graph(Element): return def _convert_xy_to_canvas_xy(self, x_in, y_in): - """ - - :param x_in: - :param y_in: - - """ if None in (x_in, y_in): return None, None scale_x = (self.CanvasSize[0] - 0) / (self.TopRight[0] - self.BottomLeft[0]) @@ -2509,12 +2294,6 @@ class Graph(Element): return new_x, new_y def _convert_canvas_xy_to_xy(self, x_in, y_in): - """ - - :param x_in: - :param y_in: - - """ if None in (x_in, y_in): return None, None scale_x = (self.CanvasSize[0] - 0) / (self.TopRight[0] - self.BottomLeft[0]) @@ -2525,14 +2304,6 @@ class Graph(Element): return int(new_x), int(new_y) def DrawLine(self, point_from, point_to, color='black', width=1): - """ - - :param point_from: - :param point_to: - :param color: (Default value = 'black') - :param width: (Default value = 1) - - """ if point_from == (None, None): return converted_point_from = self._convert_xy_to_canvas_xy(point_from[0], point_from[1]) @@ -2548,13 +2319,6 @@ class Graph(Element): return id def DrawPoint(self, point, size=2, color='black'): - """ - - :param point: - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = 2) - :param color: (Default value = 'black') - - """ if point == (None, None): return converted_point = self._convert_xy_to_canvas_xy(point[0], point[1]) @@ -2571,14 +2335,6 @@ class Graph(Element): return def DrawCircle(self, center_location, radius, fill_color=None, line_color='black'): - """ - - :param center_location: - :param radius: - :param fill_color: (Default value = None) - :param line_color: (Default value = 'black') - - """ if center_location == (None, None): return converted_point = self._convert_xy_to_canvas_xy(center_location[0], center_location[1]) @@ -2595,14 +2351,6 @@ class Graph(Element): return id def DrawOval(self, top_left, bottom_right, fill_color=None, line_color=None): - """ - - :param top_left: - :param bottom_right: - :param fill_color: (Default value = None) - :param line_color: (Default value = None) - - """ converted_top_left = self._convert_xy_to_canvas_xy(top_left[0], top_left[1]) converted_bottom_right = self._convert_xy_to_canvas_xy(bottom_right[0], bottom_right[1]) if self._TKCanvas2 is None: @@ -2618,16 +2366,6 @@ class Graph(Element): return id def DrawArc(self, top_left, bottom_right, extent, start_angle, style=None, arc_color='black'): - """ - - :param top_left: - :param bottom_right: - :param extent: - :param start_angle: - :param style: (Default value = None) - :param arc_color: (Default value = 'black') - - """ converted_top_left = self._convert_xy_to_canvas_xy(top_left[0], top_left[1]) converted_bottom_right = self._convert_xy_to_canvas_xy(bottom_right[0], bottom_right[1]) tkstyle = tk.PIESLICE if style is None else style @@ -2644,14 +2382,6 @@ class Graph(Element): return id def DrawRectangle(self, top_left, bottom_right, fill_color=None, line_color=None): - """ - - :param top_left: - :param bottom_right: - :param fill_color: (Default value = None) - :param line_color: (Default value = None) - - """ converted_top_left = self._convert_xy_to_canvas_xy(top_left[0], top_left[1]) converted_bottom_right = self._convert_xy_to_canvas_xy(bottom_right[0], bottom_right[1]) if self._TKCanvas2 is None: @@ -2667,15 +2397,6 @@ class Graph(Element): return id def DrawText(self, text, location, color='black', font=None, angle=0): - """ - - :param text: - :param location: - :param color: (Default value = 'black') - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param angle: (Default value = 0) - - """ if location == (None, None): return converted_point = self._convert_xy_to_canvas_xy(location[0], location[1]) @@ -2691,16 +2412,6 @@ class Graph(Element): return id def DrawImage(self, filename=None, data=None, location=(None, None), color='black', font=None, angle=0): - """ - - :param filename: (Default value = None) - :param data: (Default value = None) - :param location: (Default value = (None, None)) - :param color: (Default value = 'black') - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param angle: (Default value = 0) - - """ if location == (None, None): return if filename is not None: @@ -2724,7 +2435,6 @@ class Graph(Element): return id def Erase(self): - """ """ if self._TKCanvas2 is None: print('*** WARNING - The Graph element has not been finalized and cannot be drawn upon ***') print('Call Window.Finalize() prior to this operation') @@ -2736,11 +2446,6 @@ class Graph(Element): pass def DeleteFigure(self, id): - """ - - :param id: - - """ try: self._TKCanvas2.delete(id) except: @@ -2750,12 +2455,6 @@ class Graph(Element): except: pass def Update(self, background_color, visible=None): - """ - - :param background_color: color of background - :param visible: change visibility of element (Default value = None) - - """ if self._TKCanvas2 is None: print('*** WARNING - The Graph element has not been finalized and cannot be drawn upon ***') print('Call Window.Finalize() prior to this operation') @@ -2767,12 +2466,6 @@ class Graph(Element): self._TKCanvas2.pack() def Move(self, x_direction, y_direction): - """ - - :param x_direction: - :param y_direction: - - """ zero_converted = self._convert_xy_to_canvas_xy(0, 0) shift_converted = self._convert_xy_to_canvas_xy(x_direction, y_direction) shift_amount = (shift_converted[0] - zero_converted[0], shift_converted[1] - zero_converted[1]) @@ -2783,13 +2476,6 @@ class Graph(Element): self._TKCanvas2.move('all', shift_amount[0], shift_amount[1]) def MoveFigure(self, figure, x_direction, y_direction): - """ - - :param figure: - :param x_direction: - :param y_direction: - - """ zero_converted = self._convert_xy_to_canvas_xy(0, 0) shift_converted = self._convert_xy_to_canvas_xy(x_direction, y_direction) shift_amount = (shift_converted[0] - zero_converted[0], shift_converted[1] - zero_converted[1]) @@ -2800,13 +2486,6 @@ class Graph(Element): self._TKCanvas2.move(figure, shift_amount[0], shift_amount[1]) def RelocateFigure(self, figure, x, y): - """ - - :param figure: - :param x: - :param y: - - """ zero_converted = self._convert_xy_to_canvas_xy(0, 0) shift_converted = self._convert_xy_to_canvas_xy(x, y) shift_amount = (shift_converted[0] - zero_converted[0], shift_converted[1] - zero_converted[1]) @@ -2819,7 +2498,6 @@ class Graph(Element): @property def TKCanvas(self): - """ """ if self._TKCanvas2 is None: print('*** Did you forget to call Finalize()? Your code should look something like: ***') print('*** form = sg.Window("My Form").Layout(layout).Finalize() ***') @@ -2827,11 +2505,6 @@ class Graph(Element): # Realtime button release callback def ButtonReleaseCallBack(self, event): - """ - - :param event: - - """ self.ClickPosition = (None, None) self.LastButtonClickedWasRealtime = not self.DragSubmits if self.Key is not None: @@ -2846,11 +2519,6 @@ class Graph(Element): # Realtime button callback def ButtonPressCallBack(self, event): - """ - - :param event: - - """ self.ClickPosition = self._convert_canvas_xy_to_xy(event.x, event.y) self.ParentForm.LastButtonClickedWasRealtime = self.DragSubmits if self.Key is not None: @@ -2863,11 +2531,6 @@ class Graph(Element): # Realtime button callback def MotionCallBack(self, event): - """ - - :param event: - - """ if not self.MouseButtonDown: return self.ClickPosition = self._convert_canvas_xy_to_xy(event.x, event.y) @@ -2880,12 +2543,10 @@ class Graph(Element): self.ParentForm.TKroot.quit() # kick out of loop if read was called def SetFocus(self): - """ """ self._TKCanvas2.focus_set() # self._TKCanvas2.focus_force() def __del__(self): - """ """ super().__del__() @@ -2893,30 +2554,29 @@ class Graph(Element): # Frame # # ---------------------------------------------------------------------- # class Frame(Element): - """ """ - + ''' + + ''' def __init__(self, title, layout, title_color=None, background_color=None, title_location=None, relief=DEFAULT_FRAME_RELIEF, size=(None, None), font=None, pad=None, border_width=None, key=None, tooltip=None, right_click_menu=None, visible=True): - """ + ''' - :param title: - :param layout: - :param title_color: (Default value = None) - :param background_color: color of background (Default value = None) - :param title_location: (Default value = None) - :param relief: (Default value = DEFAULT_FRAME_RELIEF) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param border_width: (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param right_click_menu: see "Right Click Menus" (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param title: + :param layout: + :param title_color: + :param background_color: + :param title_location: + :param relief: + :param size: + :param font: + :param pad: + :param border_width: + :param key: + :param tooltip: + :param right_click_menu: + :param visible: + ''' self.UseDictionary = False self.ReturnValues = None self.ReturnValuesList = [] @@ -2941,11 +2601,7 @@ class Frame(Element): return def AddRow(self, *args): - """Parms are a variable number of Elements - - :param *args: - - """ + ''' Parms are a variable number of Elements ''' NumRows = len(self.Rows) # number of existing rows is our row number CurrentRowNumber = NumRows # this row's number CurrentRow = [] # start with a blank row and build up @@ -2960,39 +2616,27 @@ class Frame(Element): self.Rows.append(CurrentRow) def Layout(self, rows): - """ - - :param rows: - - """ for row in rows: self.AddRow(*row) def _GetElementAtLocation(self, location): - """ - - :param location: - - """ (row_num, col_num) = location row = self.Rows[row_num] element = row[col_num] return element def Update(self, visible=None): - """ + ''' - :param visible: change visibility of element (Default value = None) - - """ - + :param visible: + :return: + ''' if visible is False: self.TKFrame.pack_forget() elif visible is True: self.TKFrame.pack() def __del__(self): - """ """ for row in self.Rows: for element in row: element.__del__() @@ -3004,21 +2648,19 @@ class Frame(Element): # Routes stdout, stderr to a scrolled window # # ---------------------------------------------------------------------- # class VerticalSeparator(Element): - """ """ - + ''' + + ''' def __init__(self, pad=None): - """ + ''' - :param pad: (common_key) Amount of padding to put around element (Default value = None) - - """ - + :param pad: + ''' self.Orientation = 'vertical' # for now only vertical works super().__init__(ELEM_TYPE_SEPARATOR, pad=pad) def __del__(self): - """ """ super().__del__() @@ -3030,27 +2672,26 @@ VSep = VerticalSeparator # Tab # # ---------------------------------------------------------------------- # class Tab(Element): - """ """ - + ''' + + ''' def __init__(self, title, layout, title_color=None, background_color=None, font=None, pad=None, disabled=False, border_width=None, key=None, tooltip=None, right_click_menu=None, visible=True): - """ + ''' - :param title: - :param layout: - :param title_color: (Default value = None) - :param background_color: color of background (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param border_width: (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param right_click_menu: see "Right Click Menus" (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param title: + :param layout: + :param title_color: + :param background_color: + :param font: + :param pad: + :param disabled: + :param border_width: + :param key: + :param tooltip: + :param right_click_menu: + :param visible: + ''' self.UseDictionary = False self.ReturnValues = None self.ReturnValuesList = [] @@ -3075,11 +2716,7 @@ class Tab(Element): return def AddRow(self, *args): - """Parms are a variable number of Elements - - :param *args: - - """ + ''' Parms are a variable number of Elements ''' NumRows = len(self.Rows) # number of existing rows is our row number CurrentRowNumber = NumRows # this row's number CurrentRow = [] # start with a blank row and build up @@ -3094,23 +2731,17 @@ class Tab(Element): self.Rows.append(CurrentRow) def Layout(self, rows): - """ - - :param rows: - - """ for row in rows: self.AddRow(*row) return self def Update(self, disabled=None, visible=None): # TODO Disable / enable of tabs is not complete - """ + ''' - :param disabled: disable or enable state of the element (Default value = None) - :param visible: change visibility of element (Default value = None) - - """ - + :param disabled: + :param visible: + :return: + ''' if disabled is None: return self.Disabled = disabled @@ -3123,18 +2754,12 @@ class Tab(Element): return self def _GetElementAtLocation(self, location): - """ - - :param location: - - """ (row_num, col_num) = location row = self.Rows[row_num] element = row[col_num] return element def __del__(self): - """ """ for row in self.Rows: for element in row: element.__del__() @@ -3145,30 +2770,29 @@ class Tab(Element): # TabGroup # # ---------------------------------------------------------------------- # class TabGroup(Element): - """ """ - + ''' + + ''' def __init__(self, layout, tab_location=None, title_color=None, selected_title_color=None, background_color=None, font=None, change_submits=False, enable_events=False, pad=None, border_width=None, theme=None, key=None, tooltip=None, visible=True): - """ + ''' - :param layout: - :param tab_location: (Default value = None) - :param title_color: (Default value = None) - :param selected_title_color: (Default value = None) - :param background_color: color of background (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param change_submits: If True, pressing Enter key submits window (Default value = False) - :param enable_events: Turns on the element specific events.(Default value = False) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param border_width: (Default value = None) - :param theme: (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param layout: + :param tab_location: + :param title_color: + :param selected_title_color: + :param background_color: + :param font: + :param change_submits: + :param enable_events: + :param pad: + :param border_width: + :param theme: + :param key: + :param tooltip: + :param visible: + ''' self.UseDictionary = False self.ReturnValues = None self.ReturnValuesList = [] @@ -3193,11 +2817,7 @@ class TabGroup(Element): return def AddRow(self, *args): - """Parms are a variable number of Elements - - :param *args: - - """ + ''' Parms are a variable number of Elements ''' NumRows = len(self.Rows) # number of existing rows is our row number CurrentRowNumber = NumRows # this row's number CurrentRow = [] # start with a blank row and build up @@ -3212,31 +2832,16 @@ class TabGroup(Element): self.Rows.append(CurrentRow) def Layout(self, rows): - """ - - :param rows: - - """ for row in rows: self.AddRow(*row) def _GetElementAtLocation(self, location): - """ - - :param location: - - """ (row_num, col_num) = location row = self.Rows[row_num] element = row[col_num] return element def FindKeyFromTabName(self, tab_name): - """ - - :param tab_name: - - """ for row in self.Rows: for element in row: if element.Title == tab_name: @@ -3244,18 +2849,12 @@ class TabGroup(Element): return None def SelectTab(self, index): - """ - - :param index: - - """ try: self.TKNotebook.select(index) except Exception as e: print('Exception Selecting Tab {}'.format(e)) def __del__(self): - """ """ for row in self.Rows: for element in row: element.__del__() @@ -3266,36 +2865,35 @@ class TabGroup(Element): # Slider # # ---------------------------------------------------------------------- # class Slider(Element): - """ """ - + ''' + + ''' def __init__(self, range=(None, None), default_value=None, resolution=None, tick_interval=None, orientation=None, disable_number_display=False, border_width=None, relief=None, change_submits=False, enable_events=False, disabled=False, size=(None, None), font=None, background_color=None, text_color=None, key=None, pad=None, tooltip=None, visible=True): - """ + ''' - :param range: (Default value = (None, None)) - :param default_value: (Default value = None) - :param resolution: (Default value = None) - :param tick_interval: (Default value = None) - :param orientation: (Default value = None) - :param disable_number_display: (Default value = False) - :param border_width: (Default value = None) - :param relief: (Default value = None) - :param change_submits: If True, pressing Enter key submits window (Default value = False) - :param enable_events: Turns on the element specific events.(Default value = False) - :param disabled: set disable state for element (Default value = False) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param range: + :param default_value: + :param resolution: + :param tick_interval: + :param orientation: + :param disable_number_display: + :param border_width: + :param relief: + :param change_submits: + :param enable_events: + :param disabled: + :param size: + :param font: + :param background_color: + :param text_color: + :param key: + :param pad: + :param tooltip: + :param visible: + ''' self.TKScale = None # type: tk.Scale self.Range = (1, 10) if range == (None, None) else range self.DefaultValue = self.Range[0] if default_value is None else default_value @@ -3316,15 +2914,14 @@ class Slider(Element): return def Update(self, value=None, range=(None, None), disabled=None, visible=None): - """ + ''' - :param value: (Default value = None) - :param range: (Default value = (None, None)) - :param disabled: disable or enable state of the element (Default value = None) - :param visible: change visibility of element (Default value = None) - - """ - + :param value: + :param range: + :param disabled: + :param visible: + :return: + ''' if value is not None: try: self.TKIntVar.set(value) @@ -3343,11 +2940,6 @@ class Slider(Element): self.TKScale.pack() def _SliderChangedHandler(self, event): - """ - - :param event: - - """ # first, get the results table built # modify the Results table in the parent FlexForm object if self.Key is not None: @@ -3359,7 +2951,6 @@ class Slider(Element): self.ParentForm.TKroot.quit() # kick the users out of the mainloop def __del__(self): - """ """ super().__del__() @@ -3367,14 +2958,7 @@ class Slider(Element): # TkScrollableFrame (Used by Column) # # ---------------------------------------------------------------------- # class TkFixedFrame(tk.Frame): - """ """ def __init__(self, master, **kwargs): - """ - - :param master: - :param **kwargs: - - """ tk.Frame.__init__(self, master, **kwargs) self.canvas = tk.Canvas(self) @@ -3397,15 +2981,7 @@ class TkFixedFrame(tk.Frame): # TkScrollableFrame (Used by Column) # # ---------------------------------------------------------------------- # class TkScrollableFrame(tk.Frame): - """ """ def __init__(self, master, vertical_only, **kwargs): - """ - - :param master: - :param vertical_only: - :param **kwargs: - - """ tk.Frame.__init__(self, master, **kwargs) # create a canvas object and a vertical scrollbar for scrolling it @@ -3450,42 +3026,21 @@ class TkScrollableFrame(tk.Frame): self.bind_mouse_scroll(self.vscrollbar, self.yscroll) def resize_frame(self, e): - """ - - :param e: - - """ self.canvas.itemconfig(self.frame_id, height=e.height, width=e.width) def yscroll(self, event): - """ - - :param event: - - """ if event.num == 5 or event.delta < 0: self.canvas.yview_scroll(1, "unit") elif event.num == 4 or event.delta > 0: self.canvas.yview_scroll(-1, "unit") def xscroll(self, event): - """ - - :param event: - - """ if event.num == 5 or event.delta < 0: self.canvas.xview_scroll(1, "unit") elif event.num == 4 or event.delta > 0: self.canvas.xview_scroll(-1, "unit") def bind_mouse_scroll(self, parent, mode): - """ - - :param parent: - :param mode: - - """ # ~~ Windows only parent.bind("", mode) # ~~ Unix only @@ -3493,11 +3048,7 @@ class TkScrollableFrame(tk.Frame): parent.bind("", mode) def set_scrollregion(self, event=None): - """Set the scroll region on the canvas - - :param event: (Default value = None) - - """ + """ Set the scroll region on the canvas""" self.canvas.configure(scrollregion=self.canvas.bbox('all')) @@ -3505,24 +3056,23 @@ class TkScrollableFrame(tk.Frame): # Column # # ---------------------------------------------------------------------- # class Column(Element): - """ """ - + ''' + + ''' def __init__(self, layout, background_color=None, size=(None, None), pad=None, scrollable=False, vertical_scroll_only=False, right_click_menu=None, key=None, visible=True): - """ + ''' - :param layout: - :param background_color: color of background (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param scrollable: (Default value = False) - :param vertical_scroll_only: (Default value = False) - :param right_click_menu: see "Right Click Menus" (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param layout: + :param background_color: + :param size: + :param pad: + :param scrollable: + :param vertical_scroll_only: + :param right_click_menu: + :param key: + :param visible: + ''' self.UseDictionary = False self.ReturnValues = None self.ReturnValuesList = [] @@ -3545,11 +3095,7 @@ class Column(Element): return def AddRow(self, *args): - """Parms are a variable number of Elements - - :param *args: - - """ + ''' Parms are a variable number of Elements ''' NumRows = len(self.Rows) # number of existing rows is our row number CurrentRowNumber = NumRows # this row's number CurrentRow = [] # start with a blank row and build up @@ -3564,32 +3110,21 @@ class Column(Element): self.Rows.append(CurrentRow) def Layout(self, rows): - """ - - :param rows: - - """ for row in rows: self.AddRow(*row) def _GetElementAtLocation(self, location): - """ - - :param location: - - """ (row_num, col_num) = location row = self.Rows[row_num] element = row[col_num] return element def Update(self, visible=None): - """ + ''' - :param visible: change visibility of element (Default value = None) - - """ - + :param visible: + :return: + ''' if visible is False: if self.TKColFrame: self.TKColFrame.pack_forget() @@ -3602,7 +3137,6 @@ class Column(Element): self.ParentPanedWindow.add(self.TKColFrame) def __del__(self): - """ """ for row in self.Rows: for element in row: element.__del__() @@ -3617,26 +3151,25 @@ class Column(Element): # Pane # # ---------------------------------------------------------------------- # class Pane(Element): - """ """ - + ''' + + ''' def __init__(self, pane_list, background_color=None, size=(None, None), pad=None, orientation='vertical', show_handle=True, relief=RELIEF_RAISED, handle_size=None, border_width=None, key=None, visible=True): - """ + ''' - :param pane_list: - :param background_color: color of background (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param orientation: (Default value = 'vertical') - :param show_handle: (Default value = True) - :param relief: (Default value = RELIEF_RAISED) - :param handle_size: (Default value = None) - :param border_width: (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param pane_list: + :param background_color: + :param size: + :param pad: + :param orientation: + :param show_handle: + :param relief: + :param handle_size: + :param border_width: + :param key: + :param visible: + ''' self.UseDictionary = False self.ReturnValues = None self.ReturnValuesList = [] @@ -3660,12 +3193,11 @@ class Pane(Element): return def Update(self, visible=None): - """ + ''' - :param visible: change visibility of element (Default value = None) - - """ - + :param visible: + :return: + ''' if visible is False: self.PanedWindow.pack_forget() elif visible is True: @@ -3676,25 +3208,20 @@ class Pane(Element): # Calendar # # ---------------------------------------------------------------------- # class TKCalendar(ttk.Frame): - """This code was shamelessly lifted from moshekaplan's repository - moshekaplan/tkinter_components""" + """ + This code was shamelessly lifted from moshekaplan's repository - moshekaplan/tkinter_components + """ # XXX ToDo: cget and configure datetime = calendar.datetime.datetime timedelta = calendar.datetime.timedelta def __init__(self, master=None, target_element=None, close_when_chosen=True, default_date=(None, None, None), **kw): - """WIDGET-SPECIFIC OPTIONS - + """ + WIDGET-SPECIFIC OPTIONS + locale, firstweekday, year, month, selectbackground, selectforeground - - :param master: (Default value = None) - :param target_element: (Default value = None) - :param close_when_chosen: (Default value = True) - :param default_date: (Default value = (None) - :param None:, None)) - :param **kw: - """ self._TargetElement = target_element default_mon, default_day, default_year = default_date @@ -3734,12 +3261,6 @@ class TKCalendar(ttk.Frame): self._build_calendar() def __setitem__(self, item, value): - """ - - :param item: - :param value: - - """ if item in ('year', 'month'): raise AttributeError("attribute '%s' is not writeable" % item) elif item == 'selectbackground': @@ -3750,11 +3271,6 @@ class TKCalendar(ttk.Frame): ttk.Frame.__setitem__(self, item, value) def __getitem__(self, item): - """ - - :param item: - - """ if item in ('year', 'month'): return getattr(self._date, item) elif item == 'selectbackground': @@ -3766,7 +3282,6 @@ class TKCalendar(ttk.Frame): return r[item] def __setup_styles(self): - """ """ # custom ttk styles style = ttk.Style(self.master) arrow_layout = lambda dir: ( @@ -3776,7 +3291,6 @@ class TKCalendar(ttk.Frame): style.layout('R.TButton', arrow_layout('right')) def __place_widgets(self): - """ """ # header frame and its widgets hframe = ttk.Frame(self) lbtn = ttk.Button(hframe, style='L.TButton', command=self._prev_month) @@ -3793,7 +3307,6 @@ class TKCalendar(ttk.Frame): self._calendar.pack(in_=self, expand=1, fill='both', side='bottom') def __config_calendar(self): - """ """ cols = self._cal.formatweekheader(3).split() self._calendar['columns'] = cols self._calendar.tag_configure('header', background='grey90') @@ -3806,12 +3319,6 @@ class TKCalendar(ttk.Frame): anchor='e') def __setup_selection(self, sel_bg, sel_fg): - """ - - :param sel_bg: - :param sel_fg: - - """ self._font = tkinter.font.Font() self._canvas = canvas = tk.Canvas(self._calendar, background=sel_bg, borderwidth=0, highlightthickness=0) @@ -3822,17 +3329,11 @@ class TKCalendar(ttk.Frame): self._calendar.bind('', self._pressed) def __minsize(self, evt): - """ - - :param evt: - - """ width, height = self._calendar.master.geometry().split('x') height = height[:height.index('+')] self._calendar.master.minsize(width, height) def _build_calendar(self): - """ """ year, month = self._date.year, self._date.month # update header text (Month, YEAR) @@ -3847,12 +3348,7 @@ class TKCalendar(ttk.Frame): self._calendar.item(item, values=fmt_week) def _show_selection(self, text, bbox): - """Configure canvas for a new selection. - - :param text: - :param bbox: - - """ + """Configure canvas for a new selection.""" x, y, width, height = bbox textw = self._font.measure(text) @@ -3866,11 +3362,7 @@ class TKCalendar(ttk.Frame): # Callbacks def _pressed(self, evt): - """Clicked somewhere in the calendar. - - :param evt: - - """ + """Clicked somewhere in the calendar.""" x, y, widget = evt.x, evt.y, evt.widget item = widget.identify_row(y) column = widget.identify_column(x) @@ -3932,7 +3424,7 @@ class TKCalendar(ttk.Frame): @property def selection(self): - """ """ + """Return a datetime representing the current selected date.""" if not self._selection: return None @@ -3944,22 +3436,21 @@ class TKCalendar(ttk.Frame): # Menu # # ---------------------------------------------------------------------- # class Menu(Element): - """ """ - + ''' + + ''' def __init__(self, menu_definition, background_color=None, size=(None, None), tearoff=False, pad=None, key=None, visible=True): - """ + ''' - :param menu_definition: - :param background_color: color of background (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param tearoff: (Default value = False) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param menu_definition: + :param background_color: + :param size: + :param tearoff: + :param pad: + :param key: + :param visible: + ''' self.BackgroundColor = background_color if background_color is not None else DEFAULT_BACKGROUND_COLOR self.MenuDefinition = menu_definition self.TKMenu = None # type: tk.Menu @@ -3971,11 +3462,6 @@ class Menu(Element): return def _MenuItemChosenCallback(self, item_chosen): # Menu Menu Item Chosen Callback - """ - - :param item_chosen: - - """ # print('IN MENU ITEM CALLBACK', item_chosen) self.MenuItemChosen = item_chosen self.ParentForm.LastButtonClicked = item_chosen @@ -3984,13 +3470,12 @@ class Menu(Element): self.ParentForm.TKroot.quit() # kick the users out of the mainloop def Update(self, menu_definition, visible=None): - """ + ''' - :param menu_definition: - :param visible: change visibility of element (Default value = None) - - """ - + :param menu_definition: + :param visible: + :return: + ''' self.MenuDefinition = menu_definition self.TKMenu = tk.Menu(self.ParentForm.TKroot, tearoff=self.Tearoff) # create the menubar menubar = self.TKMenu @@ -4014,7 +3499,6 @@ class Menu(Element): # TODO add visible code for menus def __del__(self): - """ """ super().__del__() @@ -4025,47 +3509,46 @@ MenuBar = Menu # another name for Menu to make it clear it's the Menu Bar # Table # # ---------------------------------------------------------------------- # class Table(Element): - """ """ - + ''' + + ''' def __init__(self, values, headings=None, visible_column_map=None, col_widths=None, def_col_width=10, auto_size_columns=True, max_col_width=20, select_mode=None, display_row_numbers=False, num_rows=None, row_height=None, font=None, justification='right', text_color=None, background_color=None, alternating_row_color=None, row_colors=None, vertical_scroll_only=True, hide_vertical_scroll=False, size=(None, None), change_submits=False, enable_events=False, bind_return_key=False, pad=None, key=None, tooltip=None, right_click_menu=None, visible=True): - """ + ''' - :param values: - :param headings: (Default value = None) - :param visible_column_map: (Default value = None) - :param col_widths: (Default value = None) - :param def_col_width: (Default value = 10) - :param auto_size_columns: (Default value = True) - :param max_col_width: (Default value = 20) - :param select_mode: (Default value = None) - :param display_row_numbers: (Default value = False) - :param num_rows: (Default value = None) - :param row_height: (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param justification: (Default value = 'right') - :param text_color: color of the text (Default value = None) - :param background_color: color of background (Default value = None) - :param alternating_row_color: (Default value = None) - :param row_colors: (Default value = None) - :param vertical_scroll_only: (Default value = True) - :param hide_vertical_scroll: (Default value = False) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param change_submits: If True, pressing Enter key submits window (Default value = False) - :param enable_events: Turns on the element specific events.(Default value = False) - :param bind_return_key: (Default value = False) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param right_click_menu: see "Right Click Menus" (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param values: + :param headings: + :param visible_column_map: + :param col_widths: + :param def_col_width: + :param auto_size_columns: + :param max_col_width: + :param select_mode: + :param display_row_numbers: + :param num_rows: + :param row_height: + :param font: + :param justification: + :param text_color: + :param background_color: + :param alternating_row_color: + :param row_colors: + :param vertical_scroll_only: + :param hide_vertical_scroll: + :param size: + :param change_submits: + :param enable_events: + :param bind_return_key: + :param pad: + :param key: + :param tooltip: + :param right_click_menu: + :param visible: + ''' self.Values = values self.ColumnHeadings = headings self.ColumnsToDisplay = visible_column_map @@ -4098,15 +3581,14 @@ class Table(Element): return def Update(self, values=None, num_rows=None, visible=None, select_rows=None): - """ + ''' - :param values: (Default value = None) - :param num_rows: (Default value = None) - :param visible: change visibility of element (Default value = None) - :param select_rows: (Default value = None) - - """ - + :param values: + :param num_rows: + :param visible: + :param select_rows: + :return: + ''' if values is not None: children = self.TKTreeview.get_children() for i in children: @@ -4133,11 +3615,6 @@ class Table(Element): self.TKTreeview.selection_set(rows_to_select) def treeview_selected(self, event): - """ - - :param event: - - """ selections = self.TKTreeview.selection() self.SelectedRows = [int(x) - 1 for x in selections] if self.ChangeSubmits: @@ -4151,11 +3628,6 @@ class Table(Element): self.ParentForm.TKroot.quit() def treeview_double_click(self, event): - """ - - :param event: - - """ selections = self.TKTreeview.selection() self.SelectedRows = [int(x) - 1 for x in selections] if self.BindReturnKey: @@ -4169,7 +3641,6 @@ class Table(Element): self.ParentForm.TKroot.quit() def __del__(self): - """ """ super().__del__() @@ -4177,41 +3648,40 @@ class Table(Element): # Tree # # ---------------------------------------------------------------------- # class Tree(Element): - """ """ - + ''' + + ''' def __init__(self, data=None, headings=None, visible_column_map=None, col_widths=None, col0_width=10, def_col_width=10, auto_size_columns=True, max_col_width=20, select_mode=None, show_expanded=False, change_submits=False, enable_events=False, font=None, justification='right', text_color=None, background_color=None, num_rows=None, row_height=None, pad=None, key=None, tooltip=None, right_click_menu=None, visible=True): - """ + ''' - :param data: (Default value = None) - :param headings: (Default value = None) - :param visible_column_map: (Default value = None) - :param col_widths: (Default value = None) - :param col0_width: (Default value = 10) - :param def_col_width: (Default value = 10) - :param auto_size_columns: (Default value = True) - :param max_col_width: (Default value = 20) - :param select_mode: (Default value = None) - :param show_expanded: (Default value = False) - :param change_submits: If True, pressing Enter key submits window (Default value = False) - :param enable_events: Turns on the element specific events.(Default value = False) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param justification: (Default value = 'right') - :param text_color: color of the text (Default value = None) - :param background_color: color of background (Default value = None) - :param num_rows: (Default value = None) - :param row_height: (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param right_click_menu: see "Right Click Menus" (Default value = None) - :param visible: set visibility state of the element (Default value = True) - - """ - + :param data: + :param headings: + :param visible_column_map: + :param col_widths: + :param col0_width: + :param def_col_width: + :param auto_size_columns: + :param max_col_width: + :param select_mode: + :param show_expanded: + :param change_submits: + :param enable_events: + :param font: + :param justification: + :param text_color: + :param background_color: + :param num_rows: + :param row_height: + :param pad: + :param key: + :param tooltip: + :param right_click_menu: + :param visible: + ''' self.TreeData = data self.ColumnHeadings = headings self.ColumnsToDisplay = visible_column_map @@ -4239,11 +3709,6 @@ class Tree(Element): return def treeview_selected(self, event): - """ - - :param event: - - """ selections = self.TKTreeview.selection() self.SelectedRows = [x for x in selections] if self.ChangeSubmits: @@ -4257,11 +3722,6 @@ class Tree(Element): self.ParentForm.TKroot.quit() def add_treeview_data(self, node): - """ - - :param node: - - """ # print(f'Inserting {node.key} under parent {node.parent}') if node.key != '': if node.icon: @@ -4283,17 +3743,16 @@ class Tree(Element): self.add_treeview_data(node) def Update(self, values=None, key=None, value=None, text=None, icon=None, visible=None): - """ + ''' - :param values: (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param value: (Default value = None) - :param text: (Default value = None) - :param icon: (Default value = None) - :param visible: change visibility of element (Default value = None) - - """ - + :param values: + :param key: + :param value: + :param text: + :param icon: + :param visible: + :return: + ''' if values is not None: children = self.TKTreeview.get_children() for i in children: @@ -4327,24 +3786,12 @@ class Tree(Element): return self def __del__(self): - """ """ super().__del__() class TreeData(object): - """ """ class Node(object): - """ """ def __init__(self, parent, key, text, values, icon=None): - """ - - :param parent: - :param key: (common_key) Used with window.FindElement and with return values - :param text: - :param values: - :param icon: (Default value = None) - - """ self.parent = parent self.children = [] self.key = key @@ -4353,54 +3800,26 @@ class TreeData(object): self.icon = icon def _Add(self, node): - """ - - :param node: - - """ self.children.append(node) def __init__(self): - """ """ self.tree_dict = {} self.root_node = self.Node("", "", 'root', [], None) self.tree_dict[""] = self.root_node def _AddNode(self, key, node): - """ - - :param key: (common_key) Used with window.FindElement and with return values - :param node: - - """ self.tree_dict[key] = node def Insert(self, parent, key, text, values, icon=None): - """ - - :param parent: - :param key: (common_key) Used with window.FindElement and with return values - :param text: - :param values: - :param icon: (Default value = None) - - """ node = self.Node(parent, key, text, values, icon) self.tree_dict[key] = node parent_node = self.tree_dict[parent] parent_node._Add(node) def __repr__(self): - """ """ return self._NodeStr(self.root_node, 1) def _NodeStr(self, node, level): - """ - - :param node: - :param level: - - """ return '\n'.join( [str(node.key) + ' : ' + str(node.text)] + [' ' * 4 * level + self._NodeStr(child, level + 1) for child in node.children]) @@ -4410,26 +3829,17 @@ class TreeData(object): # Error Element # # ---------------------------------------------------------------------- # class ErrorElement(Element): - """ """ def __init__(self, key=None): - """Error Element - - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ + ''' + Error Element + :param key: + ''' self.Key = key super().__init__(ELEM_TYPE_ERROR, key=key) return def Update(self, silent_on_error=True, *args, **kwargs): - """ - - :param silent_on_error: (Default value = True) - :param *args: - :param **kwargs: - - """ if not silent_on_error: PopupError('Keyword error in Update', 'You need to stop this madness and check your spelling', @@ -4439,11 +3849,9 @@ class ErrorElement(Element): return self def Get(self): - """ """ return 'This is NOT a valid Element!\nSTOP trying to do things with it or I will have to crash at some point!' def __del__(self): - """ """ super().__del__() @@ -4458,8 +3866,9 @@ Stretch = ErrorElement # Window CLASS # # ------------------------------------------------------------------------- # class Window: - """ """ - + ''' + + ''' NumOpenWindows = 0 user_defined_icon = None hidden_master_root = None @@ -4476,43 +3885,41 @@ class Window: alpha_channel=1, return_keyboard_events=False, use_default_focus=True, text_justification=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, resizable=False, disable_close=False, disable_minimize=False, right_click_menu=None, transparent_color=None, debugger_enabled=True): - """ + ''' - :param title: - :param layout: (Default value = None) - :param default_element_size: (Default value = DEFAULT_ELEMENT_SIZE) - :param default_button_element_size: (Default value = (None, None)) - :param auto_size_text: True if size should fit the text length (Default value = None) - :param auto_size_buttons: (Default value = None) - :param location: (Default value = (None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) - :param element_padding: (Default value = None) - :param margins: (Default value = (None) - :param button_color: (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param progress_bar_color: (Default value = (None) - :param background_color: color of background (Default value = None) - :param border_depth: (Default value = None) - :param auto_close: (Default value = False) - :param auto_close_duration: (Default value = DEFAULT_AUTOCLOSE_TIME) - :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) - :param force_toplevel: (Default value = False) - :param alpha_channel: (Default value = 1) - :param return_keyboard_events: (Default value = False) - :param use_default_focus: (Default value = True) - :param text_justification: (Default value = None) - :param no_titlebar: (Default value = False) - :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) - :param location: Location on screen to display (Default value = (None, None)) - :param resizable: (Default value = False) - :param disable_close: (Default value = False) - :param disable_minimize: (Default value = False) - :param right_click_menu: see "Right Click Menus" (Default value = None) - :param transparent_color: (Default value = None) - :param debugger_enabled: (Default value = True) - - """ - + :param title: + :param layout: + :param default_element_size: + :param default_button_element_size: + :param auto_size_text: + :param auto_size_buttons: + :param location: + :param size: + :param element_padding: + :param margins: + :param button_color: + :param font: + :param progress_bar_color: + :param background_color: + :param border_depth: + :param auto_close: + :param auto_close_duration: + :param icon: + :param force_toplevel: + :param alpha_channel: + :param return_keyboard_events: + :param use_default_focus: + :param text_justification: + :param no_titlebar: + :param grab_anywhere: + :param keep_on_top: + :param resizable: + :param disable_close: + :param disable_minimize: + :param right_click_menu: + :param transparent_color: + :param debugger_enabled: + ''' 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.Title = title @@ -4577,29 +3984,22 @@ class Window: @classmethod def GetAContainerNumber(cls): - """ """ cls.container_element_counter += 1 return cls.container_element_counter @classmethod def IncrementOpenCount(self): - """ """ self.NumOpenWindows += 1 # print('+++++ INCREMENTING Num Open Windows = {} ---'.format(Window.NumOpenWindows)) @classmethod def DecrementOpenCount(self): - """ """ self.NumOpenWindows -= 1 * (self.NumOpenWindows != 0) # decrement if not 0 # print('----- DECREMENTING Num Open Windows = {} ---'.format(Window.NumOpenWindows)) # ------------------------- Add ONE Row to Form ------------------------- # def AddRow(self, *args): - """Parms are a variable number of Elements - - :param *args: - - """ + ''' Parms are a variable number of Elements ''' NumRows = len(self.Rows) # number of existing rows is our row number CurrentRowNumber = NumRows # this row's number CurrentRow = [] # start with a blank row and build up @@ -4632,31 +4032,15 @@ class Window: # ------------------------- Add Multiple Rows to Form ------------------------- # def AddRows(self, rows): - """ - - :param rows: - - """ for row in rows: self.AddRow(*row) def Layout(self, rows): - """ - - :param rows: - - """ self.AddRows(rows) self.BuildKeyDict() return self def LayoutAndRead(self, rows, non_blocking=False): - """ - - :param rows: - :param non_blocking: (Default value = False) - - """ raise DeprecationWarning( 'LayoutAndRead is no longer supported... change your call window.Layout(layout).Read()') # self.AddRows(rows) @@ -4664,20 +4048,10 @@ class Window: # return self.ReturnValues def LayoutAndShow(self, rows): - """ - - :param rows: - - """ raise DeprecationWarning('LayoutAndShow is no longer supported... ') # ------------------------- ShowForm THIS IS IT! ------------------------- # def Show(self, non_blocking=False): - """ - - :param non_blocking: (Default value = False) - - """ self.Shown = True # Compute num rows & num cols (it'll come in handy debugging) self.NumRows = len(self.Rows) @@ -4713,12 +4087,6 @@ class Window: # ------------------------- SetIcon - set the window's fav icon ------------------------- # def SetIcon(self, icon=None, pngbase64=None): - """ - - :param icon: (Default value = None) - :param pngbase64: (Default value = None) - - """ if type(icon) is bytes: wicon = tkinter.PhotoImage(data=icon) try: @@ -4741,22 +4109,15 @@ class Window: pass def _GetElementAtLocation(self, location): - """ - - :param location: - - """ (row_num, col_num) = location row = self.Rows[row_num] element = row[col_num] return element def _GetDefaultElementSize(self): - """ """ return self.DefaultElementSize def _AutoCloseAlarmCallback(self): - """ """ try: window = self if window: @@ -4770,7 +4131,6 @@ class Window: pass def _TimeoutAlarmCallback(self): - """ """ # first, get the results table built # modify the Results table in the parent FlexForm object # print('TIMEOUT CALLBACK') @@ -4782,12 +4142,6 @@ class Window: self.TKroot.quit() # kick the users out of the mainloop def Read(self, timeout=None, timeout_key=TIMEOUT_KEY): - """ - - :param timeout: (Default value = None) - :param timeout_key: (Default value = TIMEOUT_KEY) - - """ # ensure called only 1 time through a single read cycle if not Window.read_call_from_debugger: refresh_debugger() @@ -4891,7 +4245,6 @@ class Window: return self.ReturnValues def ReadNonBlocking(self): - """ """ if self.TKrootDestroyed: try: self.TKroot.quit() @@ -4921,7 +4274,6 @@ class Window: return BuildResults(self, False, self) def Finalize(self): - """ """ if self.TKrootDestroyed: return self if not self.Shown: @@ -4936,7 +4288,6 @@ class Window: return self def Refresh(self): - """ """ if self.TKrootDestroyed: return self try: @@ -4946,21 +4297,10 @@ class Window: return self def Fill(self, values_dict): - """ - - :param values_dict: - - """ FillFormWithValues(self, values_dict) return self def FindElement(self, key, silent_on_error=False): - """ - - :param key: (common_key) Used with window.FindElement and with return values - :param silent_on_error: (Default value = False) - - """ # print(f'In find elem key={key}', self.AllKeysDict) try: @@ -4983,24 +4323,15 @@ class Window: Find = FindElement def FindElementWithFocus(self): - """ """ element = _FindElementWithFocusInSubForm(self) return element def BuildKeyDict(self): - """ """ dict = {} self.AllKeysDict = self._BuildKeyDictForWindow(self, self, dict) # print(f'keys built = {self.AllKeysDict}') def _BuildKeyDictForWindow(self, top_window, window, key_dict): - """ - - :param top_window: - :param window: - :param key_dict: - - """ for row_num, row in enumerate(window.Rows): for col_num, element in enumerate(row): if element.Type == ELEM_TYPE_COLUMN: @@ -5035,11 +4366,6 @@ class Window: return key_dict def SaveToDisk(self, filename): - """ - - :param filename: - - """ try: results = BuildResults(self, False, self) with open(filename, 'wb') as sf: @@ -5048,11 +4374,6 @@ class Window: print('*** Error saving form to disk ***') def LoadFromDisk(self, filename): - """ - - :param filename: - - """ try: with open(filename, 'rb') as df: self.Fill(pickle.load(df)) @@ -5060,7 +4381,6 @@ class Window: print('*** Error loading form to disk ***') def GetScreenDimensions(self): - """ """ if self.TKrootDestroyed: return None, None screen_width = self.TKroot.winfo_screenwidth() # get window info to move to middle of screen @@ -5068,23 +4388,15 @@ class Window: return screen_width, screen_height def Move(self, x, y): - """ - - :param x: - :param y: - - """ try: self.TKroot.geometry("+%s+%s" % (x, y)) except: pass def Minimize(self): - """ """ self.TKroot.iconify() def Maximize(self): - """ """ if sys.platform != 'linux': self.TKroot.state('zoomed') else: @@ -5093,18 +4405,12 @@ class Window: # self.TKroot.attributes('-fullscreen', True) def Normal(self): - """ """ if sys.platform != 'linux': self.TKroot.state('normal') else: self.TKroot.attributes('-fullscreen', False) def StartMove(self, event): - """ - - :param event: - - """ try: self.TKroot.x = event.x self.TKroot.y = event.y @@ -5113,11 +4419,6 @@ class Window: # print('Start move {},{}'.format(event.x,event.y)) def StopMove(self, event): - """ - - :param event: - - """ try: self.TKroot.x = None self.TKroot.y = None @@ -5126,11 +4427,6 @@ class Window: # print('-Stop- move {},{}'.format(event.x,event.y)) def OnMotion(self, event): - """ - - :param event: - - """ try: deltax = event.x - self.TKroot.x deltay = event.y - self.TKroot.y @@ -5142,11 +4438,6 @@ class Window: pass def _KeyboardCallback(self, event): - """ - - :param event: - - """ self.LastButtonClicked = None self.FormRemainedOpen = True if event.char != '': @@ -5159,11 +4450,6 @@ class Window: self.TKroot.quit() def _MouseWheelCallback(self, event): - """ - - :param event: - - """ self.LastButtonClicked = None self.FormRemainedOpen = True self.LastKeyboardEvent = 'MouseWheel:Down' if event.delta < 0 else 'MouseWheel:Up' @@ -5173,7 +4459,6 @@ class Window: self.TKroot.quit() def _Close(self): - """ """ try: self.TKroot.update() except: @@ -5187,7 +4472,6 @@ class Window: return None def Close(self): - """ """ if self.TKrootDestroyed: return try: @@ -5209,7 +4493,6 @@ class Window: # IT FINALLY WORKED! 29-Oct-2018 was the first time this damned thing got called def OnClosingCallback(self): - """ """ # global _my_windows # print('Got closing callback', self.DisableClose) if self.DisableClose: @@ -5228,85 +4511,63 @@ class Window: return def Disable(self): - """ """ self.TKroot.attributes('-disabled', 1) # self.TKroot.grab_set_global() def Enable(self): - """ """ self.TKroot.attributes('-disabled', 0) # self.TKroot.grab_release() def Hide(self): - """ """ self._Hidden = True self.TKroot.withdraw() def UnHide(self): - """ """ if self._Hidden: self.TKroot.deiconify() self._Hidden = False def Disappear(self): - """ """ self.TKroot.attributes('-alpha', 0) def Reappear(self): - """ """ self.TKroot.attributes('-alpha', 255) def SetAlpha(self, alpha): - """ - - :param alpha: - - """ - # Change the window's transparency - # :param alpha: From 0 to 1 with 0 being completely transparent + ''' + Change the window's transparency + :param alpha: From 0 to 1 with 0 being completely transparent + :return: + ''' self._AlphaChannel = alpha self.TKroot.attributes('-alpha', alpha) @property def AlphaChannel(self): - """ """ return self._AlphaChannel @AlphaChannel.setter def AlphaChannel(self, alpha): - """ - - :param alpha: - - """ self._AlphaChannel = alpha self.TKroot.attributes('-alpha', alpha) def BringToFront(self): - """ """ try: self.TKroot.lift() except: pass def CurrentLocation(self): - """ """ return int(self.TKroot.winfo_x()), int(self.TKroot.winfo_y()) @property def Size(self): - """ """ win_width = self.TKroot.winfo_width() win_height = self.TKroot.winfo_height() return win_width, win_height @Size.setter def Size(self, size): - """ - - :param size: (common_key) - - """ try: self.TKroot.geometry("%sx%s" % (size[0], size[1])) self.TKroot.update_idletasks() @@ -5314,77 +4575,50 @@ class Window: pass def VisibilityChanged(self): - """ """ # A dummy function. Needed in Qt but not tkinter return def SetTransparentColor(self, color): - """ - - :param color: - - """ try: self.TKroot.attributes('-transparentcolor', color) except: print('Transparent color not supported on this platform (windows only)') def GrabAnyWhereOn(self): - """ """ self.TKroot.bind("", self.StartMove) self.TKroot.bind("", self.StopMove) self.TKroot.bind("", self.OnMotion) def GrabAnyWhereOff(self): - """ """ self.TKroot.unbind("") self.TKroot.unbind("") self.TKroot.unbind("") def _callback_main_debugger_window_create_keystroke(self, event): - """ - - :param event: - - """ - _Debugger.debugger._build_main_debugger_window() + Debugger.debugger._build_main_debugger_window() def _callback_popout_window_create_keystroke(self, event): - """ - - :param event: - - """ - _Debugger.debugger._build_floating_window() + Debugger.debugger._build_floating_window() def EnableDebugger(self): - """ """ self.TKroot.bind('', self._callback_main_debugger_window_create_keystroke) self.TKroot.bind('', self._callback_popout_window_create_keystroke) self.DebuggerEnabled = True def DisableDebugger(self): - """ """ self.TKroot.unbind("") self.TKroot.unbind("") self.DebuggerEnabled = False def __enter__(self): - """ """ return self def __exit__(self, *a): - """ - - :param *a: - - """ self.__del__() return False def __del__(self): - """ """ # print('DELETING WINDOW') for row in self.Rows: for element in row: @@ -5410,24 +4644,23 @@ FlexForm = Window def FolderBrowse(button_text='Browse', target=(ThisRow, -1), initial_folder=None, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, disabled=False, change_submits=False, enable_events=False, font=None, pad=None, key=None): - """ + ''' - :param button_text: (Default value = 'Browse') - :param target: (Default value = (ThisRow, -1)) - :param initial_folder: (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param change_submits: If True, pressing Enter key submits window (Default value = False) - :param enable_events: Turns on the element specific events.(Default value = False) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ - + :param button_text: + :param target: + :param initial_folder: + :param tooltip: + :param size: + :param auto_size_button: + :param button_color: + :param disabled: + :param change_submits: + :param enable_events: + :param font: + :param pad: + :param key: + :return: + ''' return Button(button_text=button_text, button_type=BUTTON_TYPE_BROWSE_FOLDER, target=target, initial_folder=initial_folder, tooltip=tooltip, size=size, auto_size_button=auto_size_button, disabled=disabled, button_color=button_color, change_submits=change_submits, @@ -5439,24 +4672,6 @@ def FileBrowse(button_text='Browse', target=(ThisRow, -1), file_types=(("ALL Fil tooltip=None, size=(None, None), auto_size_button=None, button_color=None, change_submits=False, enable_events=False, font=None, disabled=False, pad=None, key=None): - """ - - :param button_text: (Default value = 'Browse') - :param target: (Default value = (ThisRow, -1)) - :param file_types: (Default value = (("ALL Files", "*.*"))) - :param initial_folder: (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param change_submits: If True, pressing Enter key submits window (Default value = False) - :param enable_events: Turns on the element specific events.(Default value = False) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_BROWSE_FILE, target=target, file_types=file_types, initial_folder=initial_folder, tooltip=tooltip, size=size, auto_size_button=auto_size_button, change_submits=change_submits, enable_events=enable_events, disabled=disabled, @@ -5468,24 +4683,6 @@ def FilesBrowse(button_text='Browse', target=(ThisRow, -1), file_types=(("ALL Fi initial_folder=None, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, change_submits=False, enable_events=False, font=None, pad=None, key=None): - """ - - :param button_text: (Default value = 'Browse') - :param target: (Default value = (ThisRow, -1)) - :param file_types: (Default value = (("ALL Files", "*.*"))) - :param disabled: set disable state for element (Default value = False) - :param initial_folder: (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param change_submits: If True, pressing Enter key submits window (Default value = False) - :param enable_events: Turns on the element specific events.(Default value = False) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_BROWSE_FILES, target=target, file_types=file_types, initial_folder=initial_folder, change_submits=change_submits, enable_events=enable_events, tooltip=tooltip, size=size, auto_size_button=auto_size_button, @@ -5497,24 +4694,6 @@ def FileSaveAs(button_text='Save As...', target=(ThisRow, -1), file_types=(("ALL disabled=False, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, change_submits=False, enable_events=False, font=None, pad=None, key=None): - """ - - :param button_text: (Default value = 'Save As...') - :param target: (Default value = (ThisRow, -1)) - :param file_types: (Default value = (("ALL Files", "*.*"))) - :param initial_folder: (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param change_submits: If True, pressing Enter key submits window (Default value = False) - :param enable_events: Turns on the element specific events.(Default value = False) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_SAVEAS_FILE, target=target, file_types=file_types, initial_folder=initial_folder, tooltip=tooltip, size=size, disabled=disabled, auto_size_button=auto_size_button, button_color=button_color, change_submits=change_submits, @@ -5526,24 +4705,6 @@ def SaveAs(button_text='Save As...', target=(ThisRow, -1), file_types=(("ALL Fil disabled=False, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, change_submits=False, enable_events=False, font=None, pad=None, key=None): - """ - - :param button_text: (Default value = 'Save As...') - :param target: (Default value = (ThisRow, -1)) - :param file_types: (Default value = (("ALL Files", "*.*"))) - :param initial_folder: (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param change_submits: If True, pressing Enter key submits window (Default value = False) - :param enable_events: Turns on the element specific events.(Default value = False) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_SAVEAS_FILE, target=target, file_types=file_types, initial_folder=initial_folder, tooltip=tooltip, size=size, disabled=disabled, auto_size_button=auto_size_button, button_color=button_color, change_submits=change_submits, @@ -5553,21 +4714,6 @@ def SaveAs(button_text='Save As...', target=(ThisRow, -1), file_types=(("ALL Fil # ------------------------- SAVE BUTTON Element lazy function ------------------------- # def Save(button_text='Save', size=(None, None), auto_size_button=None, button_color=None, bind_return_key=True, disabled=False, tooltip=None, font=None, focus=False, pad=None, key=None): - """ - - :param button_text: (Default value = 'Save') - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param bind_return_key: (Default value = True) - :param disabled: set disable state for element (Default value = False) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -5576,21 +4722,6 @@ def Save(button_text='Save', size=(None, None), auto_size_button=None, button_co # ------------------------- SUBMIT BUTTON Element lazy function ------------------------- # def Submit(button_text='Submit', size=(None, None), auto_size_button=None, button_color=None, disabled=False, bind_return_key=True, tooltip=None, font=None, focus=False, pad=None, key=None): - """ - - :param button_text: (Default value = 'Submit') - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param bind_return_key: (Default value = True) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -5600,21 +4731,6 @@ def Submit(button_text='Submit', size=(None, None), auto_size_button=None, butto # ------------------------- OPEN BUTTON Element lazy function ------------------------- # def Open(button_text='Open', size=(None, None), auto_size_button=None, button_color=None, disabled=False, bind_return_key=True, tooltip=None, font=None, focus=False, pad=None, key=None): - """ - - :param button_text: (Default value = 'Open') - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param bind_return_key: (Default value = True) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -5623,21 +4739,6 @@ def Open(button_text='Open', size=(None, None), auto_size_button=None, button_co # ------------------------- OK BUTTON Element lazy function ------------------------- # def OK(button_text='OK', size=(None, None), auto_size_button=None, button_color=None, disabled=False, bind_return_key=True, tooltip=None, font=None, focus=False, pad=None, key=None): - """ - - :param button_text: (Default value = 'OK') - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param bind_return_key: (Default value = True) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -5646,21 +4747,6 @@ def OK(button_text='OK', size=(None, None), auto_size_button=None, button_color= # ------------------------- YES BUTTON Element lazy function ------------------------- # def Ok(button_text='Ok', size=(None, None), auto_size_button=None, button_color=None, disabled=False, bind_return_key=True, tooltip=None, font=None, focus=False, pad=None, key=None): - """ - - :param button_text: (Default value = 'Ok') - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param bind_return_key: (Default value = True) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -5669,21 +4755,6 @@ def Ok(button_text='Ok', size=(None, None), auto_size_button=None, button_color= # ------------------------- CANCEL BUTTON Element lazy function ------------------------- # def Cancel(button_text='Cancel', size=(None, None), auto_size_button=None, button_color=None, disabled=False, tooltip=None, font=None, bind_return_key=False, focus=False, pad=None, key=None): - """ - - :param button_text: (Default value = 'Cancel') - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param bind_return_key: (Default value = False) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -5692,21 +4763,6 @@ def Cancel(button_text='Cancel', size=(None, None), auto_size_button=None, butto # ------------------------- QUIT BUTTON Element lazy function ------------------------- # def Quit(button_text='Quit', size=(None, None), auto_size_button=None, button_color=None, disabled=False, tooltip=None, font=None, bind_return_key=False, focus=False, pad=None, key=None): - """ - - :param button_text: (Default value = 'Quit') - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param bind_return_key: (Default value = False) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -5715,21 +4771,6 @@ def Quit(button_text='Quit', size=(None, None), auto_size_button=None, button_co # ------------------------- Exit BUTTON Element lazy function ------------------------- # def Exit(button_text='Exit', size=(None, None), auto_size_button=None, button_color=None, disabled=False, tooltip=None, font=None, bind_return_key=False, focus=False, pad=None, key=None): - """ - - :param button_text: (Default value = 'Exit') - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param bind_return_key: (Default value = False) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -5738,21 +4779,6 @@ def Exit(button_text='Exit', size=(None, None), auto_size_button=None, button_co # ------------------------- YES BUTTON Element lazy function ------------------------- # def Yes(button_text='Yes', size=(None, None), auto_size_button=None, button_color=None, disabled=False, tooltip=None, font=None, bind_return_key=True, focus=False, pad=None, key=None): - """ - - :param button_text: (Default value = 'Yes') - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param bind_return_key: (Default value = True) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -5761,21 +4787,6 @@ def Yes(button_text='Yes', size=(None, None), auto_size_button=None, button_colo # ------------------------- NO BUTTON Element lazy function ------------------------- # def No(button_text='No', size=(None, None), auto_size_button=None, button_color=None, disabled=False, tooltip=None, font=None, bind_return_key=False, focus=False, pad=None, key=None): - """ - - :param button_text: (Default value = 'No') - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param bind_return_key: (Default value = False) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -5784,21 +4795,6 @@ def No(button_text='No', size=(None, None), auto_size_button=None, button_color= # ------------------------- NO BUTTON Element lazy function ------------------------- # def Help(button_text='Help', size=(None, None), auto_size_button=None, button_color=None, disabled=False, font=None, tooltip=None, bind_return_key=False, focus=False, pad=None, key=None): - """ - - :param button_text: (Default value = 'Help') - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param bind_return_key: (Default value = False) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -5807,21 +4803,6 @@ def Help(button_text='Help', size=(None, None), auto_size_button=None, button_co # ------------------------- NO BUTTON Element lazy function ------------------------- # def Debug(button_text='', size=(None, None), auto_size_button=None, button_color=None, disabled=False, font=None, tooltip=None, bind_return_key=False, focus=False, pad=None, key=None): - """ - - :param button_text: (Default value = '') - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param bind_return_key: (Default value = False) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_SHOW_DEBUGGER, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=COLOR_SYSTEM_DEFAULT, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key, image_data=PSG_DEBUGGER_LOGO, @@ -5832,26 +4813,6 @@ def Debug(button_text='', size=(None, None), auto_size_button=None, button_color def SimpleButton(button_text, image_filename=None, image_data=None, image_size=(None, None), image_subsample=None, border_width=None, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, font=None, bind_return_key=False, disabled=False, focus=False, pad=None, key=None): - """ - - :param button_text: - :param image_filename: (Default value = None) - :param image_data: (Default value = None) - :param image_size: (Default value = (None, None)) - :param image_subsample: (Default value = None) - :param border_width: (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param bind_return_key: (Default value = False) - :param disabled: set disable state for element (Default value = False) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_CLOSES_WIN, image_filename=image_filename, image_data=image_data, image_size=image_size, image_subsample=image_subsample, border_width=border_width, tooltip=tooltip, disabled=disabled, size=size, @@ -5863,26 +4824,6 @@ def SimpleButton(button_text, image_filename=None, image_data=None, image_size=( def CloseButton(button_text, image_filename=None, image_data=None, image_size=(None, None), image_subsample=None, border_width=None, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, font=None, bind_return_key=False, disabled=False, focus=False, pad=None, key=None): - """ - - :param button_text: - :param image_filename: (Default value = None) - :param image_data: (Default value = None) - :param image_size: (Default value = (None, None)) - :param image_subsample: (Default value = None) - :param border_width: (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param bind_return_key: (Default value = False) - :param disabled: set disable state for element (Default value = False) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_CLOSES_WIN, image_filename=image_filename, image_data=image_data, image_size=image_size, image_subsample=image_subsample, border_width=border_width, tooltip=tooltip, disabled=disabled, size=size, @@ -5897,26 +4838,6 @@ CButton = CloseButton def ReadButton(button_text, image_filename=None, image_data=None, image_size=(None, None), image_subsample=None, border_width=None, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, font=None, bind_return_key=False, disabled=False, focus=False, pad=None, key=None): - """ - - :param button_text: - :param image_filename: (Default value = None) - :param image_data: (Default value = None) - :param image_size: (Default value = (None, None)) - :param image_subsample: (Default value = None) - :param border_width: (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param bind_return_key: (Default value = False) - :param disabled: set disable state for element (Default value = False) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, image_filename=image_filename, image_data=image_data, image_size=image_size, image_subsample=image_subsample, border_width=border_width, tooltip=tooltip, size=size, disabled=disabled, @@ -5932,26 +4853,6 @@ RButton = ReadFormButton def RealtimeButton(button_text, image_filename=None, image_data=None, image_size=(None, None), image_subsample=None, border_width=None, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, font=None, disabled=False, bind_return_key=False, focus=False, pad=None, key=None): - """ - - :param button_text: - :param image_filename: (Default value = None) - :param image_data: (Default value = None) - :param image_size: (Default value = (None, None)) - :param image_subsample: (Default value = None) - :param border_width: (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param bind_return_key: (Default value = False) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_REALTIME, image_filename=image_filename, image_data=image_data, image_size=image_size, image_subsample=image_subsample, border_width=border_width, tooltip=tooltip, disabled=disabled, size=size, @@ -5963,26 +4864,6 @@ def RealtimeButton(button_text, image_filename=None, image_data=None, image_size def DummyButton(button_text, image_filename=None, image_data=None, image_size=(None, None), image_subsample=None, border_width=None, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, font=None, disabled=False, bind_return_key=False, focus=False, pad=None, key=None): - """ - - :param button_text: - :param image_filename: (Default value = None) - :param image_data: (Default value = None) - :param image_size: (Default value = (None, None)) - :param image_subsample: (Default value = None) - :param border_width: (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param bind_return_key: (Default value = False) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_CLOSES_WIN_ONLY, image_filename=image_filename, image_data=image_data, image_size=image_size, image_subsample=image_subsample, border_width=border_width, tooltip=tooltip, size=size, auto_size_button=auto_size_button, @@ -5996,32 +4877,6 @@ def CalendarButton(button_text, target=(None, None), close_when_date_chosen=True image_subsample=None, tooltip=None, border_width=None, size=(None, None), auto_size_button=None, button_color=None, disabled=False, font=None, bind_return_key=False, focus=False, pad=None, key=None, locale=None, format=None): - """ - - :param button_text: - :param target: (Default value = (None, None)) - :param close_when_date_chosen: (Default value = True) - :param default_date_m_d_y: (Default value = (None) - :param None: - :param image_filename: (Default value = None) - :param image_data: (Default value = None) - :param image_size: (Default value = (None) - :param image_subsample: (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param border_width: (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param bind_return_key: (Default value = False) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - :param locale: (Default value = None) - :param format: (Default value = None) - - """ button = Button(button_text=button_text, button_type=BUTTON_TYPE_CALENDAR_CHOOSER, target=target, image_filename=image_filename, image_data=image_data, image_size=image_size, image_subsample=image_subsample, border_width=border_width, tooltip=tooltip, size=size, @@ -6039,27 +4894,6 @@ def ColorChooserButton(button_text, target=(None, None), image_filename=None, im image_subsample=None, tooltip=None, border_width=None, size=(None, None), auto_size_button=None, button_color=None, disabled=False, font=None, bind_return_key=False, focus=False, pad=None, key=None): - """ - - :param button_text: - :param target: (Default value = (None, None)) - :param image_filename: (Default value = None) - :param image_data: (Default value = None) - :param image_size: (Default value = (None) - :param image_subsample: (Default value = None) - :param tooltip: text, that will appear the you hover on (Default value = None) - :param border_width: (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) - :param auto_size_button: (Default value = None) - :param button_color: (Default value = None) - :param disabled: set disable state for element (Default value = False) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param bind_return_key: (Default value = False) - :param focus: if focus should be set to this (Default value = None) - :param pad: (common_key) Amount of padding to put around element (Default value = None) - :param key: (common_key) Used with window.FindElement and with return values (Default value = None) - - """ return Button(button_text=button_text, button_type=BUTTON_TYPE_COLOR_CHOOSER, target=target, image_filename=image_filename, image_data=image_data, image_size=image_size, image_subsample=image_subsample, border_width=border_width, tooltip=tooltip, size=size, @@ -6070,13 +4904,6 @@ def ColorChooserButton(button_text, target=(None, None), image_filename=None, im ##################################### ----- RESULTS ------ ################################################## def AddToReturnDictionary(form, element, value): - """ - - :param form: - :param element: - :param value: - - """ form.ReturnValuesDictionary[element.Key] = value return # if element.Key is None: @@ -6088,23 +4915,12 @@ def AddToReturnDictionary(form, element, value): def AddToReturnList(form, value): - """ - - :param form: - :param value: - - """ form.ReturnValuesList.append(value) # ----------------------------------------------------------------------------# # ------- FUNCTION InitializeResults. Sets up form results matrix --------# def InitializeResults(form): - """ - - :param form: - - """ BuildResults(form, True, form) return @@ -6112,11 +4928,6 @@ def InitializeResults(form): # ===== Radio Button RadVar encoding and decoding =====# # ===== The value is simply the row * 1000 + col =====# def DecodeRadioRowCol(RadValue): - """ - - :param RadValue: - - """ container = RadValue // 100000 row = RadValue // 1000 col = RadValue % 1000 @@ -6124,13 +4935,6 @@ def DecodeRadioRowCol(RadValue): def EncodeRadioRowCol(container, row, col): - """ - - :param container: - :param row: - :param col: - - """ RadValue = container * 100000 + row * 1000 + col return RadValue @@ -6139,13 +4943,6 @@ def EncodeRadioRowCol(container, row, col): # format of return values is # (Button Pressed, input_values) def BuildResults(form, initialize_only, top_level_form): - """ - - :param form: - :param initialize_only: - :param top_level_form: - - """ # Results for elements are: # TEXT - Nothing # INPUT - Read value from TK @@ -6162,13 +4959,6 @@ def BuildResults(form, initialize_only, top_level_form): def BuildResultsForSubform(form, initialize_only, top_level_form): - """ - - :param form: - :param initialize_only: - :param top_level_form: - - """ button_pressed_text = top_level_form.LastButtonClicked for row_num, row in enumerate(form.Rows): for col_num, element in enumerate(row): @@ -6369,22 +5159,10 @@ def BuildResultsForSubform(form, initialize_only, top_level_form): def FillFormWithValues(form, values_dict): - """ - - :param form: - :param values_dict: - - """ FillSubformWithValues(form, values_dict) def FillSubformWithValues(form, values_dict): - """ - - :param form: - :param values_dict: - - """ for row_num, row in enumerate(form.Rows): for col_num, element in enumerate(row): value = None @@ -6423,12 +5201,6 @@ def FillSubformWithValues(form, values_dict): def _FindElementFromKeyInSubForm(form, key): - """ - - :param form: - :param key: (common_key) Used with window.FindElement and with return values - - """ for row_num, row in enumerate(form.Rows): for col_num, element in enumerate(row): if element.Type == ELEM_TYPE_COLUMN: @@ -6456,11 +5228,6 @@ def _FindElementFromKeyInSubForm(form, key): def _FindElementWithFocusInSubForm(form): - """ - - :param form: - - """ for row_num, row in enumerate(form.Rows): for col_num, element in enumerate(row): if element.Type == ELEM_TYPE_COLUMN: @@ -6495,15 +5262,6 @@ def _FindElementWithFocusInSubForm(form): if sys.version_info[0] >= 3: def AddMenuItem(top_menu, sub_menu_info, element, is_sub_menu=False, skip=False): - """ - - :param top_menu: - :param sub_menu_info: - :param element: - :param is_sub_menu: (Default value = False) - :param skip: (Default value = False) - - """ return_val = None if type(sub_menu_info) is str: if not is_sub_menu and not skip: @@ -6554,15 +5312,6 @@ if sys.version_info[0] >= 3: return return_val else: def AddMenuItem(top_menu, sub_menu_info, element, is_sub_menu=False, skip=False): - """ - - :param top_menu: - :param sub_menu_info: - :param element: - :param is_sub_menu: (Default value = False) - :param skip: (Default value = False) - - """ if not isinstance(sub_menu_info, list): if not is_sub_menu and not skip: # print(f'Adding command {sub_menu_info}') @@ -6634,15 +5383,7 @@ else: # ======================== TK CODE STARTS HERE ========================================= # def PackFormIntoFrame(form, containing_frame, toplevel_form): - """ - - :param form: - :param containing_frame: - :param toplevel_form: - - """ def CharWidthInPixels(): - """ """ return tkinter.font.Font().measure('A') # single character width border_depth = toplevel_form.BorderDepth if toplevel_form.BorderDepth is not None else DEFAULT_BORDER_WIDTH @@ -7769,11 +6510,6 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): treeview.column(heading, width=width * CharWidthInPixels(), anchor=anchor) def add_treeview_data(node): - """ - - :param node: - - """ # print(f'Inserting {node.key} under parent {node.parent}') if node.key != '': if node.icon: @@ -7893,11 +6629,6 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): def ConvertFlexToTK(MyFlexForm): - """ - - :param MyFlexForm: - - """ MyFlexForm # type: Window master = MyFlexForm.TKroot master.title(MyFlexForm.Title) @@ -7941,11 +6672,6 @@ def ConvertFlexToTK(MyFlexForm): # ----====----====----====----====----==== STARTUP TK ====----====----====----====----====----# def StartupTK(my_flex_form: Window): - """ - - :param my_flex_form: Window: - - """ # global _my_windows # ow = _my_windows.NumOpenWindows ow = Window.NumOpenWindows @@ -8047,12 +6773,6 @@ def StartupTK(my_flex_form: Window): # Helper function for determining how to wrap text # # ===================================================# def _GetNumLinesNeeded(text, max_line_width): - """ - - :param text: - :param max_line_width: - - """ if max_line_width == 0: return 1 lines = text.split('\n') @@ -8068,11 +6788,6 @@ def _GetNumLinesNeeded(text, max_line_width): # ============================== PROGRESS METER ========================================== # def ConvertArgsToSingleString(*args): - """ - - :param *args: - - """ max_line_total, width_used, total_lines, = 0, 0, 0 single_line_message = '' # loop through args and built a SINGLE string from them @@ -8097,27 +6812,11 @@ METER_STOPPED = False class QuickMeter(object): - """ """ active_meters = {} exit_reasons = {} def __init__(self, title, current_value, max_value, key, *args, orientation='v', bar_color=(None, None), button_color=(None, None), size=DEFAULT_PROGRESS_BAR_SIZE, border_width=None, grab_anywhere=False): - """ - - :param title: - :param current_value: - :param max_value: - :param key: (common_key) Used with window.FindElement and with return values - :param *args: - :param orientation: (Default value = 'v') - :param bar_color: (Default value = (None, None)) - :param button_color: (Default value = (None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = DEFAULT_PROGRESS_BAR_SIZE) - :param border_width: (Default value = None) - :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) - - """ self.start_time = datetime.datetime.utcnow() self.key = key self.orientation = orientation @@ -8133,11 +6832,6 @@ class QuickMeter(object): self.window = self.BuildWindow(*args) def BuildWindow(self, *args): - """ - - :param *args: - - """ layout = [] if self.orientation.lower().startswith('h'): col = [] @@ -8163,13 +6857,6 @@ class QuickMeter(object): return self.window def UpdateMeter(self, current_value, max_value, *args): ### support for *args when updating - """ - - :param current_value: - :param max_value: - :param *args: - - """ self.current_value = current_value self.max_value = max_value self.window.Element('_PROG_').UpdateBar(self.current_value, self.max_value) @@ -8186,7 +6873,6 @@ class QuickMeter(object): return METER_OK def ComputeProgressStats(self): - """ """ utc = datetime.datetime.utcnow() time_delta = utc - self.start_time total_seconds = time_delta.total_seconds() @@ -8217,21 +6903,6 @@ class QuickMeter(object): def OneLineProgressMeter(title, current_value, max_value, key, *args, orientation='v', bar_color=(None, None), button_color=None, size=DEFAULT_PROGRESS_BAR_SIZE, border_width=None, grab_anywhere=False): - """ - - :param title: - :param current_value: - :param max_value: - :param key: (common_key) Used with window.FindElement and with return values - :param *args: - :param orientation: (Default value = 'v') - :param bar_color: (Default value = (None, None)) - :param button_color: (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = DEFAULT_PROGRESS_BAR_SIZE) - :param border_width: (Default value = None) - :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) - - """ if key not in QuickMeter.active_meters: meter = QuickMeter(title, current_value, max_value, key, *args, orientation=orientation, bar_color=bar_color, button_color=button_color, size=size, border_width=border_width, grab_anywhere=grab_anywhere) @@ -8245,11 +6916,6 @@ def OneLineProgressMeter(title, current_value, max_value, key, *args, orientatio def OneLineProgressMeterCancel(key): - """ - - :param key: (common_key) Used with window.FindElement and with return values - - """ try: meter = QuickMeter.active_meters[key] meter.window.Close() @@ -8262,11 +6928,6 @@ def OneLineProgressMeterCancel(key): # input is #RRGGBB # output is #RRGGBB def GetComplimentaryHex(color): - """ - - :param color: - - """ # strip the # from the beginning color = color[1:] # convert the string into hex @@ -8282,23 +6943,10 @@ def GetComplimentaryHex(color): # ======================== EasyPrint =====# # ===================================================# class DebugWin(): - """ """ debug_window = None def __init__(self, size=(None, None), location=(None, None), font=None, no_titlebar=False, no_button=False, grab_anywhere=False, keep_on_top=False, do_not_reroute_stdout=True): - """ - - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param location: (Default value = (None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param no_titlebar: (Default value = False) - :param no_button: (Default value = False) - :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) - :param location: Location on screen to display (Default value = (None, None)) - :param do_not_reroute_stdout: (Default value = True) - - """ # Show a form that's a running counter self.size = size self.location = location @@ -8327,13 +6975,6 @@ class DebugWin(): return def Print(self, *args, end=None, sep=None): - """ - - :param *args: - :param end: (Default value = None) - :param sep: (Default value = None) - - """ sepchar = sep if sep is not None else ' ' endchar = end if end is not None else '\n' @@ -8357,34 +6998,17 @@ class DebugWin(): print(*args, sep=sepchar, end=endchar) def Close(self): - """ """ self.window.Close() self.window.__del__() self.window = None def PrintClose(): - """ """ EasyPrintClose() def EasyPrint(*args, size=(None, None), end=None, sep=None, location=(None, None), font=None, no_titlebar=False, no_button=False, grab_anywhere=False, keep_on_top=False, do_not_reroute_stdout=True): - """ - - :param *args: - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param end: (Default value = None) - :param sep: (Default value = None) - :param location: (Default value = (None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param no_titlebar: (Default value = False) - :param no_button: (Default value = False) - :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) - :param location: Location on screen to display (Default value = (None, None)) - :param do_not_reroute_stdout: (Default value = True) - - """ if DebugWin.debug_window is None: DebugWin.debug_window = DebugWin(size=size, location=location, font=font, no_titlebar=no_titlebar, no_button=no_button, grab_anywhere=grab_anywhere, keep_on_top=keep_on_top, @@ -8397,7 +7021,6 @@ eprint = EasyPrint def EasyPrintClose(): - """ """ if DebugWin.debug_window is not None: DebugWin.debug_window.Close() DebugWin.debug_window = None @@ -8407,19 +7030,6 @@ def EasyPrintClose(): # ===================================================# def PopupScrolled(*args, button_color=None, yes_no=False, auto_close=False, auto_close_duration=None, size=(None, None), location=(None, None), title=None, non_blocking=False): - """ - - :param *args: - :param button_color: (Default value = None) - :param yes_no: (Default value = False) - :param auto_close: (Default value = False) - :param auto_close_duration: (Default value = None) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param location: (Default value = (None) - :param title: (Default value = None) - :param non_blocking: (Default value = False) - - """ if not args: return width, height = size width = width if width else MESSAGE_BOX_LINE_WIDTH @@ -8467,11 +7077,6 @@ ScrolledTextBox = PopupScrolled # Sets the icon to be used by default # # ===================================================# def SetGlobalIcon(icon): - """ - - :param icon: - - """ # global _my_windows try: @@ -8498,43 +7103,6 @@ def SetOptions(icon=None, button_color=None, element_size=(None, None), button_e text_element_background_color=None, input_elements_background_color=None, input_text_color=None, scrollbar_color=None, text_color=None, element_text_color=None, debug_win_size=(None, None), window_location=(None, None), error_button_color=(None, None), tooltip_time=None): - """ - - :param icon: (Default value = None) - :param button_color: (Default value = None) - :param element_size: (Default value = (None, None)) - :param button_element_size: (Default value = (None) - :param margins: (Default value = (None) - :param element_padding: (Default value = (None) - :param auto_size_text: True if size should fit the text length (Default value = None) - :param auto_size_buttons: (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param border_width: (Default value = None) - :param slider_border_width: (Default value = None) - :param slider_relief: (Default value = None) - :param slider_orientation: (Default value = None) - :param autoclose_time: (Default value = None) - :param message_box_line_width: (Default value = None) - :param progress_meter_border_depth: (Default value = None) - :param progress_meter_style: (Default value = None) - :param progress_meter_relief: (Default value = None) - :param progress_meter_color: (Default value = None) - :param progress_meter_size: (Default value = None) - :param text_justification: (Default value = None) - :param background_color: color of background (Default value = None) - :param element_background_color: (Default value = None) - :param text_element_background_color: (Default value = None) - :param input_elements_background_color: (Default value = None) - :param input_text_color: (Default value = None) - :param scrollbar_color: (Default value = None) - :param text_color: color of the text (Default value = None) - :param element_text_color: (Default value = None) - :param debug_win_size: (Default value = (None) - :param window_location: (Default value = (None) - :param error_button_color: (Default value = (None) - :param tooltip_time: (Default value = None) - - """ global DEFAULT_ELEMENT_SIZE global DEFAULT_BUTTON_ELEMENT_SIZE global DEFAULT_MARGINS # Margins for each LEFT/RIGHT margin is first term @@ -8956,16 +7524,10 @@ LOOK_AND_FEEL_TABLE = {'SystemDefault': def ListOfLookAndFeelValues(): - """ """ return list(LOOK_AND_FEEL_TABLE.keys()) def ChangeLookAndFeel(index): - """ - - :param index: - - """ # global LOOK_AND_FEEL_TABLE if sys.platform == 'darwin': @@ -9004,11 +7566,6 @@ sprint = ScrolledTextBox # Converts an object's contents into a nice printable string. Great for dumping debug data def ObjToStringSingleObj(obj): - """ - - :param obj: - - """ if obj is None: return 'None' return str(obj.__class__) + '\n' + '\n'.join( @@ -9016,12 +7573,6 @@ def ObjToStringSingleObj(obj): def ObjToString(obj, extra=' '): - """ - - :param obj: - :param extra: (Default value = ' ') - - """ if obj is None: return 'None' return str(obj.__class__) + '\n' + '\n'.join( @@ -9049,27 +7600,24 @@ def Popup(*args, title=None, button_color=None, background_color=None, text_colo auto_close=False, auto_close_duration=None, custom_text=(None, None), non_blocking=False, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """Popup - Display a popup box with as many parms as you wish to include + """ + Popup - Display a popup box with as many parms as you wish to include + :param args: + :param button_color: + :param background_color: + :param text_color: + :param button_type: + :param auto_close: + :param auto_close_duration: + :param non_blocking: + :param icon: + :param line_width: + :param font: + :param no_titlebar: + :param grab_anywhere: + :param keep_on_top: + :param location: :return: - - :param *args: - :param title: (Default value = None) - :param button_color: (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param button_type: (Default value = POPUP_BUTTONS_OK) - :param auto_close: (Default value = False) - :param auto_close_duration: (Default value = None) - :param custom_text: (Default value = (None, None)) - :param non_blocking: (Default value = False) - :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) - :param line_width: Width of lines in characters (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param no_titlebar: (Default value = False) - :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) - :param location: Location on screen to display (Default value = (None, None)) - :param location: (Default value = (None) - """ if not args: args_to_print = [''] @@ -9151,11 +7699,6 @@ def Popup(*args, title=None, button_color=None, background_color=None, text_colo # ==================================================# # MsgBox is the legacy call and should not be used any longer def MsgBox(*args): - """ - - :param *args: - - """ raise DeprecationWarning('MsgBox is no longer supported... change your call to Popup') @@ -9163,25 +7706,23 @@ def MsgBox(*args): def PopupNoButtons(*args, title=None, button_color=None, background_color=None, text_color=None, auto_close=False, auto_close_duration=None, non_blocking=False, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """Show a Popup but without any buttons + """ + Show a Popup but without any buttons + :param args: + :param button_color: + :param background_color: + :param text_color: + :param auto_close: + :param auto_close_duration: + :param non_blocking: + :param icon: + :param line_width: + :param font: + :param no_titlebar: + :param grab_anywhere: + :param keep_on_top: + :param location: :return: - - :param *args: - :param title: (Default value = None) - :param button_color: (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param auto_close: (Default value = False) - :param auto_close_duration: (Default value = None) - :param non_blocking: (Default value = False) - :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) - :param line_width: Width of lines in characters (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param no_titlebar: (Default value = False) - :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) - :param location: Location on screen to display (Default value = (None, None)) - :param location: (Default value = (None, None)) - """ Popup(*args, title=title, button_color=button_color, background_color=background_color, text_color=text_color, button_type=POPUP_BUTTONS_NO_BUTTONS, @@ -9196,26 +7737,24 @@ def PopupNonBlocking(*args, title=None, button_type=POPUP_BUTTONS_OK, button_col auto_close=False, auto_close_duration=None, non_blocking=True, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """Show Popup box and immediately return (does not block) + """ + Show Popup box and immediately return (does not block) + :param args: + :param button_type: + :param button_color: + :param background_color: + :param text_color: + :param auto_close: + :param auto_close_duration: + :param non_blocking: + :param icon: + :param line_width: + :param font: + :param no_titlebar: + :param grab_anywhere: + :param keep_on_top: + :param location: :return: - - :param *args: - :param title: (Default value = None) - :param button_type: (Default value = POPUP_BUTTONS_OK) - :param button_color: (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param auto_close: (Default value = False) - :param auto_close_duration: (Default value = None) - :param non_blocking: (Default value = True) - :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) - :param line_width: Width of lines in characters (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param no_titlebar: (Default value = False) - :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) - :param location: Location on screen to display (Default value = (None, None)) - :param location: (Default value = (None, None)) - """ Popup(*args, title=title, button_color=button_color, background_color=background_color, text_color=text_color, button_type=button_type, @@ -9232,26 +7771,24 @@ def PopupQuick(*args, title=None, button_type=POPUP_BUTTONS_OK, button_color=Non text_color=None, auto_close=True, auto_close_duration=2, non_blocking=True, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """Show Popup box that doesn't block and closes itself + """ + Show Popup box that doesn't block and closes itself + :param args: + :param button_type: + :param button_color: + :param background_color: + :param text_color: + :param auto_close: + :param auto_close_duration: + :param non_blocking: + :param icon: + :param line_width: + :param font: + :param no_titlebar: + :param grab_anywhere: + :param keep_on_top: + :param location: :return: - - :param *args: - :param title: (Default value = None) - :param button_type: (Default value = POPUP_BUTTONS_OK) - :param button_color: (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param auto_close: (Default value = True) - :param auto_close_duration: (Default value = 2) - :param non_blocking: (Default value = True) - :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) - :param line_width: Width of lines in characters (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param no_titlebar: (Default value = False) - :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) - :param location: Location on screen to display (Default value = (None, None)) - :param location: (Default value = (None, None)) - """ Popup(*args, title=title, button_color=button_color, background_color=background_color, text_color=text_color, button_type=button_type, @@ -9266,26 +7803,24 @@ def PopupQuickMessage(*args, title=None, button_type=POPUP_BUTTONS_NO_BUTTONS, b auto_close=True, auto_close_duration=2, non_blocking=True, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=True, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """Show Popup box that doesn't block and closes itself + """ + Show Popup box that doesn't block and closes itself + :param args: + :param button_type: + :param button_color: + :param background_color: + :param text_color: + :param auto_close: + :param auto_close_duration: + :param non_blocking: + :param icon: + :param line_width: + :param font: + :param no_titlebar: + :param grab_anywhere: + :param keep_on_top: + :param location: :return: - - :param *args: - :param title: (Default value = None) - :param button_type: (Default value = POPUP_BUTTONS_NO_BUTTONS) - :param button_color: (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param auto_close: (Default value = True) - :param auto_close_duration: (Default value = 2) - :param non_blocking: (Default value = True) - :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) - :param line_width: Width of lines in characters (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param no_titlebar: (Default value = True) - :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) - :param location: Location on screen to display (Default value = (None, None)) - :param location: (Default value = (None, None)) - """ Popup(*args, title=title, button_color=button_color, background_color=background_color, text_color=text_color, button_type=button_type, @@ -9299,25 +7834,23 @@ def PopupNoTitlebar(*args, title=None, button_type=POPUP_BUTTONS_OK, button_colo text_color=None, auto_close=False, auto_close_duration=None, non_blocking=False, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, grab_anywhere=True, keep_on_top=False, location=(None, None)): - """Display a Popup without a titlebar. Enables grab anywhere so you can move it + """ + Display a Popup without a titlebar. Enables grab anywhere so you can move it + :param args: + :param button_type: + :param button_color: + :param background_color: + :param text_color: + :param auto_close: + :param auto_close_duration: + :param non_blocking: + :param icon: + :param line_width: + :param font: + :param grab_anywhere: + :param keep_on_top: + :param location: :return: - - :param *args: - :param title: (Default value = None) - :param button_type: (Default value = POPUP_BUTTONS_OK) - :param button_color: (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param auto_close: (Default value = False) - :param auto_close_duration: (Default value = None) - :param non_blocking: (Default value = False) - :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) - :param line_width: Width of lines in characters (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param grab_anywhere: (Default value = True) - :param location: Location on screen to display (Default value = (None, None)) - :param location: (Default value = (None, None)) - """ Popup(*args, title=title, button_color=button_color, background_color=background_color, text_color=text_color, button_type=button_type, @@ -9337,26 +7870,24 @@ def PopupAutoClose(*args, title=None, button_type=POPUP_BUTTONS_OK, button_color auto_close=True, auto_close_duration=None, non_blocking=False, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """Popup that closes itself after some time period + """ + Popup that closes itself after some time period + :param args: + :param button_type: + :param button_color: + :param background_color: + :param text_color: + :param auto_close: + :param auto_close_duration: + :param non_blocking: + :param icon: + :param line_width: + :param font: + :param no_titlebar: + :param grab_anywhere: + :param keep_on_top: + :param location: :return: - - :param *args: - :param title: (Default value = None) - :param button_type: (Default value = POPUP_BUTTONS_OK) - :param button_color: (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param auto_close: (Default value = True) - :param auto_close_duration: (Default value = None) - :param non_blocking: (Default value = False) - :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) - :param line_width: Width of lines in characters (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param no_titlebar: (Default value = False) - :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) - :param location: Location on screen to display (Default value = (None, None)) - :param location: (Default value = (None, None)) - """ Popup(*args, title=title, button_color=button_color, background_color=background_color, text_color=text_color, button_type=button_type, @@ -9372,25 +7903,23 @@ PopupTimed = PopupAutoClose def PopupError(*args, title=None, button_color=(None, None), background_color=None, text_color=None, auto_close=False, auto_close_duration=None, non_blocking=False, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """Popup with colored button and 'Error' as button text + """ + Popup with colored button and 'Error' as button text + :param args: + :param button_color: + :param background_color: + :param text_color: + :param auto_close: + :param auto_close_duration: + :param non_blocking: + :param icon: + :param line_width: + :param font: + :param no_titlebar: + :param grab_anywhere: + :param keep_on_top: + :param location: :return: - - :param *args: - :param title: (Default value = None) - :param button_color: (Default value = (None, None)) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param auto_close: (Default value = False) - :param auto_close_duration: (Default value = None) - :param non_blocking: (Default value = False) - :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) - :param line_width: Width of lines in characters (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param no_titlebar: (Default value = False) - :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) - :param location: Location on screen to display (Default value = (None, None)) - :param location: (Default value = (None) - """ tbutton_color = DEFAULT_ERROR_BUTTON_COLOR if button_color == (None, None) else button_color Popup(*args, title=title, button_type=POPUP_BUTTONS_ERROR, background_color=background_color, text_color=text_color, @@ -9404,25 +7933,23 @@ def PopupError(*args, title=None, button_color=(None, None), background_color=No def PopupCancel(*args, title=None, button_color=None, background_color=None, text_color=None, auto_close=False, auto_close_duration=None, non_blocking=False, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """Display Popup with "cancelled" button text + """ + Display Popup with "cancelled" button text + :param args: + :param button_color: + :param background_color: + :param text_color: + :param auto_close: + :param auto_close_duration: + :param non_blocking: + :param icon: + :param line_width: + :param font: + :param no_titlebar: + :param grab_anywhere: + :param keep_on_top: + :param location: :return: - - :param *args: - :param title: (Default value = None) - :param button_color: (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param auto_close: (Default value = False) - :param auto_close_duration: (Default value = None) - :param non_blocking: (Default value = False) - :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) - :param line_width: Width of lines in characters (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param no_titlebar: (Default value = False) - :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) - :param location: Location on screen to display (Default value = (None, None)) - :param location: (Default value = (None, None)) - """ Popup(*args, title=title, button_type=POPUP_BUTTONS_CANCELLED, background_color=background_color, text_color=text_color, @@ -9435,25 +7962,23 @@ def PopupCancel(*args, title=None, button_color=None, background_color=None, tex def PopupOK(*args, title=None, button_color=None, background_color=None, text_color=None, auto_close=False, auto_close_duration=None, non_blocking=False, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """Display Popup with OK button only + """ + Display Popup with OK button only + :param args: + :param button_color: + :param background_color: + :param text_color: + :param auto_close: + :param auto_close_duration: + :param non_blocking: + :param icon: + :param line_width: + :param font: + :param no_titlebar: + :param grab_anywhere: + :param keep_on_top: + :param location: :return: - - :param *args: - :param title: (Default value = None) - :param button_color: (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param auto_close: (Default value = False) - :param auto_close_duration: (Default value = None) - :param non_blocking: (Default value = False) - :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) - :param line_width: Width of lines in characters (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param no_titlebar: (Default value = False) - :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) - :param location: Location on screen to display (Default value = (None, None)) - :param location: (Default value = (None, None)) - """ Popup(*args, title=title, button_type=POPUP_BUTTONS_OK, background_color=background_color, text_color=text_color, non_blocking=non_blocking, icon=icon, line_width=line_width, button_color=button_color, auto_close=auto_close, @@ -9465,25 +7990,23 @@ def PopupOK(*args, title=None, button_color=None, background_color=None, text_co def PopupOKCancel(*args, title=None, button_color=None, background_color=None, text_color=None, auto_close=False, auto_close_duration=None, non_blocking=False, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """Display popup with OK and Cancel buttons + """ + Display popup with OK and Cancel buttons + :param args: + :param button_color: + :param background_color: + :param text_color: + :param auto_close: + :param auto_close_duration: + :param non_blocking: + :param icon: + :param line_width: + :param font: + :param no_titlebar: + :param grab_anywhere: + :param keep_on_top: + :param location: :return: OK, Cancel or None - - :param *args: - :param title: (Default value = None) - :param button_color: (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param auto_close: (Default value = False) - :param auto_close_duration: (Default value = None) - :param non_blocking: (Default value = False) - :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) - :param line_width: Width of lines in characters (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param no_titlebar: (Default value = False) - :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) - :param location: Location on screen to display (Default value = (None, None)) - :param location: (Default value = (None, None)) - """ return Popup(*args, title=title, button_type=POPUP_BUTTONS_OK_CANCEL, background_color=background_color, text_color=text_color, @@ -9496,25 +8019,23 @@ def PopupOKCancel(*args, title=None, button_color=None, background_color=None, t def PopupYesNo(*args, title=None, button_color=None, background_color=None, text_color=None, auto_close=False, auto_close_duration=None, non_blocking=False, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """Display Popup with Yes and No buttons + """ + Display Popup with Yes and No buttons + :param args: + :param button_color: + :param background_color: + :param text_color: + :param auto_close: + :param auto_close_duration: + :param non_blocking: + :param icon: + :param line_width: + :param font: + :param no_titlebar: + :param grab_anywhere: + :param keep_on_top: + :param location: :return: Yes, No or None - - :param *args: - :param title: (Default value = None) - :param button_color: (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param auto_close: (Default value = False) - :param auto_close_duration: (Default value = None) - :param non_blocking: (Default value = False) - :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) - :param line_width: Width of lines in characters (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param no_titlebar: (Default value = False) - :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) - :param location: Location on screen to display (Default value = (None, None)) - :param location: (Default value = (None, None)) - """ return Popup(*args, title=title, button_type=POPUP_BUTTONS_YES_NO, background_color=background_color, text_color=text_color, @@ -9533,25 +8054,22 @@ def PopupYesNo(*args, title=None, button_color=None, background_color=None, text def PopupGetFolder(message, title=None, default_path='', no_window=False, size=(None, None), button_color=None, background_color=None, text_color=None, icon=DEFAULT_WINDOW_ICON, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None), initial_folder=None): - """Display popup with text entry field and browse button. Browse for folder + """ + Display popup with text entry field and browse button. Browse for folder + :param message: + :param default_path: + :param no_window: + :param size: + :param button_color: + :param background_color: + :param text_color: + :param icon: + :param font: + :param no_titlebar: + :param grab_anywhere: + :param keep_on_top: + :param location: :return: Contents of text field. None if closed using X or cancelled - - :param message: - :param title: (Default value = None) - :param default_path: (Default value = '') - :param no_window: (Default value = False) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param button_color: (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param no_titlebar: (Default value = False) - :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) - :param location: Location on screen to display (Default value = (None, None)) - :param location: (Default value = (None) - :param initial_folder: (Default value = None) - """ # global _my_windows @@ -9608,29 +8126,25 @@ def PopupGetFile(message, title=None, default_path='', default_extension='', sav no_window=False, size=(None, None), button_color=None, background_color=None, text_color=None, icon=DEFAULT_WINDOW_ICON, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None), initial_folder=None): - """Display popup with text entry field and browse button. Browse for file + """ + Display popup with text entry field and browse button. Browse for file + :param message: + :param default_path: + :param default_extension: + :param save_as: + :param file_types: + :param no_window: + :param size: + :param button_color: + :param background_color: + :param text_color: + :param icon: + :param font: + :param no_titlebar: + :param grab_anywhere: + :param keep_on_top: + :param location: :return: string representing the path chosen, None if cancelled or window closed with X - - :param message: - :param title: (Default value = None) - :param default_path: (Default value = '') - :param default_extension: (Default value = '') - :param save_as: (Default value = False) - :param multiple_files: (Default value = False) - :param file_types: (Default value = (("ALL Files", "*.*"))) - :param no_window: (Default value = False) - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param button_color: (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param no_titlebar: (Default value = False) - :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) - :param location: Location on screen to display (Default value = (None, None)) - :param location: (Default value = (None) - :param initial_folder: (Default value = None) - """ if no_window: @@ -9700,24 +8214,22 @@ def PopupGetFile(message, title=None, default_path='', default_extension='', sav def PopupGetText(message, title=None, default_text='', password_char='', size=(None, None), button_color=None, background_color=None, text_color=None, icon=DEFAULT_WINDOW_ICON, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """Display Popup with text entry field + """ + Display Popup with text entry field + :param message: + :param default_text: + :param password_char: + :param size: + :param button_color: + :param background_color: + :param text_color: + :param icon: + :param font: + :param no_titlebar: + :param grab_anywhere: + :param keep_on_top: + :param location: :return: Text entered or None if window was closed - - :param message: - :param title: (Default value = None) - :param default_text: (Default value = '') - :param password_char: Passwork character if this is a password field (Default value = '') - :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) - :param button_color: (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param no_titlebar: (Default value = False) - :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) - :param location: Location on screen to display (Default value = (None, None)) - :param location: (Default value = (None) - """ layout = [[Text(message, auto_size_text=True, text_color=text_color, background_color=background_color, font=font)], @@ -9743,22 +8255,6 @@ def PopupGetText(message, title=None, default_text='', password_char='', size=(N def PopupAnimated(image_source, message=None, background_color=None, text_color=None, font=None, no_titlebar=True, grab_anywhere=True, keep_on_top=True, location=(None, None), alpha_channel=None, time_between_frames=0, transparent_color=None): - """ - - :param image_source: - :param message: (Default value = None) - :param background_color: color of background (Default value = None) - :param text_color: color of the text (Default value = None) - :param font: (common_key) specifies the font family, size, etc (Default value = None) - :param no_titlebar: (Default value = True) - :param grab_anywhere: (Default value = True) - :param keep_on_top: (Default value = True) - :param location: (Default value = (None, None)) - :param alpha_channel: (Default value = None) - :param time_between_frames: (Default value = 0) - :param transparent_color: (Default value = None) - - """ if image_source is None: for image in Window.animated_popup_dict: window = Window.animated_popup_dict[image] @@ -9811,8 +8307,7 @@ MAX_LINES_PER_RESULT_MAIN = 3 POPOUT_WINDOW_FONT = 'Sans 8' -class _Debugger(): - """ """ +class Debugger(): debugger = None @@ -9825,7 +8320,6 @@ class _Debugger(): # # # # # # # ###### ###### ##### #### #### #### ###### # # def __init__(self): - """ """ self.watcher_window = None # type: Window self.popout_window = None # type: Window self.local_choices = {} @@ -9838,28 +8332,13 @@ class _Debugger(): def _build_main_debugger_window_callback(self, events): - """ - - :param events: - - """ self._build_main_debugger_window() # Includes the DUAL PANE (now 2 tabs)! Don't forget REPL is there too! def _build_main_debugger_window(self, location=(None, None)): - """ - - :param location: (Default value = (None, None)) - - """ ChangeLookAndFeel(COLOR_SCHEME) def InVar(key1): - """ - - :param key1: - - """ row1 = [T(' '), I(key=key1, size=(WIDTH_VARIABLES, 1)), T('', key=key1 + 'CHANGED_', size=(WIDTH_RESULTS, 1)), B('Detail', key=key1 + 'DETAIL_'), @@ -9918,12 +8397,6 @@ class _Debugger(): # # # # # # # ####### ## ###### # # # ####### #### #### # def _refresh_main_debugger_window(self, mylocals, myglobals): - """ - - :param mylocals: - :param myglobals: - - """ if not self.watcher_window: # if there is no window setup, nothing to do return False event, values = self.watcher_window.Read(timeout=1) @@ -10053,11 +8526,6 @@ class _Debugger(): # displays them into a single text box def _display_all_vars(self, dict): - """ - - :param dict: - - """ num_cols = 3 output_text = '' num_lines = 2 @@ -10097,11 +8565,6 @@ class _Debugger(): # # # # # # # # ##### ###### ###### #### ## ## # # # def _choose_auto_watches(self, my_locals): - """ - - :param my_locals: - - """ ChangeLookAndFeel(COLOR_SCHEME) num_cols = 3 output_text = '' @@ -10174,11 +8637,6 @@ class _Debugger(): ## ## # # # ##### #### # # def _build_floating_window(self, location=(None, None)): - """ - - :param location: (Default value = (None, None)) - - """ if self.popout_window: # if floating window already exists, close it first self.popout_window.Close() ChangeLookAndFeel('Topanga') @@ -10249,7 +8707,6 @@ class _Debugger(): ## ## # # # ##### #### # # def _refresh_floating_window(self): - """ """ if not self.popout_window: return for key in self.popout_choices: @@ -10286,15 +8743,9 @@ class _Debugger(): def show_debugger_window(location=(None, None), *args): - """ - - :param location: (Default value = (None, None)) - :param *args: - - """ - if _Debugger.debugger is None: - _Debugger.debugger = _Debugger() - debugger = _Debugger.debugger + if Debugger.debugger is None: + Debugger.debugger = Debugger() + debugger = Debugger.debugger frame = inspect.currentframe() prev_frame = inspect.currentframe().f_back # frame, *others = inspect.stack()[1] @@ -10310,15 +8761,9 @@ def show_debugger_window(location=(None, None), *args): def show_debugger_popout_window(location=(None, None), *args): - """ - - :param location: (Default value = (None, None)) - :param *args: - - """ - if _Debugger.debugger is None: - _Debugger.debugger = _Debugger() - debugger = _Debugger.debugger + if Debugger.debugger is None: + Debugger.debugger = Debugger() + debugger = Debugger.debugger frame = inspect.currentframe() prev_frame = inspect.currentframe().f_back # frame = inspect.getframeinfo(prev_frame) @@ -10335,10 +8780,9 @@ def show_debugger_popout_window(location=(None, None), *args): def refresh_debugger(): - """ """ - if _Debugger.debugger is None: - _Debugger.debugger = _Debugger() - debugger = _Debugger.debugger + if Debugger.debugger is None: + Debugger.debugger = Debugger() + debugger = Debugger.debugger Window.read_call_from_debugger = True frame = inspect.currentframe() frame = inspect.currentframe().f_back @@ -10373,7 +8817,6 @@ def refresh_debugger(): def main(): - """ """ from random import randint ChangeLookAndFeel('GreenTan') From f4790f32780a51dc4979054b7e2ce2165df92ce8 Mon Sep 17 00:00:00 2001 From: nngogol Date: Mon, 17 Jun 2019 19:53:30 +0300 Subject: [PATCH 2/3] added documentation for claases and functions --- PySimpleGUI.py | 5405 ++++++++++++++++++++++++++++++++++++------------ 1 file changed, 4082 insertions(+), 1323 deletions(-) diff --git a/PySimpleGUI.py b/PySimpleGUI.py index 91bd1a86..b3a136c3 100644 --- a/PySimpleGUI.py +++ b/PySimpleGUI.py @@ -1,5 +1,6 @@ #!/usr/bin/python3 import sys + if sys.version_info[0] >= 3: import tkinter as tk from tkinter import filedialog @@ -18,12 +19,12 @@ else: import types import datetime import time -import textwrap import pickle import calendar from random import randint - - +import textwrap +import operator +import inspect # 888888ba .d88888b oo dP .88888. dP dP dP # 88 `8b 88. "' 88 d8' `88 88 88 88 @@ -41,33 +42,43 @@ g_time_delta = 0 def TimerStart(): + """ """ global g_time_start g_time_start = time.time() def TimerStop(): + """ """ global g_time_delta, g_time_end g_time_end = time.time() g_time_delta = g_time_end - g_time_start - print(int(g_time_delta*1000)) + print((g_time_delta * 1000)) """ Welcome to the "core" PySimpleGUI code.... - + It's a mess.... really... it's a mess internally... it's the external-facing interfaces that are not a mess. The Elements and the methods for them are well-designed. PEP8 - this code is far far from PEP8 compliant. It was written PRIOR to learning that PEP8 existed. - + + I'll be honest.... started learning Python in Nov 2017, started writing PySimpleGUI in Feb 2018. + Released PySimpleGUI in July 2018. I knew so little about Python that my parameters were all named + using CamelCase. DOH! Someone on Reddit set me straight on that. So overnight I renamed all of the + parameters to lower case. Unfortunately, the internal naming conventions have been set. Mixing them + with PEP8 at this moment would be even MORE confusing. + + Code I write now, outside PySimpleGUI, IS PEP8 compliant. + The variable and function naming in particular are not compliant. There is liberal use of CamelVariableAndFunctionNames. If you've got a serious enough problem with this that you'll pass on this package, then that's your right and I invite you to do so. However, if perhaps you're a practical thinker where it's the results that matter, then you'll have no trouble with this code base. There is consisency however. - + I truly hope you get a lot of enjoyment out of using PySimpleGUI. It came from good intentions. """ @@ -76,16 +87,11 @@ def TimerStop(): # Base64 encoded GIF file DEFAULT_BASE64_ICON = b'R0lGODlhIQAgAPcAAAAAADBpmDBqmTFqmjJrmzJsnDNtnTRrmTZtmzZumzRtnTdunDRunTRunjVvnzdwnzhwnjlxnzVwoDZxoTdyojhzozl0ozh0pDp1pjp2pjp2pzx0oj12pD52pTt3qD54pjt4qDx4qDx5qTx5qj16qj57qz57rD58rT98rkB4pkJ7q0J9rEB9rkF+rkB+r0d9qkZ/rEl7o0h8p0x9pk5/p0l+qUB+sEyBrE2Crk2Er0KAsUKAskSCtEeEtUWEtkaGuEiHuEiHukiIu0qKu0mJvEmKvEqLvk2Nv1GErVGFr1SFrVGHslaHsFCItFSIs1COvlaPvFiJsVyRuWCNsWSPsWeQs2SQtGaRtW+Wt2qVuGmZv3GYuHSdv3ievXyfvV2XxGWZwmScx2mfyXafwHikyP7TPP/UO//UPP/UPf/UPv7UP//VQP/WQP/WQf/WQv/XQ//WRP7XSf/XSv/YRf/YRv/YR//YSP/YSf/YSv/ZS//aSv/aS/7YTv/aTP/aTf/bTv/bT//cT/7aUf/cUP/cUf/cUv/cU//dVP/dVf7dVv/eVv/eV//eWP/eWf/fWv/fW/7cX/7cYf7cZP7eZf7dav7eb//gW//gXP/gXf/gXv/gX//gYP/hYf/hYv/iYf/iYv7iZP7iZf/iZv/kZv7iaP/kaP/ka//ma//lbP/lbv/mbP/mbv7hdP7lcP/ncP/nc//ndv7gef7gev7iff7ke/7kfv7lf//ocf/ocv/odP/odv/peP/pe//ofIClw4Ory4GszoSszIqqxI+vyoSv0JGvx5OxyZSxyZSzzJi0y5m2zpC10pi715++16C6z6a/05/A2qHC3aXB2K3I3bLH2brP4P7jgv7jh/7mgf7lhP7mhf7liv/qgP7qh/7qiP7rjf7sjP7nkv7nlv7nmP7pkP7qkP7rkv7rlv7slP7sl/7qmv7rnv7snv7sn/7un/7sqv7vq/7vrf7wpv7wqf7wrv7wsv7wtv7ytv7zvP7zv8LU48LV5c3a5f70wP7z0AAAACH5BAEAAP8ALAAAAAAhACAAAAj/AP8JHEiwoMGDCA1uoYIF4bhK1vwlPOjlQICLApwVpFTGzBk1siYSrCLgoskFyQZKMsOypRyR/GKYnBkgQbF/s8603KnmWkIaNIMaw6lzZ8tYB2cIWMo0KIJj/7YV9XgGDRo14gpOIUBggNevXpkKGCDsXySradSoZcMmDsFnDxpEKEC3bl2uXCFQ+7emjV83bt7AgTNroJINAq0wWBxBgYHHdgt0+cdnMJw5c+jQqYNnoARkAx04kPEvS4PTqBswuPIPUp06duzcuYMHT55wAjkwEahsQgqBNSQIHy582D9BePTs2dOnjx8/f1gJ9GXhRpTqApFQoDChu3cOAps///9D/g+gQvYGjrlw4cU/fUnYX6hAn34HgZMABQo0iJB/Qoe8UxAXOQiEg3wIXvCBQLUU4mAhh0R4SCLqJOSEBhhqkAEGHIYgUDaGICIiIoossogj6yBUTQ4htNgiCCB4oIJAtJTIyI2MOOLIIxMtQQIJIwQZpAgwCKRNI43o6Igll1ySSTsI7dOECSaUYOWVKwhkiyVMYuJlJpp0IpA6oJRTkBQopHnCmmu2IBA2mmQi5yZ0fgJKPP+0IwoooZwzkDQ2uCCoCywUyoIW/5DDyaKefOLoJ6LU8w87pJgDTzqmDNSMDpzqYMOnn/7yTyiglBqKKKOMUopA7JgCy0DdeMEjUDM71GqrrcH8QwqqqpbiayqToqJKLwN5g45A0/TAw7LL2krGP634aoopp5yiiiqrZLuKK+jg444uBIHhw7g+MMsDFP/k4wq22rririu4xItLLriAUxAQ5ObrwzL/0PPKu7fIK3C8uxz0w8EIIwzMP/cM7HC88hxEzBBCBGGxxT8AwQzDujws7zcJQVMEEUKUbPITAt1D78OSivSFEUXEXATKA+HTscC80CPSQNGEccQRYhjUDzfxcjPPzkgnLVBAADs=' - DEFAULT_BASE64_LOADING_GIF = b'R0lGODlhQABAAKUAAAQCBJyenERCRNTS1CQiJGRmZLS2tPTy9DQyNHR2dAwODKyqrFRSVNze3GxubMzKzPz6/Dw6PAwKDKSmpExKTNza3CwqLLy+vHx+fBQWFLSytAQGBKSipERGRNTW1CQmJGxqbLy6vPT29DQ2NHx6fBQSFKyurFRWVOTi5HRydPz+/Dw+PP7+/gAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh+QQJCQAsACwAAAAAQABAAAAG/kCWcEgsGo/IpHLJbDqf0CjxwEmkJgepdrvIAL6A0mJLdi7AaMC4zD4eSmlwKduuCwNxdMDOfEw4D0oOeWAOfEkmBGgEJkgphF8ph0cYhCRHeJB7SCgJAgIJKFpnkGtTCoQKdEYGEmgSBlEqipAEEEakcROcqGkSok8PkGCBRhNwcrtICYQJUJnDm0YHASkpAatHK4Qrz8Nf0mTbed3B3wDFZY95kk8QtIS2bQ29r8BPE8PKbRquYBuxpJCwdKhBghUrQpFZAA8AgX2T7DwIACiixYsYM2rc+OSAhwrZOEa5QGHDlw0dLoiEAqEAoQK3VjJxCQmEzCUhzgXciOKE/gIFJ+4NEXBOAEcPyL6UqEBExLkvIjYyiMOAyICnAAZs9IdGgVWsWjWaTON1yAGsUTVOTUOhyLhh5TQi7cqUyIVzKjmiYCBBQtAjNAnZvKmk5cuYhJVc6DAWZd7ETTx6CAm5suXLRQY4sPDTQoqwmIlAADE2DYi0oUUQhbQC8WUQ5wZf9oDVA58KdaPAflqgTgMEXxA0iPIB64c6I9AgiFL624Y2FeLkbtJ82HM2tNPYfmLBOHLlUQJ/6z0POADhUa4+3V7HA/vw58gfEaFBA+qMIt6Su9/UPAL+F4mwWxwwJZGLGitp9kFfHzgAGhIHmhKaESIkB8AIrk1YBAQmDJiQoYYghijiiFAEAQAh+QQJCQApACwAAAAAQABAAIUEAgSEgoREQkTU0tRkYmQ0MjSkpqTs6ux0cnQUEhSMjozc3ty0trT09vRUUlRsamw8OjwMCgxMSkx8fnwcGhyUlpTk5uS8vrz8/vwEBgSMioxERkTc2txkZmQ0NjS0srT08vR0dnQUFhSUkpTk4uS8urz8+vxsbmw8Pjz+/v4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAG/sCUcEgsGo/IpHLJbDqf0Kh0Sl0aPACAx1DtOh/ZMODhLSMNYjHXzBZi01lPm42BizHz5CAk2YQGSSYZdll4eUUYCHAhJkhvcAWHRiGECGeEa0gNAR4QEw1TA4RZgEcdcB1KBwViBQdSiqOWZ6wABZlIE3ATUhujAAJsj2FyUQK/wWbDcVInvydsumm8UaKjpWWrra+whNBtDRMeHp9UJs5pJ4aSXgMnGxsI2Oz09fb3+Pn6+/xEJh8KRjBo1M/JiARiEowoyIQAIQIMk1T4tXAfBw6aEI5KAArfgjcFFhj58CsLg3zDIhXRUBKABnwc4GAkoqDly3vWxMxLQbLk/kl8tbKoJAJCIyGO+RbUCnlkxC8F/DjsLOLQDsSISRREEBMBKlYlDRgoUMCg49ezaNOqVQJCqtm1Qy5IGAQgw4YLcFOYOGWnA8G0fAmRSVui5c+zx0omM2NBgwYLUhq0zPKWSIMFHCojsUAhiwjIUHKWnPpBAF27H5YEEBOg2mQA80A4ICQBRBJpWVpDAfHabAMUv1BoFkJChGcSUoCXREGEUslZRxoHAB3lQku8Qg7Q/ZWB26HAdgYLmTi5Aru9hPwSqdryKrsLG07fNTJ7soN7IAZwsH2EfUn3ETk1WUVYWbDdKBlQh1Usv0D3VQPLpOHBcAyBIAFt/K31AQrbBqGQWhtBAAAh+QQJCQAyACwAAAAAQABAAIUEAgSEgoTEwsREQkTk4uQsLiykoqRkYmQUEhTU0tRUUlT08vS0srSMjox8enwMCgzMysw8OjwcGhxcWlz8+vy8urxMSkzs6uysqqxsamzc2tyUlpQEBgSMiozExsTk5uQ0NjSkpqRkZmQUFhRUVlT09vS0trSUkpR8fnwMDgzMzsw8PjwcHhxcXlz8/vy8vrxMTkzc3tz+/v4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAG/kCZcEgsGo/IpHLJbDqf0Kh0Sq1ar8nEgMOxqLBgZCIFKAMeibB6aDGbB2u1i+Muc1xxJSWmoSwpdHUcfnlGJSgIZSkoJUptdXCFRRQrdQArhEcqD24PX0wUmVMOlmUOSiqPXkwLLQ8PLQtTFCOlAAiiVyRuJFMatmVpYIB1jVEJwADCWCWBdsZQtLa4artmvaO2p2oXrhyxVCWVdSvQahR4ViUOZAApDuaSVhQaGvHy+Pn6+/z9/v8AAzrxICJCBBEeBII6YOnAPYVDWthqAfGIgGQC/H3o0OEDEonAKPL7IKHMCI9GQCQD0S+AmwBHVAJjyQ/FyyMgJ/YjUAvA/ggCFjFqDNAxSc46IitOOlqmRS6lQwSIABHhwAuoWLNq3cq1ogcHLVqgyFiFAoMGJ0w8teJBphsQCaWcaFcGwYkwITiV4hAiCsNSB7B4cLYXwpMNye5WcVEgWZkC6ZaUSAQMwUMnFRybqdCEgWYTVUhpBrBtSQfNHZC48BDCgIfIRKxpxrakAWojLjaUNCNhA2wZsh3TVuLZMWgiJRTYgiFKtObSShbQLZUinohkIohkHs25yYnERVRo/iSDQmPHBdYi+Wsp6ZDrjrNH1Uz2SYPpKRocOZ+sQJEQhLnBgQFTlHBWAyZcxoJmEhjRliVw4cMfMP4ZQYEADpDQggMvJ/yWB3zYYQWBZnFBxV4p8mFVAgzLqacQBSf0ZNIJLla0mgGu1ThFEAAh+QQJCQAqACwAAAAAQABAAIUEAgSUkpRERkTMyswkIiTs6uy0trRkZmQ0MjTU1tQcGhykpqRUVlT09vTEwsQsKix8enwMCgycnpzU0tS8vrw8Ojzc3txcXlz8/vwEBgSUlpRMSkzMzswkJiT08vS8urxsamw0NjTc2twcHhysqqz8+vzExsQsLix8fnxkYmT+/v4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAG/kCVcEgsGo/IpHLJbDqf0Kh0Sq1ar8tEAstdWk4AwMnSLRfBYbF5nUint+tu2w2Ax5OFghMdPt2TBg9hDwZMImgnIn9HH3QAhUxaTw0LCw1WHY4dax6CAA8eVAWOYXplEm4SoqQApl2oaapUmXSbZgW0HaFUBo6QZpQLu1UGub+LWHnIy8zNzs/Q0dLTzSYQFxcoDtRMAwiOCCZJDRwDl88kGawZC0YlEOoAGRDnywPx6wNEHnxpJ8N/SvRjdaLEkAOsDiyjwMrRByEe8NHJADAOhIZ0IAgZgFHcIgYY3TAQYqIjMpAhw4xUEXFdxTUXUwLQKAQhKYXIGsl8CHGg/piXa0p4wvgAA5EG8MLMq4esZEiPRRoMMMGU2QKJbthxQ2LiG51wW5NgcACBwQUIFIyGXcu2bdgGGjZ06LBBQ1UoJg5UqHAAKhcTBByN8OukRApHKe5OcYA1TQbCTC6wuoClQeCGIxQjcYBxm5UAKQM8kdyQshUBKQU8CYERwZURKUc88crKNZIJZRlAmIAEdkjZTkhPPtLAppsDd1GHVO2Ec0PPREoodyTAIBHQIUWPHm5EA0btQxoowKgAaJISwtNcsF7ENyvgRCg0Vgq5iYMDISqkoIDEQkoyRZjgXhojQHcHRyHpYwRcAhBAgAB2LeNfSACyNaBgbqngXUPgGLElHSvVZahCA4fRcYFma3GQGwQciAhNEAAh+QQJCQAwACwAAAAAQABAAIUEAgSEgoTEwsRERkTk4uQkIiSkpqRsamwUEhTU0tT08vSUkpRUUlQ0MjS0trQMCgzMyszs6ux8enwcGhzc2tz8+vyMioxMTkysrqw8OjwEBgSEhoTExsRMSkzk5uQkJiSsqqxsbmwUFhTU1tT09vSUlpRUVlQ0NjS8vrwMDgzMzszs7ux8fnwcHhzc3tz8/vz+/v4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAG/kCYcEgsGo/IpHLJbDqf0Kh0Sq1ar9hs1sNiebRgowsBACBczJcKA1K9wkxWucxSVgKTOUC0qcCTcnN1SBEnenoZX39iZAApaEcVhod6J35SFSgoJE4EXYpHFpSUAVIqBWUFKlkVIqOHIpdOJHlzE5xXEK+UHFAClChYBruHBlAowMLEesZPtHoiuFa6y2W9UBAtZS2rWK3VsVIkmtJYosuDi1Ekk68n5epPhe4R8VR3rnN8svZTLxAg2vDrR7CgwYMItZAo0eHDhw4l4CVMwgHVoRbXjrygMOLNQQEaXmnISARErQnNCFbQtqsFPBCUUtpbUG0BkRe19EzwaG9A/rUBREa8GkHQIrEWRCgMJcjyKJFvsHjG87kMaMmYBWkus1nEwEmZ9p7tmqBA44gRA/uhCDlq5MQlHJrOaSHgLZOFAwoUGBDRrt+/gAMLhkMiwYiyV0iogCARCwUTbDWYoHBPQmQJjak4eEDpgQMpKxpQarAiCwXOox4QhXLg1YEsDIgxgKKALSUNiKvUXpb5CLVXJKeoqNatCQdiwY2QyH0kAfEnu9syJ0Jiw4dUGxorqNb7SOtRr4+saDeH9BETsqOEHl36yIVXF46MQN15NRQSlstowIzk+K7kMGzW2WdUKAABB90FQEwp8l1g2wX2xfOda0oolkB3YWyw4GBCIfgHHIdCvDdKByAKsd4h5pUIAwkBsNRCdioWoUB7MRoUBAAh+QQJCQAuACwAAAAAQABAAIUEAgSEhoTMzsxMSkykpqQcHhz08vRkYmQUEhSUlpS0trTc3twsLixsbmwMCgzU1tSsrqz8+vycnpyMjoxUUlQkJiRsamwcGhy8vrw0NjR0dnQEBgTU0tSsqqz09vRkZmQUFhScmpy8urzk5uQ0MjR0cnQMDgzc2ty0srT8/vykoqSUkpRUVlQsKiz+/v4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAG/kCXcEgsGo8RRWlAaSgix6h0Sp2KKoCstiKqer/fkHasTYDP6KFoQ25303BqBNsmV6DxvBFSr0P0gEMNfW0WgYEDhGQDRwsTFhYTC4dTiYpajEQeB2xjBx6URxaXWoZDHiR9JKChRHykAH9DB4oHcQIlJQJRc6R3Qwukk2gcnRscUSKkb0ITpBNpo6VSCZ11ZkS0l7Zo0lmmUQp0YxUKRtq1aQLGyFNJDUxOeEXOl9DqDbqhJ6QnrYDo6nD7l8cDgz4MWBHMYyBglgMGFh46MeHDhwn+JGrcyLGjx48gO3rg8CBiSDQnWBhjkfFkFQUO2jgwF8UACgUmPz6IWcfB/oMjGBBkQYABJAVFFIwYMDEGQc6NBqz1USjk1RhZHAWQ2kUERRsUHrVe4jpk6RgTTzV6IEVVCAamAEwU/XiUUNIjNlGk5bizj0+XVGDKpAl4yoO6WSj8LOzFgwAObRlLnky5suXLEg2o0FCCwF40KU48SEGwg1AtCDrk6XAhywUCrTr0UZ1GNhnYhwycbuMUdGsyF0gHkqBIApoHfRYDKqGoAcrkhzQoKoEmAog2IIRHSSEiQAAR84wQJ2Qcje0xuKOcaDGmhfIiZuughUPg9+spI66TATEiyvnbeaTwwAPhidLHB1IQsBsACKS3kX7YTWGABLlI8BlBEShSIGUQIO6HmRDekIHgh/lh19+HLjzA3hbvfZiEdwpoh+KMjAUBACH5BAkJACYALAAAAABAAEAAhQQCBISGhMzKzERCRDQyNKSmpOzq7GRiZBQSFHRydJyanNTW1LS2tPz6/Dw6PAwODLSytPTy9GxubBweHHx6fKSipNze3AQGBIyKjMzOzExOTDQ2NKyqrOzu7GRmZBQWFHR2dJyenNza3Ly+vPz+/Dw+PP7+/gAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAb+QJNwSCwaj8ikcslsmjoYx+fjwHSc2KyS8QF4vwiGdjxmXL5or5jMXnYQ6TTi2q4bA/F4wM60UDZTGxQWRw55aRt8SSQUhyAkRQ+HaA+KRw0akwAaDUSSmgCVRg0hA1MDCp1ZIKAACUQbrYlFBrGIBlgirV4LQ3ige0QNtnEbqkwSuwASQ2+aD3RDCpoKTgTKBEQMmmtEhpMlTp+tokMMcGkP3UToh+VL46DvQh0BGwgIGwHRkc/W2HW+HQrXJNkuZm2mTarWZIGyXm2GHTKGhRWoV3ZqFcOFBZMmTooaKCiBr0SqMQ0sxgFxzJIiESAI4CMAQoTLmzhz6tzJs6f+z59Ah0SoACJBgQhByXDoAoZD0iwcDjlFIuDAAQFPOzCNM+dIhjMALmRIGkJTiCMe0BxIavAQwiIH1CZNoAljka9exJI1iySDVaxJneV5gPQpk6h5Chh2UqAdAASKFzvpEKJoCH6SM2vezLmz58+gQ7fhsOHCBQeR20SAwKDwzbZf3o4ZgQ7BiJsFDqXOEiFeV0sCEZGBEGcqHxKaIGkhngaCJRJg41xQnkWwF8IuiQknM+LTg9tMBAQIADhJ7sRtOrDGfIRE3C8HWhqB7UV2Twx6lhQofWHDbp8TxDGBaEIgl4d8nwWYxoAEmvALGsEQ6J5aCIYmHnkNZqghgUEBAAAh+QQJCQAnACwAAAAAQABAAIUEAgSEgoRERkTEwsTk4uRkYmQ0MjQUFhRUVlTU1tT08vSkpqQMCgxMTkzMysxsbmz8+vzs6uwcHhxcXlzc3tysrqwEBgSEhoRMSkzExsRkZmQ8OjwcGhxcWlzc2tz09vSsqqwMDgxUUlTMzsx0dnT8/vzs7uz+/v4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAG/sCTcEgsGo/IpHLJbA5NjozJSa02RxiAFiAYWb/g08Ky3VoW4TRzxCiXLV613Jh1lwVzJ4RCgCQjdnZTeUkZImQAFiIZRxmBbgOERyUkjyQlRQOPZZFIFCAVHmGVmyRFgJtag0UUAncUVpqpAJ1Drpt4RhQHdgewVHWpGEUOiHZwR7d2uU0fbbMWfkRjx2hGHqkJTtizWqLEylwOSAup1kzc3d9GERlSShWpIE4fxpvRaumB2k7BuHPh7lSRlapWml29flEhZYkQARF31lGBwNANCWmEPIAAwS9MhgaILDQwKEnSHgoYS6pcqRJCSpZzMhTgBeBAAZIwrXzo8AjB/oecXxQYSGVgFdAmCLohODoEhAELFjacE+KoGy2mD+w8IJLU6lKgIB6d42C15tENjwwMKatFQc4SqTCdYAvALcwS9t7IpdntwNGhgdQK4en1aNhA5wjOwrkyq5utXJUyFbLgqQUDU4UIJWp3MhMFXe0gMOqZyYAJZAFwmMC4dBMIP13Lnk27tu3buHPnSYABKoaOYRwUKMBIZYJnWhgAtzIiZBxJ/rQw+6KhTIGSEPImkvulgPWSeI+9pNJcC7KS0bmoGTFhwnNJx8sod10BAYIKTRLcErD86IUyAeiGhAn2WECagCeMYMd7CJ5A4BsHIhgAgA0eUd99FWao4YYcAy4RBAA7OEloRWRqYW9jdzhOTjdUeHV4MTVCcmpRRWxDKzdGSWtiWnV5UUlCY0t5QTlKYmUzU25OM3ArSDd0K3JOMEtOTw==' +PSG_DEBUGGER_LOGO = b'R0lGODlhMgAtAPcAAAAAADD/2akK/4yz0pSxyZWyy5u3zZ24zpW30pG52J250J+60aC60KS90aDC3a3E163F2K3F2bPI2bvO3rzP3qvJ4LHN4rnR5P/zuf/zuv/0vP/0vsDS38XZ6cnb6f/xw//zwv/yxf/1w//zyP/1yf/2zP/3z//30wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH5BAEAAP8ALAAAAAAyAC0AAAj/AP8JHEiwoMGDCBMqXMiwoUOFAiJGXBigYoAPDxlK3CigwUGLIAOEyIiQI8cCBUOqJFnQpEkGA1XKZPlPgkuXBATK3JmRws2bB3TuXNmQw8+jQoeCbHj0qIGkSgNobNoUqlKIVJs++BfV4oiEWalaHVpyosCwJidw7Sr1YMQFBDn+y4qSbUW3AiDElXiWqoK1bPEKGLixr1jAXQ9GuGn4sN22Bl02roo4Kla+c8OOJbsQM9rNPJlORlr5asbPpTk/RP2YJGu7rjWnDm2RIQLZrSt3zgp6ZmqwmkHAng3ccWDEMe8Kpnw8JEHlkXnPdh6SxHPILaU/dp60LFUP07dfRq5aYntohAO0m+c+nvT6pVMPZ3jv8AJu8xktyNbw+ATJDtKFBx9NlA20gWU0DVQBYwZhsJMICRrkwEYJJGRCSBtEqGGCAQEAOw==' - - -if sys.version_info[0] >= 3: - DEFAULT_WINDOW_ICON = DEFAULT_BASE64_ICON -else: - DEFAULT_WINDOW_ICON = 'default_icon.ico' +DEFAULT_WINDOW_ICON = DEFAULT_BASE64_ICON DEFAULT_ELEMENT_SIZE = (45, 1) # In CHARACTERS DEFAULT_BUTTON_ELEMENT_SIZE = (10, 1) # In CHARACTERS @@ -101,7 +107,7 @@ DEFAULT_DEBUG_WINDOW_SIZE = (80, 20) DEFAULT_WINDOW_LOCATION = (None, None) MAX_SCROLLED_TEXT_BOX_HEIGHT = 50 DEFAULT_TOOLTIP_TIME = 400 -DEFAULT_TOOLTIP_OFFSET = (20,-20) +DEFAULT_TOOLTIP_OFFSET = (0, -20) #################### COLOR STUFF #################### BLUES = ("#082567", "#0A37A3", "#00345B") PURPLES = ("#480656", "#4F2398", "#380474") @@ -236,9 +242,10 @@ BUTTON_TYPE_READ_FORM = 7 BUTTON_TYPE_REALTIME = 9 BUTTON_TYPE_CALENDAR_CHOOSER = 30 BUTTON_TYPE_COLOR_CHOOSER = 40 +BUTTON_TYPE_SHOW_DEBUGGER = 50 # ------------------------- Element types ------------------------- # -# class ElementType(Enum): + ELEM_TYPE_TEXT = 'text' ELEM_TYPE_INPUT_TEXT = 'input' ELEM_TYPE_INPUT_COMBO = 'combo' @@ -285,12 +292,17 @@ POPUP_BUTTONS_NO_BUTTONS = 5 # ------------------------------------------------------------------------- # class ToolTip: - """ Create a tooltip for a given widget - + """Create a tooltip for a given widget (inspired by https://stackoverflow.com/a/36221216) """ - def __init__(self, widget, text, timeout=DEFAULT_TOOLTIP_TIME): + """ + + :param widget: + :param text: + :param timeout: (Default value = DEFAULT_TOOLTIP_TIME) + + """ self.widget = widget self.text = text self.timeout = timeout @@ -303,26 +315,41 @@ class ToolTip: self.widget.bind("", self.leave) def enter(self, event=None): + """ + + :param event: (Default value = None) + + """ + self.x = event.x + self.y = event.y self.schedule() def leave(self, event=None): + """ + + :param event: (Default value = None) + + """ self.unschedule() self.hidetip() def schedule(self): + """ """ self.unschedule() self.id = self.widget.after(self.timeout, self.showtip) def unschedule(self): + """ """ if self.id: self.widget.after_cancel(self.id) self.id = None def showtip(self): + """ """ if self.tipwindow: return - x = self.widget.winfo_rootx() + DEFAULT_TOOLTIP_OFFSET[0] - y = self.widget.winfo_rooty() + self.widget.winfo_height() + DEFAULT_TOOLTIP_OFFSET[1] + x = self.widget.winfo_rootx() + self.x + DEFAULT_TOOLTIP_OFFSET[0] + y = self.widget.winfo_rooty() + self.y + DEFAULT_TOOLTIP_OFFSET[1] self.tipwindow = tk.Toplevel(self.widget) self.tipwindow.wm_overrideredirect(True) self.tipwindow.wm_geometry("+%d+%d" % (x, y)) @@ -333,6 +360,7 @@ class ToolTip: label.pack() def hidetip(self): + """ """ if self.tipwindow: self.tipwindow.destroy() self.tipwindow = None @@ -349,20 +377,26 @@ class ToolTip: # Element CLASS # # ------------------------------------------------------------------------- # class Element(): + """The base class for all Elements. + Holds the basic description of an Element like size and colors + + + """ def __init__(self, type, size=(None, None), auto_size_text=None, font=None, background_color=None, text_color=None, key=None, pad=None, tooltip=None, visible=True): - ''' - Element - :param type: - :param size: - :param auto_size_text: - :param font: - :param background_color: - :param text_color: - :param key: - :param pad: - :param tooltip: - :param visible: - ''' + """ + + :param type: + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_text: True if size should fit the text length (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: element's text color (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ self.Size = size self.Type = type self.AutoSizeText = auto_size_text @@ -375,7 +409,7 @@ class Element(): self.TKEntry = None self.TKImage = None - self.ParentForm = None # type: Window + self.ParentForm = None # type: Window self.ParentContainer = None # will be a Form, Column, or Frame element self.TextInputDefault = None self.Position = (0, 0) # Default position Row 0, Col 0 @@ -386,45 +420,69 @@ class Element(): self.TooltipObject = None self.Visible = visible self.TKRightClickMenu = None + self.Widget = None # Set when creating window. Has the main tkinter widget for element - def RightClickMenuCallback(self, event): + def _RightClickMenuCallback(self, event): + """ + + :param event: + + """ self.TKRightClickMenu.tk_popup(event.x_root, event.y_root, 0) self.TKRightClickMenu.grab_release() - def MenuItemChosenCallback(self, item_chosen): # TEXT Menu item callback + def _MenuItemChosenCallback(self, item_chosen): # TEXT Menu item callback + """ + + :param item_chosen: + + """ # print('IN MENU ITEM CALLBACK', item_chosen) - self.MenuItemChosen = item_chosen.replace('&','') + self.MenuItemChosen = item_chosen.replace('&', '') self.ParentForm.LastButtonClicked = self.MenuItemChosen self.ParentForm.FormRemainedOpen = True if self.ParentForm.CurrentlyRunningMainloop: self.ParentForm.TKroot.quit() # kick the users out of the mainloop + def _FindReturnKeyBoundButton(self, form): + """ - def FindReturnKeyBoundButton(self, form): + :param form: + + """ for row in form.Rows: for element in row: if element.Type == ELEM_TYPE_BUTTON: if element.BindReturnKey: return element if element.Type == ELEM_TYPE_COLUMN: - rc = self.FindReturnKeyBoundButton(element) + rc = self._FindReturnKeyBoundButton(element) if rc is not None: return rc if element.Type == ELEM_TYPE_FRAME: - rc = self.FindReturnKeyBoundButton(element) + rc = self._FindReturnKeyBoundButton(element) if rc is not None: return rc if element.Type == ELEM_TYPE_TAB_GROUP: - rc = self.FindReturnKeyBoundButton(element) + rc = self._FindReturnKeyBoundButton(element) if rc is not None: return rc if element.Type == ELEM_TYPE_TAB: - rc = self.FindReturnKeyBoundButton(element) + rc = self._FindReturnKeyBoundButton(element) + if rc is not None: + return rc + if element.Type == ELEM_TYPE_PANE: + rc = self._FindReturnKeyBoundButton(element) if rc is not None: return rc return None - def TextClickedHandler(self, event): + def _TextClickedHandler(self, event): + """ + + :param event: + + """ if self.Key is not None: self.ParentForm.LastButtonClicked = self.Key else: @@ -433,13 +491,23 @@ class Element(): if self.ParentForm.CurrentlyRunningMainloop: self.ParentForm.TKroot.quit() # kick the users out of the mainloop - def ReturnKeyHandler(self, event): + def _ReturnKeyHandler(self, event): + """ + + :param event: + + """ MyForm = self.ParentForm - button_element = self.FindReturnKeyBoundButton(MyForm) + button_element = self._FindReturnKeyBoundButton(MyForm) if button_element is not None: button_element.ButtonCallBack() - def ListboxSelectHandler(self, event): + def _ListboxSelectHandler(self, event): + """ + + :param event: + + """ # first, get the results table built # modify the Results table in the parent FlexForm object if self.Key is not None: @@ -450,7 +518,12 @@ class Element(): if self.ParentForm.CurrentlyRunningMainloop: self.ParentForm.TKroot.quit() # kick the users out of the mainloop - def ComboboxSelectHandler(self, event): + def _ComboboxSelectHandler(self, event): + """ + + :param event: + + """ # first, get the results table built # modify the Results table in the parent FlexForm object if self.Key is not None: @@ -461,7 +534,8 @@ class Element(): if self.ParentForm.CurrentlyRunningMainloop: self.ParentForm.TKroot.quit() # kick the users out of the mainloop - def RadioHandler(self): + def _RadioHandler(self): + """ """ if self.Key is not None: self.ParentForm.LastButtonClicked = self.Key else: @@ -470,7 +544,8 @@ class Element(): if self.ParentForm.CurrentlyRunningMainloop: self.ParentForm.TKroot.quit() - def CheckboxHandler(self): + def _CheckboxHandler(self): + """ """ if self.Key is not None: self.ParentForm.LastButtonClicked = self.Key else: @@ -479,7 +554,12 @@ class Element(): if self.ParentForm.CurrentlyRunningMainloop: self.ParentForm.TKroot.quit() - def TabGroupSelectHandler(self, event): + def _TabGroupSelectHandler(self, event): + """ + + :param event: + + """ if self.Key is not None: self.ParentForm.LastButtonClicked = self.Key else: @@ -488,7 +568,12 @@ class Element(): if self.ParentForm.CurrentlyRunningMainloop: self.ParentForm.TKroot.quit() - def KeyboardHandler(self, event): + def _KeyboardHandler(self, event): + """ + + :param event: + + """ if self.Key is not None: self.ParentForm.LastButtonClicked = self.Key else: @@ -497,7 +582,12 @@ class Element(): if self.ParentForm.CurrentlyRunningMainloop: self.ParentForm.TKroot.quit() - def ClickHandler(self, event): + def _ClickHandler(self, event): + """ + + :param event: + + """ if self.Key is not None: self.ParentForm.LastButtonClicked = self.Key else: @@ -506,8 +596,16 @@ class Element(): if self.ParentForm.CurrentlyRunningMainloop: self.ParentForm.TKroot.quit() + def SetTooltip(self, tooltip_text): + """ + + :param tooltip_text: + + """ + self.TooltipObject = ToolTip(self.Widget, text=tooltip_text, timeout=DEFAULT_TOOLTIP_TIME) def __del__(self): + """ """ try: self.TKStringVar.__del__() except: @@ -530,29 +628,31 @@ class Element(): # Input Class # # ---------------------------------------------------------------------- # class InputText(Element): + """Shows a single line of input.""" def __init__(self, default_text='', size=(None, None), disabled=False, password_char='', - justification=None, background_color=None, text_color=None, font=None, tooltip=None, - change_submits=False, enable_events=False, do_not_clear=True, key=None, focus=False, pad=None, right_click_menu=None, visible=True): - ''' - InputText - :param default_text: - :param size: - :param disabled: - :param password_char: - :param justification: - :param background_color: - :param text_color: - :param font: - :param tooltip: - :param change_submits: - :param enable_events: - :param do_not_clear: - :param key: - :param focus: - :param pad: - :param right_click_menu: - :param visible: - ''' + justification=None, background_color=None, text_color=None, font=None, tooltip=None, + change_submits=False, enable_events=False, do_not_clear=True, key=None, focus=False, pad=None, + right_click_menu=None, visible=True): + """ + + :param default_text: (Default value = '') + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param disabled: set disable state for element (Default value = False) + :param password_char: Passwork character if this is a password field (Default value = '') + :param justification: justification for data display (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param change_submits: If True, pressing Enter key submits window- DEPRICATED DO NOT USE! (Default value = False) + :param enable_events: Turns on the element specific events. Use this instead of change_submits (Default value = False) + :param do_not_clear: see docx (Default value = True) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param right_click_menu: see "Right Click Menus" (Default value = None) + :param visible: set visibility state of the element (Default value = True) + """ self.DefaultText = default_text self.PasswordCharacter = password_char bg = background_color if background_color is not None else DEFAULT_INPUT_ELEMENTS_COLOR @@ -563,10 +663,20 @@ class InputText(Element): self.Disabled = disabled self.ChangeSubmits = change_submits or enable_events self.RightClickMenu = right_click_menu + self.TKEntry = self.Widget = None # type: tk.Entry super().__init__(ELEM_TYPE_INPUT_TEXT, size=size, background_color=bg, text_color=fg, key=key, pad=pad, font=font, tooltip=tooltip, visible=visible) def Update(self, value=None, disabled=None, select=None, visible=None): + """ + + :param value: (Default value = None) + :param disabled: disable or enable state of the element (Default value = None) + :param select: (Default value = None) + :param visible: change visibility of element (Default value = None) + + """ + #NOTE - Read or Finalize must be called on Window prior to Update call if disabled is True: self.TKEntry['state'] = 'readonly' elif disabled is False: @@ -585,20 +695,22 @@ class InputText(Element): self.TKEntry.pack() def Get(self): + """ """ try: text = self.TKStringVar.get() except: text = '' return text - def SetFocus(self): + """ """ try: self.TKEntry.focus_set() except: pass def __del__(self): + """ """ super().__del__() @@ -607,30 +719,34 @@ In = InputText Input = InputText I = InputText + # ---------------------------------------------------------------------- # # Combo # # ---------------------------------------------------------------------- # class Combo(Element): + """ComboBox Element""" def __init__(self, values, default_value=None, size=(None, None), auto_size_text=None, background_color=None, - text_color=None, change_submits=False, enable_events=False, disabled=False, key=None, pad=None, tooltip=None, readonly=False, font=None, visible=True): - ''' - Combo - :param values: - :param default_value: - :param size: - :param auto_size_text: - :param background_color: - :param text_color: - :param change_submits: - :param enable_events: - :param disabled: - :param key: - :param pad: - :param tooltip: - :param readonly: - :param font: - :param visible: - ''' + text_color=None, change_submits=False, enable_events=False, disabled=False, key=None, pad=None, + tooltip=None, readonly=False, font=None, visible=True): + """Combo Element - Combo Box, Drop Down Menu, ... + + :param values: + :param default_value: (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_text: True if size should fit the text length (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param change_submits: If True, pressing Enter key submits window (Default value = False) + :param enable_events: Turns on the element specific events.(Default value = False) + :param disabled: set disable state for element (Default value = False) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param readonly: make element readonly (Default value = False) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ self.Values = values self.DefaultValue = default_value self.ChangeSubmits = change_submits or enable_events @@ -645,6 +761,16 @@ class Combo(Element): text_color=fg, key=key, pad=pad, tooltip=tooltip, font=font or DEFAULT_FONT, visible=visible) def Update(self, value=None, values=None, set_to_index=None, disabled=None, readonly=None, font=None, visible=None): + """ + :param value: (Default value = None) + :param values: (Default value = None) + :param set_to_index: (Default value = None) + :param disabled: disable or enable state of the element (Default value = None) + :param readonly: make element readonly (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param visible: change visibility of element (Default value = None) + + """ if values is not None: try: self.TKCombo['values'] = values @@ -681,7 +807,9 @@ class Combo(Element): self.TKCombo.pack_forget() elif visible is True: self.TKCombo.pack() + def __del__(self): + """ """ try: self.TKCombo.__del__() except: @@ -699,25 +827,33 @@ Drop = InputCombo # Option Menu # # ---------------------------------------------------------------------- # class OptionMenu(Element): + """Option Menu is an Element available ONLY on the tkinter port of PySimpleGUI. It's is a widget that is unique + to tkinter. However, it looks much like a ComboBox. Instead of an arrow to click to pull down the list of + choices, another little graphic is shown on the widget to indicate where you click. After clicking to activate, + it looks like a Combo Box that you scroll to select a choice. + + + """ def __init__(self, values, default_value=None, size=(None, None), disabled=False, auto_size_text=None, background_color=None, text_color=None, key=None, pad=None, tooltip=None, visible=True): - ''' - OptionMenu - :param values: - :param default_value: - :param size: - :param disabled: - :param auto_size_text: - :param background_color: - :param text_color: - :param key: - :param pad: - :param tooltip: - :param visible: - ''' + """Option Menu Element + + :param values: + :param default_value: (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param disabled: set disable state for element (Default value = False) + :param auto_size_text: True if size should fit the text length (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ self.Values = values self.DefaultValue = default_value - self.TKOptionMenu = None # type: tk.OptionMenu + self.TKOptionMenu = None # type: tk.OptionMenu self.Disabled = disabled bg = background_color if background_color else DEFAULT_INPUT_ELEMENTS_COLOR fg = text_color if text_color is not None else DEFAULT_INPUT_TEXT_COLOR @@ -726,6 +862,14 @@ class OptionMenu(Element): text_color=fg, key=key, pad=pad, tooltip=tooltip, visible=visible) def Update(self, value=None, values=None, disabled=None, visible=None): + """OptionMenu Element Update + + :param value: (Default value = None) + :param values: (Default value = None) + :param disabled: disable or enable state of the element (Default value = None) + :param visible: change visibility of element (Default value = None) + + """ if values is not None: self.Values = values self.TKOptionMenu['menu'].delete(0, 'end') @@ -752,7 +896,9 @@ class OptionMenu(Element): self.TKOptionMenu.pack_forget() elif visible is True: self.TKOptionMenu.pack() + def __del__(self): + """ """ try: self.TKOptionMenu.__del__() except: @@ -768,27 +914,36 @@ InputOptionMenu = OptionMenu # Listbox # # ---------------------------------------------------------------------- # class Listbox(Element): - def __init__(self, values, default_values=None, select_mode=None, change_submits=False,enable_events=False, bind_return_key=False, size=(None, None), disabled=False, auto_size_text=None, font=None, background_color=None, text_color=None, key=None, pad=None, tooltip=None, right_click_menu=None, visible=True): - ''' - Listbox - :param values: - :param default_values: - :param select_mode: - :param change_submits: - :param enable_events: - :param bind_return_key: - :param size: - :param disabled: - :param auto_size_text: - :param font: - :param background_color: - :param text_color: - :param key: - :param pad: - :param tooltip: - :param right_click_menu: - :param visible: - ''' + """A List Box. Provide a list of values for the user to choose one or more of. Returns a list of selected rows + when a window.Read() is executed. + + + """ + def __init__(self, values, default_values=None, select_mode=None, change_submits=False, enable_events=False, + bind_return_key=False, size=(None, None), disabled=False, auto_size_text=None, font=None, + background_color=None, text_color=None, key=None, pad=None, tooltip=None, right_click_menu=None, + visible=True): + """Listbox Element + + :param values: + :param default_values: (Default value = None) + :param select_mode: (Default value = None) + :param change_submits: If True, pressing Enter key submits window (Default value = False) + :param enable_events: Turns on the element specific events.(Default value = False) + :param bind_return_key: (Default value = False) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param disabled: set disable state for element (Default value = False) + :param auto_size_text: True if size should fit the text length (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param right_click_menu: see "Right Click Menus" (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ self.Values = values self.DefaultValues = default_values self.TKListbox = None @@ -808,11 +963,21 @@ class Listbox(Element): bg = background_color if background_color else DEFAULT_INPUT_ELEMENTS_COLOR fg = text_color if text_color is not None else DEFAULT_INPUT_TEXT_COLOR self.RightClickMenu = right_click_menu - + self.vsb = None # type: tk.Scrollbar + self.TKListbox = self.Widget = None # type: tk.Listbox super().__init__(ELEM_TYPE_INPUT_LISTBOX, size=size, auto_size_text=auto_size_text, font=font, background_color=bg, text_color=fg, key=key, pad=pad, tooltip=tooltip, visible=visible) def Update(self, values=None, disabled=None, set_to_index=None, visible=None): + """ + + :param values: (Default value = None) + :param disabled: disable or enable state of the element (Default value = None) + :param set_to_index: (Default value = None) + :param visible: change visibility of element (Default value = None) + + """ + if disabled == True: self.TKListbox.configure(state='disabled') elif disabled == False: @@ -831,11 +996,17 @@ class Listbox(Element): pass if visible is False: self.TKListbox.pack_forget() + self.vsb.pack_forget() elif visible is True: self.TKListbox.pack() - + self.vsb.pack() def SetValue(self, values): + """ + + :param values: + + """ for index, item in enumerate(self.Values): try: if item in values: @@ -847,18 +1018,18 @@ class Listbox(Element): self.DefaultValues = values def GetListValues(self): + """ """ return self.Values - def SetFocus(self): + """ """ try: self.TKListbox.focus_set() except: pass - - def __del__(self): + """ """ try: self.TKListBox.__del__() except: @@ -870,26 +1041,34 @@ class Listbox(Element): # Radio # # ---------------------------------------------------------------------- # class Radio(Element): + """Radio Button Element - Used in a group of other Radio Elements to provide user with ability to select only + 1 choice in a list of choices. + + + """ def __init__(self, text, group_id, default=False, disabled=False, size=(None, None), auto_size_text=None, - background_color=None, text_color=None, font=None, key=None, pad=None, tooltip=None, change_submits=False, enable_events=False, visible=True): - ''' - Radio - :param text: - :param group_id: - :param default: - :param disabled: - :param size: - :param auto_size_text: - :param background_color: - :param text_color: - :param font: - :param key: - :param pad: - :param tooltip: - :param change_submits: - :param enable_events: - :param visible: - ''' + background_color=None, text_color=None, font=None, key=None, pad=None, tooltip=None, + change_submits=False, enable_events=False, visible=True): + """ + + :param text: + :param group_id: + :param default: (Default value = False) + :param disabled: set disable state for element (Default value = False) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_text: True if size should fit the text length (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param change_submits: If True, pressing Enter key submits window (Default value = False) + :param enable_events: Turns on the element specific events.(Default value = False) + :param visible: set visibility state of the element (Default value = True) + + """ + self.InitialState = default self.Text = text self.TKRadio = None @@ -904,10 +1083,17 @@ class Radio(Element): tooltip=tooltip, visible=visible) def Update(self, value=None, disabled=None, visible=None): - location = EncodeRadioRowCol(self.ParentForm.ContainerElemementNumber, self.Position[0], self.Position[1]) + """ + + :param value: (Default value = None) + :param disabled: disable or enable state of the element (Default value = None) + :param visible: change visibility of element (Default value = None) + + """ + if value is not None: try: - self.TKIntVar.set(location) + self.TKIntVar.set(self.EncodedRadioValue) except: pass self.InitialState = value @@ -920,7 +1106,12 @@ class Radio(Element): elif visible is True: self.TKRadio.pack() + def ResetGroup(self): + """ """ + self.TKIntVar.set(0) + def __del__(self): + """ """ try: self.TKRadio.__del__() except: @@ -931,25 +1122,35 @@ class Radio(Element): # ---------------------------------------------------------------------- # # Checkbox # # ---------------------------------------------------------------------- # +########################################################################## +# June 15, 2019 - This is the last element that has been converted to use the new +# Doc strings +# Note - The renaming of the member function to have _ if internal only has NOT yet been done! class Checkbox(Element): - def __init__(self, text, default=False, size=(None, None), auto_size_text=None, font=None, background_color=None, text_color=None, change_submits=False,enable_events=False, disabled=False, key=None, pad=None, tooltip=None, visible=True): - ''' - Checkbox - :param text: - :param default: - :param size: - :param auto_size_text: - :param font: - :param background_color: - :param text_color: - :param change_submits: - :param enable_events: - :param disabled: - :param key: - :param pad: - :param tooltip: - :param visible: - ''' + """ """ + + def __init__(self, text, default=False, size=(None, None), auto_size_text=None, font=None, background_color=None, + text_color=None, change_submits=False, enable_events=False, disabled=False, key=None, pad=None, + tooltip=None, visible=True): + """ + + :param text: + :param default: (Default value = False) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_text: True if size should fit the text length (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param change_submits: If True, pressing Enter key submits window (Default value = False) + :param enable_events: Turns on the element specific events.(Default value = False) + :param disabled: set disable state for element (Default value = False) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ + self.Text = text self.InitialState = default self.Value = None @@ -963,15 +1164,24 @@ class Checkbox(Element): tooltip=tooltip, visible=visible) def Get(self): + """ """ return self.TKIntVar.get() def Update(self, value=None, disabled=None, visible=None): + """ + + :param value: (Default value = None) + :param disabled: disable or enable state of the element (Default value = None) + :param visible: change visibility of element (Default value = None) + + """ + if value is not None: try: self.TKIntVar.set(value) self.InitialState = value except: - pass + print('Checkbox update failed') if disabled == True: self.TKCheckbutton.configure(state='disabled') elif disabled == False: @@ -982,6 +1192,7 @@ class Checkbox(Element): self.TKCheckbutton.pack() def __del__(self): + """ """ super().__del__() @@ -996,26 +1207,30 @@ Check = Checkbox # ---------------------------------------------------------------------- # class Spin(Element): - # Values = None - # TKSpinBox = None - def __init__(self, values, initial_value=None, disabled=False, change_submits=False,enable_events=False , size=(None, None), auto_size_text=None, font=None, background_color=None, text_color=None, key=None, pad=None, tooltip=None, visible=True): - ''' - Spin - :param values: - :param initial_value: - :param disabled: - :param change_submits: - :param enable_events: - :param size: - :param auto_size_text: - :param font: - :param background_color: - :param text_color: - :param key: - :param pad: - :param tooltip: - :param visible: - ''' + """ """ + + def __init__(self, values, initial_value=None, disabled=False, change_submits=False, enable_events=False, + size=(None, None), auto_size_text=None, font=None, background_color=None, text_color=None, key=None, + pad=None, tooltip=None, visible=True): + """ + + :param values: + :param initial_value: (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param change_submits: If True, pressing Enter key submits window (Default value = False) + :param enable_events: Turns on the element specific events.(Default value = False) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_text: True if size should fit the text length (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ + self.Values = values self.DefaultValue = initial_value self.ChangeSubmits = change_submits or enable_events @@ -1029,6 +1244,15 @@ class Spin(Element): return def Update(self, value=None, values=None, disabled=None, visible=None): + """ + + :param value: (Default value = None) + :param values: (Default value = None) + :param disabled: disable or enable state of the element (Default value = None) + :param visible: change visibility of element (Default value = None) + + """ + if values != None: old_value = self.TKStringVar.get() self.Values = values @@ -1049,8 +1273,12 @@ class Spin(Element): elif visible is True: self.TKSpinBox.pack() - def SpinChangedHandler(self, event): + """ + + :param event: + + """ # first, get the results table built # modify the Results table in the parent FlexForm object if self.Key is not None: @@ -1062,9 +1290,11 @@ class Spin(Element): self.ParentForm.TKroot.quit() # kick the users out of the mainloop def Get(self): + """ """ return self.TKStringVar.get() def __del__(self): + """ """ try: self.TKSpinBox.__del__() except: @@ -1076,29 +1306,36 @@ class Spin(Element): # Multiline # # ---------------------------------------------------------------------- # class Multiline(Element): - def __init__(self, default_text='', enter_submits=False, disabled=False, autoscroll=False, size=(None, None), - auto_size_text=None, background_color=None, text_color=None, change_submits=False, enable_events=False,do_not_clear=True, key=None, focus=False, font=None, pad=None, tooltip=None, right_click_menu=None, visible=True): - ''' - Multiline - :param default_text: - :param enter_submits: - :param disabled: - :param autoscroll: - :param size: - :param auto_size_text: - :param background_color: - :param text_color: - :param change_submits: - :param enable_events: - :param do_not_clear: - :param key: - :param focus: - :param font: - :param pad: - :param tooltip: - :param right_click_menu: - :param visible: - ''' + """ """ + + def __init__(self, default_text='', enter_submits=False, disabled=False, autoscroll=False, border_width=None, + size=(None, None), auto_size_text=None, background_color=None, text_color=None, change_submits=False, + enable_events=False, do_not_clear=True, key=None, focus=False, font=None, pad=None, tooltip=None, + right_click_menu=None, visible=True): + """ + + :param default_text: (Default value = '') + :param enter_submits: (Default value = False) + :param disabled: set disable state for element (Default value = False) + :param autoscroll: (Default value = False) + :param border_width: (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_text: True if size should fit the text length (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param change_submits: If True, pressing Enter key submits window (Default value = False) + :param enable_events: Turns on the element specific events.(Default value = False) + :param do_not_clear: see docx (Default value = True) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param focus: if focus should be set to this (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param right_click_menu: see "Right Click Menus" (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ + self.DefaultText = default_text self.EnterSubmits = enter_submits @@ -1110,21 +1347,40 @@ class Multiline(Element): self.Disabled = disabled self.ChangeSubmits = change_submits or enable_events self.RightClickMenu = right_click_menu + self.BorderWidth = border_width if border_width is not None else DEFAULT_BORDER_WIDTH super().__init__(ELEM_TYPE_INPUT_MULTILINE, size=size, auto_size_text=auto_size_text, background_color=bg, text_color=fg, key=key, pad=pad, tooltip=tooltip, font=font or DEFAULT_FONT, visible=visible) return - def Update(self, value=None, disabled=None, append=False, font=None, text_color=None, background_color=None, visible=None, autoscroll=None): + def Update(self, value=None, disabled=None, append=False, font=None, text_color=None, background_color=None, + visible=None, autoscroll=None): + """ + + :param value: (Default value = None) + :param disabled: disable or enable state of the element (Default value = None) + :param append: (Default value = False) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param text_color: color of the text (Default value = None) + :param background_color: color of background (Default value = None) + :param visible: change visibility of element (Default value = None) + :param autoscroll: (Default value = None) + + """ + if autoscroll is not None: self.Autoscroll = autoscroll if value is not None: + if self.Disabled: + self.TKText.configure(state='normal') try: if not append: self.TKText.delete('1.0', tk.END) self.TKText.insert(tk.END, value) except: pass + if self.Disabled: + self.TKText.configure(state='disabled') self.DefaultText = value if self.Autoscroll: self.TKText.see(tk.END) @@ -1143,19 +1399,19 @@ class Multiline(Element): elif visible is True: self.TKText.pack() - - def Get(self): + """ """ return self.TKText.get(1.0, tk.END) - def SetFocus(self): + """ """ try: self.TKText.focus_set() except: pass def __del__(self): + """ """ super().__del__() @@ -1163,25 +1419,31 @@ class Multiline(Element): # Text # # ---------------------------------------------------------------------- # class Text(Element): - def __init__(self, text, size=(None, None), auto_size_text=None, click_submits=False, enable_events=False, relief=None, font=None, text_color=None, background_color=None, justification=None, pad=None, key=None, right_click_menu=None, tooltip=None, visible=True): - ''' - Text - :param text: - :param size: - :param auto_size_text: - :param click_submits: - :param enable_events: - :param relief: - :param font: - :param text_color: - :param background_color: - :param justification: - :param pad: - :param key: - :param right_click_menu: - :param tooltip: - :param visible: - ''' + """ """ + + def __init__(self, text, size=(None, None), auto_size_text=None, click_submits=False, enable_events=False, + relief=None, font=None, text_color=None, background_color=None, justification=None, pad=None, key=None, + right_click_menu=None, tooltip=None, visible=True): + """ + + :param text: + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_text: True if size should fit the text length (Default value = None) + :param click_submits: (Default value = False) + :param enable_events: Turns on the element specific events.(Default value = False) + :param relief: (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param text_color: color of the text (Default value = None) + :param background_color: color of background (Default value = None) + :param justification: justification for data display (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param right_click_menu: see "Right Click Menus" (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ + self.DisplayText = str(text) self.TextColor = text_color if text_color else DEFAULT_TEXT_COLOR self.Justification = justification @@ -1199,6 +1461,16 @@ class Text(Element): return def Update(self, value=None, background_color=None, text_color=None, font=None, visible=None): + """ + + :param value: (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param visible: change visibility of element (Default value = None) + + """ + if value is not None: self.DisplayText = value stringvar = self.TKStringVar @@ -1215,6 +1487,7 @@ class Text(Element): self.TKText.pack() def __del__(self): + """ """ super().__del__() @@ -1223,29 +1496,34 @@ Txt = Text T = Text - # ---------------------------------------------------------------------- # # StatusBar # # ---------------------------------------------------------------------- # class StatusBar(Element): - def __init__(self, text, size=(None, None), auto_size_text=None, click_submits=None, enable_events=False, relief=RELIEF_SUNKEN, font=None, text_color=None, background_color=None, justification=None, pad=None, key=None, tooltip=None, visible=True): - ''' - StatusBar - :param text: - :param size: - :param auto_size_text: - :param click_submits: - :param enable_events: - :param relief: - :param font: - :param text_color: - :param background_color: - :param justification: - :param pad: - :param key: - :param tooltip: - :param visible: - ''' + """ """ + + def __init__(self, text, size=(None, None), auto_size_text=None, click_submits=None, enable_events=False, + relief=RELIEF_SUNKEN, font=None, text_color=None, background_color=None, justification=None, pad=None, + key=None, tooltip=None, visible=True): + """ + + :param text: + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_text: True if size should fit the text length (Default value = None) + :param click_submits: (Default value = None) + :param enable_events: Turns on the element specific events.(Default value = False) + :param relief: (Default value = RELIEF_SUNKEN) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param text_color: color of the text (Default value = None) + :param background_color: color of background (Default value = None) + :param justification: justification for data display (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ + self.DisplayText = text self.TextColor = text_color if text_color else DEFAULT_TEXT_COLOR self.Justification = justification @@ -1255,10 +1533,22 @@ class StatusBar(Element): bg = DEFAULT_TEXT_ELEMENT_BACKGROUND_COLOR else: bg = background_color - super().__init__(ELEM_TYPE_STATUSBAR, size=size, auto_size_text=auto_size_text, background_color=bg, font=font or DEFAULT_FONT, text_color=self.TextColor, pad=pad, key=key, tooltip=tooltip, visible=visible) + super().__init__(ELEM_TYPE_STATUSBAR, size=size, auto_size_text=auto_size_text, background_color=bg, + font=font or DEFAULT_FONT, text_color=self.TextColor, pad=pad, key=key, tooltip=tooltip, + visible=visible) return def Update(self, value=None, background_color=None, text_color=None, font=None, visible=None): + """ + + :param value: (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param visible: change visibility of element (Default value = None) + + """ + if value is not None: self.DisplayText = value stringvar = self.TKStringVar @@ -1275,6 +1565,7 @@ class StatusBar(Element): self.TKText.pack() def __del__(self): + """ """ super().__del__() @@ -1284,9 +1575,24 @@ class StatusBar(Element): # ---------------------------------------------------------------------- # class TKProgressBar(): + """ """ def __init__(self, root, max, length=400, width=DEFAULT_PROGRESS_BAR_SIZE[1], style=DEFAULT_PROGRESS_BAR_STYLE, relief=DEFAULT_PROGRESS_BAR_RELIEF, border_width=DEFAULT_PROGRESS_BAR_BORDER_WIDTH, orientation='horizontal', BarColor=(None, None), key=None): + """ + + :param root: + :param max: + :param length: (Default value = 400) + :param width: (Default value = DEFAULT_PROGRESS_BAR_SIZE[1]) + :param style: (Default value = DEFAULT_PROGRESS_BAR_STYLE) + :param relief: (Default value = DEFAULT_PROGRESS_BAR_RELIEF) + :param border_width: (Default value = DEFAULT_PROGRESS_BAR_BORDER_WIDTH) + :param orientation: (Default value = 'horizontal') + :param BarColor: (Default value = (None, None)) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ self.Length = length self.Width = width @@ -1322,6 +1628,12 @@ class TKProgressBar(): length=length, orient=tk.VERTICAL, mode='determinate') def Update(self, count=None, max=None): + """ + + :param count: (Default value = None) + :param max: (Default value = None) + + """ if max is not None: self.Max = max try: @@ -1337,6 +1649,7 @@ class TKProgressBar(): return True def __del__(self): + """ """ try: self.TKProgressBarForReal.__del__() except: @@ -1350,7 +1663,20 @@ class TKProgressBar(): # Scroll bar will span the length of the frame # # ---------------------------------------------------------------------- # class TKOutput(tk.Frame): + """ """ def __init__(self, parent, width, height, bd, background_color=None, text_color=None, font=None, pad=None): + """ + + :param parent: + :param width: + :param height: + :param bd: + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + + """ self.frame = tk.Frame(parent) tk.Frame.__init__(self, self.frame) self.output = tk.Text(self.frame, width=width, height=height, bd=bd, font=font) @@ -1372,6 +1698,11 @@ class TKOutput(tk.Frame): self.pack() def write(self, txt): + """ + + :param txt: + + """ try: self.output.insert(tk.END, str(txt)) self.output.see(tk.END) @@ -1379,14 +1710,17 @@ class TKOutput(tk.Frame): pass def Close(self): + """ """ sys.stdout = self.previous_stdout sys.stderr = self.previous_stderr def flush(self): + """ """ sys.stdout = self.previous_stdout sys.stderr = self.previous_stderr def __del__(self): + """ """ sys.stdout = self.previous_stdout sys.stderr = self.previous_stderr @@ -1396,20 +1730,24 @@ class TKOutput(tk.Frame): # Routes stdout, stderr to a scrolled window # # ---------------------------------------------------------------------- # class Output(Element): + """ """ + def __init__(self, size=(None, None), background_color=None, text_color=None, pad=None, font=None, tooltip=None, key=None, right_click_menu=None, visible=True): - ''' - Output - :param size: - :param background_color: - :param text_color: - :param pad: - :param font: - :param tooltip: - :param key: - :param right_click_menu: - :param visible: - ''' + """ + + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param right_click_menu: see "Right Click Menus" (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ + self._TKOut = None bg = background_color if background_color else DEFAULT_INPUT_ELEMENTS_COLOR fg = text_color if text_color is not None else DEFAULT_INPUT_TEXT_COLOR @@ -1420,13 +1758,20 @@ class Output(Element): @property def TKOut(self): + """ """ if self._TKOut is None: print('*** Did you forget to call Finalize()? Your code should look something like: ***') print('*** form = sg.Window("My Form").Layout(layout).Finalize() ***') return self._TKOut - def Update(self, value=None, visible=None): + """ + + :param value: (Default value = None) + :param visible: change visibility of element (Default value = None) + + """ + if value is not None: self._TKOut.output.delete('1.0', tk.END) self._TKOut.output.insert(tk.END, value) @@ -1436,6 +1781,7 @@ class Output(Element): self._TKOut.frame.pack() def __del__(self): + """ """ try: self._TKOut.__del__() except: @@ -1447,38 +1793,45 @@ class Output(Element): # Button Class # # ---------------------------------------------------------------------- # class Button(Element): + """ """ + def __init__(self, button_text='', button_type=BUTTON_TYPE_READ_FORM, target=(None, None), tooltip=None, - file_types=(("ALL Files", "*.*"),), initial_folder=None, disabled=False, change_submits=False, enable_events=False, image_filename=None, image_data=None, image_size=(None, None), image_subsample=None, border_width=None, size=(None, None), auto_size_button=None, button_color=None, font=None, bind_return_key=False, focus=False, pad=None, key=None, visible=True): - ''' - Button - :param button_text: - :param button_type: - :param target: - :param tooltip: - :param file_types: - :param initial_folder: - :param disabled: - :param change_submits: - :param enable_events: - :param image_filename: - :param image_data: - :param image_size: - :param image_subsample: - :param border_width: - :param size: - :param auto_size_button: - :param button_color: - :param font: - :param bind_return_key: - :param focus: - :param pad: - :param key: - :param visible: - ''' + file_types=(("ALL Files", "*.*"),), initial_folder=None, disabled=False, change_submits=False, + enable_events=False, image_filename=None, image_data=None, image_size=(None, None), + image_subsample=None, border_width=None, size=(None, None), auto_size_button=None, button_color=None, + font=None, bind_return_key=False, focus=False, pad=None, key=None, visible=True): + """ + + :param button_text: (Default value = '') + :param button_type: (Default value = BUTTON_TYPE_READ_FORM) + :param target: + :param tooltip: text, that will appear the you hover on (Default value = None) + :param file_types: (Default value = (("ALL Files", "*.*"),)) + :param initial_folder: (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param change_submits: If True, pressing Enter key submits window (Default value = False) + :param enable_events: Turns on the element specific events.(Default value = False) + :param image_filename: (Default value = None) + :param image_data: (Default value = None) + :param image_size: (Default value = (None) + :param image_subsample: (Default value = None) + :param border_width: (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param bind_return_key: (Default value = False) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ + self.AutoSizeButton = auto_size_button self.BType = button_type self.FileTypes = file_types - self.TKButton = None # type: tk.Button + self.TKButton = None # type: tk.Button self.Target = target self.ButtonText = str(button_text) if sys.platform == 'darwin' and button_color is not None: @@ -1504,21 +1857,32 @@ class Button(Element): # Realtime button release callback def ButtonReleaseCallBack(self, parm): + """ + + :param parm: + + """ self.LastButtonClickedWasRealtime = False self.ParentForm.LastButtonClicked = None # Realtime button callback def ButtonPressCallBack(self, parm): + """ + + :param parm: + + """ self.ParentForm.LastButtonClickedWasRealtime = True if self.Key is not None: self.ParentForm.LastButtonClicked = self.Key else: self.ParentForm.LastButtonClicked = self.ButtonText if self.ParentForm.CurrentlyRunningMainloop: - self.ParentForm.TKroot.quit() # kick out of loop if read was called + self.ParentForm.TKroot.quit() # kick out of loop if read was called # ------- Button Callback ------- # def ButtonCallBack(self): + """ """ # global _my_windows # print('Button callback') @@ -1563,9 +1927,11 @@ class Button(Element): pass elif self.BType == BUTTON_TYPE_BROWSE_FILE: if sys.platform == 'darwin': - file_name = tk.filedialog.askopenfilename(initialdir=self.InitialFolder) # show the 'get file' dialog box + file_name = tk.filedialog.askopenfilename( + initialdir=self.InitialFolder) # show the 'get file' dialog box else: - file_name = tk.filedialog.askopenfilename(filetypes=filetypes, initialdir=self.InitialFolder) # show the 'get file' dialog box + file_name = tk.filedialog.askopenfilename(filetypes=filetypes, + initialdir=self.InitialFolder) # show the 'get file' dialog box if file_name != '': strvar.set(file_name) self.TKStringVar.set(file_name) @@ -1585,10 +1951,11 @@ class Button(Element): self.TKStringVar.set(file_name) elif self.BType == BUTTON_TYPE_SAVEAS_FILE: if sys.platform == 'darwin': - file_name = tk.filedialog.asksaveasfilename(initialdir=self.InitialFolder) # show the 'get file' dialog box + file_name = tk.filedialog.asksaveasfilename( + initialdir=self.InitialFolder) # show the 'get file' dialog box else: file_name = tk.filedialog.asksaveasfilename(filetypes=filetypes, - initialdir=self.InitialFolder) # show the 'get file' dialog box + initialdir=self.InitialFolder) # show the 'get file' dialog box if file_name != '': strvar.set(file_name) self.TKStringVar.set(file_name) @@ -1605,7 +1972,6 @@ class Button(Element): self.ParentForm.TKroot.quit() if self.ParentForm.NonBlocking: self.ParentForm.TKroot.destroy() - # _my_windows.Decrement() Window.DecrementOpenCount() elif self.BType == BUTTON_TYPE_READ_FORM: # LEAVE THE WINDOW OPEN!! DO NOT CLOSE # first, get the results table built @@ -1615,23 +1981,37 @@ class Button(Element): else: self.ParentForm.LastButtonClicked = self.ButtonText self.ParentForm.FormRemainedOpen = True - if self.ParentForm.CurrentlyRunningMainloop: # if this window is running the mainloop, kick out + if self.ParentForm.CurrentlyRunningMainloop: # if this window is running the mainloop, kick out self.ParentForm.TKroot.quit() # kick the users out of the mainloop elif self.BType == BUTTON_TYPE_CLOSES_WIN_ONLY: # special kind of button that does not exit main loop self.ParentForm._Close() if self.ParentForm.NonBlocking: self.ParentForm.TKroot.destroy() Window.DecrementOpenCount() - # _my_windows.Decrement() elif self.BType == BUTTON_TYPE_CALENDAR_CHOOSER: # this is a return type button so GET RESULTS and destroy window should_submit_window = False root = tk.Toplevel() root.title('Calendar Chooser') root.wm_attributes("-topmost", 1) - self.TKCal = TKCalendar(master=root, firstweekday=calendar.SUNDAY, target_element=target_element, close_when_chosen=self.CalendarCloseWhenChosen, default_date=self.DefaultDate_M_D_Y ) + self.TKCal = TKCalendar(master=root, firstweekday=calendar.SUNDAY, target_element=target_element, + close_when_chosen=self.CalendarCloseWhenChosen, default_date=self.DefaultDate_M_D_Y, + locale=self.CalendarLocale, format=self.CalendarFormat) self.TKCal.pack(expand=1, fill='both') root.update() + if type(Window.user_defined_icon) is bytes: + calendar_icon = tkinter.PhotoImage(data=Window.user_defined_icon) + else: + calendar_icon = tkinter.PhotoImage(data=DEFAULT_BASE64_ICON) + try: + root.tk.call('wm', 'iconphoto', root._w, calendar_icon) + except: + pass + elif self.BType == BUTTON_TYPE_SHOW_DEBUGGER: + if self.ParentForm.DebuggerEnabled: + Debugger.debugger._build_floating_window() + # show_debugger_window() + if should_submit_window: self.ParentForm.LastButtonClicked = target_element.Key self.ParentForm.FormRemainedOpen = True @@ -1640,7 +2020,21 @@ class Button(Element): return - def Update(self, text=None, button_color=(None, None), disabled=None, image_data=None, image_filename=None, visible=None, image_subsample=None, image_size=None): + def Update(self, text=None, button_color=(None, None), disabled=None, image_data=None, image_filename=None, + visible=None, image_subsample=None, image_size=None): + """ + + :param text: (Default value = None) + :param button_color: (Default value = (None) + :param disabled: disable or enable state of the element (Default value = None) + :param image_data: (Default value = None) + :param image_filename: (Default value = None) + :param visible: change visibility of element (Default value = None) + :param image_subsample: (Default value = None) + :param image_size: (Default value = None) + + """ + try: if text is not None: self.TKButton.configure(text=text) @@ -1649,6 +2043,7 @@ class Button(Element): print('Button.Update *** WARNING - Button colors are not supported on the Mac***') if button_color != (None, None): self.TKButton.config(foreground=button_color[0], background=button_color[1]) + self.ButtonColor = button_color except: return if disabled == True: @@ -1682,17 +2077,29 @@ class Button(Element): self.TKButton.pack() def GetText(self): + """ """ return self.ButtonText - def SetFocus(self): + """ """ try: self.TKButton.focus_set() except: pass + def Click(self): + """Generates a click of the button as if the user clicked the button + :return: + + + """ + try: + self.TKButton.invoke() + except: + print('Exception clicking button') def __del__(self): + """ """ try: self.TKButton.__del__() except: @@ -1705,33 +2112,39 @@ B = Button Btn = Button Butt = Button + # ---------------------------------------------------------------------- # # ButtonMenu Class # # ---------------------------------------------------------------------- # class ButtonMenu(Element): - def __init__(self, button_text,menu_def, tooltip=None,disabled=False, - image_filename=None, image_data=None, image_size=(None, None), image_subsample=None,border_width=None, - size=(None, None), auto_size_button=None, button_color=None, font=None, pad=None, key=None, tearoff=False, visible=True): - ''' - ButtonMenu - :param button_text: - :param menu_def: - :param tooltip: - :param disabled: - :param image_filename: - :param image_data: - :param image_size: - :param image_subsample: - :param border_width: - :param size: - :param auto_size_button: - :param button_color: - :param font: - :param pad: - :param key: - :param tearoff: - :param visible: - ''' + """ """ + + def __init__(self, button_text, menu_def, tooltip=None, disabled=False, + image_filename=None, image_data=None, image_size=(None, None), image_subsample=None, border_width=None, + size=(None, None), auto_size_button=None, button_color=None, font=None, pad=None, key=None, + tearoff=False, visible=True): + """ + + :param button_text: + :param menu_def: + :param tooltip: text, that will appear the you hover on (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param image_filename: (Default value = None) + :param image_data: (Default value = None) + :param image_size: (Default value = (None, None)) + :param image_subsample: (Default value = None) + :param border_width: (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param tearoff: (Default value = False) + :param visible: set visibility state of the element (Default value = True) + + """ + self.MenuDefinition = menu_def self.AutoSizeButton = auto_size_button self.ButtonText = button_text @@ -1751,20 +2164,31 @@ class ButtonMenu(Element): self.TKMenu = None # self.temp_size = size if size != (NONE, NONE) else - super().__init__(ELEM_TYPE_BUTTONMENU, size=size, font=font, pad=pad, key=key, tooltip=tooltip, text_color=self.TextColor, background_color=self.BackgroundColor, visible=visible) + super().__init__(ELEM_TYPE_BUTTONMENU, size=size, font=font, pad=pad, key=key, tooltip=tooltip, + text_color=self.TextColor, background_color=self.BackgroundColor, visible=visible) return + def _MenuItemChosenCallback(self, item_chosen): # ButtonMenu Menu Item Chosen Callback + """ - def MenuItemChosenCallback(self, item_chosen): # ButtonMenu Menu Item Chosen Callback + :param item_chosen: + + """ # print('IN MENU ITEM CALLBACK', item_chosen) - self.MenuItemChosen = item_chosen.replace('&','') + self.MenuItemChosen = item_chosen.replace('&', '') self.ParentForm.LastButtonClicked = self.Key self.ParentForm.FormRemainedOpen = True if self.ParentForm.CurrentlyRunningMainloop: self.ParentForm.TKroot.quit() # kick the users out of the mainloop - def Update(self, menu_definition, visible=None): + """ + + :param menu_definition: + :param visible: change visibility of element (Default value = None) + + """ + self.MenuDefinition = menu_definition if menu_definition is not None: self.TKMenu = tk.Menu(self.TKButtonMenu, tearoff=self.Tearoff) # create the menubar @@ -1775,9 +2199,8 @@ class ButtonMenu(Element): elif visible is True: self.TKButtonMenu.pack() - - def __del__(self): + """ """ try: self.TKButton.__del__() except: @@ -1785,29 +2208,29 @@ class ButtonMenu(Element): super().__del__() - - - # ---------------------------------------------------------------------- # # ProgreessBar # # ---------------------------------------------------------------------- # class ProgressBar(Element): + """ """ def __init__(self, max_value, orientation=None, size=(None, None), auto_size_text=None, bar_color=(None, None), style=None, border_width=None, relief=None, key=None, pad=None, visible=True): - ''' - ProgressBar - :param max_value: - :param orientation: - :param size: - :param auto_size_text: - :param bar_color: - :param style: - :param border_width: - :param relief: - :param key: - :param pad: - :param visible: - ''' + """ + + :param max_value: + :param orientation: (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_text: True if size should fit the text length (Default value = None) + :param bar_color: (Default value = (None) + :param style: (Default value = None) + :param border_width: (Default value = None) + :param relief: (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ + self.MaxValue = max_value self.TKProgressBar = None self.Cancelled = False @@ -1818,10 +2241,18 @@ class ProgressBar(Element): self.BorderWidth = border_width if border_width else DEFAULT_PROGRESS_BAR_BORDER_WIDTH self.Relief = relief if relief else DEFAULT_PROGRESS_BAR_RELIEF self.BarExpired = False - super().__init__(ELEM_TYPE_PROGRESS_BAR, size=size, auto_size_text=auto_size_text, key=key, pad=pad, visible=visible) + super().__init__(ELEM_TYPE_PROGRESS_BAR, size=size, auto_size_text=auto_size_text, key=key, pad=pad, + visible=visible) # returns False if update failed def UpdateBar(self, current_count, max=None): + """ + + :param current_count: + :param max: (Default value = None) + + """ + if self.ParentForm.TKrootDestroyed: return False self.TKProgressBar.Update(current_count, max=max) @@ -1834,13 +2265,19 @@ class ProgressBar(Element): return True def Update(self, visible=None): + """ + + :param visible: change visibility of element (Default value = None) + + """ + if visible is False: self.TKProgressBar.TKProgressBarForReal.pack_forget() elif visible is True: self.TKProgressBar.TKProgressBarForReal.pack() - def __del__(self): + """ """ try: self.TKProgressBar.__del__() except: @@ -1852,21 +2289,25 @@ class ProgressBar(Element): # Image # # ---------------------------------------------------------------------- # class Image(Element): + """ """ + def __init__(self, filename=None, data=None, background_color=None, size=(None, None), pad=None, key=None, tooltip=None, right_click_menu=None, visible=True, enable_events=False): - ''' - Image - :param filename: - :param data: - :param background_color: - :param size: - :param pad: - :param key: - :param tooltip: - :param right_click_menu: - :param visible: - :param enable_events: - ''' + """ + + :param filename: (Default value = None) + :param data: (Default value = None) + :param background_color: color of background (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param right_click_menu: see "Right Click Menus" (Default value = None) + :param visible: set visibility state of the element (Default value = True) + :param enable_events: Turns on the element specific events.(Default value = False) + + """ + self.Filename = filename self.Data = data self.tktext_label = None @@ -1885,7 +2326,16 @@ class Image(Element): tooltip=tooltip, visible=visible) return - def Update(self, filename=None, data=None, size=(None,None), visible=None): + def Update(self, filename=None, data=None, size=(None, None), visible=None): + """ + + :param filename: (Default value = None) + :param data: (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param visible: change visibility of element (Default value = None) + + """ + if filename is not None: image = tk.PhotoImage(file=filename) elif data is not None: @@ -1897,7 +2347,7 @@ class Image(Element): else: return width, height = size[0] or image.width(), size[1] or image.height() - try: # sometimes crashes if user closed with X + try: # sometimes crashes if user closed with X self.tktext_label.configure(image=image, width=width, height=height) except: pass @@ -1908,6 +2358,13 @@ class Image(Element): self.tktext_label.pack() def UpdateAnimation(self, source, time_between_frames=0): + """ + + :param source: + :param time_between_frames: (Default value = 0) + + """ + if self.Source != source: self.AnimatedFrames = None self.Source = source @@ -1936,21 +2393,19 @@ class Image(Element): if time_between_frames: if (now - self.LastFrameTime) * 1000 > time_between_frames: self.LastFrameTime = now - self.CurrentFrameNumber = self.CurrentFrameNumber + 1 if self.CurrentFrameNumber+1< self.TotalAnimatedFrames else 0 - else: # don't reshow the frame again if not time for new frame + self.CurrentFrameNumber = self.CurrentFrameNumber + 1 if self.CurrentFrameNumber + 1 < self.TotalAnimatedFrames else 0 + else: # don't reshow the frame again if not time for new frame return else: - self.CurrentFrameNumber = self.CurrentFrameNumber + 1 if self.CurrentFrameNumber+1< self.TotalAnimatedFrames else 0 + self.CurrentFrameNumber = self.CurrentFrameNumber + 1 if self.CurrentFrameNumber + 1 < self.TotalAnimatedFrames else 0 image = self.AnimatedFrames[self.CurrentFrameNumber] - try: # needed in case the window was closed with an "X" + try: # needed in case the window was closed with an "X" self.tktext_label.configure(image=image, width=image.width(), heigh=image.height()) except: pass - - - def __del__(self): + """ """ super().__del__() @@ -1958,18 +2413,23 @@ class Image(Element): # Canvas # # ---------------------------------------------------------------------- # class Canvas(Element): - def __init__(self, canvas=None, background_color=None, size=(None, None), pad=None, key=None, tooltip=None, right_click_menu=None, visible=True): - ''' - Canvas - :param canvas: - :param background_color: - :param size: - :param pad: - :param key: - :param tooltip: - :param right_click_menu: - :param visible: - ''' + """ """ + + def __init__(self, canvas=None, background_color=None, size=(None, None), pad=None, key=None, tooltip=None, + right_click_menu=None, visible=True): + """ + + :param canvas: (Default value = None) + :param background_color: color of background (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param right_click_menu: see "Right Click Menus" (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ + self.BackgroundColor = background_color if background_color is not None else DEFAULT_BACKGROUND_COLOR self._TKCanvas = canvas self.RightClickMenu = right_click_menu @@ -1980,12 +2440,14 @@ class Canvas(Element): @property def TKCanvas(self): + """ """ if self._TKCanvas is None: print('*** Did you forget to call Finalize()? Your code should look something like: ***') print('*** form = sg.Window("My Form").Layout(layout).Finalize() ***') return self._TKCanvas def __del__(self): + """ """ super().__del__() @@ -1993,32 +2455,38 @@ class Canvas(Element): # Graph # # ---------------------------------------------------------------------- # class Graph(Element): - def __init__(self, canvas_size, graph_bottom_left, graph_top_right, background_color=None, pad=None, change_submits=False, drag_submits=False, enable_events=False, key=None, tooltip=None, right_click_menu=None, visible=True): - ''' - Graph - :param canvas_size: - :param graph_bottom_left: - :param graph_top_right: - :param background_color: - :param pad: - :param change_submits: - :param drag_submits: - :param enable_events: - :param key: - :param tooltip: - :param right_click_menu: - :param visible: - ''' + """ """ + + def __init__(self, canvas_size, graph_bottom_left, graph_top_right, background_color=None, pad=None, + change_submits=False, drag_submits=False, enable_events=False, key=None, tooltip=None, + right_click_menu=None, visible=True): + """ + + :param canvas_size: + :param graph_bottom_left: + :param graph_top_right: + :param background_color: color of background (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param change_submits: If True, pressing Enter key submits window (Default value = False) + :param drag_submits: (Default value = False) + :param enable_events: Turns on the element specific events.(Default value = False) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param right_click_menu: see "Right Click Menus" (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ + self.CanvasSize = canvas_size self.BottomLeft = graph_bottom_left self.TopRight = graph_top_right - self._TKCanvas = None - self._TKCanvas2 = None # Type: tk.Canvas + # self._TKCanvas = None # type: tk.Canvas + self._TKCanvas2 = None # type: tk.Canvas self.ChangeSubmits = change_submits or enable_events self.DragSubmits = drag_submits self.ClickPosition = (None, None) self.MouseButtonDown = False - self.Images = [] + self.Images = {} self.RightClickMenu = right_click_menu super().__init__(ELEM_TYPE_GRAPH, background_color=background_color, size=canvas_size, pad=pad, key=key, @@ -2026,7 +2494,13 @@ class Graph(Element): return def _convert_xy_to_canvas_xy(self, x_in, y_in): - if None in (x_in,y_in): + """ + + :param x_in: + :param y_in: + + """ + if None in (x_in, y_in): return None, None scale_x = (self.CanvasSize[0] - 0) / (self.TopRight[0] - self.BottomLeft[0]) scale_y = (0 - self.CanvasSize[1]) / (self.TopRight[1] - self.BottomLeft[1]) @@ -2034,19 +2508,31 @@ class Graph(Element): new_y = self.CanvasSize[1] + scale_y * (y_in - self.BottomLeft[1]) return new_x, new_y - def _convert_canvas_xy_to_xy(self, x_in, y_in): - if None in (x_in,y_in): + """ + + :param x_in: + :param y_in: + + """ + if None in (x_in, y_in): return None, None scale_x = (self.CanvasSize[0] - 0) / (self.TopRight[0] - self.BottomLeft[0]) scale_y = (0 - self.CanvasSize[1]) / (self.TopRight[1] - self.BottomLeft[1]) - new_x = x_in/scale_x+self.BottomLeft[0] - new_y = (y_in - self.CanvasSize[1]) / scale_y + self.BottomLeft[1] + new_x = x_in / scale_x + self.BottomLeft[0] + new_y = (y_in - self.CanvasSize[1]) / scale_y + self.BottomLeft[1] return int(new_x), int(new_y) - def DrawLine(self, point_from, point_to, color='black', width=1): + """ + + :param point_from: + :param point_to: + :param color: (Default value = 'black') + :param width: (Default value = 1) + + """ if point_from == (None, None): return converted_point_from = self._convert_xy_to_canvas_xy(point_from[0], point_from[1]) @@ -2055,14 +2541,20 @@ class Graph(Element): print('*** WARNING - The Graph element has not been finalized and cannot be drawn upon ***') print('Call Window.Finalize() prior to this operation') return None - try: # in case window was closed with an X + try: # in case window was closed with an X id = self._TKCanvas2.create_line(converted_point_from, converted_point_to, width=width, fill=color) except: id = None return id - def DrawPoint(self, point, size=2, color='black'): + """ + + :param point: + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = 2) + :param color: (Default value = 'black') + + """ if point == (None, None): return converted_point = self._convert_xy_to_canvas_xy(point[0], point[1]) @@ -2070,16 +2562,23 @@ class Graph(Element): print('*** WARNING - The Graph element has not been finalized and cannot be drawn upon ***') print('Call Window.Finalize() prior to this operation') return None - try: # needed in case window was closed with an X - id = self._TKCanvas2.create_oval(converted_point[0] - size, converted_point[1] - size, - converted_point[0] + size, converted_point[1] + size, fill=color, - outline=color) + try: # needed in case window was closed with an X + id = self._TKCanvas2.create_oval(converted_point[0] - size, converted_point[1] - size, + converted_point[0] + size, converted_point[1] + size, fill=color, + outline=color) except: id = None return - def DrawCircle(self, center_location, radius, fill_color=None, line_color='black'): + """ + + :param center_location: + :param radius: + :param fill_color: (Default value = None) + :param line_color: (Default value = 'black') + + """ if center_location == (None, None): return converted_point = self._convert_xy_to_canvas_xy(center_location[0], center_location[1]) @@ -2087,30 +2586,48 @@ class Graph(Element): print('*** WARNING - The Graph element has not been finalized and cannot be drawn upon ***') print('Call Window.Finalize() prior to this operation') return None - try: # needed in case the window was closed with an X + try: # needed in case the window was closed with an X id = self._TKCanvas2.create_oval(converted_point[0] - radius, converted_point[1] - radius, - converted_point[0] + radius, converted_point[1] + radius, fill=fill_color, - outline=line_color) + converted_point[0] + radius, converted_point[1] + radius, fill=fill_color, + outline=line_color) except: id = None return id def DrawOval(self, top_left, bottom_right, fill_color=None, line_color=None): + """ + + :param top_left: + :param bottom_right: + :param fill_color: (Default value = None) + :param line_color: (Default value = None) + + """ converted_top_left = self._convert_xy_to_canvas_xy(top_left[0], top_left[1]) converted_bottom_right = self._convert_xy_to_canvas_xy(bottom_right[0], bottom_right[1]) if self._TKCanvas2 is None: print('*** WARNING - The Graph element has not been finalized and cannot be drawn upon ***') print('Call Window.Finalize() prior to this operation') return None - try: # in case windows close with X + try: # in case windows close with X id = self._TKCanvas2.create_oval(converted_top_left[0], converted_top_left[1], converted_bottom_right[0], - converted_bottom_right[1], fill=fill_color, outline=line_color) + converted_bottom_right[1], fill=fill_color, outline=line_color) except: id = None return id def DrawArc(self, top_left, bottom_right, extent, start_angle, style=None, arc_color='black'): + """ + + :param top_left: + :param bottom_right: + :param extent: + :param start_angle: + :param style: (Default value = None) + :param arc_color: (Default value = 'black') + + """ converted_top_left = self._convert_xy_to_canvas_xy(top_left[0], top_left[1]) converted_bottom_right = self._convert_xy_to_canvas_xy(bottom_right[0], bottom_right[1]) tkstyle = tk.PIESLICE if style is None else style @@ -2118,30 +2635,47 @@ class Graph(Element): print('*** WARNING - The Graph element has not been finalized and cannot be drawn upon ***') print('Call Window.Finalize() prior to this operation') return None - try: # in case closed with X + try: # in case closed with X id = self._TKCanvas2.create_arc(converted_top_left[0], converted_top_left[1], converted_bottom_right[0], - converted_bottom_right[1], extent=extent, start=start_angle, style=tkstyle, - outline=arc_color) + converted_bottom_right[1], extent=extent, start=start_angle, style=tkstyle, + outline=arc_color) except: id = None return id def DrawRectangle(self, top_left, bottom_right, fill_color=None, line_color=None): + """ + + :param top_left: + :param bottom_right: + :param fill_color: (Default value = None) + :param line_color: (Default value = None) + + """ converted_top_left = self._convert_xy_to_canvas_xy(top_left[0], top_left[1]) converted_bottom_right = self._convert_xy_to_canvas_xy(bottom_right[0], bottom_right[1]) if self._TKCanvas2 is None: print('*** WARNING - The Graph element has not been finalized and cannot be drawn upon ***') print('Call Window.Finalize() prior to this operation') return None - try: # in case closed with X - id = self._TKCanvas2.create_rectangle(converted_top_left[0], converted_top_left[1], converted_bottom_right[0], - converted_bottom_right[1], fill=fill_color, outline=line_color) + try: # in case closed with X + id = self._TKCanvas2.create_rectangle(converted_top_left[0], converted_top_left[1], + converted_bottom_right[0], + converted_bottom_right[1], fill=fill_color, outline=line_color) except: id = None return id - def DrawText(self, text, location, color='black', font=None, angle=0): + """ + + :param text: + :param location: + :param color: (Default value = 'black') + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param angle: (Default value = 0) + + """ if location == (None, None): return converted_point = self._convert_xy_to_canvas_xy(location[0], location[1]) @@ -2151,13 +2685,22 @@ class Graph(Element): return None try: # in case closed with X id = self._TKCanvas2.create_text(converted_point[0], converted_point[1], text=text, font=font, fill=color, - angle=angle) + angle=angle) except: id = None return id - def DrawImage(self, filename=None, data=None, location=(None, None), color='black', font=None, angle=0): + """ + + :param filename: (Default value = None) + :param data: (Default value = None) + :param location: (Default value = (None, None)) + :param color: (Default value = 'black') + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param angle: (Default value = 0) + + """ if location == (None, None): return if filename is not None: @@ -2167,39 +2710,52 @@ class Graph(Element): try: image = tk.PhotoImage(data=data) except: - return None # an error likely means the window has closed so exit + return None # an error likely means the window has closed so exit converted_point = self._convert_xy_to_canvas_xy(location[0], location[1]) if self._TKCanvas2 is None: print('*** WARNING - The Graph element has not been finalized and cannot be drawn upon ***') print('Call Window.Finalize() prior to this operation') return None - self.Images.append(image) try: # in case closed with X id = self._TKCanvas2.create_image(converted_point, image=image, anchor=tk.NW) + self.Images[id] = image except: id = None return id - - def Erase(self): + """ """ if self._TKCanvas2 is None: print('*** WARNING - The Graph element has not been finalized and cannot be drawn upon ***') print('Call Window.Finalize() prior to this operation') return None - try: # in case window was closed with X + self.Images = {} + try: # in case window was closed with X self._TKCanvas2.delete('all') except: pass - def DeleteFigure(self, id): + """ + + :param id: + + """ try: self._TKCanvas2.delete(id) except: print('DeleteFigure - bad ID {}'.format(id)) + try: + del self.Images[id] # in case was an image. If wasn't an image, then will get exception + except: pass def Update(self, background_color, visible=None): + """ + + :param background_color: color of background + :param visible: change visibility of element (Default value = None) + + """ if self._TKCanvas2 is None: print('*** WARNING - The Graph element has not been finalized and cannot be drawn upon ***') print('Call Window.Finalize() prior to this operation') @@ -2211,6 +2767,12 @@ class Graph(Element): self._TKCanvas2.pack() def Move(self, x_direction, y_direction): + """ + + :param x_direction: + :param y_direction: + + """ zero_converted = self._convert_xy_to_canvas_xy(0, 0) shift_converted = self._convert_xy_to_canvas_xy(x_direction, y_direction) shift_amount = (shift_converted[0] - zero_converted[0], shift_converted[1] - zero_converted[1]) @@ -2221,6 +2783,13 @@ class Graph(Element): self._TKCanvas2.move('all', shift_amount[0], shift_amount[1]) def MoveFigure(self, figure, x_direction, y_direction): + """ + + :param figure: + :param x_direction: + :param y_direction: + + """ zero_converted = self._convert_xy_to_canvas_xy(0, 0) shift_converted = self._convert_xy_to_canvas_xy(x_direction, y_direction) shift_amount = (shift_converted[0] - zero_converted[0], shift_converted[1] - zero_converted[1]) @@ -2230,8 +2799,14 @@ class Graph(Element): return None self._TKCanvas2.move(figure, shift_amount[0], shift_amount[1]) - def RelocateFigure(self, figure, x, y): + """ + + :param figure: + :param x: + :param y: + + """ zero_converted = self._convert_xy_to_canvas_xy(0, 0) shift_converted = self._convert_xy_to_canvas_xy(x, y) shift_amount = (shift_converted[0] - zero_converted[0], shift_converted[1] - zero_converted[1]) @@ -2240,11 +2815,11 @@ class Graph(Element): print('Call Window.Finalize() prior to all graph operations') return None xy = self._TKCanvas2.coords(figure) - self._TKCanvas2.move(figure, shift_converted[0]-xy[0], shift_converted[1]-xy[1]) - + self._TKCanvas2.move(figure, shift_converted[0] - xy[0], shift_converted[1] - xy[1]) @property def TKCanvas(self): + """ """ if self._TKCanvas2 is None: print('*** Did you forget to call Finalize()? Your code should look something like: ***') print('*** form = sg.Window("My Form").Layout(layout).Finalize() ***') @@ -2252,34 +2827,47 @@ class Graph(Element): # Realtime button release callback def ButtonReleaseCallBack(self, event): + """ + + :param event: + + """ self.ClickPosition = (None, None) self.LastButtonClickedWasRealtime = not self.DragSubmits if self.Key is not None: self.ParentForm.LastButtonClicked = self.Key else: - self.ParentForm.LastButtonClicked = '__GRAPH__' # need to put something rather than None + self.ParentForm.LastButtonClicked = '__GRAPH__' # need to put something rather than None if self.ParentForm.CurrentlyRunningMainloop: self.ParentForm.TKroot.quit() if self.DragSubmits: self.ParentForm.LastButtonClicked = None self.MouseButtonDown = False - # Realtime button callback def ButtonPressCallBack(self, event): + """ + + :param event: + + """ self.ClickPosition = self._convert_canvas_xy_to_xy(event.x, event.y) self.ParentForm.LastButtonClickedWasRealtime = self.DragSubmits if self.Key is not None: self.ParentForm.LastButtonClicked = self.Key else: - self.ParentForm.LastButtonClicked = '__GRAPH__' # need to put something rather than None + self.ParentForm.LastButtonClicked = '__GRAPH__' # need to put something rather than None if self.ParentForm.CurrentlyRunningMainloop: - self.ParentForm.TKroot.quit() # kick out of loop if read was called + self.ParentForm.TKroot.quit() # kick out of loop if read was called self.MouseButtonDown = True - # Realtime button callback def MotionCallBack(self, event): + """ + + :param event: + + """ if not self.MouseButtonDown: return self.ClickPosition = self._convert_canvas_xy_to_xy(event.x, event.y) @@ -2287,14 +2875,17 @@ class Graph(Element): if self.Key is not None: self.ParentForm.LastButtonClicked = self.Key else: - self.ParentForm.LastButtonClicked = '__GRAPH__' # need to put something rather than None + self.ParentForm.LastButtonClicked = '__GRAPH__' # need to put something rather than None if self.ParentForm.CurrentlyRunningMainloop: - self.ParentForm.TKroot.quit() # kick out of loop if read was called - - + self.ParentForm.TKroot.quit() # kick out of loop if read was called + def SetFocus(self): + """ """ + self._TKCanvas2.focus_set() + # self._TKCanvas2.focus_force() def __del__(self): + """ """ super().__del__() @@ -2302,26 +2893,30 @@ class Graph(Element): # Frame # # ---------------------------------------------------------------------- # class Frame(Element): + """ """ + def __init__(self, title, layout, title_color=None, background_color=None, title_location=None, relief=DEFAULT_FRAME_RELIEF, size=(None, None), font=None, pad=None, border_width=None, key=None, tooltip=None, right_click_menu=None, visible=True): - ''' - Frame - :param title: - :param layout: - :param title_color: - :param background_color: - :param title_location: - :param relief: - :param size: - :param font: - :param pad: - :param border_width: - :param key: - :param tooltip: - :param right_click_menu: - :param visible: - ''' + """ + + :param title: + :param layout: + :param title_color: (Default value = None) + :param background_color: color of background (Default value = None) + :param title_location: (Default value = None) + :param relief: (Default value = DEFAULT_FRAME_RELIEF) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param border_width: (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param right_click_menu: see "Right Click Menus" (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ + self.UseDictionary = False self.ReturnValues = None self.ReturnValuesList = [] @@ -2346,7 +2941,11 @@ class Frame(Element): return def AddRow(self, *args): - ''' Parms are a variable number of Elements ''' + """Parms are a variable number of Elements + + :param *args: + + """ NumRows = len(self.Rows) # number of existing rows is our row number CurrentRowNumber = NumRows # this row's number CurrentRow = [] # start with a blank row and build up @@ -2361,24 +2960,39 @@ class Frame(Element): self.Rows.append(CurrentRow) def Layout(self, rows): + """ + + :param rows: + + """ for row in rows: self.AddRow(*row) def _GetElementAtLocation(self, location): + """ + + :param location: + + """ (row_num, col_num) = location row = self.Rows[row_num] element = row[col_num] return element - def Update(self, visible=None): + """ + + :param visible: change visibility of element (Default value = None) + + """ + if visible is False: self.TKFrame.pack_forget() elif visible is True: self.TKFrame.pack() - def __del__(self): + """ """ for row in self.Rows: for element in row: element.__del__() @@ -2390,16 +3004,21 @@ class Frame(Element): # Routes stdout, stderr to a scrolled window # # ---------------------------------------------------------------------- # class VerticalSeparator(Element): + """ """ + def __init__(self, pad=None): - ''' - VerticalSeperator - A separator that spans only 1 row in a vertical fashion - :param pad: - ''' + """ + + :param pad: (common_key) Amount of padding to put around element (Default value = None) + + """ + self.Orientation = 'vertical' # for now only vertical works super().__init__(ELEM_TYPE_SEPARATOR, pad=pad) def __del__(self): + """ """ super().__del__() @@ -2411,23 +3030,27 @@ VSep = VerticalSeparator # Tab # # ---------------------------------------------------------------------- # class Tab(Element): + """ """ + def __init__(self, title, layout, title_color=None, background_color=None, font=None, pad=None, disabled=False, border_width=None, key=None, tooltip=None, right_click_menu=None, visible=True): - ''' - Tab - :param title: - :param layout: - :param title_color: - :param background_color: - :param font: - :param pad: - :param disabled: - :param border_width: - :param key: - :param tooltip: - :param right_click_menu: - :param visible: - ''' + """ + + :param title: + :param layout: + :param title_color: (Default value = None) + :param background_color: color of background (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param border_width: (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param right_click_menu: see "Right Click Menus" (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ + self.UseDictionary = False self.ReturnValues = None self.ReturnValuesList = [] @@ -2452,7 +3075,11 @@ class Tab(Element): return def AddRow(self, *args): - ''' Parms are a variable number of Elements ''' + """Parms are a variable number of Elements + + :param *args: + + """ NumRows = len(self.Rows) # number of existing rows is our row number CurrentRowNumber = NumRows # this row's number CurrentRow = [] # start with a blank row and build up @@ -2467,11 +3094,23 @@ class Tab(Element): self.Rows.append(CurrentRow) def Layout(self, rows): + """ + + :param rows: + + """ for row in rows: self.AddRow(*row) return self def Update(self, disabled=None, visible=None): # TODO Disable / enable of tabs is not complete + """ + + :param disabled: disable or enable state of the element (Default value = None) + :param visible: change visibility of element (Default value = None) + + """ + if disabled is None: return self.Disabled = disabled @@ -2484,12 +3123,18 @@ class Tab(Element): return self def _GetElementAtLocation(self, location): + """ + + :param location: + + """ (row_num, col_num) = location row = self.Rows[row_num] element = row[col_num] return element def __del__(self): + """ """ for row in self.Rows: for element in row: element.__del__() @@ -2500,25 +3145,30 @@ class Tab(Element): # TabGroup # # ---------------------------------------------------------------------- # class TabGroup(Element): + """ """ + def __init__(self, layout, tab_location=None, title_color=None, selected_title_color=None, background_color=None, - font=None, change_submits=False, enable_events=False,pad=None, border_width=None, theme=None, key=None, tooltip=None, visible=True): - ''' - TabGroup - :param layout: - :param tab_location: - :param title_color: - :param selected_title_color: - :param background_color: - :param font: - :param change_submits: - :param enable_events: - :param pad: - :param border_width: - :param theme: - :param key: - :param tooltip: - :param visible: - ''' + font=None, change_submits=False, enable_events=False, pad=None, border_width=None, theme=None, + key=None, tooltip=None, visible=True): + """ + + :param layout: + :param tab_location: (Default value = None) + :param title_color: (Default value = None) + :param selected_title_color: (Default value = None) + :param background_color: color of background (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param change_submits: If True, pressing Enter key submits window (Default value = False) + :param enable_events: Turns on the element specific events.(Default value = False) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param border_width: (Default value = None) + :param theme: (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ + self.UseDictionary = False self.ReturnValues = None self.ReturnValuesList = [] @@ -2527,7 +3177,8 @@ class TabGroup(Element): self.ParentWindow = None self.SelectedTitleColor = selected_title_color self.Rows = [] - self.TKNotebook = None + self.TKNotebook = None # type: ttk.Notebook + self.Widget = None # type: ttk.Notebook self.TabCount = 0 self.BorderWidth = border_width self.Theme = theme @@ -2542,7 +3193,11 @@ class TabGroup(Element): return def AddRow(self, *args): - ''' Parms are a variable number of Elements ''' + """Parms are a variable number of Elements + + :param *args: + + """ NumRows = len(self.Rows) # number of existing rows is our row number CurrentRowNumber = NumRows # this row's number CurrentRow = [] # start with a blank row and build up @@ -2557,23 +3212,50 @@ class TabGroup(Element): self.Rows.append(CurrentRow) def Layout(self, rows): + """ + + :param rows: + + """ for row in rows: self.AddRow(*row) def _GetElementAtLocation(self, location): + """ + + :param location: + + """ (row_num, col_num) = location row = self.Rows[row_num] element = row[col_num] return element def FindKeyFromTabName(self, tab_name): + """ + + :param tab_name: + + """ for row in self.Rows: for element in row: if element.Title == tab_name: return element.Key return None + def SelectTab(self, index): + """ + + :param index: + + """ + try: + self.TKNotebook.select(index) + except Exception as e: + print('Exception Selecting Tab {}'.format(e)) + def __del__(self): + """ """ for row in self.Rows: for element in row: element.__del__() @@ -2584,30 +3266,37 @@ class TabGroup(Element): # Slider # # ---------------------------------------------------------------------- # class Slider(Element): - def __init__(self, range=(None, None), default_value=None, resolution=None, tick_interval=None, orientation=None, disable_number_display=False, border_width=None, relief=None, change_submits=False, enable_events=False, disabled=False, size=(None, None), font=None, background_color=None, text_color=None, key=None, pad=None, tooltip=None, visible=True): - ''' - Slider - :param range: - :param default_value: - :param resolution: - :param tick_interval: - :param orientation: - :param disable_number_display: - :param border_width: - :param relief: - :param change_submits: - :param enable_events: - :param disabled: - :param size: - :param font: - :param background_color: - :param text_color: - :param key: - :param pad: - :param tooltip: - :param visible: - ''' - self.TKScale = None # type: tk.Scale + """ """ + + def __init__(self, range=(None, None), default_value=None, resolution=None, tick_interval=None, orientation=None, + disable_number_display=False, border_width=None, relief=None, change_submits=False, + enable_events=False, disabled=False, size=(None, None), font=None, background_color=None, + text_color=None, key=None, pad=None, tooltip=None, visible=True): + """ + + :param range: (Default value = (None, None)) + :param default_value: (Default value = None) + :param resolution: (Default value = None) + :param tick_interval: (Default value = None) + :param orientation: (Default value = None) + :param disable_number_display: (Default value = False) + :param border_width: (Default value = None) + :param relief: (Default value = None) + :param change_submits: If True, pressing Enter key submits window (Default value = False) + :param enable_events: Turns on the element specific events.(Default value = False) + :param disabled: set disable state for element (Default value = False) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ + + self.TKScale = None # type: tk.Scale self.Range = (1, 10) if range == (None, None) else range self.DefaultValue = self.Range[0] if default_value is None else default_value self.Orientation = orientation if orientation else DEFAULT_SLIDER_ORIENTATION @@ -2627,6 +3316,15 @@ class Slider(Element): return def Update(self, value=None, range=(None, None), disabled=None, visible=None): + """ + + :param value: (Default value = None) + :param range: (Default value = (None, None)) + :param disabled: disable or enable state of the element (Default value = None) + :param visible: change visibility of element (Default value = None) + + """ + if value is not None: try: self.TKIntVar.set(value) @@ -2644,7 +3342,12 @@ class Slider(Element): elif visible is True: self.TKScale.pack() - def SliderChangedHandler(self, event): + def _SliderChangedHandler(self, event): + """ + + :param event: + + """ # first, get the results table built # modify the Results table in the parent FlexForm object if self.Key is not None: @@ -2656,6 +3359,7 @@ class Slider(Element): self.ParentForm.TKroot.quit() # kick the users out of the mainloop def __del__(self): + """ """ super().__del__() @@ -2663,7 +3367,14 @@ class Slider(Element): # TkScrollableFrame (Used by Column) # # ---------------------------------------------------------------------- # class TkFixedFrame(tk.Frame): + """ """ def __init__(self, master, **kwargs): + """ + + :param master: + :param **kwargs: + + """ tk.Frame.__init__(self, master, **kwargs) self.canvas = tk.Canvas(self) @@ -2682,12 +3393,19 @@ class TkFixedFrame(tk.Frame): self.config(borderwidth=0, highlightthickness=0) - # ---------------------------------------------------------------------- # # TkScrollableFrame (Used by Column) # # ---------------------------------------------------------------------- # class TkScrollableFrame(tk.Frame): + """ """ def __init__(self, master, vertical_only, **kwargs): + """ + + :param master: + :param vertical_only: + :param **kwargs: + + """ tk.Frame.__init__(self, master, **kwargs) # create a canvas object and a vertical scrollbar for scrolling it @@ -2732,21 +3450,42 @@ class TkScrollableFrame(tk.Frame): self.bind_mouse_scroll(self.vscrollbar, self.yscroll) def resize_frame(self, e): + """ + + :param e: + + """ self.canvas.itemconfig(self.frame_id, height=e.height, width=e.width) def yscroll(self, event): + """ + + :param event: + + """ if event.num == 5 or event.delta < 0: self.canvas.yview_scroll(1, "unit") elif event.num == 4 or event.delta > 0: self.canvas.yview_scroll(-1, "unit") def xscroll(self, event): + """ + + :param event: + + """ if event.num == 5 or event.delta < 0: self.canvas.xview_scroll(1, "unit") elif event.num == 4 or event.delta > 0: self.canvas.xview_scroll(-1, "unit") def bind_mouse_scroll(self, parent, mode): + """ + + :param parent: + :param mode: + + """ # ~~ Windows only parent.bind("", mode) # ~~ Unix only @@ -2754,7 +3493,11 @@ class TkScrollableFrame(tk.Frame): parent.bind("", mode) def set_scrollregion(self, event=None): - """ Set the scroll region on the canvas""" + """Set the scroll region on the canvas + + :param event: (Default value = None) + + """ self.canvas.configure(scrollregion=self.canvas.bbox('all')) @@ -2762,19 +3505,24 @@ class TkScrollableFrame(tk.Frame): # Column # # ---------------------------------------------------------------------- # class Column(Element): - def __init__(self, layout, background_color=None, size=(None, None), pad=None, scrollable=False, vertical_scroll_only=False, right_click_menu=None, key=None, visible=True): - ''' - Column - :param layout: - :param background_color: - :param size: - :param pad: - :param scrollable: - :param vertical_scroll_only: - :param right_click_menu: - :param key: - :param visible: - ''' + """ """ + + def __init__(self, layout, background_color=None, size=(None, None), pad=None, scrollable=False, + vertical_scroll_only=False, right_click_menu=None, key=None, visible=True): + """ + + :param layout: + :param background_color: color of background (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param scrollable: (Default value = False) + :param vertical_scroll_only: (Default value = False) + :param right_click_menu: see "Right Click Menus" (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ + self.UseDictionary = False self.ReturnValues = None self.ReturnValuesList = [] @@ -2796,9 +3544,12 @@ class Column(Element): super().__init__(ELEM_TYPE_COLUMN, background_color=bg, size=size, pad=pad, key=key, visible=visible) return - def AddRow(self, *args): - ''' Parms are a variable number of Elements ''' + """Parms are a variable number of Elements + + :param *args: + + """ NumRows = len(self.Rows) # number of existing rows is our row number CurrentRowNumber = NumRows # this row's number CurrentRow = [] # start with a blank row and build up @@ -2813,16 +3564,32 @@ class Column(Element): self.Rows.append(CurrentRow) def Layout(self, rows): + """ + + :param rows: + + """ for row in rows: self.AddRow(*row) def _GetElementAtLocation(self, location): + """ + + :param location: + + """ (row_num, col_num) = location row = self.Rows[row_num] element = row[col_num] return element def Update(self, visible=None): + """ + + :param visible: change visibility of element (Default value = None) + + """ + if visible is False: if self.TKColFrame: self.TKColFrame.pack_forget() @@ -2834,8 +3601,8 @@ class Column(Element): if self.ParentPanedWindow: self.ParentPanedWindow.add(self.TKColFrame) - def __del__(self): + """ """ for row in self.Rows: for element in row: element.__del__() @@ -2850,21 +3617,26 @@ class Column(Element): # Pane # # ---------------------------------------------------------------------- # class Pane(Element): - def __init__(self, pane_list, background_color=None, size=(None, None), pad=None, orientation='vertical', show_handle=True, relief=RELIEF_RAISED, handle_size=None, border_width=None, key=None, visible=True): - ''' - Pane - :param pane_list: - :param background_color: - :param size: - :param pad: - :param orientation: - :param show_handle: - :param relief: - :param handle_size: - :param border_width: - :param key: - :param visible: - ''' + """ """ + + def __init__(self, pane_list, background_color=None, size=(None, None), pad=None, orientation='vertical', + show_handle=True, relief=RELIEF_RAISED, handle_size=None, border_width=None, key=None, visible=True): + """ + + :param pane_list: + :param background_color: color of background (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param orientation: (Default value = 'vertical') + :param show_handle: (Default value = True) + :param relief: (Default value = RELIEF_RAISED) + :param handle_size: (Default value = None) + :param border_width: (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ + self.UseDictionary = False self.ReturnValues = None self.ReturnValuesList = [] @@ -2878,7 +3650,7 @@ class Pane(Element): self.PaneList = pane_list self.ShowHandle = show_handle self.Relief = relief - self.HandleSize = handle_size or 8 + self.HandleSize = handle_size or 8 self.BorderDepth = border_width bg = background_color if background_color is not None else DEFAULT_BACKGROUND_COLOR @@ -2887,33 +3659,42 @@ class Pane(Element): super().__init__(ELEM_TYPE_PANE, background_color=bg, size=size, pad=pad, key=key, visible=visible) return - def Update(self, visible=None): + """ + + :param visible: change visibility of element (Default value = None) + + """ + if visible is False: self.PanedWindow.pack_forget() elif visible is True: self.PanedWindow.pack() - # ---------------------------------------------------------------------- # # Calendar # # ---------------------------------------------------------------------- # class TKCalendar(ttk.Frame): - """ - This code was shamelessly lifted from moshekaplan's repository - moshekaplan/tkinter_components - """ + """This code was shamelessly lifted from moshekaplan's repository - moshekaplan/tkinter_components""" # XXX ToDo: cget and configure datetime = calendar.datetime.datetime timedelta = calendar.datetime.timedelta def __init__(self, master=None, target_element=None, close_when_chosen=True, default_date=(None, None, None), **kw): - """ - WIDGET-SPECIFIC OPTIONS - + """WIDGET-SPECIFIC OPTIONS + locale, firstweekday, year, month, selectbackground, selectforeground + + :param master: (Default value = None) + :param target_element: (Default value = None) + :param close_when_chosen: (Default value = True) + :param default_date: (Default value = (None) + :param None:, None)) + :param **kw: + """ self._TargetElement = target_element default_mon, default_day, default_year = default_date @@ -2924,6 +3705,9 @@ class TKCalendar(ttk.Frame): locale = kw.pop('locale', None) sel_bg = kw.pop('selectbackground', '#ecffc4') sel_fg = kw.pop('selectforeground', '#05640e') + self.format = kw.pop('format') + if self.format is None: + self.format = '%Y-%m-%d %H:%M:%S' self._date = self.datetime(year, month, default_day or 1) self._selection = None # no date selected @@ -2950,6 +3734,12 @@ class TKCalendar(ttk.Frame): self._build_calendar() def __setitem__(self, item, value): + """ + + :param item: + :param value: + + """ if item in ('year', 'month'): raise AttributeError("attribute '%s' is not writeable" % item) elif item == 'selectbackground': @@ -2960,6 +3750,11 @@ class TKCalendar(ttk.Frame): ttk.Frame.__setitem__(self, item, value) def __getitem__(self, item): + """ + + :param item: + + """ if item in ('year', 'month'): return getattr(self._date, item) elif item == 'selectbackground': @@ -2971,6 +3766,7 @@ class TKCalendar(ttk.Frame): return r[item] def __setup_styles(self): + """ """ # custom ttk styles style = ttk.Style(self.master) arrow_layout = lambda dir: ( @@ -2980,6 +3776,7 @@ class TKCalendar(ttk.Frame): style.layout('R.TButton', arrow_layout('right')) def __place_widgets(self): + """ """ # header frame and its widgets hframe = ttk.Frame(self) lbtn = ttk.Button(hframe, style='L.TButton', command=self._prev_month) @@ -2996,6 +3793,7 @@ class TKCalendar(ttk.Frame): self._calendar.pack(in_=self, expand=1, fill='both', side='bottom') def __config_calendar(self): + """ """ cols = self._cal.formatweekheader(3).split() self._calendar['columns'] = cols self._calendar.tag_configure('header', background='grey90') @@ -3008,6 +3806,12 @@ class TKCalendar(ttk.Frame): anchor='e') def __setup_selection(self, sel_bg, sel_fg): + """ + + :param sel_bg: + :param sel_fg: + + """ self._font = tkinter.font.Font() self._canvas = canvas = tk.Canvas(self._calendar, background=sel_bg, borderwidth=0, highlightthickness=0) @@ -3018,11 +3822,17 @@ class TKCalendar(ttk.Frame): self._calendar.bind('', self._pressed) def __minsize(self, evt): + """ + + :param evt: + + """ width, height = self._calendar.master.geometry().split('x') height = height[:height.index('+')] self._calendar.master.minsize(width, height) def _build_calendar(self): + """ """ year, month = self._date.year, self._date.month # update header text (Month, YEAR) @@ -3037,7 +3847,12 @@ class TKCalendar(ttk.Frame): self._calendar.item(item, values=fmt_week) def _show_selection(self, text, bbox): - """Configure canvas for a new selection.""" + """Configure canvas for a new selection. + + :param text: + :param bbox: + + """ x, y, width, height = bbox textw = self._font.measure(text) @@ -3051,7 +3866,11 @@ class TKCalendar(ttk.Frame): # Callbacks def _pressed(self, evt): - """Clicked somewhere in the calendar.""" + """Clicked somewhere in the calendar. + + :param evt: + + """ x, y, widget = evt.x, evt.y, evt.widget item = widget.identify_row(y) column = widget.identify_column(x) @@ -3077,8 +3896,11 @@ class TKCalendar(ttk.Frame): self._selection = (text, item, column) self._show_selection(text, bbox) year, month = self._date.year, self._date.month + now = self.datetime.now() try: - self._TargetElement.Update(self.datetime(year, month, int(self._selection[0]))) + self._TargetElement.Update( + self.datetime(year, month, int(self._selection[0]), now.hour, now.minute, now.second).strftime( + self.format)) if self._TargetElement.ChangeSubmits: self._TargetElement.ParentForm.LastButtonClicked = self._TargetElement.Key self._TargetElement.ParentForm.FormRemainedOpen = True @@ -3110,7 +3932,7 @@ class TKCalendar(ttk.Frame): @property def selection(self): - """Return a datetime representing the current selected date.""" + """ """ if not self._selection: return None @@ -3122,27 +3944,38 @@ class TKCalendar(ttk.Frame): # Menu # # ---------------------------------------------------------------------- # class Menu(Element): - def __init__(self, menu_definition, background_color=None, size=(None, None), tearoff=False, pad=None, key=None, visible=True): - ''' - Menu - :param menu_definition: - :param background_color: - :param size: - :param tearoff: - :param pad: - :param key: - :param visible: - ''' + """ """ + + def __init__(self, menu_definition, background_color=None, size=(None, None), tearoff=False, pad=None, key=None, + visible=True): + """ + + :param menu_definition: + :param background_color: color of background (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param tearoff: (Default value = False) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ + self.BackgroundColor = background_color if background_color is not None else DEFAULT_BACKGROUND_COLOR self.MenuDefinition = menu_definition - self.TKMenu = None + self.TKMenu = None # type: tk.Menu self.Tearoff = tearoff self.MenuItemChosen = None - super().__init__(ELEM_TYPE_MENUBAR, background_color=background_color, size=size, pad=pad, key=key, visible=visible) + super().__init__(ELEM_TYPE_MENUBAR, background_color=background_color, size=size, pad=pad, key=key, + visible=visible) return - def MenuItemChosenCallback(self, item_chosen): # Menu Menu Item Chosen Callback + def _MenuItemChosenCallback(self, item_chosen): # Menu Menu Item Chosen Callback + """ + + :param item_chosen: + + """ # print('IN MENU ITEM CALLBACK', item_chosen) self.MenuItemChosen = item_chosen self.ParentForm.LastButtonClicked = item_chosen @@ -3150,8 +3983,14 @@ class Menu(Element): if self.ParentForm.CurrentlyRunningMainloop: self.ParentForm.TKroot.quit() # kick the users out of the mainloop - def Update(self, menu_definition, visible=None): + """ + + :param menu_definition: + :param visible: change visibility of element (Default value = None) + + """ + self.MenuDefinition = menu_definition self.TKMenu = tk.Menu(self.ParentForm.TKroot, tearoff=self.Tearoff) # create the menubar menubar = self.TKMenu @@ -3172,47 +4011,61 @@ class Menu(Element): if len(menu_entry) > 1: AddMenuItem(baritem, menu_entry[1], self) self.ParentForm.TKroot.configure(menu=self.TKMenu) - #TODO add visible code for menus + # TODO add visible code for menus + def __del__(self): + """ """ super().__del__() -MenuBar = Menu # another name for Menu to make it clear it's the Menu Bar + +MenuBar = Menu # another name for Menu to make it clear it's the Menu Bar + # ---------------------------------------------------------------------- # # Table # # ---------------------------------------------------------------------- # class Table(Element): + """ """ + def __init__(self, values, headings=None, visible_column_map=None, col_widths=None, def_col_width=10, - auto_size_columns=True, max_col_width=20, select_mode=None, display_row_numbers=False, num_rows=None, row_height=None, font=None, justification='right', text_color=None, background_color=None, alternating_row_color=None, row_colors=None, vertical_scroll_only=True, - size=(None, None), change_submits=False, enable_events=False, bind_return_key=False, pad=None, key=None, tooltip=None, right_click_menu=None, visible=True): - ''' - Table - :param values: - :param headings: - :param visible_column_map: - :param col_widths: - :param def_col_width: - :param auto_size_columns: - :param max_col_width: - :param select_mode: - :param display_row_numbers: - :param num_rows: - :param row_height: - :param font: - :param justification: - :param text_color: - :param background_color: - :param alternating_row_color: - :param size: - :param change_submits: - :param enable_events: - :param bind_return_key: - :param pad: - :param key: - :param tooltip: - :param right_click_menu: - :param visible: - ''' + auto_size_columns=True, max_col_width=20, select_mode=None, display_row_numbers=False, num_rows=None, + row_height=None, font=None, justification='right', text_color=None, background_color=None, + alternating_row_color=None, row_colors=None, vertical_scroll_only=True, hide_vertical_scroll=False, + size=(None, None), change_submits=False, enable_events=False, bind_return_key=False, pad=None, + key=None, tooltip=None, right_click_menu=None, visible=True): + """ + + :param values: + :param headings: (Default value = None) + :param visible_column_map: (Default value = None) + :param col_widths: (Default value = None) + :param def_col_width: (Default value = 10) + :param auto_size_columns: (Default value = True) + :param max_col_width: (Default value = 20) + :param select_mode: (Default value = None) + :param display_row_numbers: (Default value = False) + :param num_rows: (Default value = None) + :param row_height: (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param justification: (Default value = 'right') + :param text_color: color of the text (Default value = None) + :param background_color: color of background (Default value = None) + :param alternating_row_color: (Default value = None) + :param row_colors: (Default value = None) + :param vertical_scroll_only: (Default value = True) + :param hide_vertical_scroll: (Default value = False) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param change_submits: If True, pressing Enter key submits window (Default value = False) + :param enable_events: Turns on the element specific events.(Default value = False) + :param bind_return_key: (Default value = False) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param right_click_menu: see "Right Click Menus" (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ + self.Values = values self.ColumnHeadings = headings self.ColumnsToDisplay = visible_column_map @@ -3228,13 +4081,14 @@ class Table(Element): self.DisplayRowNumbers = display_row_numbers self.NumRows = num_rows if num_rows is not None else size[1] self.RowHeight = row_height - self.TKTreeview = None + self.TKTreeview = None # type: ttk.Treeview self.AlternatingRowColor = alternating_row_color self.VerticalScrollOnly = vertical_scroll_only + self.HideVerticalScroll = hide_vertical_scroll self.SelectedRows = [] self.ChangeSubmits = change_submits or enable_events self.BindReturnKey = bind_return_key - self.StartingRowNumber = 0 # When displaying row numbers, where to start + self.StartingRowNumber = 0 # When displaying row numbers, where to start self.RowHeaderText = 'Row' self.RightClickMenu = right_click_menu self.RowColors = row_colors @@ -3243,7 +4097,16 @@ class Table(Element): size=size, pad=pad, key=key, tooltip=tooltip, visible=visible) return - def Update(self, values=None, num_rows=None, visible=None): + def Update(self, values=None, num_rows=None, visible=None, select_rows=None): + """ + + :param values: (Default value = None) + :param num_rows: (Default value = None) + :param visible: change visibility of element (Default value = None) + :param select_rows: (Default value = None) + + """ + if values is not None: children = self.TKTreeview.get_children() for i in children: @@ -3253,7 +4116,7 @@ class Table(Element): # self.TKTreeview.delete(*self.TKTreeview.get_children()) for i, value in enumerate(values): if self.DisplayRowNumbers: - value = [i+self.StartingRowNumber] + value + value = [i + self.StartingRowNumber] + value id = self.TKTreeview.insert('', 'end', text=i, iid=i + 1, values=value, tag=i % 2) if self.AlternatingRowColor is not None: self.TKTreeview.tag_configure(1, background=self.AlternatingRowColor) @@ -3265,9 +4128,16 @@ class Table(Element): self.TKTreeview.pack() if num_rows is not None: self.TKTreeview.config(height=num_rows) - + if select_rows is not None: + rows_to_select = [i+1 for i in select_rows] + self.TKTreeview.selection_set(rows_to_select) def treeview_selected(self, event): + """ + + :param event: + + """ selections = self.TKTreeview.selection() self.SelectedRows = [int(x) - 1 for x in selections] if self.ChangeSubmits: @@ -3280,8 +4150,12 @@ class Table(Element): if self.ParentForm.CurrentlyRunningMainloop: self.ParentForm.TKroot.quit() - def treeview_double_click(self, event): + """ + + :param event: + + """ selections = self.TKTreeview.selection() self.SelectedRows = [int(x) - 1 for x in selections] if self.BindReturnKey: @@ -3294,8 +4168,8 @@ class Table(Element): if self.ParentForm.CurrentlyRunningMainloop: self.ParentForm.TKroot.quit() - def __del__(self): + """ """ super().__del__() @@ -3303,33 +4177,41 @@ class Table(Element): # Tree # # ---------------------------------------------------------------------- # class Tree(Element): + """ """ + def __init__(self, data=None, headings=None, visible_column_map=None, col_widths=None, col0_width=10, - def_col_width=10, auto_size_columns=True, max_col_width=20, select_mode=None, show_expanded=False, change_submits=False, enable_events=False, font=None, justification='right', text_color=None, background_color=None, num_rows=None, row_height=None, pad=None, key=None, tooltip=None,right_click_menu=None, visible=True): - ''' - Tree - :param data: - :param headings: - :param visible_column_map: - :param col_widths: - :param col0_width: - :param def_col_width: - :param auto_size_columns: - :param max_col_width: - :param select_mode: - :param show_expanded: - :param change_submits: - :param enable_events: - :param font: - :param justification: - :param text_color: - :param background_color: - :param num_rows: - :param pad: - :param key: - :param tooltip: - :param right_click_menu: - :param visible: - ''' + def_col_width=10, auto_size_columns=True, max_col_width=20, select_mode=None, show_expanded=False, + change_submits=False, enable_events=False, font=None, justification='right', text_color=None, + background_color=None, num_rows=None, row_height=None, pad=None, key=None, tooltip=None, + right_click_menu=None, visible=True): + """ + + :param data: (Default value = None) + :param headings: (Default value = None) + :param visible_column_map: (Default value = None) + :param col_widths: (Default value = None) + :param col0_width: (Default value = 10) + :param def_col_width: (Default value = 10) + :param auto_size_columns: (Default value = True) + :param max_col_width: (Default value = 20) + :param select_mode: (Default value = None) + :param show_expanded: (Default value = False) + :param change_submits: If True, pressing Enter key submits window (Default value = False) + :param enable_events: Turns on the element specific events.(Default value = False) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param justification: (Default value = 'right') + :param text_color: color of the text (Default value = None) + :param background_color: color of background (Default value = None) + :param num_rows: (Default value = None) + :param row_height: (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param right_click_menu: see "Right Click Menus" (Default value = None) + :param visible: set visibility state of the element (Default value = True) + + """ + self.TreeData = data self.ColumnHeadings = headings self.ColumnsToDisplay = visible_column_map @@ -3352,13 +4234,16 @@ class Tree(Element): self.RowHeight = row_height self.IconList = {} - super().__init__(ELEM_TYPE_TREE, text_color=text_color, background_color=background_color, font=font, pad=pad, key=key, tooltip=tooltip, visible=visible) return - def treeview_selected(self, event): + """ + + :param event: + + """ selections = self.TKTreeview.selection() self.SelectedRows = [x for x in selections] if self.ChangeSubmits: @@ -3372,6 +4257,11 @@ class Tree(Element): self.ParentForm.TKroot.quit() def add_treeview_data(self, node): + """ + + :param node: + + """ # print(f'Inserting {node.key} under parent {node.parent}') if node.key != '': if node.icon: @@ -3382,18 +4272,28 @@ class Tree(Element): photo = tk.PhotoImage(file=node.icon) node.photo = photo self.TKTreeview.insert(node.parent, 'end', node.key, text=node.text, values=node.values, - open=self.ShowExpanded, image=node.photo) + open=self.ShowExpanded, image=node.photo) except: self.photo = None else: self.TKTreeview.insert(node.parent, 'end', node.key, text=node.text, values=node.values, - open=self.ShowExpanded) + open=self.ShowExpanded) for node in node.children: self.add_treeview_data(node) - def Update(self, values=None, key=None, value=None, text=None, icon=None, visible=None): + """ + + :param values: (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param value: (Default value = None) + :param text: (Default value = None) + :param icon: (Default value = None) + :param visible: change visibility of element (Default value = None) + + """ + if values is not None: children = self.TKTreeview.get_children() for i in children: @@ -3416,7 +4316,7 @@ class Tree(Element): else: photo = tk.PhotoImage(file=icon) self.TKTreeview.item(key, image=photo) - self.IconList[key] = photo # save so that it's not deleted (save reference) + self.IconList[key] = photo # save so that it's not deleted (save reference) except: pass item = self.TKTreeview.item(key) @@ -3427,12 +4327,24 @@ class Tree(Element): return self def __del__(self): + """ """ super().__del__() class TreeData(object): + """ """ class Node(object): + """ """ def __init__(self, parent, key, text, values, icon=None): + """ + + :param parent: + :param key: (common_key) Used with window.FindElement and with return values + :param text: + :param values: + :param icon: (Default value = None) + + """ self.parent = parent self.children = [] self.key = key @@ -3441,27 +4353,54 @@ class TreeData(object): self.icon = icon def _Add(self, node): + """ + + :param node: + + """ self.children.append(node) def __init__(self): + """ """ self.tree_dict = {} self.root_node = self.Node("", "", 'root', [], None) self.tree_dict[""] = self.root_node def _AddNode(self, key, node): + """ + + :param key: (common_key) Used with window.FindElement and with return values + :param node: + + """ self.tree_dict[key] = node def Insert(self, parent, key, text, values, icon=None): + """ + + :param parent: + :param key: (common_key) Used with window.FindElement and with return values + :param text: + :param values: + :param icon: (Default value = None) + + """ node = self.Node(parent, key, text, values, icon) self.tree_dict[key] = node parent_node = self.tree_dict[parent] parent_node._Add(node) - def __repr__(self): + """ """ return self._NodeStr(self.root_node, 1) def _NodeStr(self, node, level): + """ + + :param node: + :param level: + + """ return '\n'.join( [str(node.key) + ' : ' + str(node.text)] + [' ' * 4 * level + self._NodeStr(child, level + 1) for child in node.children]) @@ -3471,83 +4410,109 @@ class TreeData(object): # Error Element # # ---------------------------------------------------------------------- # class ErrorElement(Element): + """ """ def __init__(self, key=None): - ''' - Error Element - :param key: - ''' + """Error Element + + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ self.Key = key super().__init__(ELEM_TYPE_ERROR, key=key) return - def Update(self, *args, **kwargs): - PopupError('Keyword error in Update', - 'You need to stop this madness and check your spelling', - 'Bad key = {}'.format(self.Key), - 'Your bad line of code may resemble this:', - 'window.FindElement("{}")'.format(self.Key)) + def Update(self, silent_on_error=True, *args, **kwargs): + """ + + :param silent_on_error: (Default value = True) + :param *args: + :param **kwargs: + + """ + if not silent_on_error: + PopupError('Keyword error in Update', + 'You need to stop this madness and check your spelling', + 'Bad key = {}'.format(self.Key), + 'Your bad line of code may resemble this:', + 'window.FindElement("{}")'.format(self.Key)) return self def Get(self): + """ """ return 'This is NOT a valid Element!\nSTOP trying to do things with it or I will have to crash at some point!' def __del__(self): + """ """ super().__del__() + # ---------------------------------------------------------------------- # # Stretch Element # # ---------------------------------------------------------------------- # # This is for source code compatibility with tkinter version. No tkinter equivalent Stretch = ErrorElement + # ------------------------------------------------------------------------- # # Window CLASS # # ------------------------------------------------------------------------- # class Window: + """ """ + NumOpenWindows = 0 user_defined_icon = None hidden_master_root = None animated_popup_dict = {} - container_element_counter = 0 # used to get a number of Container Elements (Frame, Column, Tab) + container_element_counter = 0 # used to get a number of Container Elements (Frame, Column, Tab) + read_call_from_debugger = False - def __init__(self, title, layout=None, default_element_size=DEFAULT_ELEMENT_SIZE, default_button_element_size=(None, None), - auto_size_text=None, auto_size_buttons=None, location=(None, None), size=(None, None), element_padding=None, margins=(None, None), button_color=None, font=None, + def __init__(self, title, layout=None, default_element_size=DEFAULT_ELEMENT_SIZE, + default_button_element_size=(None, None), + auto_size_text=None, auto_size_buttons=None, location=(None, None), size=(None, None), + element_padding=None, margins=(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, alpha_channel=1, return_keyboard_events=False, use_default_focus=True, text_justification=None, - no_titlebar=False, grab_anywhere=False, keep_on_top=False, resizable=False, disable_close=False, disable_minimize=False, right_click_menu=None): - ''' - Window - :param title: - :param default_element_size: - :param default_button_element_size: - :param auto_size_text: - :param auto_size_buttons: - :param location: - :param size: - :param element_padding: - :param button_color: - :param font: - :param progress_bar_color: - :param background_color: - :param border_depth: - :param auto_close: - :param auto_close_duration: - :param icon: - :param force_toplevel: - :param alpha_channel: - :param return_keyboard_events: - :param use_default_focus: - :param text_justification: - :param no_titlebar: - :param grab_anywhere: - :param keep_on_top: - :param resizable: - :param disable_close: - :param disable_minimize: - :param right_click_menu: - ''' + no_titlebar=False, grab_anywhere=False, keep_on_top=False, resizable=False, disable_close=False, + disable_minimize=False, right_click_menu=None, transparent_color=None, debugger_enabled=True): + """ + + :param title: + :param layout: (Default value = None) + :param default_element_size: (Default value = DEFAULT_ELEMENT_SIZE) + :param default_button_element_size: (Default value = (None, None)) + :param auto_size_text: True if size should fit the text length (Default value = None) + :param auto_size_buttons: (Default value = None) + :param location: (Default value = (None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) + :param element_padding: (Default value = None) + :param margins: (Default value = (None) + :param button_color: (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param progress_bar_color: (Default value = (None) + :param background_color: color of background (Default value = None) + :param border_depth: (Default value = None) + :param auto_close: (Default value = False) + :param auto_close_duration: (Default value = DEFAULT_AUTOCLOSE_TIME) + :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) + :param force_toplevel: (Default value = False) + :param alpha_channel: (Default value = 1) + :param return_keyboard_events: (Default value = False) + :param use_default_focus: (Default value = True) + :param text_justification: (Default value = None) + :param no_titlebar: (Default value = False) + :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) + :param location: Location on screen to display (Default value = (None, None)) + :param resizable: (Default value = False) + :param disable_close: (Default value = False) + :param disable_minimize: (Default value = False) + :param right_click_menu: see "Right Click Menus" (Default value = None) + :param transparent_color: (Default value = None) + :param debugger_enabled: (Default value = True) + + """ + 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.Title = title @@ -3603,32 +4568,62 @@ class Window: self.RightClickMenu = right_click_menu self.Margins = margins if margins != (None, None) else DEFAULT_MARGINS self.ContainerElemementNumber = Window.GetAContainerNumber() + self.AllKeysDict = {} + self.TransparentColor = transparent_color + self.UniqueKeyCounter = 0 + self.DebuggerEnabled = debugger_enabled if layout is not None: self.Layout(layout) @classmethod def GetAContainerNumber(cls): + """ """ cls.container_element_counter += 1 return cls.container_element_counter @classmethod def IncrementOpenCount(self): + """ """ self.NumOpenWindows += 1 # print('+++++ INCREMENTING Num Open Windows = {} ---'.format(Window.NumOpenWindows)) @classmethod def DecrementOpenCount(self): + """ """ self.NumOpenWindows -= 1 * (self.NumOpenWindows != 0) # decrement if not 0 # print('----- DECREMENTING Num Open Windows = {} ---'.format(Window.NumOpenWindows)) # ------------------------- Add ONE Row to Form ------------------------- # def AddRow(self, *args): - ''' Parms are a variable number of Elements ''' + """Parms are a variable number of Elements + + :param *args: + + """ NumRows = len(self.Rows) # number of existing rows is our row number CurrentRowNumber = NumRows # this row's number CurrentRow = [] # start with a blank row and build up # ------------------------- Add the elements to a row ------------------------- # for i, element in enumerate(args): # Loop through list of elements and add them to the row + if type(element) == list: + PopupError('Error creating layout', + 'Layout has a LIST instead of an ELEMENT', + 'This means you have a badly placed ]', + 'The offensive list is:', + element, + 'This list will be stripped from your layout' + ) + continue + elif callable(element): + PopupError('Error creating layout', + 'Layout has a FUNCTION instead of an ELEMENT', + 'This means you are missing () from your layout', + 'The offensive list is:', + element, + 'This item will be stripped from your layout' + ) + continue + element.Position = (CurrentRowNumber, i) element.ParentContainer = self CurrentRow.append(element) @@ -3637,24 +4632,52 @@ class Window: # ------------------------- Add Multiple Rows to Form ------------------------- # def AddRows(self, rows): + """ + + :param rows: + + """ for row in rows: self.AddRow(*row) def Layout(self, rows): + """ + + :param rows: + + """ self.AddRows(rows) + self.BuildKeyDict() return self def LayoutAndRead(self, rows, non_blocking=False): - raise DeprecationWarning('LayoutAndRead is no longer supported... change your call window.Layout(layout).Read()') + """ + + :param rows: + :param non_blocking: (Default value = False) + + """ + raise DeprecationWarning( + 'LayoutAndRead is no longer supported... change your call window.Layout(layout).Read()') # self.AddRows(rows) # self.Show(non_blocking=non_blocking) # return self.ReturnValues def LayoutAndShow(self, rows): + """ + + :param rows: + + """ raise DeprecationWarning('LayoutAndShow is no longer supported... ') # ------------------------- ShowForm THIS IS IT! ------------------------- # def Show(self, non_blocking=False): + """ + + :param non_blocking: (Default value = False) + + """ self.Shown = True # Compute num rows & num cols (it'll come in handy debugging) self.NumRows = len(self.Rows) @@ -3690,16 +4713,24 @@ class Window: # ------------------------- SetIcon - set the window's fav icon ------------------------- # def SetIcon(self, icon=None, pngbase64=None): + """ + + :param icon: (Default value = None) + :param pngbase64: (Default value = None) + + """ if type(icon) is bytes: wicon = tkinter.PhotoImage(data=icon) try: self.TKroot.tk.call('wm', 'iconphoto', self.TKroot._w, wicon) - except: pass + except: + pass elif pngbase64 != None: wicon = tkinter.PhotoImage(data=pngbase64) try: self.TKroot.tk.call('wm', 'iconphoto', self.TKroot._w, wicon) - except: pass + except: + pass else: wicon = icon @@ -3710,15 +4741,22 @@ class Window: pass def _GetElementAtLocation(self, location): + """ + + :param location: + + """ (row_num, col_num) = location row = self.Rows[row_num] element = row[col_num] return element def _GetDefaultElementSize(self): + """ """ return self.DefaultElementSize def _AutoCloseAlarmCallback(self): + """ """ try: window = self if window: @@ -3732,6 +4770,7 @@ class Window: pass def _TimeoutAlarmCallback(self): + """ """ # first, get the results table built # modify the Results table in the parent FlexForm object # print('TIMEOUT CALLBACK') @@ -3743,13 +4782,23 @@ class Window: self.TKroot.quit() # kick the users out of the mainloop def Read(self, timeout=None, timeout_key=TIMEOUT_KEY): - if timeout == 0: # timeout of zero runs the old readnonblocking - event, values = self.ReadNonBlocking() + """ + + :param timeout: (Default value = None) + :param timeout_key: (Default value = TIMEOUT_KEY) + + """ + # ensure called only 1 time through a single read cycle + if not Window.read_call_from_debugger: + refresh_debugger() + timeout = int(timeout) if timeout is not None else None + if timeout == 0: # timeout of zero runs the old readnonblocking + event, values = self.ReadNonBlocking() if event is None: event = timeout_key if values is None: event = None - return event, values # make event None if values was None and return + return event, values # make event None if values was None and return # Read with a timeout self.Timeout = timeout self.TimeoutKey = timeout_key @@ -3781,7 +4830,7 @@ class Window: # print('ROOT Destroyed') results = BuildResults(self, False, self) if results[0] != None and results[0] != timeout_key: - return results + return results else: pass @@ -3827,7 +4876,7 @@ class Window: # _my_windows.Decrement() # Determine return values if self.LastKeyboardEvent is not None or self.LastButtonClicked is not None: - results = BuildResults(self, False, self) + results = BuildResults(self, False, self) if not self.LastButtonClickedWasRealtime: self.LastButtonClicked = None return results @@ -3835,12 +4884,14 @@ class Window: if not self.XFound and self.Timeout != 0 and self.Timeout is not None and self.ReturnValues[ 0] is None: # Special Qt case because returning for no reason so fake timeout self.ReturnValues = self.TimeoutKey, self.ReturnValues[1] # fake a timeout - elif not self.XFound and self.ReturnValues[0] is None: # TODO HIGHLY EXPERIMENTAL... added due to tray icon interaction + elif not self.XFound and self.ReturnValues[ + 0] is None: # TODO HIGHLY EXPERIMENTAL... added due to tray icon interaction # print("*** Faking timeout ***") self.ReturnValues = self.TimeoutKey, self.ReturnValues[1] # fake a timeout return self.ReturnValues def ReadNonBlocking(self): + """ """ if self.TKrootDestroyed: try: self.TKroot.quit() @@ -3870,6 +4921,7 @@ class Window: return BuildResults(self, False, self) def Finalize(self): + """ """ if self.TKrootDestroyed: return self if not self.Shown: @@ -3884,6 +4936,7 @@ class Window: return self def Refresh(self): + """ """ if self.TKrootDestroyed: return self try: @@ -3893,31 +4946,100 @@ class Window: return self def Fill(self, values_dict): + """ + + :param values_dict: + + """ FillFormWithValues(self, values_dict) return self def FindElement(self, key, silent_on_error=False): - element = _FindElementFromKeyInSubForm(self, key) + """ + + :param key: (common_key) Used with window.FindElement and with return values + :param silent_on_error: (Default value = False) + + """ + # print(f'In find elem key={key}', self.AllKeysDict) + + try: + element = self.AllKeysDict[key] + except KeyError: + element = None + # element = _FindElementFromKeyInSubForm(self, key) if element is None: if not silent_on_error: - print('*** WARNING = FindElement did not find the key. Please check your key\'s spelling ***') + print( + '*** WARNING = FindElement did not find the key. Please check your key\'s spelling key = %s ***' % key) PopupError('Keyword error in FindElement Call', 'Bad key = {}'.format(key), 'Your bad line of code may resemble this:', 'window.FindElement("{}")'.format(key)) - return ErrorElement(key=key) - else: - return False + return ErrorElement(key=key) return element - Element = FindElement # Shortcut function - + Element = FindElement # Shortcut function + Find = FindElement def FindElementWithFocus(self): + """ """ element = _FindElementWithFocusInSubForm(self) return element + def BuildKeyDict(self): + """ """ + dict = {} + self.AllKeysDict = self._BuildKeyDictForWindow(self, self, dict) + # print(f'keys built = {self.AllKeysDict}') + + def _BuildKeyDictForWindow(self, top_window, window, key_dict): + """ + + :param top_window: + :param window: + :param key_dict: + + """ + for row_num, row in enumerate(window.Rows): + for col_num, element in enumerate(row): + if element.Type == ELEM_TYPE_COLUMN: + key_dict = self._BuildKeyDictForWindow(top_window, element, key_dict) + if element.Type == ELEM_TYPE_FRAME: + key_dict = self._BuildKeyDictForWindow(top_window, element, key_dict) + if element.Type == ELEM_TYPE_TAB_GROUP: + key_dict = self._BuildKeyDictForWindow(top_window, element, key_dict) + if element.Type == ELEM_TYPE_PANE: + key_dict = self._BuildKeyDictForWindow(top_window, element, key_dict) + if element.Type == ELEM_TYPE_TAB: + key_dict = self._BuildKeyDictForWindow(top_window, element, key_dict) + if element.Key is None: # if no key has been assigned.... create one for input elements + if element.Type == ELEM_TYPE_BUTTON: + element.Key = element.ButtonText + if element.Type in (ELEM_TYPE_MENUBAR, ELEM_TYPE_BUTTONMENU, ELEM_TYPE_CANVAS, + ELEM_TYPE_INPUT_SLIDER, ELEM_TYPE_GRAPH, ELEM_TYPE_IMAGE, + ELEM_TYPE_INPUT_CHECKBOX, ELEM_TYPE_INPUT_LISTBOX, ELEM_TYPE_INPUT_COMBO, + ELEM_TYPE_INPUT_MULTILINE, ELEM_TYPE_INPUT_OPTION_MENU, ELEM_TYPE_INPUT_SPIN, + ELEM_TYPE_INPUT_RADIO, ELEM_TYPE_INPUT_TEXT): + element.Key = top_window.DictionaryKeyCounter + top_window.DictionaryKeyCounter += 1 + if element.Key is not None: + if element.Key in key_dict.keys(): + print('*** Duplicate key found in your layout {} ***'.format( + element.Key)) if element.Type != ELEM_TYPE_BUTTON else None + element.Key = element.Key + str(self.UniqueKeyCounter) + self.UniqueKeyCounter += 1 + print('*** Replaced new key with {} ***'.format( + element.Key)) if element.Type != ELEM_TYPE_BUTTON else None + key_dict[element.Key] = element + return key_dict + def SaveToDisk(self, filename): + """ + + :param filename: + + """ try: results = BuildResults(self, False, self) with open(filename, 'wb') as sf: @@ -3926,6 +5048,11 @@ class Window: print('*** Error saving form to disk ***') def LoadFromDisk(self, filename): + """ + + :param filename: + + """ try: with open(filename, 'rb') as df: self.Fill(pickle.load(df)) @@ -3933,6 +5060,7 @@ class Window: print('*** Error loading form to disk ***') def GetScreenDimensions(self): + """ """ if self.TKrootDestroyed: return None, None screen_width = self.TKroot.winfo_screenwidth() # get window info to move to middle of screen @@ -3940,42 +5068,85 @@ class Window: return screen_width, screen_height def Move(self, x, y): + """ + + :param x: + :param y: + + """ try: self.TKroot.geometry("+%s+%s" % (x, y)) except: pass def Minimize(self): + """ """ self.TKroot.iconify() def Maximize(self): - self.TKroot.attributes('-fullscreen', True) + """ """ + if sys.platform != 'linux': + self.TKroot.state('zoomed') + else: + self.TKroot.attributes('-fullscreen', True) + # this method removes the titlebar too + # self.TKroot.attributes('-fullscreen', True) + + def Normal(self): + """ """ + if sys.platform != 'linux': + self.TKroot.state('normal') + else: + self.TKroot.attributes('-fullscreen', False) def StartMove(self, event): + """ + + :param event: + + """ try: self.TKroot.x = event.x self.TKroot.y = event.y except: pass + # print('Start move {},{}'.format(event.x,event.y)) def StopMove(self, event): + """ + + :param event: + + """ try: self.TKroot.x = None self.TKroot.y = None except: pass + # print('-Stop- move {},{}'.format(event.x,event.y)) def OnMotion(self, event): + """ + + :param event: + + """ try: deltax = event.x - self.TKroot.x deltay = event.y - self.TKroot.y x = self.TKroot.winfo_x() + deltax y = self.TKroot.winfo_y() + deltay self.TKroot.geometry("+%s+%s" % (x, y)) + # print('{},{}'.format(x,y)) except: pass def _KeyboardCallback(self, event): + """ + + :param event: + + """ self.LastButtonClicked = None self.FormRemainedOpen = True if event.char != '': @@ -3984,19 +5155,25 @@ class Window: self.LastKeyboardEvent = str(event.keysym) + ':' + str(event.keycode) if not self.NonBlocking: BuildResults(self, False, self) - if self.CurrentlyRunningMainloop: # quit if this is the current mainloop, otherwise don't quit! + if self.CurrentlyRunningMainloop: # quit if this is the current mainloop, otherwise don't quit! self.TKroot.quit() def _MouseWheelCallback(self, event): + """ + + :param event: + + """ self.LastButtonClicked = None self.FormRemainedOpen = True self.LastKeyboardEvent = 'MouseWheel:Down' if event.delta < 0 else 'MouseWheel:Up' if not self.NonBlocking: BuildResults(self, False, self) - if self.CurrentlyRunningMainloop: # quit if this is the current mainloop, otherwise don't quit! + if self.CurrentlyRunningMainloop: # quit if this is the current mainloop, otherwise don't quit! self.TKroot.quit() def _Close(self): + """ """ try: self.TKroot.update() except: @@ -4009,8 +5186,8 @@ class Window: self.RootNeedsDestroying = True return None - def Close(self): + """ """ if self.TKrootDestroyed: return try: @@ -4019,18 +5196,26 @@ class Window: # _my_windows.Decrement() except: pass + # if down to 1 window, try and destroy the hidden window, if there is one + if Window.NumOpenWindows == 1: + try: + Window.hidden_master_root.destroy() + Window.NumOpenWindows = 0 # if no hidden window, then this won't execute + except: + pass CloseNonBlockingForm = Close CloseNonBlocking = Close # IT FINALLY WORKED! 29-Oct-2018 was the first time this damned thing got called def OnClosingCallback(self): + """ """ # global _my_windows # print('Got closing callback', self.DisableClose) if self.DisableClose: return self.XFound = True - if self.CurrentlyRunningMainloop: # quit if this is the current mainloop, otherwise don't quit! + if self.CurrentlyRunningMainloop: # quit if this is the current mainloop, otherwise don't quit! self.TKroot.quit() # kick the users out of the mainloop self.TKroot.destroy() # kick the users out of the mainloop self.RootNeedsDestroying = True @@ -4043,90 +5228,172 @@ class Window: return def Disable(self): - self.TKroot.grab_set_global() + """ """ + self.TKroot.attributes('-disabled', 1) + # self.TKroot.grab_set_global() def Enable(self): - self.TKroot.grab_release() + """ """ + self.TKroot.attributes('-disabled', 0) + # self.TKroot.grab_release() def Hide(self): + """ """ self._Hidden = True self.TKroot.withdraw() def UnHide(self): + """ """ if self._Hidden: self.TKroot.deiconify() self._Hidden = False def Disappear(self): + """ """ self.TKroot.attributes('-alpha', 0) def Reappear(self): + """ """ self.TKroot.attributes('-alpha', 255) def SetAlpha(self, alpha): - ''' - Change the window's transparency - :param alpha: From 0 to 1 with 0 being completely transparent - :return: - ''' + """ + + :param alpha: + + """ + # Change the window's transparency + # :param alpha: From 0 to 1 with 0 being completely transparent self._AlphaChannel = alpha self.TKroot.attributes('-alpha', alpha) @property def AlphaChannel(self): + """ """ return self._AlphaChannel @AlphaChannel.setter def AlphaChannel(self, alpha): + """ + + :param alpha: + + """ self._AlphaChannel = alpha self.TKroot.attributes('-alpha', alpha) def BringToFront(self): + """ """ try: self.TKroot.lift() except: pass def CurrentLocation(self): + """ """ return int(self.TKroot.winfo_x()), int(self.TKroot.winfo_y()) - @property def Size(self): + """ """ win_width = self.TKroot.winfo_width() win_height = self.TKroot.winfo_height() return win_width, win_height @Size.setter def Size(self, size): + """ + + :param size: (common_key) + + """ try: self.TKroot.geometry("%sx%s" % (size[0], size[1])) self.TKroot.update_idletasks() except: pass - def VisibilityChanged(self): + """ """ # A dummy function. Needed in Qt but not tkinter return + def SetTransparentColor(self, color): + """ + + :param color: + + """ + try: + self.TKroot.attributes('-transparentcolor', color) + except: + print('Transparent color not supported on this platform (windows only)') + + def GrabAnyWhereOn(self): + """ """ + self.TKroot.bind("", self.StartMove) + self.TKroot.bind("", self.StopMove) + self.TKroot.bind("", self.OnMotion) + + def GrabAnyWhereOff(self): + """ """ + self.TKroot.unbind("") + self.TKroot.unbind("") + self.TKroot.unbind("") + + def _callback_main_debugger_window_create_keystroke(self, event): + """ + + :param event: + + """ + Debugger.debugger._build_main_debugger_window() + + def _callback_popout_window_create_keystroke(self, event): + """ + + :param event: + + """ + Debugger.debugger._build_floating_window() + + def EnableDebugger(self): + """ """ + self.TKroot.bind('', self._callback_main_debugger_window_create_keystroke) + self.TKroot.bind('', self._callback_popout_window_create_keystroke) + self.DebuggerEnabled = True + + + def DisableDebugger(self): + """ """ + self.TKroot.unbind("") + self.TKroot.unbind("") + self.DebuggerEnabled = False + def __enter__(self): + """ """ return self def __exit__(self, *a): + """ + + :param *a: + + """ self.__del__() return False def __del__(self): + """ """ # print('DELETING WINDOW') for row in self.Rows: for element in row: element.__del__() - FlexForm = Window + # ################################################################################ # ################################################################################ # END OF ELEMENT DEFINITIONS @@ -4141,50 +5408,166 @@ FlexForm = Window # ------------------------- FOLDER BROWSE Element lazy function ------------------------- # def FolderBrowse(button_text='Browse', target=(ThisRow, -1), initial_folder=None, tooltip=None, size=(None, None), - auto_size_button=None, button_color=None, disabled=False, change_submits=False, enable_events=False,font=None, pad=None, key=None): + auto_size_button=None, button_color=None, disabled=False, change_submits=False, enable_events=False, + font=None, pad=None, key=None): + """ + + :param button_text: (Default value = 'Browse') + :param target: (Default value = (ThisRow, -1)) + :param initial_folder: (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param change_submits: If True, pressing Enter key submits window (Default value = False) + :param enable_events: Turns on the element specific events.(Default value = False) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ + return Button(button_text=button_text, button_type=BUTTON_TYPE_BROWSE_FOLDER, target=target, initial_folder=initial_folder, tooltip=tooltip, size=size, auto_size_button=auto_size_button, - disabled=disabled, button_color=button_color,change_submits=change_submits, enable_events=enable_events, font=font, pad=pad, key=key) + disabled=disabled, button_color=button_color, change_submits=change_submits, + enable_events=enable_events, font=font, pad=pad, key=key) # ------------------------- FILE BROWSE Element lazy function ------------------------- # def FileBrowse(button_text='Browse', target=(ThisRow, -1), file_types=(("ALL Files", "*.*"),), initial_folder=None, - tooltip=None, size=(None, None), auto_size_button=None, button_color=None, change_submits=False, enable_events=False, font=None, disabled=False, + tooltip=None, size=(None, None), auto_size_button=None, button_color=None, change_submits=False, + enable_events=False, font=None, disabled=False, pad=None, key=None): + """ + + :param button_text: (Default value = 'Browse') + :param target: (Default value = (ThisRow, -1)) + :param file_types: (Default value = (("ALL Files", "*.*"))) + :param initial_folder: (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param change_submits: If True, pressing Enter key submits window (Default value = False) + :param enable_events: Turns on the element specific events.(Default value = False) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_BROWSE_FILE, target=target, file_types=file_types, - initial_folder=initial_folder, tooltip=tooltip, size=size, auto_size_button=auto_size_button, change_submits=change_submits, enable_events=enable_events, disabled=disabled, button_color=button_color, font=font, pad=pad, key=key) + initial_folder=initial_folder, tooltip=tooltip, size=size, auto_size_button=auto_size_button, + change_submits=change_submits, enable_events=enable_events, disabled=disabled, + button_color=button_color, font=font, pad=pad, key=key) # ------------------------- FILES BROWSE Element (Multiple file selection) lazy function ------------------------- # def FilesBrowse(button_text='Browse', target=(ThisRow, -1), file_types=(("ALL Files", "*.*"),), disabled=False, - initial_folder=None, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, change_submits=False,enable_events=False, + initial_folder=None, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, + change_submits=False, enable_events=False, font=None, pad=None, key=None): + """ + + :param button_text: (Default value = 'Browse') + :param target: (Default value = (ThisRow, -1)) + :param file_types: (Default value = (("ALL Files", "*.*"))) + :param disabled: set disable state for element (Default value = False) + :param initial_folder: (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param change_submits: If True, pressing Enter key submits window (Default value = False) + :param enable_events: Turns on the element specific events.(Default value = False) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_BROWSE_FILES, target=target, file_types=file_types, - initial_folder=initial_folder,change_submits=change_submits, enable_events=enable_events, tooltip=tooltip, size=size, auto_size_button=auto_size_button, + initial_folder=initial_folder, change_submits=change_submits, enable_events=enable_events, + tooltip=tooltip, size=size, auto_size_button=auto_size_button, disabled=disabled, button_color=button_color, font=font, pad=pad, key=key) # ------------------------- FILE BROWSE Element lazy function ------------------------- # def FileSaveAs(button_text='Save As...', target=(ThisRow, -1), file_types=(("ALL Files", "*.*"),), initial_folder=None, - disabled=False, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, change_submits=False, enable_events=False, font=None, + disabled=False, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, + change_submits=False, enable_events=False, font=None, pad=None, key=None): + """ + + :param button_text: (Default value = 'Save As...') + :param target: (Default value = (ThisRow, -1)) + :param file_types: (Default value = (("ALL Files", "*.*"))) + :param initial_folder: (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param change_submits: If True, pressing Enter key submits window (Default value = False) + :param enable_events: Turns on the element specific events.(Default value = False) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_SAVEAS_FILE, target=target, file_types=file_types, initial_folder=initial_folder, tooltip=tooltip, size=size, disabled=disabled, - auto_size_button=auto_size_button, button_color=button_color, change_submits=change_submits, enable_events=enable_events, font=font, pad=pad, key=key) + auto_size_button=auto_size_button, button_color=button_color, change_submits=change_submits, + enable_events=enable_events, font=font, pad=pad, key=key) # ------------------------- SAVE AS Element lazy function ------------------------- # def SaveAs(button_text='Save As...', target=(ThisRow, -1), file_types=(("ALL Files", "*.*"),), initial_folder=None, - disabled=False, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, change_submits=False, enable_events=False, font=None, + disabled=False, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, + change_submits=False, enable_events=False, font=None, pad=None, key=None): + """ + + :param button_text: (Default value = 'Save As...') + :param target: (Default value = (ThisRow, -1)) + :param file_types: (Default value = (("ALL Files", "*.*"))) + :param initial_folder: (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param change_submits: If True, pressing Enter key submits window (Default value = False) + :param enable_events: Turns on the element specific events.(Default value = False) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_SAVEAS_FILE, target=target, file_types=file_types, initial_folder=initial_folder, tooltip=tooltip, size=size, disabled=disabled, - auto_size_button=auto_size_button, button_color=button_color, change_submits=change_submits, enable_events=enable_events,font=font, pad=pad, key=key) + auto_size_button=auto_size_button, button_color=button_color, change_submits=change_submits, + enable_events=enable_events, font=font, pad=pad, key=key) # ------------------------- SAVE BUTTON Element lazy function ------------------------- # def Save(button_text='Save', size=(None, None), auto_size_button=None, button_color=None, bind_return_key=True, disabled=False, tooltip=None, font=None, focus=False, pad=None, key=None): + """ + + :param button_text: (Default value = 'Save') + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param bind_return_key: (Default value = True) + :param disabled: set disable state for element (Default value = False) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -4193,6 +5576,21 @@ def Save(button_text='Save', size=(None, None), auto_size_button=None, button_co # ------------------------- SUBMIT BUTTON Element lazy function ------------------------- # def Submit(button_text='Submit', size=(None, None), auto_size_button=None, button_color=None, disabled=False, bind_return_key=True, tooltip=None, font=None, focus=False, pad=None, key=None): + """ + + :param button_text: (Default value = 'Submit') + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param bind_return_key: (Default value = True) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -4202,6 +5600,21 @@ def Submit(button_text='Submit', size=(None, None), auto_size_button=None, butto # ------------------------- OPEN BUTTON Element lazy function ------------------------- # def Open(button_text='Open', size=(None, None), auto_size_button=None, button_color=None, disabled=False, bind_return_key=True, tooltip=None, font=None, focus=False, pad=None, key=None): + """ + + :param button_text: (Default value = 'Open') + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param bind_return_key: (Default value = True) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -4210,6 +5623,21 @@ def Open(button_text='Open', size=(None, None), auto_size_button=None, button_co # ------------------------- OK BUTTON Element lazy function ------------------------- # def OK(button_text='OK', size=(None, None), auto_size_button=None, button_color=None, disabled=False, bind_return_key=True, tooltip=None, font=None, focus=False, pad=None, key=None): + """ + + :param button_text: (Default value = 'OK') + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param bind_return_key: (Default value = True) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -4218,6 +5646,21 @@ def OK(button_text='OK', size=(None, None), auto_size_button=None, button_color= # ------------------------- YES BUTTON Element lazy function ------------------------- # def Ok(button_text='Ok', size=(None, None), auto_size_button=None, button_color=None, disabled=False, bind_return_key=True, tooltip=None, font=None, focus=False, pad=None, key=None): + """ + + :param button_text: (Default value = 'Ok') + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param bind_return_key: (Default value = True) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -4226,6 +5669,21 @@ def Ok(button_text='Ok', size=(None, None), auto_size_button=None, button_color= # ------------------------- CANCEL BUTTON Element lazy function ------------------------- # def Cancel(button_text='Cancel', size=(None, None), auto_size_button=None, button_color=None, disabled=False, tooltip=None, font=None, bind_return_key=False, focus=False, pad=None, key=None): + """ + + :param button_text: (Default value = 'Cancel') + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param bind_return_key: (Default value = False) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -4234,6 +5692,21 @@ def Cancel(button_text='Cancel', size=(None, None), auto_size_button=None, butto # ------------------------- QUIT BUTTON Element lazy function ------------------------- # def Quit(button_text='Quit', size=(None, None), auto_size_button=None, button_color=None, disabled=False, tooltip=None, font=None, bind_return_key=False, focus=False, pad=None, key=None): + """ + + :param button_text: (Default value = 'Quit') + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param bind_return_key: (Default value = False) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -4242,36 +5715,21 @@ def Quit(button_text='Quit', size=(None, None), auto_size_button=None, button_co # ------------------------- Exit BUTTON Element lazy function ------------------------- # def Exit(button_text='Exit', size=(None, None), auto_size_button=None, button_color=None, disabled=False, tooltip=None, font=None, bind_return_key=False, focus=False, pad=None, key=None): - return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, - auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, - bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) + """ + :param button_text: (Default value = 'Exit') + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param bind_return_key: (Default value = False) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) -# ------------------------- Up arrow BUTTON Element lazy function ------------------------- # -def Up(button_text='â–²', size=(None, None), auto_size_button=None, button_color=None, disabled=False, tooltip=None, - font=None, bind_return_key=True, focus=False, pad=None, key=None): - return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, - auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, - bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) - -# ------------------------- Down arrow BUTTON Element lazy function ------------------------- # -def Down(button_text='â–¼', size=(None, None), auto_size_button=None, button_color=None, disabled=False, tooltip=None, - font=None, bind_return_key=True, focus=False, pad=None, key=None): - return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, - auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, - bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) - -# ------------------------- Left arrow BUTTON Element lazy function ------------------------- # -def Left(button_text='â—„', size=(None, None), auto_size_button=None, button_color=None, disabled=False, tooltip=None, - font=None, bind_return_key=True, focus=False, pad=None, key=None): - return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, - auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, - bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) - - -# ------------------------- Right arrow BUTTON Element lazy function ------------------------- # -def Right(button_text='â–º', size=(None, None), auto_size_button=None, button_color=None, disabled=False, tooltip=None, - font=None, bind_return_key=True, focus=False, pad=None, key=None): + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -4280,6 +5738,21 @@ def Right(button_text='â–º', size=(None, None), auto_size_button=None, button_co # ------------------------- YES BUTTON Element lazy function ------------------------- # def Yes(button_text='Yes', size=(None, None), auto_size_button=None, button_color=None, disabled=False, tooltip=None, font=None, bind_return_key=True, focus=False, pad=None, key=None): + """ + + :param button_text: (Default value = 'Yes') + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param bind_return_key: (Default value = True) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -4288,6 +5761,21 @@ def Yes(button_text='Yes', size=(None, None), auto_size_button=None, button_colo # ------------------------- NO BUTTON Element lazy function ------------------------- # def No(button_text='No', size=(None, None), auto_size_button=None, button_color=None, disabled=False, tooltip=None, font=None, bind_return_key=False, focus=False, pad=None, key=None): + """ + + :param button_text: (Default value = 'No') + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param bind_return_key: (Default value = False) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) @@ -4296,15 +5784,74 @@ def No(button_text='No', size=(None, None), auto_size_button=None, button_color= # ------------------------- NO BUTTON Element lazy function ------------------------- # def Help(button_text='Help', size=(None, None), auto_size_button=None, button_color=None, disabled=False, font=None, tooltip=None, bind_return_key=False, focus=False, pad=None, key=None): + """ + + :param button_text: (Default value = 'Help') + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param bind_return_key: (Default value = False) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) +# ------------------------- NO BUTTON Element lazy function ------------------------- # +def Debug(button_text='', size=(None, None), auto_size_button=None, button_color=None, disabled=False, font=None, + tooltip=None, bind_return_key=False, focus=False, pad=None, key=None): + """ + + :param button_text: (Default value = '') + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param bind_return_key: (Default value = False) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ + return Button(button_text=button_text, button_type=BUTTON_TYPE_SHOW_DEBUGGER, tooltip=tooltip, size=size, + auto_size_button=auto_size_button, button_color=COLOR_SYSTEM_DEFAULT, font=font, disabled=disabled, + bind_return_key=bind_return_key, focus=focus, pad=pad, key=key, image_data=PSG_DEBUGGER_LOGO, + image_subsample=4, border_width=0) + + # ------------------------- GENERIC BUTTON Element lazy function ------------------------- # def SimpleButton(button_text, image_filename=None, image_data=None, image_size=(None, None), image_subsample=None, border_width=None, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, font=None, bind_return_key=False, disabled=False, focus=False, pad=None, key=None): + """ + + :param button_text: + :param image_filename: (Default value = None) + :param image_data: (Default value = None) + :param image_size: (Default value = (None, None)) + :param image_subsample: (Default value = None) + :param border_width: (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param bind_return_key: (Default value = False) + :param disabled: set disable state for element (Default value = False) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_CLOSES_WIN, image_filename=image_filename, image_data=image_data, image_size=image_size, image_subsample=image_subsample, border_width=border_width, tooltip=tooltip, disabled=disabled, size=size, @@ -4313,15 +5860,63 @@ def SimpleButton(button_text, image_filename=None, image_data=None, image_size=( # ------------------------- CLOSE BUTTON Element lazy function ------------------------- # -def CloseButton(button_text, image_filename=None, image_data=None, image_size=(None, None), image_subsample=None, border_width=None, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, font=None, bind_return_key=False, disabled=False, focus=False, pad=None, key=None): - return Button(button_text=button_text, button_type=BUTTON_TYPE_CLOSES_WIN, image_filename=image_filename, image_data=image_data, image_size=image_size, image_subsample=image_subsample, border_width=border_width, tooltip=tooltip, disabled=disabled, size=size, auto_size_button=auto_size_button, button_color=button_color, font=font, bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) +def CloseButton(button_text, image_filename=None, image_data=None, image_size=(None, None), image_subsample=None, + border_width=None, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, font=None, + bind_return_key=False, disabled=False, focus=False, pad=None, key=None): + """ + + :param button_text: + :param image_filename: (Default value = None) + :param image_data: (Default value = None) + :param image_size: (Default value = (None, None)) + :param image_subsample: (Default value = None) + :param border_width: (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param bind_return_key: (Default value = False) + :param disabled: set disable state for element (Default value = False) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ + return Button(button_text=button_text, button_type=BUTTON_TYPE_CLOSES_WIN, image_filename=image_filename, + image_data=image_data, image_size=image_size, image_subsample=image_subsample, + border_width=border_width, tooltip=tooltip, disabled=disabled, size=size, + auto_size_button=auto_size_button, button_color=button_color, font=font, + bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) + CButton = CloseButton + # ------------------------- GENERIC BUTTON Element lazy function ------------------------- # def ReadButton(button_text, image_filename=None, image_data=None, image_size=(None, None), image_subsample=None, border_width=None, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, font=None, bind_return_key=False, disabled=False, focus=False, pad=None, key=None): + """ + + :param button_text: + :param image_filename: (Default value = None) + :param image_data: (Default value = None) + :param image_size: (Default value = (None, None)) + :param image_subsample: (Default value = None) + :param border_width: (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param bind_return_key: (Default value = False) + :param disabled: set disable state for element (Default value = False) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, image_filename=image_filename, image_data=image_data, image_size=image_size, image_subsample=image_subsample, border_width=border_width, tooltip=tooltip, size=size, disabled=disabled, @@ -4337,6 +5932,26 @@ RButton = ReadFormButton def RealtimeButton(button_text, image_filename=None, image_data=None, image_size=(None, None), image_subsample=None, border_width=None, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, font=None, disabled=False, bind_return_key=False, focus=False, pad=None, key=None): + """ + + :param button_text: + :param image_filename: (Default value = None) + :param image_data: (Default value = None) + :param image_size: (Default value = (None, None)) + :param image_subsample: (Default value = None) + :param border_width: (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param bind_return_key: (Default value = False) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_REALTIME, image_filename=image_filename, image_data=image_data, image_size=image_size, image_subsample=image_subsample, border_width=border_width, tooltip=tooltip, disabled=disabled, size=size, @@ -4348,6 +5963,26 @@ def RealtimeButton(button_text, image_filename=None, image_data=None, image_size def DummyButton(button_text, image_filename=None, image_data=None, image_size=(None, None), image_subsample=None, border_width=None, tooltip=None, size=(None, None), auto_size_button=None, button_color=None, font=None, disabled=False, bind_return_key=False, focus=False, pad=None, key=None): + """ + + :param button_text: + :param image_filename: (Default value = None) + :param image_data: (Default value = None) + :param image_size: (Default value = (None, None)) + :param image_subsample: (Default value = None) + :param border_width: (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param bind_return_key: (Default value = False) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_CLOSES_WIN_ONLY, image_filename=image_filename, image_data=image_data, image_size=image_size, image_subsample=image_subsample, border_width=border_width, tooltip=tooltip, size=size, auto_size_button=auto_size_button, @@ -4356,17 +5991,46 @@ def DummyButton(button_text, image_filename=None, image_data=None, image_size=(N # ------------------------- Calendar Chooser Button lazy function ------------------------- # -def CalendarButton(button_text, target=(None, None), close_when_date_chosen=True, default_date_m_d_y=(None,None,None), image_filename=None, image_data=None, image_size=(None, None), +def CalendarButton(button_text, target=(None, None), close_when_date_chosen=True, default_date_m_d_y=(None, None, None), + image_filename=None, image_data=None, image_size=(None, None), image_subsample=None, tooltip=None, border_width=None, size=(None, None), auto_size_button=None, button_color=None, disabled=False, font=None, bind_return_key=False, focus=False, pad=None, - key=None): - button = Button(button_text=button_text, button_type=BUTTON_TYPE_CALENDAR_CHOOSER, target=target, - image_filename=image_filename, image_data=image_data, image_size=image_size, - image_subsample=image_subsample, border_width=border_width, tooltip=tooltip, size=size, - auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, - bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) + key=None, locale=None, format=None): + """ + + :param button_text: + :param target: (Default value = (None, None)) + :param close_when_date_chosen: (Default value = True) + :param default_date_m_d_y: (Default value = (None) + :param None: + :param image_filename: (Default value = None) + :param image_data: (Default value = None) + :param image_size: (Default value = (None) + :param image_subsample: (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param border_width: (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param bind_return_key: (Default value = False) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + :param locale: (Default value = None) + :param format: (Default value = None) + + """ + button = Button(button_text=button_text, button_type=BUTTON_TYPE_CALENDAR_CHOOSER, target=target, + image_filename=image_filename, image_data=image_data, image_size=image_size, + image_subsample=image_subsample, border_width=border_width, tooltip=tooltip, size=size, + auto_size_button=auto_size_button, button_color=button_color, font=font, disabled=disabled, + bind_return_key=bind_return_key, focus=focus, pad=pad, key=key) button.CalendarCloseWhenChosen = close_when_date_chosen button.DefaultDate_M_D_Y = default_date_m_d_y + button.CalendarLocale = locale + button.CalendarFormat = format return button @@ -4375,6 +6039,27 @@ def ColorChooserButton(button_text, target=(None, None), image_filename=None, im image_subsample=None, tooltip=None, border_width=None, size=(None, None), auto_size_button=None, button_color=None, disabled=False, font=None, bind_return_key=False, focus=False, pad=None, key=None): + """ + + :param button_text: + :param target: (Default value = (None, None)) + :param image_filename: (Default value = None) + :param image_data: (Default value = None) + :param image_size: (Default value = (None) + :param image_subsample: (Default value = None) + :param tooltip: text, that will appear the you hover on (Default value = None) + :param border_width: (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) + :param auto_size_button: (Default value = None) + :param button_color: (Default value = None) + :param disabled: set disable state for element (Default value = False) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param bind_return_key: (Default value = False) + :param focus: if focus should be set to this (Default value = None) + :param pad: (common_key) Amount of padding to put around element (Default value = None) + :param key: (common_key) Used with window.FindElement and with return values (Default value = None) + + """ return Button(button_text=button_text, button_type=BUTTON_TYPE_COLOR_CHOOSER, target=target, image_filename=image_filename, image_data=image_data, image_size=image_size, image_subsample=image_subsample, border_width=border_width, tooltip=tooltip, size=size, @@ -4385,21 +6070,41 @@ def ColorChooserButton(button_text, target=(None, None), image_filename=None, im ##################################### ----- RESULTS ------ ################################################## def AddToReturnDictionary(form, element, value): - if element.Key is None: - form.ReturnValuesDictionary[form.DictionaryKeyCounter] = value - element.Key = form.DictionaryKeyCounter - form.DictionaryKeyCounter += 1 - else: - form.ReturnValuesDictionary[element.Key] = value + """ + + :param form: + :param element: + :param value: + + """ + form.ReturnValuesDictionary[element.Key] = value + return + # if element.Key is None: + # form.ReturnValuesDictionary[form.DictionaryKeyCounter] = value + # element.Key = form.DictionaryKeyCounter + # form.DictionaryKeyCounter += 1 + # else: + # form.ReturnValuesDictionary[element.Key] = value def AddToReturnList(form, value): + """ + + :param form: + :param value: + + """ form.ReturnValuesList.append(value) # ----------------------------------------------------------------------------# # ------- FUNCTION InitializeResults. Sets up form results matrix --------# def InitializeResults(form): + """ + + :param form: + + """ BuildResults(form, True, form) return @@ -4407,6 +6112,11 @@ def InitializeResults(form): # ===== Radio Button RadVar encoding and decoding =====# # ===== The value is simply the row * 1000 + col =====# def DecodeRadioRowCol(RadValue): + """ + + :param RadValue: + + """ container = RadValue // 100000 row = RadValue // 1000 col = RadValue % 1000 @@ -4414,7 +6124,14 @@ def DecodeRadioRowCol(RadValue): def EncodeRadioRowCol(container, row, col): - RadValue = container*100000 + row * 1000 + col + """ + + :param container: + :param row: + :param col: + + """ + RadValue = container * 100000 + row * 1000 + col return RadValue @@ -4422,6 +6139,13 @@ def EncodeRadioRowCol(container, row, col): # format of return values is # (Button Pressed, input_values) def BuildResults(form, initialize_only, top_level_form): + """ + + :param form: + :param initialize_only: + :param top_level_form: + + """ # Results for elements are: # TEXT - Nothing # INPUT - Read value from TK @@ -4438,10 +6162,17 @@ def BuildResults(form, initialize_only, top_level_form): def BuildResultsForSubform(form, initialize_only, top_level_form): + """ + + :param form: + :param initialize_only: + :param top_level_form: + + """ button_pressed_text = top_level_form.LastButtonClicked for row_num, row in enumerate(form.Rows): for col_num, element in enumerate(row): - if element.Key is not None and WRITE_ONLY_KEY in str(element.Key): + if element.Key is not None and WRITE_ONLY_KEY in str(element.Key): continue value = None if element.Type == ELEM_TYPE_COLUMN: @@ -4638,10 +6369,22 @@ def BuildResultsForSubform(form, initialize_only, top_level_form): def FillFormWithValues(form, values_dict): + """ + + :param form: + :param values_dict: + + """ FillSubformWithValues(form, values_dict) def FillSubformWithValues(form, values_dict): + """ + + :param form: + :param values_dict: + + """ for row_num, row in enumerate(form.Rows): for col_num, element in enumerate(row): value = None @@ -4680,6 +6423,12 @@ def FillSubformWithValues(form, values_dict): def _FindElementFromKeyInSubForm(form, key): + """ + + :param form: + :param key: (common_key) Used with window.FindElement and with return values + + """ for row_num, row in enumerate(form.Rows): for col_num, element in enumerate(row): if element.Type == ELEM_TYPE_COLUMN: @@ -4707,6 +6456,11 @@ def _FindElementFromKeyInSubForm(form, key): def _FindElementWithFocusInSubForm(form): + """ + + :param form: + + """ for row_num, row in enumerate(form.Rows): for col_num, element in enumerate(row): if element.Type == ELEM_TYPE_COLUMN: @@ -4738,8 +6492,18 @@ def _FindElementWithFocusInSubForm(form): if element.TKButton is element.TKButton.focus_get(): return element + if sys.version_info[0] >= 3: def AddMenuItem(top_menu, sub_menu_info, element, is_sub_menu=False, skip=False): + """ + + :param top_menu: + :param sub_menu_info: + :param element: + :param is_sub_menu: (Default value = False) + :param skip: (Default value = False) + + """ return_val = None if type(sub_menu_info) is str: if not is_sub_menu and not skip: @@ -4758,11 +6522,11 @@ if sys.version_info[0] >= 3: if item_without_key[0] == MENU_DISABLED_CHARACTER: top_menu.add_command(label=item_without_key[len(MENU_DISABLED_CHARACTER):], underline=pos, - command=lambda: element.MenuItemChosenCallback(sub_menu_info)) + command=lambda: element._MenuItemChosenCallback(sub_menu_info)) top_menu.entryconfig(item_without_key[len(MENU_DISABLED_CHARACTER):], state='disabled') else: top_menu.add_command(label=item_without_key, underline=pos, - command=lambda: element.MenuItemChosenCallback(sub_menu_info)) + command=lambda: element._MenuItemChosenCallback(sub_menu_info)) else: i = 0 while i < (len(sub_menu_info)): @@ -4776,7 +6540,8 @@ if sys.version_info[0] >= 3: if pos == 0 or sub_menu_info[i][pos - 1] != "\\": sub_menu_info[i] = sub_menu_info[i][:pos] + sub_menu_info[i][pos + 1:] if sub_menu_info[i][0] == MENU_DISABLED_CHARACTER: - top_menu.add_cascade(label=sub_menu_info[i][len(MENU_DISABLED_CHARACTER):], menu=new_menu, underline=pos, state='disabled') + top_menu.add_cascade(label=sub_menu_info[i][len(MENU_DISABLED_CHARACTER):], menu=new_menu, + underline=pos, state='disabled') else: top_menu.add_cascade(label=sub_menu_info[i], menu=new_menu, underline=pos) AddMenuItem(new_menu, sub_menu_info[i + 1], element, is_sub_menu=True) @@ -4789,6 +6554,15 @@ if sys.version_info[0] >= 3: return return_val else: def AddMenuItem(top_menu, sub_menu_info, element, is_sub_menu=False, skip=False): + """ + + :param top_menu: + :param sub_menu_info: + :param element: + :param is_sub_menu: (Default value = False) + :param skip: (Default value = False) + + """ if not isinstance(sub_menu_info, list): if not is_sub_menu and not skip: # print(f'Adding command {sub_menu_info}') @@ -4806,11 +6580,11 @@ else: if item_without_key[0] == MENU_DISABLED_CHARACTER: top_menu.add_command(label=item_without_key[len(MENU_DISABLED_CHARACTER):], underline=pos, - command=lambda: element.MenuItemChosenCallback(sub_menu_info)) + command=lambda: element._MenuItemChosenCallback(sub_menu_info)) top_menu.entryconfig(item_without_key[len(MENU_DISABLED_CHARACTER):], state='disabled') else: top_menu.add_command(label=item_without_key, underline=pos, - command=lambda: element.MenuItemChosenCallback(sub_menu_info)) + command=lambda: element._MenuItemChosenCallback(sub_menu_info)) else: i = 0 while i < (len(sub_menu_info)): @@ -4823,7 +6597,8 @@ else: if pos == 0 or sub_menu_info[i][pos - 1] != "\\": sub_menu_info[i] = sub_menu_info[i][:pos] + sub_menu_info[i][pos + 1:] if sub_menu_info[i][0] == MENU_DISABLED_CHARACTER: - top_menu.add_cascade(label=sub_menu_info[i][len(MENU_DISABLED_CHARACTER):], menu=new_menu, underline=pos, state='disabled') + top_menu.add_cascade(label=sub_menu_info[i][len(MENU_DISABLED_CHARACTER):], menu=new_menu, + underline=pos, state='disabled') else: top_menu.add_cascade(label=sub_menu_info[i], menu=new_menu, underline=pos) AddMenuItem(new_menu, sub_menu_info[i + 1], element, is_sub_menu=True) @@ -4834,7 +6609,6 @@ else: AddMenuItem(top_menu, item, element) i += 1 - # 888 888 d8b 888 # 888 888 Y8P 888 # 888 888 888 @@ -4856,10 +6630,19 @@ else: """ + # ======================== TK CODE STARTS HERE ========================================= # def PackFormIntoFrame(form, containing_frame, toplevel_form): + """ + + :param form: + :param containing_frame: + :param toplevel_form: + + """ def CharWidthInPixels(): + """ """ return tkinter.font.Font().measure('A') # single character width border_depth = toplevel_form.BorderDepth if toplevel_form.BorderDepth is not None else DEFAULT_BORDER_WIDTH @@ -4875,6 +6658,7 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): # *********** ------- Loop through ELEMENTS ------- ***********# # *********** Make TK Row ***********# tk_row_frame = tk.Frame(containing_frame) + row_should_expand = False for col_num, element in enumerate(flex_row): element.ParentForm = toplevel_form # save the button's parent form object if toplevel_form.Font and (element.Font == DEFAULT_FONT or not element.Font): @@ -4896,7 +6680,8 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): elementpad = element.Pad if element.Pad is not None else toplevel_form.ElementPadding # Determine Element size element_size = element.Size - if (element_size == (None, None) and element_type not in (ELEM_TYPE_BUTTON, ELEM_TYPE_BUTTONMENU)): # user did not specify a size + if (element_size == (None, None) and element_type not in ( + ELEM_TYPE_BUTTON, ELEM_TYPE_BUTTONMENU)): # user did not specify a size element_size = toplevel_form.DefaultElementSize elif (element_size == (None, None) and element_type in (ELEM_TYPE_BUTTON, ELEM_TYPE_BUTTONMENU)): element_size = toplevel_form.DefaultButtonElementSize @@ -4905,20 +6690,22 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): # ------------------------- COLUMN element ------------------------- # if element_type == ELEM_TYPE_COLUMN: if element.Scrollable: - element.TKColFrame = TkScrollableFrame(tk_row_frame, element.VerticalScrollOnly) # do not use yet! not working + element.TKColFrame = element.Widget = TkScrollableFrame(tk_row_frame, + element.VerticalScrollOnly) # do not use yet! not working PackFormIntoFrame(element, element.TKColFrame.TKFrame, toplevel_form) element.TKColFrame.TKFrame.update() if element.Size == (None, None): # if no size specified, use column width x column height/2 element.TKColFrame.canvas.config(width=element.TKColFrame.TKFrame.winfo_reqwidth(), - height=element.TKColFrame.TKFrame.winfo_reqheight() / 2) + height=element.TKColFrame.TKFrame.winfo_reqheight() / 2) else: element.TKColFrame.canvas.config(width=element.Size[0], height=element.Size[1]) if not element.BackgroundColor in (None, COLOR_SYSTEM_DEFAULT): element.TKColFrame.canvas.config(background=element.BackgroundColor) element.TKColFrame.TKFrame.config(background=element.BackgroundColor, borderwidth=0, - highlightthickness=0) - element.TKColFrame.config(background=element.BackgroundColor, borderwidth=0, highlightthickness=0) + highlightthickness=0) + element.TKColFrame.config(background=element.BackgroundColor, borderwidth=0, + highlightthickness=0) else: if element.Size != (None, None): element.TKColFrame = TkFixedFrame(tk_row_frame) @@ -4938,22 +6725,24 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): element.TKColFrame = element.TKColFrame if element.BackgroundColor != COLOR_SYSTEM_DEFAULT and element.BackgroundColor is not None: - element.TKColFrame.configure(background=element.BackgroundColor, highlightbackground=element.BackgroundColor, - highlightcolor=element.BackgroundColor) + element.TKColFrame.configure(background=element.BackgroundColor, + highlightbackground=element.BackgroundColor, + highlightcolor=element.BackgroundColor) if element.RightClickMenu or toplevel_form.RightClickMenu: menu = element.RightClickMenu or toplevel_form.RightClickMenu top_menu = tk.Menu(toplevel_form.TKroot, tearoff=False) AddMenuItem(top_menu, menu[1], element) element.TKRightClickMenu = top_menu - element.TKColFrame.bind('', element.RightClickMenuCallback) + element.TKColFrame.bind('', element._RightClickMenuCallback) # ------------------------- Pane element ------------------------- # if element_type == ELEM_TYPE_PANE: bd = element.BorderDepth if element.BorderDepth is not None else border_depth - element.PanedWindow = tk.PanedWindow(tk_row_frame, - orient=tk.VERTICAL if element.Orientation.startswith('v') else tk.HORIZONTAL, - borderwidth=bd, - bd=bd, - ) + element.PanedWindow = element.Widget = tk.PanedWindow(tk_row_frame, + orient=tk.VERTICAL if element.Orientation.startswith( + 'v') else tk.HORIZONTAL, + borderwidth=bd, + bd=bd, + ) if element.Relief is not None: element.PanedWindow.configure(relief=element.Relief) element.PanedWindow.configure(handlesize=element.HandleSize) @@ -4970,8 +6759,9 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): if pane.Visible: element.PanedWindow.add(pane.TKColFrame) if pane.BackgroundColor != COLOR_SYSTEM_DEFAULT and pane.BackgroundColor is not None: - pane.TKColFrame.configure(background=pane.BackgroundColor, highlightbackground=pane.BackgroundColor, - highlightcolor=pane.BackgroundColor) + pane.TKColFrame.configure(background=pane.BackgroundColor, + highlightbackground=pane.BackgroundColor, + highlightcolor=pane.BackgroundColor) element.PanedWindow.pack(side=tk.LEFT, padx=elementpad[0], pady=elementpad[1], expand=True, fill='both') if element.Visible is False: @@ -4979,7 +6769,7 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): # ------------------------- TEXT element ------------------------- # elif element_type == ELEM_TYPE_TEXT: # auto_size_text = element.AutoSizeText - element = element # type: Text + element = element # type: Text display_text = element.DisplayText # text to display if auto_size_text is False: width, height = element_size @@ -4995,7 +6785,7 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): # ---===--- LABEL widget create and place --- # stringvar = tk.StringVar() element.TKStringVar = stringvar - stringvar.set(display_text) + stringvar.set(str(display_text)) if auto_size_text: width = 0 if element.Justification is not None: @@ -5006,14 +6796,15 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): justification = DEFAULT_TEXT_JUSTIFICATION justify = tk.LEFT if justification == 'left' else tk.CENTER if justification == 'center' else tk.RIGHT anchor = tk.NW if justification == 'left' else tk.N if justification == 'center' else tk.NE - # tktext_label = tk.Label(tk_row_frame, textvariable=stringvar, width=width, height=height, - # justify=justify, bd=border_depth, font=font) - tktext_label = tk.Label(tk_row_frame, textvariable=stringvar, width=width, height=height, - justify=justify, bd=border_depth, font=font) + + tktext_label = element.Widget = tk.Label(tk_row_frame, textvariable=stringvar, width=width, + height=height, justify=justify, bd=border_depth, font=font) # Set wrap-length for text (in PIXELS) == PAIN IN THE ASS - wraplen = tktext_label.winfo_reqwidth() + 40 # width of widget in Pixels - if not auto_size_text and height == 1: + wraplen = tktext_label.winfo_reqwidth() # width of widget in Pixels + if not auto_size_text and height == 1: # if just 1 line high, ensure no wrap happens wraplen = 0 + # print(f'Text wraplen = {wraplen} wxh = {width} x {height}') + # print(f'Len = {len(display_text)} Text = {str(display_text)}') tktext_label.configure(anchor=anchor, wraplen=wraplen) # set wrap to width of widget if element.Relief is not None: tktext_label.configure(relief=element.Relief) @@ -5021,12 +6812,12 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): tktext_label.configure(background=element.BackgroundColor) if element.TextColor != COLOR_SYSTEM_DEFAULT and element.TextColor is not None: tktext_label.configure(fg=element.TextColor) - tktext_label.pack(side=tk.LEFT, padx=elementpad[0], pady=elementpad[1], expand=True) + tktext_label.pack(side=tk.LEFT, padx=elementpad[0], pady=elementpad[1]) if element.Visible is False: tktext_label.pack_forget() element.TKText = tktext_label if element.ClickSubmits: - tktext_label.bind('', element.TextClickedHandler) + tktext_label.bind('', element._TextClickedHandler) if element.Tooltip is not None: element.TooltipObject = ToolTip(element.TKText, text=element.Tooltip, timeout=DEFAULT_TOOLTIP_TIME) if element.RightClickMenu or toplevel_form.RightClickMenu: @@ -5034,10 +6825,10 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): top_menu = tk.Menu(toplevel_form.TKroot, tearoff=False) AddMenuItem(top_menu, menu[1], element) element.TKRightClickMenu = top_menu - tktext_label.bind('', element.RightClickMenuCallback) + tktext_label.bind('', element._RightClickMenuCallback) # ------------------------- BUTTON element ------------------------- # elif element_type == ELEM_TYPE_BUTTON: - element = element # type: Button + element = element # type: Button stringvar = tk.StringVar() element.TKStringVar = stringvar element.Location = (row_num, col_num) @@ -5060,11 +6851,13 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): bc = DEFAULT_BUTTON_COLOR border_depth = element.BorderWidth if btype != BUTTON_TYPE_REALTIME: - tkbutton = tk.Button(tk_row_frame, text=btext, width=width, height=height, - command=element.ButtonCallBack, justify=tk.LEFT, bd=border_depth, font=font) + tkbutton = element.Widget = tk.Button(tk_row_frame, text=btext, width=width, height=height, + command=element.ButtonCallBack, justify=tk.LEFT, + bd=border_depth, font=font) else: - tkbutton = tk.Button(tk_row_frame, text=btext, width=width, height=height, justify=tk.LEFT, - bd=border_depth, font=font) + tkbutton = element.Widget = tk.Button(tk_row_frame, text=btext, width=width, height=height, + justify=tk.LEFT, + bd=border_depth, font=font) tkbutton.bind('', element.ButtonReleaseCallBack) tkbutton.bind('', element.ButtonPressCallBack) if bc != (None, None) and bc != COLOR_SYSTEM_DEFAULT and bc[1] != COLOR_SYSTEM_DEFAULT: @@ -5104,10 +6897,10 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): if element.Visible is False: tkbutton.pack_forget() if element.BindReturnKey: - element.TKButton.bind('', element.ReturnKeyHandler) + element.TKButton.bind('', element._ReturnKeyHandler) if element.Focus is True or (toplevel_form.UseDefaultFocus and not focus_set): focus_set = True - element.TKButton.bind('', element.ReturnKeyHandler) + element.TKButton.bind('', element._ReturnKeyHandler) element.TKButton.focus_set() toplevel_form.TKroot.focus_force() if element.Disabled == True: @@ -5135,7 +6928,8 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): else: bc = DEFAULT_BUTTON_COLOR border_depth = element.BorderWidth - tkbutton = tk.Menubutton(tk_row_frame, text=btext, width=width, height=height, justify=tk.LEFT, bd=border_depth, font=font) + tkbutton = element.Widget = tk.Menubutton(tk_row_frame, text=btext, width=width, height=height, + justify=tk.LEFT, bd=border_depth, font=font) element.TKButtonMenu = tkbutton if bc != (None, None) and bc != COLOR_SYSTEM_DEFAULT and bc[1] != COLOR_SYSTEM_DEFAULT: tkbutton.config(foreground=bc[0], background=bc[1], activebackground=bc[1]) @@ -5190,6 +6984,7 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): # ------------------------- INPUT element ------------------------- # elif element_type == ELEM_TYPE_INPUT_TEXT: + element = element # type: InputText default_text = element.DefaultText element.TKStringVar = tk.StringVar() element.TKStringVar.set(default_text) @@ -5200,11 +6995,12 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): justification = DEFAULT_TEXT_JUSTIFICATION justify = tk.LEFT if justification == 'left' else tk.CENTER if justification == 'center' else tk.RIGHT # anchor = tk.NW if justification == 'left' else tk.N if justification == 'center' else tk.NE - element.TKEntry = tk.Entry(tk_row_frame, width=element_size[0], textvariable=element.TKStringVar, - bd=border_depth, font=font, show=show, justify=justify) + element.TKEntry = element.Widget = tk.Entry(tk_row_frame, width=element_size[0], + textvariable=element.TKStringVar, bd=border_depth, + font=font, show=show, justify=justify) if element.ChangeSubmits: - element.TKEntry.bind('', element.KeyboardHandler) - element.TKEntry.bind('', element.ReturnKeyHandler) + element.TKEntry.bind('', element._KeyboardHandler) + element.TKEntry.bind('', element._ReturnKeyHandler) if element.BackgroundColor is not None and element.BackgroundColor != COLOR_SYSTEM_DEFAULT: element.TKEntry.configure(background=element.BackgroundColor) if text_color is not None and text_color != COLOR_SYSTEM_DEFAULT: @@ -5224,10 +7020,10 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): top_menu = tk.Menu(toplevel_form.TKroot, tearoff=False) AddMenuItem(top_menu, menu[1], element) element.TKRightClickMenu = top_menu - element.TKEntry.bind('', element.RightClickMenuCallback) + element.TKEntry.bind('', element._RightClickMenuCallback) # ------------------------- COMBOBOX element ------------------------- # elif element_type == ELEM_TYPE_INPUT_COMBO: - max_line_len = max([len(str(l)) for l in element.Values]) + max_line_len = max([len(str(l)) for l in element.Values]) if len(element.Values) else 0 if auto_size_text is False: width = element_size[0] else: @@ -5240,8 +7036,13 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): # print(style_name) combostyle = ttk.Style() - unique_field = str(time.time()).replace('.','') + '.TCombobox.field' # Creates a unique name for each field element(Sure there is a better way to do this) + + unique_field = str(element.Key) + '.TCombobox.field' + + # unique_field = str(time.time()).replace('.', '') + str(element.Key) + '.TCombobox.field' + + # unique_field = str(time.time()).replace('.','') + '.TCombobox.field' # unique_field = str(datetime.datetime.today().timestamp()).replace('.','') + '.TCombobox.field' # unique_field = str(randint(1,50000000)) + '.TCombobox.field' @@ -5273,7 +7074,9 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): combostyle.configure(style_name, fieldbackground=element.BackgroundColor) combostyle.configure(style_name, selectforeground=element.TextColor) - element.TKCombo = ttk.Combobox(tk_row_frame, width=width, textvariable=element.TKStringVar, font=font, style=style_name) + element.TKCombo = element.Widget = ttk.Combobox(tk_row_frame, width=width, + textvariable=element.TKStringVar, font=font, + style=style_name) if element.Size[1] != 1 and element.Size[1] is not None: element.TKCombo.configure(height=element.Size[1]) element.TKCombo['values'] = element.Values @@ -5286,10 +7089,10 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): if v == element.DefaultValue: element.TKCombo.current(i) break - else: + elif element.Values: element.TKCombo.current(0) if element.ChangeSubmits: - element.TKCombo.bind('<>', element.ComboboxSelectHandler) + element.TKCombo.bind('<>', element._ComboboxSelectHandler) if element.Readonly: element.TKCombo['state'] = 'readonly' if element.Disabled is True: # note overrides readonly if disabled @@ -5306,7 +7109,8 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): element.TKStringVar = tk.StringVar() default = element.DefaultValue if element.DefaultValue else element.Values[0] element.TKStringVar.set(default) - element.TKOptionMenu = tk.OptionMenu(tk_row_frame, element.TKStringVar, *element.Values) + element.TKOptionMenu = element.Widget = tk.OptionMenu(tk_row_frame, element.TKStringVar, + *element.Values) element.TKOptionMenu.config(highlightthickness=0, font=font, width=width) element.TKOptionMenu.config(borderwidth=border_depth) if element.BackgroundColor is not None and element.BackgroundColor != COLOR_SYSTEM_DEFAULT: @@ -5323,15 +7127,17 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): timeout=DEFAULT_TOOLTIP_TIME) # ------------------------- LISTBOX element ------------------------- # elif element_type == ELEM_TYPE_INPUT_LISTBOX: - max_line_len = max([len(str(l)) for l in element.Values]) if len(element.Values) != 0 else 0 + element = element # type: Listbox + max_line_len = max([len(str(l)) for l in element.Values]) if len(element.Values) else 0 if auto_size_text is False: width = element_size[0] else: width = max_line_len listbox_frame = tk.Frame(tk_row_frame) element.TKStringVar = tk.StringVar() - element.TKListbox = tk.Listbox(listbox_frame, height=element_size[1], width=width, - selectmode=element.SelectMode, font=font, exportselection=False) + element.TKListbox = element.Widget = tk.Listbox(listbox_frame, height=element_size[1], width=width, + selectmode=element.SelectMode, font=font, + exportselection=False) for index, item in enumerate(element.Values): element.TKListbox.insert(tk.END, item) if element.DefaultValues is not None and item in element.DefaultValues: @@ -5341,17 +7147,18 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): if text_color is not None and text_color != COLOR_SYSTEM_DEFAULT: element.TKListbox.configure(fg=text_color) if element.ChangeSubmits: - element.TKListbox.bind('<>', element.ListboxSelectHandler) - vsb = tk.Scrollbar(listbox_frame, orient="vertical", command=element.TKListbox.yview) - element.TKListbox.configure(yscrollcommand=vsb.set) + element.TKListbox.bind('<>', element._ListboxSelectHandler) + element.vsb = tk.Scrollbar(listbox_frame, orient="vertical", command=element.TKListbox.yview) + element.TKListbox.configure(yscrollcommand=element.vsb.set) element.TKListbox.pack(side=tk.LEFT) - vsb.pack(side=tk.LEFT, fill='y') + element.vsb.pack(side=tk.LEFT, fill='y') listbox_frame.pack(side=tk.LEFT, padx=elementpad[0], pady=elementpad[1]) if element.Visible is False: listbox_frame.pack_forget() + element.vsb.pack_forget() if element.BindReturnKey: - element.TKListbox.bind('', element.ListboxSelectHandler) - element.TKListbox.bind('', element.ListboxSelectHandler) + element.TKListbox.bind('', element._ListboxSelectHandler) + element.TKListbox.bind('', element._ListboxSelectHandler) if element.Disabled == True: element.TKListbox['state'] = 'disabled' if element.Tooltip is not None: @@ -5362,25 +7169,28 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): top_menu = tk.Menu(toplevel_form.TKroot, tearoff=False) AddMenuItem(top_menu, menu[1], element) element.TKRightClickMenu = top_menu - element.TKListbox.bind('', element.RightClickMenuCallback) + element.TKListbox.bind('', element._RightClickMenuCallback) # ------------------------- MULTILINE element ------------------------- # elif element_type == ELEM_TYPE_INPUT_MULTILINE: - element = element # type: Multiline + element = element # type: Multiline default_text = element.DefaultText width, height = element_size - element.TKText = tk.scrolledtext.ScrolledText(tk_row_frame, width=width, height=height, wrap='word', - bd=border_depth, font=font, relief=tk.FLAT) + border_depth = element.BorderWidth + element.TKText = element.Widget = tk.scrolledtext.ScrolledText(tk_row_frame, width=width, height=height, + wrap='word', bd=border_depth, font=font, + relief=RELIEF_SUNKEN) element.TKText.insert(1.0, default_text) # set the default text if element.BackgroundColor is not None and element.BackgroundColor != COLOR_SYSTEM_DEFAULT: element.TKText.configure(background=element.BackgroundColor) + if DEFAULT_SCROLLBAR_COLOR not in (None, COLOR_SYSTEM_DEFAULT): element.TKText.vbar.config(troughcolor=DEFAULT_SCROLLBAR_COLOR) element.TKText.pack(side=tk.LEFT, padx=elementpad[0], pady=elementpad[1], expand=True, fill='both') if element.Visible is False: element.TKText.pack_forget() if element.ChangeSubmits: - element.TKText.bind('', element.KeyboardHandler) + element.TKText.bind('', element._KeyboardHandler) if element.EnterSubmits: - element.TKText.bind('', element.ReturnKeyHandler) + element.TKText.bind('', element._ReturnKeyHandler) if element.Focus is True or (toplevel_form.UseDefaultFocus and not focus_set): focus_set = True element.TKText.focus_set() @@ -5395,7 +7205,8 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): top_menu = tk.Menu(toplevel_form.TKroot, tearoff=False) AddMenuItem(top_menu, menu[1], element) element.TKRightClickMenu = top_menu - element.TKText.bind('', element.RightClickMenuCallback) + element.TKText.bind('', element._RightClickMenuCallback) + row_should_expand = True # ------------------------- CHECKBOX element ------------------------- # elif element_type == ELEM_TYPE_INPUT_CHECKBOX: width = 0 if auto_size_text else element_size[0] @@ -5403,13 +7214,17 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): element.TKIntVar = tk.IntVar() element.TKIntVar.set(default_value if default_value is not None else 0) if element.ChangeSubmits: - element.TKCheckbutton = tk.Checkbutton(tk_row_frame, anchor=tk.NW, text=element.Text, width=width, - variable=element.TKIntVar, bd=border_depth, font=font, - command=element.CheckboxHandler) + element.TKCheckbutton = element.Widget = tk.Checkbutton(tk_row_frame, anchor=tk.NW, + text=element.Text, width=width, + variable=element.TKIntVar, bd=border_depth, + font=font, + command=element._CheckboxHandler) else: - element.TKCheckbutton = tk.Checkbutton(tk_row_frame, anchor=tk.NW, text=element.Text, width=width, - variable=element.TKIntVar, bd=border_depth, font=font) - if default_value is None or element.Disabled: + element.TKCheckbutton = element.Widget = tk.Checkbutton(tk_row_frame, anchor=tk.NW, + text=element.Text, width=width, + variable=element.TKIntVar, bd=border_depth, + font=font) + if element.Disabled: element.TKCheckbutton.configure(state='disable') if element.BackgroundColor is not None and element.BackgroundColor != COLOR_SYSTEM_DEFAULT: element.TKCheckbutton.configure(background=element.BackgroundColor) @@ -5443,14 +7258,16 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): element.TKProgressBar.TKProgressBarForReal.pack(side=tk.LEFT, padx=elementpad[0], pady=elementpad[1]) if element.Visible is False: element.TKProgressBar.TKProgressBarForReal.pack_forget() + element.Widget = element.TKProgressBar.TKProgressBarForReal # ------------------------- RADIO BUTTON element ------------------------- # elif element_type == ELEM_TYPE_INPUT_RADIO: - element = element # type: Radio + element = element # type: Radio width = 0 if auto_size_text else element_size[0] default_value = element.InitialState ID = element.GroupID # see if ID has already been placed - value = EncodeRadioRowCol(form.ContainerElemementNumber, row_num, col_num) # value to set intvar to if this radio is selected + value = EncodeRadioRowCol(form.ContainerElemementNumber, row_num, + col_num) # value to set intvar to if this radio is selected element.EncodedRadioValue = value if ID in toplevel_form.RadioDict: RadVar = toplevel_form.RadioDict[ID] @@ -5461,12 +7278,16 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): if default_value: # if this radio is the one selected, set RadVar to match element.TKIntVar.set(value) if element.ChangeSubmits: - element.TKRadio = tk.Radiobutton(tk_row_frame, anchor=tk.NW, text=element.Text, width=width, - variable=element.TKIntVar, value=value, bd=border_depth, font=font, - command=element.RadioHandler) + element.TKRadio = element.Widget = tk.Radiobutton(tk_row_frame, anchor=tk.NW, text=element.Text, + width=width, + variable=element.TKIntVar, value=value, + bd=border_depth, font=font, + command=element._RadioHandler) else: - element.TKRadio = tk.Radiobutton(tk_row_frame, anchor=tk.NW, text=element.Text, width=width, - variable=element.TKIntVar, value=value, bd=border_depth, font=font) + element.TKRadio = element.Widget = tk.Radiobutton(tk_row_frame, anchor=tk.NW, text=element.Text, + width=width, + variable=element.TKIntVar, value=value, + bd=border_depth, font=font) if not element.BackgroundColor in (None, COLOR_SYSTEM_DEFAULT): element.TKRadio.configure(background=element.BackgroundColor) element.TKRadio.configure(selectcolor=element.BackgroundColor) @@ -5484,8 +7305,9 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): width, height = element_size width = 0 if auto_size_text else element_size[0] element.TKStringVar = tk.StringVar() - element.TKSpinBox = tk.Spinbox(tk_row_frame, values=element.Values, textvariable=element.TKStringVar, - width=width, bd=border_depth) + element.TKSpinBox = element.Widget = tk.Spinbox(tk_row_frame, values=element.Values, + textvariable=element.TKStringVar, + width=width, bd=border_depth) element.TKStringVar.set(element.DefaultValue) element.TKSpinBox.configure(font=font) # set wrap to width of widget if element.BackgroundColor is not None and element.BackgroundColor != COLOR_SYSTEM_DEFAULT: @@ -5505,11 +7327,12 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): # ------------------------- OUTPUT element ------------------------- # elif element_type == ELEM_TYPE_OUTPUT: width, height = element_size - element._TKOut = TKOutput(tk_row_frame, width=width, height=height, bd=border_depth, - background_color=element.BackgroundColor, text_color=text_color, font=font, - pad=elementpad) - element._TKOut.output.configure(takefocus=0) # make it so that Output does not get focus - element._TKOut.pack(side=tk.LEFT, expand=True, fill='both') + element._TKOut = element.Widget = TKOutput(tk_row_frame, width=width, height=height, bd=border_depth, + background_color=element.BackgroundColor, + text_color=text_color, font=font, + pad=elementpad) + element._TKOut.output.configure(takefocus=0) # make it so that Output does not get focus + element._TKOut.pack(side=tk.LEFT, expand=True, fill=tk.BOTH) if element.Visible is False: element._TKOut.frame.pack_forget() if element.Tooltip is not None: @@ -5519,7 +7342,8 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): top_menu = tk.Menu(toplevel_form.TKroot, tearoff=False) AddMenuItem(top_menu, menu[1], element) element.TKRightClickMenu = top_menu - element._TKOut.bind('', element.RightClickMenuCallback) + element._TKOut.bind('', element._RightClickMenuCallback) + row_should_expand = True # ------------------------- IMAGE element ------------------------- # elif element_type == ELEM_TYPE_IMAGE: if element.Filename is not None: @@ -5537,11 +7361,14 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): else: width, height = element_size if photo is not None: - element.tktext_label = tk.Label(tk_row_frame, image=photo, width=width, height=height, - bd=border_depth) + element.tktext_label = element.Widget = tk.Label(tk_row_frame, image=photo, width=width, + height=height, + bd=border_depth) else: - element.tktext_label = tk.Label(tk_row_frame, width=width, height=height, bd=border_depth) - if element.BackgroundColor is not None: + element.tktext_label = element.Widget = tk.Label(tk_row_frame, width=width, height=height, + bd=border_depth) + + if not element.BackgroundColor in (None, COLOR_SYSTEM_DEFAULT): element.tktext_label.config(background=element.BackgroundColor) element.tktext_label.image = photo @@ -5553,18 +7380,19 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): element.TooltipObject = ToolTip(element.tktext_label, text=element.Tooltip, timeout=DEFAULT_TOOLTIP_TIME) if element.EnableEvents: - element.tktext_label.bind('', element.ClickHandler) + element.tktext_label.bind('', element._ClickHandler) if element.RightClickMenu or toplevel_form.RightClickMenu: menu = element.RightClickMenu or toplevel_form.RightClickMenu top_menu = tk.Menu(toplevel_form.TKroot, tearoff=False) AddMenuItem(top_menu, menu[1], element) element.TKRightClickMenu = top_menu - element.tktext_label.bind('', element.RightClickMenuCallback) + element.tktext_label.bind('', element._RightClickMenuCallback) # ------------------------- Canvas element ------------------------- # elif element_type == ELEM_TYPE_CANVAS: width, height = element_size if element._TKCanvas is None: - element._TKCanvas = tk.Canvas(tk_row_frame, width=width, height=height, bd=border_depth) + element._TKCanvas = element.Widget = tk.Canvas(tk_row_frame, width=width, height=height, + bd=border_depth) else: element._TKCanvas.master = tk_row_frame if element.BackgroundColor is not None and element.BackgroundColor != COLOR_SYSTEM_DEFAULT: @@ -5580,26 +7408,29 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): top_menu = tk.Menu(toplevel_form.TKroot, tearoff=False) AddMenuItem(top_menu, menu[1], element) element.TKRightClickMenu = top_menu - element._TKCanvas.bind('', element.RightClickMenuCallback) + element._TKCanvas.bind('', element._RightClickMenuCallback) # ------------------------- Graph element ------------------------- # elif element_type == ELEM_TYPE_GRAPH: + element = element # type: Graph width, height = element_size - if element._TKCanvas is None: - element._TKCanvas = tk.Canvas(tk_row_frame, width=width, height=height, bd=border_depth) - else: - element._TKCanvas.master = tk_row_frame - element._TKCanvas2 = tk.Canvas(element._TKCanvas, width=width, height=height, bd=border_depth) + # I don't know why TWO canvases were being defined, on inside the other. Was it so entire canvas can move? + # if element._TKCanvas is None: + # element._TKCanvas = tk.Canvas(tk_row_frame, width=width, height=height, bd=border_depth) + # else: + # element._TKCanvas.master = tk_row_frame + element._TKCanvas2 = element.Widget = tk.Canvas(tk_row_frame, width=width, height=height, + bd=border_depth) element._TKCanvas2.pack(side=tk.LEFT) element._TKCanvas2.addtag_all('mytag') if element.BackgroundColor is not None and element.BackgroundColor != COLOR_SYSTEM_DEFAULT: element._TKCanvas2.configure(background=element.BackgroundColor, highlightthickness=0) - element._TKCanvas.configure(background=element.BackgroundColor, highlightthickness=0) - element._TKCanvas.pack(side=tk.LEFT, padx=elementpad[0], pady=elementpad[1]) + # element._TKCanvas.configure(background=element.BackgroundColor, highlightthickness=0) + element._TKCanvas2.pack(side=tk.LEFT, padx=elementpad[0], pady=elementpad[1]) if element.Visible is False: - element._TKCanvas.pack_forget() + # element._TKCanvas.pack_forget() element._TKCanvas2.pack_forget() if element.Tooltip is not None: - element.TooltipObject = ToolTip(element._TKCanvas, text=element.Tooltip, + element.TooltipObject = ToolTip(element._TKCanvas2, text=element.Tooltip, timeout=DEFAULT_TOOLTIP_TIME) if element.ChangeSubmits: element._TKCanvas2.bind('', element.ButtonReleaseCallBack) @@ -5611,11 +7442,13 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): top_menu = tk.Menu(toplevel_form.TKroot, tearoff=False) AddMenuItem(top_menu, menu[1], element) element.TKRightClickMenu = top_menu - element._TKCanvas2.bind('', element.RightClickMenuCallback) + element._TKCanvas2.bind('', element._RightClickMenuCallback) # ------------------------- MENUBAR element ------------------------- # elif element_type == ELEM_TYPE_MENUBAR: + element = element # type: MenuBar menu_def = element.MenuDefinition - element.TKMenu = tk.Menu(toplevel_form.TKroot, tearoff=element.Tearoff) # create the menubar + element.TKMenu = element.Widget = tk.Menu(toplevel_form.TKroot, + tearoff=element.Tearoff) # create the menubar menubar = element.TKMenu for menu_entry in menu_def: # print(f'Adding a Menubar ENTRY {menu_entry}') @@ -5626,7 +7459,8 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): if pos == 0 or menu_entry[0][pos - 1] != "\\": menu_entry[0] = menu_entry[0][:pos] + menu_entry[0][pos + 1:] if menu_entry[0][0] == MENU_DISABLED_CHARACTER: - menubar.add_cascade(label=menu_entry[0][len(MENU_DISABLED_CHARACTER):], menu=baritem, underline=pos) + menubar.add_cascade(label=menu_entry[0][len(MENU_DISABLED_CHARACTER):], menu=baritem, + underline=pos) menubar.entryconfig(menu_entry[0][len(MENU_DISABLED_CHARACTER):], state='disabled') else: menubar.add_cascade(label=menu_entry[0], menu=baritem, underline=pos) @@ -5636,7 +7470,7 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): toplevel_form.TKroot.configure(menu=element.TKMenu) # ------------------------- Frame element ------------------------- # elif element_type == ELEM_TYPE_FRAME: - labeled_frame = tk.LabelFrame(tk_row_frame, text=element.Title, relief=element.Relief) + labeled_frame = element.Widget = tk.LabelFrame(tk_row_frame, text=element.Title, relief=element.Relief) element.TKFrame = labeled_frame PackFormIntoFrame(element, labeled_frame, toplevel_form) labeled_frame.pack(side=tk.LEFT, padx=elementpad[0], pady=elementpad[1]) @@ -5661,10 +7495,10 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): top_menu = tk.Menu(toplevel_form.TKroot, tearoff=False) AddMenuItem(top_menu, menu[1], element) element.TKRightClickMenu = top_menu - labeled_frame.bind('', element.RightClickMenuCallback) + labeled_frame.bind('', element._RightClickMenuCallback) # ------------------------- Tab element ------------------------- # elif element_type == ELEM_TYPE_TAB: - element.TKFrame = tk.Frame(form.TKNotebook) + element.TKFrame = element.Widget = tk.Frame(form.TKNotebook) PackFormIntoFrame(element, element.TKFrame, toplevel_form) if element.Disabled: form.TKNotebook.add(element.TKFrame, text=element.Title, state='disabled') @@ -5696,10 +7530,10 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): top_menu = tk.Menu(toplevel_form.TKroot, tearoff=False) AddMenuItem(top_menu, menu[1], element) element.TKRightClickMenu = top_menu - element.TKFrame.bind('', element.RightClickMenuCallback) + element.TKFrame.bind('', element._RightClickMenuCallback) # ------------------------- TabGroup element ------------------------- # elif element_type == ELEM_TYPE_TAB_GROUP: - + element=element # type: TabGroup custom_style = str(element.Key) + 'customtab.TNotebook' style = ttk.Style(tk_row_frame) if element.Theme is not None: @@ -5731,12 +7565,12 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): style.configure(custom_style + '.Tab', foreground=element.TextColor) # style.configure(custom_style, background='blue', foreground='yellow') - element.TKNotebook = ttk.Notebook(tk_row_frame, style=custom_style) + element.TKNotebook = element.Widget = ttk.Notebook(tk_row_frame, style=custom_style) PackFormIntoFrame(element, toplevel_form.TKroot, toplevel_form) if element.ChangeSubmits: - element.TKNotebook.bind('<>', element.TabGroupSelectHandler) + element.TKNotebook.bind('<>', element._TabGroupSelectHandler) if element.BorderWidth is not None: element.TKNotebook.configure(borderwidth=element.BorderWidth) if element.Tooltip is not None: @@ -5756,16 +7590,22 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): range_from = element.Range[0] range_to = element.Range[1] if element.ChangeSubmits: - tkscale = tk.Scale(tk_row_frame, orient=element.Orientation, variable=element.TKIntVar, - from_=range_from, to_=range_to, resolution=element.Resolution, - length=slider_length, width=slider_width, bd=element.BorderWidth, - relief=element.Relief, font=font, tickinterval=element.TickInterval, - command=element.SliderChangedHandler) + tkscale = element.Widget = tk.Scale(tk_row_frame, orient=element.Orientation, + variable=element.TKIntVar, + from_=range_from, to_=range_to, resolution=element.Resolution, + length=slider_length, width=slider_width, + bd=element.BorderWidth, + relief=element.Relief, font=font, + tickinterval=element.TickInterval, + command=element._SliderChangedHandler) else: - tkscale = tk.Scale(tk_row_frame, orient=element.Orientation, variable=element.TKIntVar, - from_=range_from, to_=range_to, resolution=element.Resolution, - length=slider_length, width=slider_width, bd=element.BorderWidth, - relief=element.Relief, font=font, tickinterval=element.TickInterval) + tkscale = element.Widget = tk.Scale(tk_row_frame, orient=element.Orientation, + variable=element.TKIntVar, + from_=range_from, to_=range_to, resolution=element.Resolution, + length=slider_length, width=slider_width, + bd=element.BorderWidth, + relief=element.Relief, font=font, + tickinterval=element.TickInterval) tkscale.config(highlightthickness=0) if element.BackgroundColor is not None and element.BackgroundColor != COLOR_SYSTEM_DEFAULT: tkscale.configure(background=element.BackgroundColor) @@ -5785,7 +7625,7 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): element.TooltipObject = ToolTip(element.TKScale, text=element.Tooltip, timeout=DEFAULT_TOOLTIP_TIME) # ------------------------- TABLE element ------------------------- # elif element_type == ELEM_TYPE_TABLE: - element = element # type: Table + element = element # type: Table frame = tk.Frame(tk_row_frame) height = element.NumRows @@ -5815,9 +7655,10 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): if element.DisplayRowNumbers: # if display row number, tack on the numbers to front of columns displaycolumns = [element.RowHeaderText, ] + displaycolumns column_headings = [element.RowHeaderText, ] + element.ColumnHeadings - element.TKTreeview = ttk.Treeview(frame, columns=column_headings, - displaycolumns=displaycolumns, show='headings', height=height, - selectmode=element.SelectMode,) + element.TKTreeview = element.Widget = ttk.Treeview(frame, columns=column_headings, + displaycolumns=displaycolumns, show='headings', + height=height, + selectmode=element.SelectMode, ) treeview = element.TKTreeview if element.DisplayRowNumbers: treeview.heading(element.RowHeaderText, text=element.RowHeaderText) # make a dummy heading @@ -5838,14 +7679,14 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): # Insert values into the tree for i, value in enumerate(element.Values): if element.DisplayRowNumbers: - value = [i+element.StartingRowNumber] + value + value = [i + element.StartingRowNumber] + value id = treeview.insert('', 'end', text=value, iid=i + 1, values=value, tag=i) - if element.AlternatingRowColor is not None: # alternating colors + if element.AlternatingRowColor is not None: # alternating colors for row in range(0, len(element.Values), 2): treeview.tag_configure(row, background=element.AlternatingRowColor) - if element.RowColors is not None: # individual row colors + if element.RowColors is not None: # individual row colors for row_def in element.RowColors: - if len(row_def) == 2: # only background is specified + if len(row_def) == 2: # only background is specified treeview.tag_configure(row_def[0], background=row_def[1]) else: treeview.tag_configure(row_def[0], background=row_def[2], foreground=row_def[1]) @@ -5864,9 +7705,11 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): treeview.bind('', element.treeview_double_click) treeview.bind('', element.treeview_double_click) - scrollbar = tk.Scrollbar(frame) - scrollbar.pack(side=tk.RIGHT, fill='y') - scrollbar.config(command=treeview.yview) + if not element.HideVerticalScroll: + scrollbar = tk.Scrollbar(frame) + scrollbar.pack(side=tk.RIGHT, fill='y') + scrollbar.config(command=treeview.yview) + treeview.configure(yscrollcommand=scrollbar.set) if not element.VerticalScrollOnly: hscrollbar = tk.Scrollbar(frame, orient=tk.HORIZONTAL) @@ -5874,8 +7717,6 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): hscrollbar.config(command=treeview.xview) treeview.configure(xscrollcommand=hscrollbar.set) - treeview.configure(yscrollcommand=scrollbar.set) - element.TKTreeview.pack(side=tk.LEFT, expand=True, padx=0, pady=0, fill='both') if element.Visible is False: element.TKTreeview.pack_forget() @@ -5888,10 +7729,10 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): top_menu = tk.Menu(toplevel_form.TKroot, tearoff=False) AddMenuItem(top_menu, menu[1], element) element.TKRightClickMenu = top_menu - element.TKTreeview.bind('', element.RightClickMenuCallback) + element.TKTreeview.bind('', element._RightClickMenuCallback) # ------------------------- Tree element ------------------------- # elif element_type == ELEM_TYPE_TREE: - element = element #type: Tree + element = element # type: Tree frame = tk.Frame(tk_row_frame) height = element.NumRows @@ -5911,9 +7752,10 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): displaycolumns.append(element.ColumnHeadings[i]) column_headings = element.ColumnHeadings # ------------- GET THE TREEVIEW WIDGET ------------- - element.TKTreeview = ttk.Treeview(frame, columns=column_headings, - displaycolumns=displaycolumns, show='tree headings', height=height, - selectmode=element.SelectMode) + element.TKTreeview = element.Widget = ttk.Treeview(frame, columns=column_headings, + displaycolumns=displaycolumns, show='tree headings', + height=height, + selectmode=element.SelectMode) treeview = element.TKTreeview for i, heading in enumerate(element.ColumnHeadings): # Configure cols + headings treeview.heading(heading, text=heading) @@ -5925,7 +7767,13 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): except: width = element.DefaultColumnWidth treeview.column(heading, width=width * CharWidthInPixels(), anchor=anchor) + def add_treeview_data(node): + """ + + :param node: + + """ # print(f'Inserting {node.key} under parent {node.parent}') if node.key != '': if node.icon: @@ -5934,9 +7782,11 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): else: photo = tk.PhotoImage(file=node.icon) node.photo = photo - treeview.insert(node.parent, 'end', node.key, text=node.text, values=node.values, open=element.ShowExpanded, image=node.photo) + treeview.insert(node.parent, 'end', node.key, text=node.text, values=node.values, + open=element.ShowExpanded, image=node.photo) else: - treeview.insert(node.parent, 'end', node.key, text=node.text, values=node.values, open=element.ShowExpanded) + treeview.insert(node.parent, 'end', node.key, text=node.text, values=node.values, + open=element.ShowExpanded) for node in node.children: add_treeview_data(node) @@ -5970,11 +7820,11 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): top_menu = tk.Menu(toplevel_form.TKroot, tearoff=False) AddMenuItem(top_menu, menu[1], element) element.TKRightClickMenu = top_menu - element.TKTreeview.bind('', element.RightClickMenuCallback) + element.TKTreeview.bind('', element._RightClickMenuCallback) # ------------------------- Separator element ------------------------- # elif element_type == ELEM_TYPE_SEPARATOR: - element = element # type: VerticalSeparator - separator = ttk.Separator(tk_row_frame, orient=element.Orientation, ) + element = element # type: VerticalSeparator + separator = element.Widget = ttk.Separator(tk_row_frame, orient=element.Orientation, ) separator.pack(side=tk.LEFT, padx=elementpad[0], pady=elementpad[1], fill='both', expand=True) # ------------------------- StatusBar element ------------------------- # elif element_type == ELEM_TYPE_STATUSBAR: @@ -6007,8 +7857,9 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): anchor = tk.NW if justification == 'left' else tk.N if justification == 'center' else tk.NE # tktext_label = tk.Label(tk_row_frame, textvariable=stringvar, width=width, height=height, # justify=justify, bd=border_depth, font=font) - tktext_label = tk.Label(tk_row_frame, textvariable=stringvar, width=width, height=height, - justify=justify, bd=border_depth, font=font) + tktext_label = element.Widget = tk.Label(tk_row_frame, textvariable=stringvar, width=width, + height=height, + justify=justify, bd=border_depth, font=font) # Set wrap-length for text (in PIXELS) == PAIN IN THE ASS wraplen = tktext_label.winfo_reqwidth() + 40 # width of widget in Pixels if not auto_size_text and height == 1: @@ -6021,19 +7872,20 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): tktext_label.configure(background=element.BackgroundColor) if element.TextColor != COLOR_SYSTEM_DEFAULT and element.TextColor is not None: tktext_label.configure(fg=element.TextColor) - tktext_label.pack(side=tk.LEFT, padx=elementpad[0], pady=elementpad[1],fill=tk.BOTH, expand=True) + tktext_label.pack(side=tk.LEFT, padx=elementpad[0], pady=elementpad[1], fill=tk.BOTH, expand=True) if element.Visible is False: tktext_label.pack_forget() element.TKText = tktext_label if element.ClickSubmits: - tktext_label.bind('', element.TextClickedHandler) + tktext_label.bind('', element._TextClickedHandler) if element.Tooltip is not None: element.TooltipObject = ToolTip(element.TKText, text=element.Tooltip, timeout=DEFAULT_TOOLTIP_TIME) # ............................DONE WITH ROW pack the row of widgets ..........................# # done with row, pack the row of widgets # tk_row_frame.grid(row=row_num+2, sticky=tk.NW, padx=DEFAULT_MARGINS[0]) - tk_row_frame.pack(side=tk.TOP, anchor='nw', padx=toplevel_form.Margins[0], expand=False) + tk_row_frame.pack(side=tk.TOP, anchor='nw', padx=toplevel_form.Margins[0], + expand=row_should_expand, fill=tk.BOTH if row_should_expand else tk.NONE) if form.BackgroundColor is not None and form.BackgroundColor != COLOR_SYSTEM_DEFAULT: tk_row_frame.configure(background=form.BackgroundColor) toplevel_form.TKroot.configure(padx=toplevel_form.Margins[0], pady=toplevel_form.Margins[1]) @@ -6041,13 +7893,21 @@ def PackFormIntoFrame(form, containing_frame, toplevel_form): def ConvertFlexToTK(MyFlexForm): - MyFlexForm # type: Window + """ + + :param MyFlexForm: + + """ + MyFlexForm # type: Window master = MyFlexForm.TKroot master.title(MyFlexForm.Title) InitializeResults(MyFlexForm) try: if MyFlexForm.NoTitleBar: - MyFlexForm.TKroot.wm_overrideredirect(True) + if sys.platform == 'linux': + MyFlexForm.TKroot.wm_attributes("-type", "splash") + else: + MyFlexForm.TKroot.wm_overrideredirect(True) except: pass PackFormIntoFrame(MyFlexForm, master, MyFlexForm) @@ -6080,7 +7940,12 @@ def ConvertFlexToTK(MyFlexForm): # ----====----====----====----====----==== STARTUP TK ====----====----====----====----====----# -def StartupTK(my_flex_form:Window): +def StartupTK(my_flex_form: Window): + """ + + :param my_flex_form: Window: + + """ # global _my_windows # ow = _my_windows.NumOpenWindows ow = Window.NumOpenWindows @@ -6094,16 +7959,16 @@ def StartupTK(my_flex_form:Window): Window.hidden_master_root.attributes('-alpha', 0) # HIDE this window really really really Window.hidden_master_root.wm_overrideredirect(True) Window.hidden_master_root.withdraw() - # good - # _my_windows.Increment() - # _my_windows.hidden_master_root = tk.Tk() - # _my_windows.hidden_master_root.attributes('-alpha', 0) # HIDE this window really really really good - # _my_windows.hidden_master_root.wm_overrideredirect(True) # damn, what did this do again? - # _my_windows.hidden_master_root.withdraw() # no, REALLY hide it root = tk.Toplevel() else: root = tk.Toplevel() + if my_flex_form.DebuggerEnabled: + root.bind('', my_flex_form._callback_main_debugger_window_create_keystroke) + root.bind('', my_flex_form._callback_popout_window_create_keystroke) + + # root.bind('', Debugger._build_main_debugger_window) + # root.bind('', Debugger._build_floating_window) try: root.attributes('-alpha', 0) # hide window while building it. makes for smoother 'paint' except: @@ -6111,7 +7976,6 @@ def StartupTK(my_flex_form:Window): if my_flex_form.BackgroundColor is not None and my_flex_form.BackgroundColor != COLOR_SYSTEM_DEFAULT: root.configure(background=my_flex_form.BackgroundColor) Window.IncrementOpenCount() - # _my_windows.Increment() my_flex_form.TKroot = root # Make moveable window @@ -6130,6 +7994,9 @@ def StartupTK(my_flex_form:Window): if my_flex_form.KeepOnTop: root.wm_attributes("-topmost", 1) + if my_flex_form.TransparentColor is not None: + my_flex_form.SetTransparentColor(my_flex_form.TransparentColor) + # root.protocol("WM_DELETE_WINDOW", MyFlexForm.DestroyedCallback()) # root.bind('', MyFlexForm.DestroyedCallback()) ConvertFlexToTK(my_flex_form) @@ -6137,7 +8004,8 @@ def StartupTK(my_flex_form:Window): my_flex_form.SetIcon(my_flex_form.WindowIcon) try: - root.attributes('-alpha', my_flex_form.AlphaChannel) # Make window visible again + root.attributes('-alpha', + 1 if my_flex_form.AlphaChannel is None else my_flex_form.AlphaChannel) # Make window visible again except: pass @@ -6179,6 +8047,12 @@ def StartupTK(my_flex_form:Window): # Helper function for determining how to wrap text # # ===================================================# def _GetNumLinesNeeded(text, max_line_width): + """ + + :param text: + :param max_line_width: + + """ if max_line_width == 0: return 1 lines = text.split('\n') @@ -6194,6 +8068,11 @@ def _GetNumLinesNeeded(text, max_line_width): # ============================== PROGRESS METER ========================================== # def ConvertArgsToSingleString(*args): + """ + + :param *args: + + """ max_line_total, width_used, total_lines, = 0, 0, 0 single_line_message = '' # loop through args and built a SINGLE string from them @@ -6216,12 +8095,29 @@ METER_REASON_REACHED_MAX = 'finished' METER_OK = True METER_STOPPED = False + class QuickMeter(object): + """ """ active_meters = {} exit_reasons = {} def __init__(self, title, current_value, max_value, key, *args, orientation='v', bar_color=(None, None), - button_color=(None, None), size=DEFAULT_PROGRESS_BAR_SIZE, border_width=None, grab_anywhere=False): + button_color=(None, None), size=DEFAULT_PROGRESS_BAR_SIZE, border_width=None, grab_anywhere=False): + """ + + :param title: + :param current_value: + :param max_value: + :param key: (common_key) Used with window.FindElement and with return values + :param *args: + :param orientation: (Default value = 'v') + :param bar_color: (Default value = (None, None)) + :param button_color: (Default value = (None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = DEFAULT_PROGRESS_BAR_SIZE) + :param border_width: (Default value = None) + :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) + + """ self.start_time = datetime.datetime.utcnow() self.key = key self.orientation = orientation @@ -6237,19 +8133,28 @@ class QuickMeter(object): self.window = self.BuildWindow(*args) def BuildWindow(self, *args): + """ + + :param *args: + + """ layout = [] if self.orientation.lower().startswith('h'): col = [] - col += [[T(''.join(map(lambda x: str(x)+'\n',args)),key='_OPTMSG_')]] ### convert all *args into one string that can be updated - col += [[T('', size=(30,10), key='_STATS_')], - [ProgressBar(max_value=self.max_value, orientation='h', key='_PROG_', size=self.size, bar_color=self.bar_color)], + col += [[T(''.join(map(lambda x: str(x) + '\n', args)), + key='_OPTMSG_')]] ### convert all *args into one string that can be updated + col += [[T('', size=(30, 10), key='_STATS_')], + [ProgressBar(max_value=self.max_value, orientation='h', key='_PROG_', size=self.size, + bar_color=self.bar_color)], [Cancel(button_color=self.button_color), Stretch()]] layout = [Column(col)] else: - col = [[ProgressBar(max_value=self.max_value, orientation='v', key='_PROG_', size=self.size, bar_color=self.bar_color)]] + col = [[ProgressBar(max_value=self.max_value, orientation='v', key='_PROG_', size=self.size, + bar_color=self.bar_color)]] col2 = [] - col2 += [[T(''.join(map(lambda x: str(x)+'\n',args)),key='_OPTMSG_')]] ### convert all *args into one string that can be updated - col2 += [[T('', size=(30,10), key='_STATS_')], + col2 += [[T(''.join(map(lambda x: str(x) + '\n', args)), + key='_OPTMSG_')]] ### convert all *args into one string that can be updated + col2 += [[T('', size=(30, 10), key='_STATS_')], [Cancel(button_color=self.button_color), Stretch()]] layout = [Column(col), Column(col2)] self.window = Window(self.title, grab_anywhere=self.grab_anywhere, border_depth=self.border_width) @@ -6257,22 +8162,31 @@ class QuickMeter(object): return self.window - def UpdateMeter(self, current_value, max_value,*args): ### support for *args when updating + def UpdateMeter(self, current_value, max_value, *args): ### support for *args when updating + """ + + :param current_value: + :param max_value: + :param *args: + + """ self.current_value = current_value self.max_value = max_value self.window.Element('_PROG_').UpdateBar(self.current_value, self.max_value) self.window.Element('_STATS_').Update('\n'.join(self.ComputeProgressStats())) - self.window.Element('_OPTMSG_').Update(value=''.join(map(lambda x: str(x)+'\n',args))) ### update the string with the args + self.window.Element('_OPTMSG_').Update( + value=''.join(map(lambda x: str(x) + '\n', args))) ### update the string with the args event, values = self.window.Read(timeout=0) - if event in('Cancel', None) or current_value >= max_value: + if event in ('Cancel', None) or current_value >= max_value: self.window.Close() - del(QuickMeter.active_meters[self.key]) - QuickMeter.exit_reasons[self.key] = METER_REASON_CANCELLED if event == 'Cancel' else METER_REASON_CLOSED if event is None else METER_REASON_REACHED_MAX + del (QuickMeter.active_meters[self.key]) + QuickMeter.exit_reasons[ + self.key] = METER_REASON_CANCELLED if event == 'Cancel' else METER_REASON_CLOSED if event is None else METER_REASON_REACHED_MAX return QuickMeter.exit_reasons[self.key] return METER_OK - def ComputeProgressStats(self): + """ """ utc = datetime.datetime.utcnow() time_delta = utc - self.start_time total_seconds = time_delta.total_seconds() @@ -6303,6 +8217,21 @@ class QuickMeter(object): def OneLineProgressMeter(title, current_value, max_value, key, *args, orientation='v', bar_color=(None, None), button_color=None, size=DEFAULT_PROGRESS_BAR_SIZE, border_width=None, grab_anywhere=False): + """ + + :param title: + :param current_value: + :param max_value: + :param key: (common_key) Used with window.FindElement and with return values + :param *args: + :param orientation: (Default value = 'v') + :param bar_color: (Default value = (None, None)) + :param button_color: (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = DEFAULT_PROGRESS_BAR_SIZE) + :param border_width: (Default value = None) + :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) + + """ if key not in QuickMeter.active_meters: meter = QuickMeter(title, current_value, max_value, key, *args, orientation=orientation, bar_color=bar_color, button_color=button_color, size=size, border_width=border_width, grab_anywhere=grab_anywhere) @@ -6310,25 +8239,34 @@ def OneLineProgressMeter(title, current_value, max_value, key, *args, orientatio else: meter = QuickMeter.active_meters[key] - rc = meter.UpdateMeter(current_value, max_value,*args) ### pass the *args to to UpdateMeter function - OneLineProgressMeter.exit_reasons = getattr(OneLineProgressMeter,'exit_reasons', QuickMeter.exit_reasons) + rc = meter.UpdateMeter(current_value, max_value, *args) ### pass the *args to to UpdateMeter function + OneLineProgressMeter.exit_reasons = getattr(OneLineProgressMeter, 'exit_reasons', QuickMeter.exit_reasons) return rc == METER_OK def OneLineProgressMeterCancel(key): + """ + + :param key: (common_key) Used with window.FindElement and with return values + + """ try: meter = QuickMeter.active_meters[key] meter.window.Close() - del(QuickMeter.active_meters[key]) + del (QuickMeter.active_meters[key]) QuickMeter.exit_reasons[key] = METER_REASON_CANCELLED except: # meter is already deleted return - # input is #RRGGBB # output is #RRGGBB def GetComplimentaryHex(color): + """ + + :param color: + + """ # strip the # from the beginning color = color[1:] # convert the string into hex @@ -6344,10 +8282,23 @@ def GetComplimentaryHex(color): # ======================== EasyPrint =====# # ===================================================# class DebugWin(): + """ """ debug_window = None def __init__(self, size=(None, None), location=(None, None), font=None, no_titlebar=False, no_button=False, grab_anywhere=False, keep_on_top=False, do_not_reroute_stdout=True): + """ + + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param location: (Default value = (None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param no_titlebar: (Default value = False) + :param no_button: (Default value = False) + :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) + :param location: Location on screen to display (Default value = (None, None)) + :param do_not_reroute_stdout: (Default value = True) + + """ # Show a form that's a running counter self.size = size self.location = location @@ -6361,7 +8312,8 @@ class DebugWin(): win_size = size if size != (None, None) else DEFAULT_DEBUG_WINDOW_SIZE self.window = Window('Debug Window', no_titlebar=no_titlebar, auto_size_text=True, location=location, font=font or ('Courier New', 10), grab_anywhere=grab_anywhere, keep_on_top=keep_on_top) - self.output_element = Multiline(size=win_size, autoscroll=True, key='_MULTILINE_') if do_not_reroute_stdout else Output(size=win_size) + self.output_element = Multiline(size=win_size, autoscroll=True, + key='_MULTILINE_') if do_not_reroute_stdout else Output(size=win_size) if no_button: self.layout = [[self.output_element]] @@ -6375,15 +8327,26 @@ class DebugWin(): return def Print(self, *args, end=None, sep=None): + """ + + :param *args: + :param end: (Default value = None) + :param sep: (Default value = None) + + """ sepchar = sep if sep is not None else ' ' endchar = end if end is not None else '\n' if self.window is None: # if window was destroyed alread re-open it - self.__init__(size=self.size, location=self.location, font=self.font, no_titlebar=self.no_titlebar, no_button=self.no_button, grab_anywhere=self.grab_anywhere, keep_on_top=self.keep_on_top, do_not_reroute_stdout=self.do_not_reroute_stdout) + self.__init__(size=self.size, location=self.location, font=self.font, no_titlebar=self.no_titlebar, + no_button=self.no_button, grab_anywhere=self.grab_anywhere, keep_on_top=self.keep_on_top, + do_not_reroute_stdout=self.do_not_reroute_stdout) event, values = self.window.Read(timeout=0) if event == 'Quit' or event is None: self.Close() - self.__init__(size=self.size, location=self.location, font=self.font, no_titlebar=self.no_titlebar, no_button=self.no_button, grab_anywhere=self.grab_anywhere, keep_on_top=self.keep_on_top, do_not_reroute_stdout=self.do_not_reroute_stdout) + self.__init__(size=self.size, location=self.location, font=self.font, no_titlebar=self.no_titlebar, + no_button=self.no_button, grab_anywhere=self.grab_anywhere, keep_on_top=self.keep_on_top, + do_not_reroute_stdout=self.do_not_reroute_stdout) if self.do_not_reroute_stdout: outstring = '' for arg in args: @@ -6393,43 +8356,75 @@ class DebugWin(): else: print(*args, sep=sepchar, end=endchar) - def Close(self): + """ """ self.window.Close() self.window.__del__() self.window = None def PrintClose(): + """ """ EasyPrintClose() def EasyPrint(*args, size=(None, None), end=None, sep=None, location=(None, None), font=None, no_titlebar=False, - no_button=False, grab_anywhere=False, keep_on_top=False, do_not_reroute_stdout=False): + no_button=False, grab_anywhere=False, keep_on_top=False, do_not_reroute_stdout=True): + """ + :param *args: + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param end: (Default value = None) + :param sep: (Default value = None) + :param location: (Default value = (None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param no_titlebar: (Default value = False) + :param no_button: (Default value = False) + :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) + :param location: Location on screen to display (Default value = (None, None)) + :param do_not_reroute_stdout: (Default value = True) + """ if DebugWin.debug_window is None: DebugWin.debug_window = DebugWin(size=size, location=location, font=font, no_titlebar=no_titlebar, - no_button=no_button, grab_anywhere=grab_anywhere, keep_on_top=keep_on_top, do_not_reroute_stdout=do_not_reroute_stdout) + no_button=no_button, grab_anywhere=grab_anywhere, keep_on_top=keep_on_top, + do_not_reroute_stdout=do_not_reroute_stdout) DebugWin.debug_window.Print(*args, end=end, sep=sep) + Print = EasyPrint eprint = EasyPrint def EasyPrintClose(): + """ """ if DebugWin.debug_window is not None: DebugWin.debug_window.Close() DebugWin.debug_window = None + # ======================== Scrolled Text Box =====# # ===================================================# -def PopupScrolled(*args, button_color=None, yes_no=False, auto_close=False, auto_close_duration=None, size=(None, None), location=(None, None), title=None, non_blocking=False): +def PopupScrolled(*args, button_color=None, yes_no=False, auto_close=False, auto_close_duration=None, size=(None, None), + location=(None, None), title=None, non_blocking=False): + """ + + :param *args: + :param button_color: (Default value = None) + :param yes_no: (Default value = False) + :param auto_close: (Default value = False) + :param auto_close_duration: (Default value = None) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param location: (Default value = (None) + :param title: (Default value = None) + :param non_blocking: (Default value = False) + + """ if not args: return width, height = size width = width if width else MESSAGE_BOX_LINE_WIDTH window = Window(title=title or args[0], auto_size_text=True, button_color=button_color, auto_close=auto_close, - auto_close_duration=auto_close_duration, location=location) + auto_close_duration=auto_close_duration, location=location, resizable=True) max_line_total, max_line_width, total_lines, height_computed = 0, 0, 0, 0 complete_output = '' for message in args: @@ -6450,27 +8445,33 @@ def PopupScrolled(*args, button_color=None, yes_no=False, auto_close=False, auto window.AddRow(Multiline(complete_output, size=(max_line_width, height_computed))) pad = max_line_total - 15 if max_line_total > 15 else 1 # show either an OK or Yes/No depending on paramater - button = DummyButton if non_blocking else Button + button = DummyButton if non_blocking else CloseButton if yes_no: window.AddRow(Text('', size=(pad, 1), auto_size_text=False), button('Yes'), button('No')) else: - window.AddRow(Text('', size=(pad, 1), auto_size_text=False), button('OK', size=(5, 1), button_color=button_color)) + window.AddRow(Text('', size=(pad, 1), auto_size_text=False), + button('OK', size=(5, 1), button_color=button_color)) if non_blocking: button, values = window.Read(timeout=0) else: button, values = window.Read() + # window.Close() return button ScrolledTextBox = PopupScrolled - # ============================== SetGlobalIcon ======# # Sets the icon to be used by default # # ===================================================# def SetGlobalIcon(icon): + """ + + :param icon: + + """ # global _my_windows try: @@ -6496,7 +8497,44 @@ def SetOptions(icon=None, button_color=None, element_size=(None, None), button_e text_justification=None, background_color=None, element_background_color=None, text_element_background_color=None, input_elements_background_color=None, input_text_color=None, scrollbar_color=None, text_color=None, element_text_color=None, debug_win_size=(None, None), - window_location=(None, None), error_button_color=(None,None), tooltip_time=None): + window_location=(None, None), error_button_color=(None, None), tooltip_time=None): + """ + + :param icon: (Default value = None) + :param button_color: (Default value = None) + :param element_size: (Default value = (None, None)) + :param button_element_size: (Default value = (None) + :param margins: (Default value = (None) + :param element_padding: (Default value = (None) + :param auto_size_text: True if size should fit the text length (Default value = None) + :param auto_size_buttons: (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param border_width: (Default value = None) + :param slider_border_width: (Default value = None) + :param slider_relief: (Default value = None) + :param slider_orientation: (Default value = None) + :param autoclose_time: (Default value = None) + :param message_box_line_width: (Default value = None) + :param progress_meter_border_depth: (Default value = None) + :param progress_meter_style: (Default value = None) + :param progress_meter_relief: (Default value = None) + :param progress_meter_color: (Default value = None) + :param progress_meter_size: (Default value = None) + :param text_justification: (Default value = None) + :param background_color: color of background (Default value = None) + :param element_background_color: (Default value = None) + :param text_element_background_color: (Default value = None) + :param input_elements_background_color: (Default value = None) + :param input_text_color: (Default value = None) + :param scrollbar_color: (Default value = None) + :param text_color: color of the text (Default value = None) + :param element_text_color: (Default value = None) + :param debug_win_size: (Default value = (None) + :param window_location: (Default value = (None) + :param error_button_color: (Default value = (None) + :param tooltip_time: (Default value = None) + + """ global DEFAULT_ELEMENT_SIZE global DEFAULT_BUTTON_ELEMENT_SIZE global DEFAULT_MARGINS # Margins for each LEFT/RIGHT margin is first term @@ -6628,7 +8666,7 @@ def SetOptions(icon=None, button_color=None, element_size=(None, None), button_e if tooltip_time is not None: DEFAULT_TOOLTIP_TIME = tooltip_time - if error_button_color != (None,None): + if error_button_color != (None, None): DEFAULT_ERROR_BUTTON_COLOR = error_button_color return True @@ -6918,10 +8956,16 @@ LOOK_AND_FEEL_TABLE = {'SystemDefault': def ListOfLookAndFeelValues(): + """ """ return list(LOOK_AND_FEEL_TABLE.keys()) def ChangeLookAndFeel(index): + """ + + :param index: + + """ # global LOOK_AND_FEEL_TABLE if sys.platform == 'darwin': @@ -6960,6 +9004,11 @@ sprint = ScrolledTextBox # Converts an object's contents into a nice printable string. Great for dumping debug data def ObjToStringSingleObj(obj): + """ + + :param obj: + + """ if obj is None: return 'None' return str(obj.__class__) + '\n' + '\n'.join( @@ -6967,6 +9016,12 @@ def ObjToStringSingleObj(obj): def ObjToString(obj, extra=' '): + """ + + :param obj: + :param extra: (Default value = ' ') + + """ if obj is None: return 'None' return str(obj.__class__) + '\n' + '\n'.join( @@ -6991,26 +9046,30 @@ def ObjToString(obj, extra=' '): # ----------------------------------- The mighty Popup! ------------------------------------------------------------ # def Popup(*args, title=None, button_color=None, background_color=None, text_color=None, button_type=POPUP_BUTTONS_OK, - auto_close=False, auto_close_duration=None, custom_text=(None, None), non_blocking=False, icon=DEFAULT_WINDOW_ICON, line_width=None, + auto_close=False, auto_close_duration=None, custom_text=(None, None), non_blocking=False, + icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """ - Popup - Display a popup box with as many parms as you wish to include - :param args: - :param button_color: - :param background_color: - :param text_color: - :param button_type: - :param auto_close: - :param auto_close_duration: - :param non_blocking: - :param icon: - :param line_width: - :param font: - :param no_titlebar: - :param grab_anywhere: - :param keep_on_top: - :param location: + """Popup - Display a popup box with as many parms as you wish to include :return: + + :param *args: + :param title: (Default value = None) + :param button_color: (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param button_type: (Default value = POPUP_BUTTONS_OK) + :param auto_close: (Default value = False) + :param auto_close_duration: (Default value = None) + :param custom_text: (Default value = (None, None)) + :param non_blocking: (Default value = False) + :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) + :param line_width: Width of lines in characters (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param no_titlebar: (Default value = False) + :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) + :param location: Location on screen to display (Default value = (None, None)) + :param location: (Default value = (None) + """ if not args: args_to_print = [''] @@ -7020,7 +9079,7 @@ def Popup(*args, title=None, button_color=None, background_color=None, text_colo local_line_width = line_width else: local_line_width = MESSAGE_BOX_LINE_WIDTH - _title = title if title is not None else args_to_print[0] + _title = title if title is not None else args_to_print[0] window = Window(_title, auto_size_text=True, background_color=background_color, button_color=button_color, auto_close=auto_close, auto_close_duration=auto_close_duration, icon=icon, font=font, no_titlebar=no_titlebar, grab_anywhere=grab_anywhere, keep_on_top=keep_on_top, location=location) @@ -7050,11 +9109,15 @@ def Popup(*args, title=None, button_color=None, background_color=None, text_colo # show either an OK or Yes/No depending on paramater if custom_text != (None, None): if type(custom_text) is not tuple: - window.AddRow(PopupButton(custom_text,size=(len(custom_text),1), button_color=button_color, focus=True, bind_return_key=True)) + window.AddRow(PopupButton(custom_text, size=(len(custom_text), 1), button_color=button_color, focus=True, + bind_return_key=True)) elif custom_text[1] is None: - window.AddRow(PopupButton(custom_text[0],size=(len(custom_text[0]),1), button_color=button_color, focus=True, bind_return_key=True)) + window.AddRow( + PopupButton(custom_text[0], size=(len(custom_text[0]), 1), button_color=button_color, focus=True, + bind_return_key=True)) else: - window.AddRow(PopupButton(custom_text[0], button_color=button_color, focus=True, bind_return_key=True, size=(len(custom_text[0]), 1)), + window.AddRow(PopupButton(custom_text[0], button_color=button_color, focus=True, bind_return_key=True, + size=(len(custom_text[0]), 1)), PopupButton(custom_text[1], button_color=button_color, size=(len(custom_text[0]), 1))) elif button_type is POPUP_BUTTONS_YES_NO: window.AddRow(PopupButton('Yes', button_color=button_color, focus=True, bind_return_key=True, pad=((20, 5), 3), @@ -7088,6 +9151,11 @@ def Popup(*args, title=None, button_color=None, background_color=None, text_colo # ==================================================# # MsgBox is the legacy call and should not be used any longer def MsgBox(*args): + """ + + :param *args: + + """ raise DeprecationWarning('MsgBox is no longer supported... change your call to Popup') @@ -7095,23 +9163,25 @@ def MsgBox(*args): def PopupNoButtons(*args, title=None, button_color=None, background_color=None, text_color=None, auto_close=False, auto_close_duration=None, non_blocking=False, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """ - Show a Popup but without any buttons - :param args: - :param button_color: - :param background_color: - :param text_color: - :param auto_close: - :param auto_close_duration: - :param non_blocking: - :param icon: - :param line_width: - :param font: - :param no_titlebar: - :param grab_anywhere: - :param keep_on_top: - :param location: + """Show a Popup but without any buttons :return: + + :param *args: + :param title: (Default value = None) + :param button_color: (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param auto_close: (Default value = False) + :param auto_close_duration: (Default value = None) + :param non_blocking: (Default value = False) + :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) + :param line_width: Width of lines in characters (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param no_titlebar: (Default value = False) + :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) + :param location: Location on screen to display (Default value = (None, None)) + :param location: (Default value = (None, None)) + """ Popup(*args, title=title, button_color=button_color, background_color=background_color, text_color=text_color, button_type=POPUP_BUTTONS_NO_BUTTONS, @@ -7121,28 +9191,31 @@ def PopupNoButtons(*args, title=None, button_color=None, background_color=None, # --------------------------- PopupNonBlocking --------------------------- -def PopupNonBlocking(*args, title=None, button_type=POPUP_BUTTONS_OK, button_color=None, background_color=None, text_color=None, +def PopupNonBlocking(*args, title=None, button_type=POPUP_BUTTONS_OK, button_color=None, background_color=None, + text_color=None, auto_close=False, auto_close_duration=None, non_blocking=True, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """ - Show Popup box and immediately return (does not block) - :param args: - :param button_type: - :param button_color: - :param background_color: - :param text_color: - :param auto_close: - :param auto_close_duration: - :param non_blocking: - :param icon: - :param line_width: - :param font: - :param no_titlebar: - :param grab_anywhere: - :param keep_on_top: - :param location: + """Show Popup box and immediately return (does not block) :return: + + :param *args: + :param title: (Default value = None) + :param button_type: (Default value = POPUP_BUTTONS_OK) + :param button_color: (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param auto_close: (Default value = False) + :param auto_close_duration: (Default value = None) + :param non_blocking: (Default value = True) + :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) + :param line_width: Width of lines in characters (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param no_titlebar: (Default value = False) + :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) + :param location: Location on screen to display (Default value = (None, None)) + :param location: (Default value = (None, None)) + """ Popup(*args, title=title, button_color=button_color, background_color=background_color, text_color=text_color, button_type=button_type, @@ -7155,27 +9228,30 @@ PopupNoWait = PopupNonBlocking # --------------------------- PopupQuick - a NonBlocking, Self-closing Popup --------------------------- -def PopupQuick(*args,title=None, button_type=POPUP_BUTTONS_OK, button_color=None, background_color=None, text_color=None, +def PopupQuick(*args, title=None, button_type=POPUP_BUTTONS_OK, button_color=None, background_color=None, + text_color=None, auto_close=True, auto_close_duration=2, non_blocking=True, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """ - Show Popup box that doesn't block and closes itself - :param args: - :param button_type: - :param button_color: - :param background_color: - :param text_color: - :param auto_close: - :param auto_close_duration: - :param non_blocking: - :param icon: - :param line_width: - :param font: - :param no_titlebar: - :param grab_anywhere: - :param keep_on_top: - :param location: + """Show Popup box that doesn't block and closes itself :return: + + :param *args: + :param title: (Default value = None) + :param button_type: (Default value = POPUP_BUTTONS_OK) + :param button_color: (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param auto_close: (Default value = True) + :param auto_close_duration: (Default value = 2) + :param non_blocking: (Default value = True) + :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) + :param line_width: Width of lines in characters (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param no_titlebar: (Default value = False) + :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) + :param location: Location on screen to display (Default value = (None, None)) + :param location: (Default value = (None, None)) + """ Popup(*args, title=title, button_color=button_color, background_color=background_color, text_color=text_color, button_type=button_type, @@ -7185,27 +9261,31 @@ def PopupQuick(*args,title=None, button_type=POPUP_BUTTONS_OK, button_color=None # --------------------------- PopupQuick - a NonBlocking, Self-closing Popup with no titlebar and no buttons --------------------------- -def PopupQuickMessage(*args, title=None, button_type=POPUP_BUTTONS_NO_BUTTONS, button_color=None, background_color=None, text_color=None, - auto_close=True, auto_close_duration=2, non_blocking=True, icon=DEFAULT_WINDOW_ICON, line_width=None, - font=None, no_titlebar=True, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """ - Show Popup box that doesn't block and closes itself - :param args: - :param button_type: - :param button_color: - :param background_color: - :param text_color: - :param auto_close: - :param auto_close_duration: - :param non_blocking: - :param icon: - :param line_width: - :param font: - :param no_titlebar: - :param grab_anywhere: - :param keep_on_top: - :param location: +def PopupQuickMessage(*args, title=None, button_type=POPUP_BUTTONS_NO_BUTTONS, button_color=None, background_color=None, + text_color=None, + auto_close=True, auto_close_duration=2, non_blocking=True, icon=DEFAULT_WINDOW_ICON, + line_width=None, + font=None, no_titlebar=True, grab_anywhere=False, keep_on_top=False, location=(None, None)): + """Show Popup box that doesn't block and closes itself :return: + + :param *args: + :param title: (Default value = None) + :param button_type: (Default value = POPUP_BUTTONS_NO_BUTTONS) + :param button_color: (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param auto_close: (Default value = True) + :param auto_close_duration: (Default value = 2) + :param non_blocking: (Default value = True) + :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) + :param line_width: Width of lines in characters (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param no_titlebar: (Default value = True) + :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) + :param location: Location on screen to display (Default value = (None, None)) + :param location: (Default value = (None, None)) + """ Popup(*args, title=title, button_color=button_color, background_color=background_color, text_color=text_color, button_type=button_type, @@ -7215,26 +9295,29 @@ def PopupQuickMessage(*args, title=None, button_type=POPUP_BUTTONS_NO_BUTTONS, b # --------------------------- PopupNoTitlebar --------------------------- -def PopupNoTitlebar(*args, title=None, button_type=POPUP_BUTTONS_OK, button_color=None, background_color=None, text_color=None, +def PopupNoTitlebar(*args, title=None, button_type=POPUP_BUTTONS_OK, button_color=None, background_color=None, + text_color=None, auto_close=False, auto_close_duration=None, non_blocking=False, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, grab_anywhere=True, keep_on_top=False, location=(None, None)): - """ - Display a Popup without a titlebar. Enables grab anywhere so you can move it - :param args: - :param button_type: - :param button_color: - :param background_color: - :param text_color: - :param auto_close: - :param auto_close_duration: - :param non_blocking: - :param icon: - :param line_width: - :param font: - :param grab_anywhere: - :param keep_on_top: - :param location: + """Display a Popup without a titlebar. Enables grab anywhere so you can move it :return: + + :param *args: + :param title: (Default value = None) + :param button_type: (Default value = POPUP_BUTTONS_OK) + :param button_color: (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param auto_close: (Default value = False) + :param auto_close_duration: (Default value = None) + :param non_blocking: (Default value = False) + :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) + :param line_width: Width of lines in characters (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param grab_anywhere: (Default value = True) + :param location: Location on screen to display (Default value = (None, None)) + :param location: (Default value = (None, None)) + """ Popup(*args, title=title, button_color=button_color, background_color=background_color, text_color=text_color, button_type=button_type, @@ -7249,28 +9332,31 @@ PopupAnnoying = PopupNoTitlebar # --------------------------- PopupAutoClose --------------------------- -def PopupAutoClose(*args, title=None, button_type=POPUP_BUTTONS_OK, button_color=None, background_color=None, text_color=None, +def PopupAutoClose(*args, title=None, button_type=POPUP_BUTTONS_OK, button_color=None, background_color=None, + text_color=None, auto_close=True, auto_close_duration=None, non_blocking=False, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """ - Popup that closes itself after some time period - :param args: - :param button_type: - :param button_color: - :param background_color: - :param text_color: - :param auto_close: - :param auto_close_duration: - :param non_blocking: - :param icon: - :param line_width: - :param font: - :param no_titlebar: - :param grab_anywhere: - :param keep_on_top: - :param location: + """Popup that closes itself after some time period :return: + + :param *args: + :param title: (Default value = None) + :param button_type: (Default value = POPUP_BUTTONS_OK) + :param button_color: (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param auto_close: (Default value = True) + :param auto_close_duration: (Default value = None) + :param non_blocking: (Default value = False) + :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) + :param line_width: Width of lines in characters (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param no_titlebar: (Default value = False) + :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) + :param location: Location on screen to display (Default value = (None, None)) + :param location: (Default value = (None, None)) + """ Popup(*args, title=title, button_color=button_color, background_color=background_color, text_color=text_color, button_type=button_type, @@ -7286,54 +9372,60 @@ PopupTimed = PopupAutoClose def PopupError(*args, title=None, button_color=(None, None), background_color=None, text_color=None, auto_close=False, auto_close_duration=None, non_blocking=False, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """ - Popup with colored button and 'Error' as button text - :param args: - :param button_color: - :param background_color: - :param text_color: - :param auto_close: - :param auto_close_duration: - :param non_blocking: - :param icon: - :param line_width: - :param font: - :param no_titlebar: - :param grab_anywhere: - :param keep_on_top: - :param location: + """Popup with colored button and 'Error' as button text :return: + + :param *args: + :param title: (Default value = None) + :param button_color: (Default value = (None, None)) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param auto_close: (Default value = False) + :param auto_close_duration: (Default value = None) + :param non_blocking: (Default value = False) + :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) + :param line_width: Width of lines in characters (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param no_titlebar: (Default value = False) + :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) + :param location: Location on screen to display (Default value = (None, None)) + :param location: (Default value = (None) + """ tbutton_color = DEFAULT_ERROR_BUTTON_COLOR if button_color == (None, None) else button_color Popup(*args, title=title, button_type=POPUP_BUTTONS_ERROR, background_color=background_color, text_color=text_color, - non_blocking=non_blocking, icon=icon, line_width=line_width, button_color=tbutton_color, auto_close=auto_close, + non_blocking=non_blocking, icon=icon, line_width=line_width, button_color=tbutton_color, + auto_close=auto_close, auto_close_duration=auto_close_duration, font=font, no_titlebar=no_titlebar, grab_anywhere=grab_anywhere, keep_on_top=keep_on_top, location=location) # --------------------------- PopupCancel --------------------------- -def PopupCancel(*args,title=None, button_color=None, background_color=None, text_color=None, auto_close=False, +def PopupCancel(*args, title=None, button_color=None, background_color=None, text_color=None, auto_close=False, auto_close_duration=None, non_blocking=False, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """ - Display Popup with "cancelled" button text - :param args: - :param button_color: - :param background_color: - :param text_color: - :param auto_close: - :param auto_close_duration: - :param non_blocking: - :param icon: - :param line_width: - :param font: - :param no_titlebar: - :param grab_anywhere: - :param keep_on_top: - :param location: + """Display Popup with "cancelled" button text :return: + + :param *args: + :param title: (Default value = None) + :param button_color: (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param auto_close: (Default value = False) + :param auto_close_duration: (Default value = None) + :param non_blocking: (Default value = False) + :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) + :param line_width: Width of lines in characters (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param no_titlebar: (Default value = False) + :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) + :param location: Location on screen to display (Default value = (None, None)) + :param location: (Default value = (None, None)) + """ - Popup(*args, title=title, button_type=POPUP_BUTTONS_CANCELLED, background_color=background_color, text_color=text_color, + Popup(*args, title=title, button_type=POPUP_BUTTONS_CANCELLED, background_color=background_color, + text_color=text_color, non_blocking=non_blocking, icon=icon, line_width=line_width, button_color=button_color, auto_close=auto_close, auto_close_duration=auto_close_duration, font=font, no_titlebar=no_titlebar, grab_anywhere=grab_anywhere, keep_on_top=keep_on_top, location=location) @@ -7343,23 +9435,25 @@ def PopupCancel(*args,title=None, button_color=None, background_color=None, text def PopupOK(*args, title=None, button_color=None, background_color=None, text_color=None, auto_close=False, auto_close_duration=None, non_blocking=False, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """ - Display Popup with OK button only - :param args: - :param button_color: - :param background_color: - :param text_color: - :param auto_close: - :param auto_close_duration: - :param non_blocking: - :param icon: - :param line_width: - :param font: - :param no_titlebar: - :param grab_anywhere: - :param keep_on_top: - :param location: + """Display Popup with OK button only :return: + + :param *args: + :param title: (Default value = None) + :param button_color: (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param auto_close: (Default value = False) + :param auto_close_duration: (Default value = None) + :param non_blocking: (Default value = False) + :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) + :param line_width: Width of lines in characters (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param no_titlebar: (Default value = False) + :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) + :param location: Location on screen to display (Default value = (None, None)) + :param location: (Default value = (None, None)) + """ Popup(*args, title=title, button_type=POPUP_BUTTONS_OK, background_color=background_color, text_color=text_color, non_blocking=non_blocking, icon=icon, line_width=line_width, button_color=button_color, auto_close=auto_close, @@ -7368,28 +9462,31 @@ def PopupOK(*args, title=None, button_color=None, background_color=None, text_co # --------------------------- PopupOKCancel --------------------------- -def PopupOKCancel(*args, title=None, button_color=None, background_color=None, text_color=None, auto_close=False, +def PopupOKCancel(*args, title=None, button_color=None, background_color=None, text_color=None, auto_close=False, auto_close_duration=None, non_blocking=False, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """ - Display popup with OK and Cancel buttons - :param args: - :param button_color: - :param background_color: - :param text_color: - :param auto_close: - :param auto_close_duration: - :param non_blocking: - :param icon: - :param line_width: - :param font: - :param no_titlebar: - :param grab_anywhere: - :param keep_on_top: - :param location: + """Display popup with OK and Cancel buttons :return: OK, Cancel or None + + :param *args: + :param title: (Default value = None) + :param button_color: (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param auto_close: (Default value = False) + :param auto_close_duration: (Default value = None) + :param non_blocking: (Default value = False) + :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) + :param line_width: Width of lines in characters (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param no_titlebar: (Default value = False) + :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) + :param location: Location on screen to display (Default value = (None, None)) + :param location: (Default value = (None, None)) + """ - return Popup(*args, title=title, button_type=POPUP_BUTTONS_OK_CANCEL, background_color=background_color, text_color=text_color, + return Popup(*args, title=title, button_type=POPUP_BUTTONS_OK_CANCEL, background_color=background_color, + text_color=text_color, non_blocking=non_blocking, icon=icon, line_width=line_width, button_color=button_color, auto_close=auto_close, auto_close_duration=auto_close_duration, font=font, no_titlebar=no_titlebar, grab_anywhere=grab_anywhere, keep_on_top=keep_on_top, location=location) @@ -7399,25 +9496,28 @@ def PopupOKCancel(*args, title=None, button_color=None, background_color=None, def PopupYesNo(*args, title=None, button_color=None, background_color=None, text_color=None, auto_close=False, auto_close_duration=None, non_blocking=False, icon=DEFAULT_WINDOW_ICON, line_width=None, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """ - Display Popup with Yes and No buttons - :param args: - :param button_color: - :param background_color: - :param text_color: - :param auto_close: - :param auto_close_duration: - :param non_blocking: - :param icon: - :param line_width: - :param font: - :param no_titlebar: - :param grab_anywhere: - :param keep_on_top: - :param location: + """Display Popup with Yes and No buttons :return: Yes, No or None + + :param *args: + :param title: (Default value = None) + :param button_color: (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param auto_close: (Default value = False) + :param auto_close_duration: (Default value = None) + :param non_blocking: (Default value = False) + :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) + :param line_width: Width of lines in characters (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param no_titlebar: (Default value = False) + :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) + :param location: Location on screen to display (Default value = (None, None)) + :param location: (Default value = (None, None)) + """ - return Popup(*args, title=title, button_type=POPUP_BUTTONS_YES_NO, background_color=background_color, text_color=text_color, + return Popup(*args, title=title, button_type=POPUP_BUTTONS_YES_NO, background_color=background_color, + text_color=text_color, non_blocking=non_blocking, icon=icon, line_width=line_width, button_color=button_color, auto_close=auto_close, auto_close_duration=auto_close_duration, font=font, no_titlebar=no_titlebar, grab_anywhere=grab_anywhere, keep_on_top=keep_on_top, location=location) @@ -7433,121 +9533,165 @@ def PopupYesNo(*args, title=None, button_color=None, background_color=None, text def PopupGetFolder(message, title=None, default_path='', no_window=False, size=(None, None), button_color=None, background_color=None, text_color=None, icon=DEFAULT_WINDOW_ICON, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None), initial_folder=None): - """ - Display popup with text entry field and browse button. Browse for folder - :param message: - :param default_path: - :param no_window: - :param size: - :param button_color: - :param background_color: - :param text_color: - :param icon: - :param font: - :param no_titlebar: - :param grab_anywhere: - :param keep_on_top: - :param location: + """Display popup with text entry field and browse button. Browse for folder :return: Contents of text field. None if closed using X or cancelled + + :param message: + :param title: (Default value = None) + :param default_path: (Default value = '') + :param no_window: (Default value = False) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param button_color: (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param no_titlebar: (Default value = False) + :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) + :param location: Location on screen to display (Default value = (None, None)) + :param location: (Default value = (None) + :param initial_folder: (Default value = None) + """ # global _my_windows - if no_window: - # if _my_windows.NumOpenWindows: - if Window.NumOpenWindows: - root = tk.Toplevel() - else: - root = tk.Tk() + if not Window.hidden_master_root: + # if first window being created, make a throwaway, hidden master root. This stops one user + # window from becoming the child of another user window. All windows are children of this + # hidden window + Window.IncrementOpenCount() + Window.hidden_master_root = tk.Tk() + Window.hidden_master_root.attributes('-alpha', 0) # HIDE this window really really really + Window.hidden_master_root.wm_overrideredirect(True) + Window.hidden_master_root.withdraw() + root = tk.Toplevel() + try: root.attributes('-alpha', 0) # hide window while building it. makes for smoother 'paint' + root.wm_overrideredirect(True) + root.withdraw() except: pass folder_name = tk.filedialog.askdirectory() # show the 'get folder' dialog box + root.destroy() + if Window.NumOpenWindows == 1: + Window.NumOpenWindows = 0 + Window.hidden_master_root.destroy() + Window.hidden_master_root = None + return folder_name layout = [[Text(message, auto_size_text=True, text_color=text_color, background_color=background_color)], - [InputText(default_text=default_path, size=size), FolderBrowse(initial_folder=initial_folder)], + [InputText(default_text=default_path, size=size, key='_INPUT_'), + FolderBrowse(initial_folder=initial_folder)], [CloseButton('Ok', size=(5, 1), bind_return_key=True), CloseButton('Cancel', size=(5, 1))]] - window = Window(title=title or message, icon=icon, auto_size_text=True, button_color=button_color, + window = Window(title=title or message, layout=layout, icon=icon, auto_size_text=True, button_color=button_color, background_color=background_color, font=font, no_titlebar=no_titlebar, grab_anywhere=grab_anywhere, keep_on_top=keep_on_top, location=location) - (button, input_values) = window.Layout(layout).Read() - + button, values = window.Read() + window.Close() if button != 'Ok': return None else: - path = input_values[0] - return path + return values['_INPUT_'] # --------------------------- PopupGetFile --------------------------- -def PopupGetFile(message, title=None, default_path='', default_extension='', save_as=False, file_types=(("ALL Files", "*.*"),), +def PopupGetFile(message, title=None, default_path='', default_extension='', save_as=False, multiple_files=False, + file_types=(("ALL Files", "*.*"),), no_window=False, size=(None, None), button_color=None, background_color=None, text_color=None, icon=DEFAULT_WINDOW_ICON, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, - location=(None, None), initial_folder=None): - """ - Display popup with text entry field and browse button. Browse for file - :param message: - :param default_path: - :param default_extension: - :param save_as: - :param file_types: - :param no_window: - :param size: - :param button_color: - :param background_color: - :param text_color: - :param icon: - :param font: - :param no_titlebar: - :param grab_anywhere: - :param keep_on_top: - :param location: + location=(None, None), initial_folder=None): + """Display popup with text entry field and browse button. Browse for file :return: string representing the path chosen, None if cancelled or window closed with X - """ - # global _my_windows + :param message: + :param title: (Default value = None) + :param default_path: (Default value = '') + :param default_extension: (Default value = '') + :param save_as: (Default value = False) + :param multiple_files: (Default value = False) + :param file_types: (Default value = (("ALL Files", "*.*"))) + :param no_window: (Default value = False) + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param button_color: (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param no_titlebar: (Default value = False) + :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) + :param location: Location on screen to display (Default value = (None, None)) + :param location: (Default value = (None) + :param initial_folder: (Default value = None) + + """ if no_window: - # if _my_windows.NumOpenWindows: - if Window.NumOpenWindows: - root = tk.Toplevel() - else: - root = tk.Tk() + if not Window.hidden_master_root: + # if first window being created, make a throwaway, hidden master root. This stops one user + # window from becoming the child of another user window. All windows are children of this + # hidden window + Window.IncrementOpenCount() + Window.hidden_master_root = tk.Tk() + Window.hidden_master_root.attributes('-alpha', 0) # HIDE this window really really really + Window.hidden_master_root.wm_overrideredirect(True) + Window.hidden_master_root.withdraw() + root = tk.Toplevel() + try: root.attributes('-alpha', 0) # hide window while building it. makes for smoother 'paint' + root.wm_overrideredirect(True) + root.withdraw() except: pass if save_as: filename = tk.filedialog.asksaveasfilename(filetypes=file_types, defaultextension=default_extension) # show the 'get file' dialog box + elif multiple_files: + filename = tk.filedialog.askopenfilenames(filetypes=file_types, + defaultextension=default_extension) # show the 'get file' dialog box else: filename = tk.filedialog.askopenfilename(filetypes=file_types, - defaultextension=default_extension) # show the 'get file' dialog box + defaultextension=default_extension) # show the 'get files' dialog box + root.destroy() + if Window.NumOpenWindows == 1: + Window.NumOpenWindows = 0 + Window.hidden_master_root.destroy() + Window.hidden_master_root = None + if not multiple_files and type(filename) in (tuple, list): + filename = filename[0] return filename - browse_button = SaveAs(file_types=file_types, initial_folder=initial_folder) if save_as else FileBrowse(file_types=file_types, initial_folder=initial_folder) + if save_as: + browse_button = SaveAs(file_types=file_types, initial_folder=initial_folder) + elif multiple_files: + browse_button = FilesBrowse(file_types=file_types, initial_folder=initial_folder) + else: + browse_button = FileBrowse(file_types=file_types, initial_folder=initial_folder) layout = [[Text(message, auto_size_text=True, text_color=text_color, background_color=background_color)], - [InputText(default_text=default_path, size=size), browse_button], + [InputText(default_text=default_path, size=size, key='_INPUT_'), browse_button], [CloseButton('Ok', size=(6, 1), bind_return_key=True), CloseButton('Cancel', size=(6, 1))]] - window = Window(title=title or message, icon=icon, auto_size_text=True, button_color=button_color, font=font, + window = Window(title=title or message, layout=layout, icon=icon, auto_size_text=True, button_color=button_color, + font=font, background_color=background_color, no_titlebar=no_titlebar, grab_anywhere=grab_anywhere, keep_on_top=keep_on_top, location=location) - (button, input_values) = window.Layout(layout).Read() + button, values = window.Read() + window.Close() if button != 'Ok': return None else: - path = input_values[0] + path = values['_INPUT_'] return path @@ -7556,43 +9700,65 @@ def PopupGetFile(message, title=None, default_path='', default_extension='', sav def PopupGetText(message, title=None, default_text='', password_char='', size=(None, None), button_color=None, background_color=None, text_color=None, icon=DEFAULT_WINDOW_ICON, font=None, no_titlebar=False, grab_anywhere=False, keep_on_top=False, location=(None, None)): - """ - Display Popup with text entry field - :param message: - :param default_text: - :param password_char: - :param size: - :param button_color: - :param background_color: - :param text_color: - :param icon: - :param font: - :param no_titlebar: - :param grab_anywhere: - :param keep_on_top: - :param location: + """Display Popup with text entry field :return: Text entered or None if window was closed + + :param message: + :param title: (Default value = None) + :param default_text: (Default value = '') + :param password_char: Passwork character if this is a password field (Default value = '') + :param size: (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) + :param button_color: (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param no_titlebar: (Default value = False) + :param grab_anywhere: If True can grab anywhere to move the window (Default value = False) + :param location: Location on screen to display (Default value = (None, None)) + :param location: (Default value = (None) + """ layout = [[Text(message, auto_size_text=True, text_color=text_color, background_color=background_color, font=font)], - [InputText(default_text=default_text, size=size, password_char=password_char)], + [InputText(default_text=default_text, size=size, key='_INPUT_', password_char=password_char)], [CloseButton('Ok', size=(5, 1), bind_return_key=True), CloseButton('Cancel', size=(5, 1))]] - window = Window(title=title or message, icon=icon, auto_size_text=True, button_color=button_color, no_titlebar=no_titlebar, + window = Window(title=title or message, layout=layout, icon=icon, auto_size_text=True, button_color=button_color, + no_titlebar=no_titlebar, background_color=background_color, grab_anywhere=grab_anywhere, keep_on_top=keep_on_top, location=location) - (button, input_values) = window.Layout(layout).Read() - + button, values = window.Read() + window.Close() if button != 'Ok': return None else: - return input_values[0] + path = values['_INPUT_'] + return path + # --------------------------- PopupAnimated --------------------------- -def PopupAnimated(image_source, message=None, background_color=None, text_color=None, font=None, no_titlebar=True, grab_anywhere=True, keep_on_top=True, location=(None, None), alpha_channel=.8, time_between_frames=0): +def PopupAnimated(image_source, message=None, background_color=None, text_color=None, font=None, no_titlebar=True, + grab_anywhere=True, keep_on_top=True, location=(None, None), alpha_channel=None, + time_between_frames=0, transparent_color=None): + """ + :param image_source: + :param message: (Default value = None) + :param background_color: color of background (Default value = None) + :param text_color: color of the text (Default value = None) + :param font: (common_key) specifies the font family, size, etc (Default value = None) + :param no_titlebar: (Default value = True) + :param grab_anywhere: (Default value = True) + :param keep_on_top: (Default value = True) + :param location: (Default value = (None, None)) + :param alpha_channel: (Default value = None) + :param time_between_frames: (Default value = 0) + :param transparent_color: (Default value = None) + + """ if image_source is None: for image in Window.animated_popup_dict: window = Window.animated_popup_dict[image] @@ -7601,41 +9767,620 @@ def PopupAnimated(image_source, message=None, background_color=None, text_color= return if image_source not in Window.animated_popup_dict: - if type(image_source) is bytes: - layout = [[Image(data=image_source, background_color=background_color, key='_IMAGE_',)],] + if type(image_source) is bytes or len(image_source) > 300: + layout = [[Image(data=image_source, background_color=background_color, key='_IMAGE_', )], ] else: - layout = [[Image(filename=image_source, background_color=background_color, key='_IMAGE_',)],] + layout = [[Image(filename=image_source, background_color=background_color, key='_IMAGE_', )], ] if message: layout.append([Text(message, background_color=background_color, text_color=text_color, font=font)]) - window = Window('Animated GIF', no_titlebar=no_titlebar, grab_anywhere=grab_anywhere, keep_on_top=keep_on_top, - background_color=background_color, location=location, alpha_channel=alpha_channel, element_padding=(0,0), margins=(0,0)).Layout(layout).Finalize() + window = Window('Animated GIF', layout, no_titlebar=no_titlebar, grab_anywhere=grab_anywhere, + keep_on_top=keep_on_top, background_color=background_color, location=location, + alpha_channel=alpha_channel, element_padding=(0, 0), margins=(0, 0), + transparent_color=transparent_color).Finalize() Window.animated_popup_dict[image_source] = window else: window = Window.animated_popup_dict[image_source] window.Element('_IMAGE_').UpdateAnimation(image_source, time_between_frames=time_between_frames) - window.Refresh() # call refresh instead of Read to save significant CPU time + window.Refresh() # call refresh instead of Read to save significant CPU time + + +##################################################################################################### +# Debugger +##################################################################################################### + + +PSGDebugLogo = b'R0lGODlhMgAtAPcAAAAAADD/2akK/4yz0pSxyZWyy5u3zZ24zpW30pG52J250J+60aC60KS90aDC3a3E163F2K3F2bPI2bvO3rzP3qvJ4LHN4rnR5P/zuf/zuv/0vP/0vsDS38XZ6cnb6f/xw//zwv/yxf/1w//zyP/1yf/2zP/3z//30wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH5BAEAAP8ALAAAAAAyAC0AAAj/AP8JHEiwoMGDCBMqXMiwoUOFAiJGXBigYoAPDxlK3CigwUGLIAOEyIiQI8cCBUOqJFnQpEkGA1XKZPlPgkuXBATK3JmRws2bB3TuXNmQw8+jQoeCbHj0qIGkSgNobNoUqlKIVJs++BfV4oiEWalaHVpyosCwJidw7Sr1YMQFBDn+y4qSbUW3AiDElXiWqoK1bPEKGLixr1jAXQ9GuGn4sN22Bl02roo4Kla+c8OOJbsQM9rNPJlORlr5asbPpTk/RP2YJGu7rjWnDm2RIQLZrSt3zgp6ZmqwmkHAng3ccWDEMe8Kpnw8JEHlkXnPdh6SxHPILaU/dp60LFUP07dfRq5aYntohAO0m+c+nvT6pVMPZ3jv8AJu8xktyNbw+ATJDtKFBx9NlA20gWU0DVQBYwZhsJMICRrkwEYJJGRCSBtEqGGCAQEAOw==' + +red_x = b"R0lGODlhEAAQAPeQAIsAAI0AAI4AAI8AAJIAAJUAAJQCApkAAJoAAJ4AAJkJCaAAAKYAAKcAAKcCAKcDA6cGAKgAAKsAAKsCAKwAAK0AAK8AAK4CAK8DAqUJAKULAKwLALAAALEAALIAALMAALMDALQAALUAALYAALcEALoAALsAALsCALwAAL8AALkJAL4NAL8NAKoTAKwbAbEQALMVAL0QAL0RAKsREaodHbkQELMsALg2ALk3ALs+ALE2FbgpKbA1Nbc1Nb44N8AAAMIWAMsvAMUgDMcxAKVABb9NBbVJErFYEq1iMrtoMr5kP8BKAMFLAMxKANBBANFCANJFANFEB9JKAMFcANFZANZcANpfAMJUEMZVEc5hAM5pAMluBdRsANR8AM9YOrdERMpIQs1UVMR5WNt8X8VgYMdlZcxtYtx4YNF/btp9eraNf9qXXNCCZsyLeNSLd8SSecySf82kd9qqc9uBgdyBgd+EhN6JgtSIiNuJieGHhOGLg+GKhOKamty1ste4sNO+ueenp+inp+HHrebGrefKuOPTzejWzera1O7b1vLb2/bl4vTu7fbw7ffx7vnz8f///wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH5BAEAAJAALAAAAAAQABAAAAjUACEJHEiwYEEABniQKfNFgQCDkATQwAMokEU+PQgUFDAjjR09e/LUmUNnh8aBCcCgUeRmzBkzie6EeQBAoAAMXuA8ciRGCaJHfXzUMCAQgYooWN48anTokR8dQk4sELggBhQrU9Q8evSHiJQgLCIIfMDCSZUjhbYuQkLFCRAMAiOQGGLE0CNBcZYmaRIDLqQFGF60eTRoSxc5jwjhACFWIAgMLtgUocJFy5orL0IQRHAiQgsbRZYswbEhBIiCCH6EiJAhAwQMKU5DjHCi9gnZEHMTDAgAOw==" + +COLOR_SCHEME = 'LightGreen' + +WIDTH_VARIABLES = 23 +WIDTH_RESULTS = 46 + +WIDTH_WATCHER_VARIABLES = 20 +WIDTH_WATCHER_RESULTS = 60 + +WIDTH_LOCALS = 80 +NUM_AUTO_WATCH = 9 + +MAX_LINES_PER_RESULT_FLOATING = 4 +MAX_LINES_PER_RESULT_MAIN = 3 + +POPOUT_WINDOW_FONT = 'Sans 8' + +class Debugger(): + """ """ + + debugger = None + + # # ###### + ## ## ## # # # # # ###### ##### # # #### #### ###### ##### + # # # # # # # ## # # # # # # # # # # # # # # # + # # # # # # # # # # # ##### ##### # # # # ##### # # + # # ###### # # # # # # # # # # # # ### # ### # ##### + # # # # # # ## # # # # # # # # # # # # # # + # # # # # # # ###### ###### ##### #### #### #### ###### # # + + def __init__(self): + """ """ + self.watcher_window = None # type: Window + self.popout_window = None # type: Window + self.local_choices = {} + self.myrc = '' + self.custom_watch = '' + self.locals = {} + self.globals = {} + self.popout_choices = {} + + + + def _build_main_debugger_window_callback(self, events): + """ + + :param events: + + """ + self._build_main_debugger_window() + + # Includes the DUAL PANE (now 2 tabs)! Don't forget REPL is there too! + def _build_main_debugger_window(self, location=(None, None)): + """ + + :param location: (Default value = (None, None)) + + """ + ChangeLookAndFeel(COLOR_SCHEME) + + def InVar(key1): + """ + + :param key1: + + """ + row1 = [T(' '), + I(key=key1, size=(WIDTH_VARIABLES, 1)), + T('', key=key1 + 'CHANGED_', size=(WIDTH_RESULTS, 1)), B('Detail', key=key1 + 'DETAIL_'), + B('Obj', key=key1 + 'OBJ_'), ] + return row1 + + variables_frame = [InVar('_VAR0_'), + InVar('_VAR1_'), + InVar('_VAR2_'), ] + + interactive_frame = [[T('>>> '), In(size=(83, 1), key='_REPL_', + tooltip='Type in any "expression" or "statement"\n and it will be disaplayed below.\nPress RETURN KEY instead of "Go"\nbutton for faster use'), + B('Go', bind_return_key=True, visible=True)], + [Multiline(size=(93, 26), key='_OUTPUT_', autoscroll=True, do_not_clear=True)], ] + + autowatch_frame = [[Button('Choose Variables To Auto Watch', key='_LOCALS_'), + Button('Clear All Auto Watches'), + Button('Show All Variables', key='_SHOW_ALL_'), + Button('Locals', key='_ALL_LOCALS_'), + Button('Globals', key='_GLOBALS_'), + Button('Popout', key='_POPOUT_')]] + + var_layout = [] + for i in range(NUM_AUTO_WATCH): + var_layout.append([T('', size=(WIDTH_WATCHER_VARIABLES, 1), key='_WATCH%s_' % i), + T('', size=(WIDTH_WATCHER_RESULTS, MAX_LINES_PER_RESULT_MAIN), key='_WATCH%s_RESULT_' % i, + )]) + + col1 = [ + # [Frame('Auto Watches', autowatch_frame+variable_values, title_color='blue')] + [Frame('Auto Watches', autowatch_frame+var_layout, title_color='blue')] + ] + + col2 = [ + [Frame('Variables or Expressions to Watch', variables_frame, title_color='blue'), ], + [Frame('REPL-Light - Press Enter To Execute Commands', interactive_frame, title_color='blue'), ] + ] + + # Tab based layout + layout = [[TabGroup([[Tab('Variables', col1), Tab('REPL & Watches', col2)]])], + [Button('', image_data=red_x, key='_EXIT_', button_color=None),]] + + # ------------------------------- Create main window ------------------------------- + window = Window("PySimpleGUI Debugger", layout, icon=PSGDebugLogo, margins=(0, 0), location=location).Finalize() + window.Element('_VAR1_').SetFocus() + self.watcher_window = window + ChangeLookAndFeel('SystemDefault') # set look and feel to default before exiting + return window + + # # ####### # + ## ## ## # # # # # # ###### # # ##### # #### #### ##### + # # # # # # # ## # # # # # ## # # # # # # # # # + # # # # # # # # # ##### # # ##### # # # # # # # # # # # + # # ###### # # # # # # # # # # # # # # # # # ##### + # # # # # # ## # # # # # ## # # # # # # # + # # # # # # # ####### ## ###### # # # ####### #### #### # + + def _refresh_main_debugger_window(self, mylocals, myglobals): + """ + + :param mylocals: + :param myglobals: + + """ + if not self.watcher_window: # if there is no window setup, nothing to do + return False + event, values = self.watcher_window.Read(timeout=1) + if event in (None, 'Exit', '_EXIT_'): # EXIT BUTTON / X BUTTON + try: + self.watcher_window.Close() + except: pass + self.watcher_window = None + return False + # ------------------------------- Process events from REPL Tab ------------------------------- + cmd = values['_REPL_'] # get the REPL entered + # BUTTON - GO (NOTE - This button is invisible!!) + if event == 'Go': # GO BUTTON + self.watcher_window.Element('_REPL_').Update('') + self.watcher_window.Element('_OUTPUT_').Update(">>> {}\n".format(cmd), append=True, autoscroll=True) + + try: + result = eval('{}'.format(cmd), myglobals, mylocals) + except Exception as e: + try: + result = exec('{}'.format(cmd), myglobals, mylocals) + except Exception as e: + result = 'Exception {}\n'.format(e) + + self.watcher_window.Element('_OUTPUT_').Update('{}\n'.format(result), append=True, autoscroll=True) + # BUTTON - DETAIL + elif event.endswith('_DETAIL_'): # DETAIL BUTTON + var = values['_VAR{}_'.format(event[4])] + try: + result = str(eval(str(var), myglobals, mylocals)) + except: + result = '' + PopupScrolled(str(values['_VAR{}_'.format(event[4])]) + '\n' + result, title=var, non_blocking=True) + # BUTTON - OBJ + elif event.endswith('_OBJ_'): # OBJECT BUTTON + var = values['_VAR{}_'.format(event[4])] + try: + result = ObjToStringSingleObj(mylocals[var]) + except Exception as e: + result = '{}\nError showing object {}'.format(e, var) + PopupScrolled(str(var) + '\n' + str(result), title=var, non_blocking=True) + # ------------------------------- Process Watch Tab ------------------------------- + # BUTTON - Choose Locals to see + elif event == '_LOCALS_': # Show all locals BUTTON + self._choose_auto_watches(mylocals) + # BUTTON - Locals (quick popup) + elif event == '_ALL_LOCALS_': + self._display_all_vars(mylocals) + # BUTTON - Globals (quick popup) + elif event == '_GLOBALS_': + self._display_all_vars(myglobals) + # BUTTON - clear all + elif event == 'Clear All Auto Watches': + if PopupYesNo('Do you really want to clear all Auto-Watches?', 'Really Clear??') == 'Yes': + self.local_choices = {} + self.custom_watch = '' + # BUTTON - Popout + elif event == '_POPOUT_': + if not self.popout_window: + self._build_floating_window() + # BUTTON - Show All + elif event == '_SHOW_ALL_': + for key in self.locals: + self.local_choices[key] = not key.startswith('_') + + # -------------------- Process the manual "watch list" ------------------ + for i in range(3): + key = '_VAR{}_'.format(i) + out_key = '_VAR{}_CHANGED_'.format(i) + self.myrc = '' + if self.watcher_window.Element(key): + var = values[key] + try: + result = eval(str(var), myglobals, mylocals) + except: + result = '' + self.watcher_window.Element(out_key).Update(str(result)) + else: + self.watcher_window.Element(out_key).Update('') + + # -------------------- Process the automatic "watch list" ------------------ + slot = 0 + for key in self.local_choices: + if key == '_CUSTOM_WATCH_': + continue + if self.local_choices[key]: + self.watcher_window.Element('_WATCH{}_'.format(slot)).Update(key) + try: + self.watcher_window.Element('_WATCH{}_RESULT_'.format(slot), silent_on_error=True).Update(mylocals[key]) + except: + self.watcher_window.Element('_WATCH{}_RESULT_'.format(slot)).Update('') + slot += 1 + + if slot + int(not self.custom_watch in (None, '')) >= NUM_AUTO_WATCH: + break + # If a custom watch was set, display that value in the window + if self.custom_watch: + self.watcher_window.Element('_WATCH{}_'.format(slot)).Update(self.custom_watch) + try: + self.myrc = eval(self.custom_watch, myglobals, mylocals) + except: + self.myrc = '' + self.watcher_window.Element('_WATCH{}_RESULT_'.format(slot)).Update(self.myrc) + slot += 1 + # blank out all of the slots not used (blank) + for i in range(slot, NUM_AUTO_WATCH): + self.watcher_window.Element('_WATCH{}_'.format(i)).Update('') + self.watcher_window.Element('_WATCH{}_RESULT_'.format(i)).Update('') + + return True # return indicating the window stayed open + + ###### # # + # # #### ##### # # ##### # # # # # # ##### #### # # + # # # # # # # # # # # # # # ## # # # # # # # + ###### # # # # # # # # # # # # # # # # # # # # # + # # # ##### # # ##### # # # # # # # # # # # # ## # + # # # # # # # # # # # # ## # # # # ## ## + # #### # #### # ## ## # # # ##### #### # # + + ###### # # # + # # # # # # ##### #### # # # # # # ## ##### #### + # # # # ## ## # # # # # # # # # # # # # # + # # # # # ## # # # #### # # # # # # # # # # #### + # # # # # # ##### # ####### # # # # ###### ##### # + # # # # # # # # # # # # # # # # # # # # # + ###### #### # # # #### # # ###### ###### # # # # # #### + # displays them into a single text box + + def _display_all_vars(self, dict): + """ + + :param dict: + + """ + num_cols = 3 + output_text = '' + num_lines = 2 + cur_col = 0 + out_text = 'All of your Vars' + longest_line = max([len(key) for key in dict]) + line = [] + sorted_dict = {} + for key in sorted(dict.keys()): + sorted_dict[key] = dict[key] + for key in sorted_dict: + value = dict[key] + wrapped_list = textwrap.wrap(str(value), 60) + wrapped_text = '\n'.join(wrapped_list) + out_text += '{} - {}\n'.format(key, wrapped_text) + if cur_col + 1 == num_cols: + cur_col = 0 + num_lines += len(wrapped_list) + else: + cur_col += 1 + ScrolledTextBox(out_text, non_blocking=True) + + ##### # # +# # # # #### #### #### ###### # # # ## ##### #### # # +# # # # # # # # # # # # # # # # # # # +# ###### # # # # #### ##### # # # # # # # ###### +# # # # # # # # # # # # ###### # # # # +# # # # # # # # # # # # # # # # # # # # # + ##### # # #### #### #### ###### ## ## # # # #### # # + +# # # # +# # ## ##### # ## ##### # ###### #### # # # # # # +# # # # # # # # # # # # # # # # # # ## # +# # # # # # # # # ##### # ##### #### # # # # # # # + # # ###### ##### # ###### # # # # # # # # # # # # + # # # # # # # # # # # # # # # # # # # # ## + # # # # # # # # ##### ###### ###### #### ## ## # # # + + def _choose_auto_watches(self, my_locals): + """ + + :param my_locals: + + """ + ChangeLookAndFeel(COLOR_SCHEME) + num_cols = 3 + output_text = '' + num_lines = 2 + cur_col = 0 + layout = [[Text('Choose your "Auto Watch" variables', font='ANY 14', text_color='red')]] + longest_line = max([len(key) for key in my_locals]) + line = [] + sorted_dict = {} + for key in sorted(my_locals.keys()): + sorted_dict[key] = my_locals[key] + for key in sorted_dict: + line.append(CB(key, key=key, size=(longest_line, 1), + default=self.local_choices[key] if key in self.local_choices else False)) + if cur_col + 1 == num_cols: + cur_col = 0 + layout.append(line) + line = [] + else: + cur_col += 1 + if cur_col: + layout.append(line) + + layout += [ + [Text('Custom Watch (any expression)'), Input(default_text=self.custom_watch, size=(40, 1), key='_CUSTOM_WATCH_')]] + layout += [ + [Ok(), Cancel(), Button('Clear All'), Button('Select [almost] All', key='_AUTO_SELECT_')]] + + window = Window('All Locals', layout, icon=PSGDebugLogo).Finalize() + + while True: # event loop + event, values = window.Read() + if event in (None, 'Cancel'): + break + elif event == 'Ok': + self.local_choices = values + self.custom_watch = values['_CUSTOM_WATCH_'] + break + elif event == 'Clear All': + PopupQuickMessage('Cleared Auto Watches', auto_close=True, auto_close_duration=3, non_blocking=True, + text_color='red', font='ANY 18') + for key in sorted_dict: + window.Element(key).Update(False) + window.Element('_CUSTOM_WATCH_').Update('') + elif event == 'Select All': + for key in sorted_dict: + window.Element(key).Update(False) + elif event == '_AUTO_SELECT_': + for key in sorted_dict: + window.Element(key).Update(not key.startswith('_')) + + # exited event loop + window.Close() + ChangeLookAndFeel('SystemDefault') + + ###### ####### + # # # # # # ##### # # #### ## ##### # # # #### + # # # # # # # # # # # # # # # # ## # # # + ###### # # # # # # ##### # # # # # # # # # # # + # # # # # # # # # # # # ###### # # # # # # ### + # # # # # # # # # # # # # # # # # ## # # + ###### #### # ###### ##### # ###### #### # # # # # # #### + + # # + # # # # # # ##### #### # # + # # # # ## # # # # # # # + # # # # # # # # # # # # # + # # # # # # # # # # # # ## # + # # # # # ## # # # # ## ## + ## ## # # # ##### #### # # + + def _build_floating_window(self, location=(None, None)): + """ + + :param location: (Default value = (None, None)) + + """ + if self.popout_window: # if floating window already exists, close it first + self.popout_window.Close() + ChangeLookAndFeel('Topanga') + num_cols = 2 + width_var = 15 + width_value = 30 + layout = [] + line = [] + col = 0 + self.popout_choices = self.local_choices + if self.popout_choices == {}: # if nothing chosen, then choose all non-_ variables + for key in sorted(self.locals.keys()): + self.popout_choices[key] = not key.startswith('_') + + width_var = max([len(key) for key in self.popout_choices]) + for key in self.popout_choices: + if self.popout_choices[key] is True: + value = str(self.locals.get(key)) + h = min(len(value)//width_value + 1, MAX_LINES_PER_RESULT_FLOATING) + line += [Text('{}'.format(key), size=(width_var, 1), font=POPOUT_WINDOW_FONT), + Text(' = ', font=POPOUT_WINDOW_FONT), + Text(value, key=key, size=(width_value, h), font=POPOUT_WINDOW_FONT)] + if col + 1 < num_cols: + line += [VerticalSeparator(), T(' ')] + col += 1 + if col >= num_cols: + layout.append(line) + line = [] + col = 0 + if col != 0: + layout.append(line) + layout = [[Column(layout), Column( + [[Button('', key='_EXIT_', image_data=red_x, button_color=('#282923', '#282923'), border_width=0)]])]] + + self.popout_window = Window('Floating', layout, alpha_channel=0, no_titlebar=True, grab_anywhere=True, + element_padding=(0, 0), margins=(0, 0), keep_on_top=True, + right_click_menu=['&Right', ['Debugger::RightClick', 'Exit::RightClick']], location=location ).Finalize() + if location == (None, None): + screen_size = self.popout_window.GetScreenDimensions() + self.popout_window.Move(screen_size[0] - self.popout_window.Size[0], 0) + self.popout_window.SetAlpha(1) + + ChangeLookAndFeel('SystemDefault') + return True + + ###### + # # ###### ###### ##### ###### #### # # + # # # # # # # # # # + ###### ##### ##### # # ##### #### ###### + # # # # ##### # # # # + # # # # # # # # # # # + # # ###### # # # ###### #### # # + + ####### + # # #### ## ##### # # # #### + # # # # # # # # ## # # # + ##### # # # # # # # # # # # + # # # # ###### # # # # # # ### + # # # # # # # # # ## # # + # ###### #### # # # # # # #### + + # # + # # # # # # ##### #### # # + # # # # ## # # # # # # # + # # # # # # # # # # # # # + # # # # # # # # # # # # ## # + # # # # # ## # # # # ## ## + ## ## # # # ##### #### # # + + def _refresh_floating_window(self): + """ """ + if not self.popout_window: + return + for key in self.popout_choices: + if self.popout_choices[key] is True and key in self.locals: + if key is not None: + self.popout_window.Element(key, silent_on_error=True).Update(self.locals.get(key)) + event, values = self.popout_window.Read(timeout=1) + if event in (None, '_EXIT_', 'Exit::RightClick'): + self.popout_window.Close() + self.popout_window = None + elif event == 'Debugger::RightClick': + show_debugger_window() + + +# 888 888 .d8888b. d8888 888 888 888 888 +# 888 888 d88P Y88b d88888 888 888 888 888 +# 888 888 888 888 d88P888 888 888 888 888 +# 888 888 .d8888b .d88b. 888d888 888 d88P 888 888 888 8888b. 88888b. 888 .d88b. +# 888 888 88K d8P Y8b 888P" 888 d88P 888 888 888 "88b 888 "88b 888 d8P Y8b +# 888 888 "Y8888b. 88888888 888 888 888 d88P 888 888 888 .d888888 888 888 888 88888888 +# Y88b. .d88P X88 Y8b. 888 Y88b d88P d8888888888 888 888 888 888 888 d88P 888 Y8b. +# "Y88888P" 88888P' "Y8888 888 "Y8888P" d88P 888 888 888 "Y888888 88888P" 888 "Y8888 + +# 8888888888 888 d8b +# 888 888 Y8P +# 888 888 +# 8888888 888 888 88888b. .d8888b 888888 888 .d88b. 88888b. .d8888b +# 888 888 888 888 "88b d88P" 888 888 d88""88b 888 "88b 88K +# 888 888 888 888 888 888 888 888 888 888 888 888 "Y8888b. +# 888 Y88b 888 888 888 Y88b. Y88b. 888 Y88..88P 888 888 X88 +# 888 "Y88888 888 888 "Y8888P "Y888 888 "Y88P" 888 888 88888P' + + + + +def show_debugger_window(location=(None, None), *args): + """ + + :param location: (Default value = (None, None)) + :param *args: + + """ + if Debugger.debugger is None: + Debugger.debugger = Debugger() + debugger = Debugger.debugger + frame = inspect.currentframe() + prev_frame = inspect.currentframe().f_back + # frame, *others = inspect.stack()[1] + try: + debugger.locals = frame.f_back.f_locals + debugger.globals = frame.f_back.f_globals + finally: + del frame + + if not debugger.watcher_window: + debugger.watcher_window = debugger._build_main_debugger_window(location=location) + return True + + +def show_debugger_popout_window(location=(None, None), *args): + """ + + :param location: (Default value = (None, None)) + :param *args: + + """ + if Debugger.debugger is None: + Debugger.debugger = Debugger() + debugger = Debugger.debugger + frame = inspect.currentframe() + prev_frame = inspect.currentframe().f_back + # frame = inspect.getframeinfo(prev_frame) + # frame, *others = inspect.stack()[1] + try: + debugger.locals = frame.f_back.f_locals + debugger.globals = frame.f_back.f_globals + finally: + del frame + if debugger.popout_window: + debugger.popout_window.Close() + debugger.popout_window = None + debugger._build_floating_window(location=location) + + +def refresh_debugger(): + """ """ + if Debugger.debugger is None: + Debugger.debugger = Debugger() + debugger = Debugger.debugger + Window.read_call_from_debugger = True + frame = inspect.currentframe() + frame = inspect.currentframe().f_back + # frame, *others = inspect.stack()[1] + try: + debugger.locals = frame.f_back.f_locals + debugger.globals = frame.f_back.f_globals + finally: + del frame + debugger._refresh_floating_window() if debugger.popout_window else None + rc = debugger._refresh_main_debugger_window(debugger.locals, debugger.globals) if debugger.watcher_window else False + Window.read_call_from_debugger = False + return rc + + + + + + """ d8b Y8P - + 88888b.d88b. 8888b. 888 88888b. 888 "888 "88b "88b 888 888 "88b 888 888 888 .d888888 888 888 888 888 888 888 888 888 888 888 888 888 888 888 "Y888888 888 888 888 - + """ + def main(): + """ """ from random import randint ChangeLookAndFeel('GreenTan') # ------ Menu Definition ------ # menu_def = [['&File', ['!&Open', '&Save::savekey', '---', '&Properties', 'E&xit']], ['!&Edit', ['!&Paste', ['Special', 'Normal', ], 'Undo'], ], + ['&Debugger', ['Popout', 'Launch Debugger']], ['&Toolbar', ['Command &1', 'Command &2', 'Command &3', 'Command &4']], ['&Help', '&About...'], ] @@ -7661,12 +10406,13 @@ def main(): frame2 = [ [Listbox(['Listbox 1', 'Listbox 2', 'Listbox 3'], size=(20, 5))], [Combo(['Combo item 1', ], size=(20, 3), text_color='red', background_color='red')], + [Combo(['Combo item 1', ], size=(20, 3), text_color='red', background_color='red')], [Spin([1, 2, 3], size=(4, 3))], ] frame3 = [ [Checkbox('Checkbox1', True), Checkbox('Checkbox1')], - [Radio('Radio Button1', 1), Radio('Radio Button2', 1, default=True)], + [Radio('Radio Button1', 1), Radio('Radio Button2', 1, default=True, tooltip='Radio 2')], [T('', size=(1, 4))], ] @@ -7678,11 +10424,11 @@ def main(): frame5 = [ [Table(values=matrix, headings=matrix[0], - auto_size_columns=False, display_row_numbers=True, change_submits=False, justification='right', - num_rows=10, alternating_row_color='lightblue', key='_table_', text_color='black', - col_widths=[5, 5, 5, 5], size=(400, 200)), T(' '), + auto_size_columns=False, display_row_numbers=True, change_submits=False, justification='right', + num_rows=10, alternating_row_color='lightblue', key='_table_', text_color='black', + col_widths=[5, 5, 5, 5], size=(400, 200)), T(' '), Tree(data=treedata, headings=['col1', 'col2', 'col3'], change_submits=True, auto_size_columns=True, - num_rows=10, col0_width=10, key='_TREE_', show_expanded=True, )], + num_rows=10, col0_width=10, key='_TREE_', show_expanded=True, )], ] graph_elem = Graph((800, 150), (0, 0), (800, 300), key='+GRAPH+') @@ -7691,30 +10437,35 @@ def main(): [graph_elem], ] - tab1 = Tab('Graph Number 1', frame6) + tab1 = Tab('Graph Number 1', frame6, tooltip='tab 1') tab2 = Tab('Graph Number 2', [[]]) layout1 = [ [Menu(menu_def)], - [Text('You are running the PySimpleGUI.py file itself', font='ANY 15')], + [Image(data=DEFAULT_BASE64_ICON)], + [Text('You are running the py file itself', font='ANY 15', tooltip='My tooltip', key='_TEXT1_')], [Text('You should be importing it rather than running it', font='ANY 15')], [Frame('Input Text Group', frame1, title_color='red'), Image(data=DEFAULT_BASE64_LOADING_GIF, key='_IMAGE_')], [Frame('Multiple Choice Group', frame2, title_color='green'), - Frame('Binary Choice Group', frame3, title_color='purple'), + Frame('Binary Choice Group', frame3, title_color='purple', tooltip='Binary Choice'), Frame('Variable Choice Group', frame4, title_color='blue')], [Frame('Structured Data Group', frame5, title_color='red'), ], # [Frame('Graphing Group', frame6)], [TabGroup([[tab1, tab2]])], - [ProgressBar(max_value=800, size=(60, 25), key='+PROGRESS+'), Button('Button'), Button('Exit')], + [ProgressBar(max_value=800, size=(60, 25), key='+PROGRESS+'), Button('Button'), B('Normal'), + Button('Exit', tooltip='Exit button')], ] - layout=[[Column(layout1)]] + layout = [[Column(layout1)]] - window = Window('Window Title', + window = Window('Window Title', layout, font=('Helvetica', 13), + # background_color='black', right_click_menu=['&Right', ['Right', '!&Click', '&Menu', 'E&xit', 'Properties']], - ).Layout(layout).Finalize() + # transparent_color= '#9FB8AD', + resizable=True, + ).Finalize() graph_elem.DrawCircle((200, 200), 50, 'blue') i = 0 while True: # Event Loop @@ -7733,10 +10484,19 @@ def main(): window.FindElement('+PROGRESS+').UpdateBar(i % 800) window.Element('_IMAGE_').UpdateAnimation(DEFAULT_BASE64_LOADING_GIF, time_between_frames=50) i += 1 + if event == 'Button': + window.Element('_TEXT1_').SetTooltip('NEW TEXT') + window.SetTransparentColor('#9FB8AD') + window.Maximize() + elif event == 'Normal': + window.Normal() + elif event == 'Popout': + show_debugger_popout_window() + elif event == 'Launch Debugger': + show_debugger_window() # TimerStop() window.Close() - # layout = [[Text('You are running the PySimpleGUI.py file itself')], # [Text('You should be importing it rather than running it', size=(50, 2))], # [Text('Here is your sample input window....')], @@ -7750,7 +10510,6 @@ def main(): # window.Close() - if __name__ == '__main__': main() exit(69) From f236991119e1d186c9ed43043b3f93745b3cf960 Mon Sep 17 00:00:00 2001 From: MikeTheWatchGuy <13696193+MikeTheWatchGuy@users.noreply.github.com> Date: Mon, 17 Jun 2019 16:39:07 -0400 Subject: [PATCH 3/3] Revert "Release 4.0" --- docs/index.md | 6850 +++++++++++++++++++++---------------------------- readme.md | 6850 +++++++++++++++++++++---------------------------- 2 files changed, 5872 insertions(+), 7828 deletions(-) diff --git a/docs/index.md b/docs/index.md index 3e1c2201..9cc7ea0e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,59 +1,31 @@ - - +![Documentation Status](https://readthedocs.org/projects/pysimplegui/badge/?version=latest) + ![Awesome Meter](https://img.shields.io/badge/Awesome_meter-100-yellow.svg) + ![Python Version](https://img.shields.io/badge/Python-2.7_3.x-yellow.svg) + -![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) tkinter - -[![Downloads ](https://pepy.tech/badge/pysimplegui27)](https://pepy.tech/project/pysimplegui27) tkinter 2.7 - -[![Downloads](https://pepy.tech/badge/pysimpleguiqt)](https://pepy.tech/project/pysimpleguiqt) Qt - -[![Downloads](https://pepy.tech/badge/pysimpleguiwx)](https://pepy.tech/project/pysimpleguiWx) WxPython - -[![Downloads](https://pepy.tech/badge/pysimpleguiweb)](https://pepy.tech/project/pysimpleguiWeb) Web (Remi) - - -![Documentation Status](https://readthedocs.org/projects/pysimplegui/badge/?version=latest) -![Awesome Meter](https://img.shields.io/badge/Awesome_meter-100-yellow.svg) -![Python Version](https://img.shields.io/badge/Python-2.7_3.x-yellow.svg) - - - -# PySimpleGUI - -* Create windows that look and operate _identically_ to those created directly with tkinter, Qt, WxPython, and Remi. -* Requires 1/2 to 1/5th the amount of code as underlying frameworks. -* For exampl, develop a working Qt application in 1/2 to 1/5th the number lines of code. + +# PySimpleGUI + +* Create windows that look and operate _identically_ to those created directly with tkinter, Qt, WxPython, and Remi. +* Requires 1/2 to 1/5th the amount of code as underlying frameworks. +* For exampl, develop a working Qt application in 1/2 to 1/5th the number lines of code. * The savings can be even greater depending on your application. * One afternoon is all that is required to learn the PySimpleGUI concepts and APIs. - + ## Supports both Python 2.7 & 3 when using tkinter ## Supports both PySide2 and PyQt5 (limited support) @@ -63,47 +35,47 @@ HOW DO I INSERT IMAGES ??? ## The *only* way to write both desktop and web based GUIs at the same time -![Python Version](https://img.shields.io/badge/PySimpleGUI_For_Python_3.x_Version-3.39.0-red.svg?longCache=true&style=for-the-badge) - -![Python Version](https://img.shields.io/badge/PySimpleGUI_For_Python_2.7_Version-1.39.0-blue.svg?longCache=true&style=for-the-badge) - -![Python Version](https://img.shields.io/badge/PySimpleGUIQt_Version-0.31.0-orange.svg?longCache=true&style=for-the-badge) - +![Python Version](https://img.shields.io/badge/PySimpleGUI_For_Python_3.x_Version-3.39.0-red.svg?longCache=true&style=for-the-badge) + +![Python Version](https://img.shields.io/badge/PySimpleGUI_For_Python_2.7_Version-1.39.0-blue.svg?longCache=true&style=for-the-badge) + +![Python Version](https://img.shields.io/badge/PySimpleGUIQt_Version-0.31.0-orange.svg?longCache=true&style=for-the-badge) + ![Python Version](https://img.shields.io/badge/PySimpleGUIWx_version-0.11.0-orange.svg?longCache=true&style=for-the-badge) ![Python Version](https://img.shields.io/badge/PySimpleGUIWeb_Version-0.28.1-orange.svg?longCache=true&style=for-the-badge) -[Announcements of Latest Developments](https://github.com/MikeTheWatchGuy/PySimpleGUI/issues/142) +[Announcements of Latest Developments](https://github.com/MikeTheWatchGuy/PySimpleGUI/issues/142) -[ReadTheDocs](http://pysimplegui.readthedocs.io/) +[ReadTheDocs](http://pysimplegui.readthedocs.io/) -[COOKBOOK!](https://pysimplegui.readthedocs.io/cookbook/) +[COOKBOOK!](https://pysimplegui.readthedocs.io/cookbook/) -[Brief Tutorial](https://pysimplegui.readthedocs.io/tutorial/) +[Brief Tutorial](https://pysimplegui.readthedocs.io/tutorial/) -[Latest Demos and Master Branch on GitHub](https://github.com/MikeTheWatchGuy/PySimpleGUI) +[Latest Demos and Master Branch on GitHub](https://github.com/MikeTheWatchGuy/PySimpleGUI) -[Docs in PDF Format](https://github.com/MikeTheWatchGuy/PySimpleGUI/tree/master/docs) +[Docs in PDF Format](https://github.com/MikeTheWatchGuy/PySimpleGUI/tree/master/docs) [Repl.it Home for PySimpleGUI](https://repl.it/@PySimpleGUI) -Super-simple GUI to use... Powerfully customizable +Super-simple GUI to use... Powerfully customizable -Home of the 1-line custom GUI & 1-line progress meter +Home of the 1-line custom GUI & 1-line progress meter -The native GUI framework for perfectionists with deadlines +The native GUI framework for perfectionists with deadlines Actively developed and supported (It's 2019 and still going strong) -#### 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 `PySimpleGUI27`. They are installed separately and the imports are different. See instructions in Installation section for more info. +#### 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 `PySimpleGUI27`. They are installed separately and the imports are different. See instructions in Installation section for more info. # Qt Version -Check out the new PySimpleGUI port to the Qt GUI Framework. You can learn more on the [PySimpleGUIQt GitHub site](https://github.com/MikeTheWatchGuy/PySimpleGUI/tree/master/PySimpleGUIQt). **There is a separate Readme file for the Qt version** that you'll find there. +Check out the new PySimpleGUI port to the Qt GUI Framework. You can learn more on the [PySimpleGUIQt GitHub site](https://github.com/MikeTheWatchGuy/PySimpleGUI/tree/master/PySimpleGUIQt). **There is a separate Readme file for the Qt version** that you'll find there. -Give it a shot if you're looking for something a bit more "modern". PySimpleGUIQt is currently in Alpha. All of the widgets are operational but some may not yet be full-featured. If one is missing and your project needs it, log an Issue and you'll likely get priority support. +Give it a shot if you're looking for something a bit more "modern". PySimpleGUIQt is currently in Alpha. All of the widgets are operational but some may not yet be full-featured. If one is missing and your project needs it, log an Issue and you'll likely get priority support. Here is a summary of the Qt Elements @@ -121,7 +93,7 @@ Your source code is completely portable from one platform to another by simply c Started in late December 2018 PySimpleGUIWx started with the SystemTray Icon feature. This enabled the package to have one fully functioning feature that can be used along with tkinter to provide a complete program. The System Tray feature is complete and working very well. -The Windowing code is coming together with Reads now operational which means Popups work. The elements are getting completed on a regular basis. 3 more were just checked in. At least 1 new element is getting completed a week. +The Windowing code is coming together with Reads now operational which means Popups work. The elements are getting completed on a regular basis. 3 more were just checked in. At least 1 new element is getting completed a week. # Web Version (Remi) @@ -137,11 +109,11 @@ Read on and you'll understand even more why this is an important project... ***Want to really get your mind blown?*** Check out this [PySimpleGUI program](https://repl.it/@PySimpleGUI/PySimpleGUIWeb-Demos) running in your web browser. -Thanks to the magic of repl.it and Remi it's possible to run PySimpleGUI code in a browser window without having Python running on your computer. +Thanks to the magic of repl.it and Remi it's possible to run PySimpleGUI code in a browser window without having Python running on your computer. -The programs you write using repl.it will automatically download and install the latest PySimpleGUIWeb from PyPI onto a virtual Python environment. All that is required is to type `import PySimpleGUIWeb` you'll have a Python environment up and running with the latest PyPI release of PySimpleGUIWeb. +The programs you write using repl.it will automatically download and install the latest PySimpleGUIWeb from PyPI onto a virtual Python environment. All that is required is to type `import PySimpleGUIWeb` you'll have a Python environment up and running with the latest PyPI release of PySimpleGUIWeb. -This is an exciting new development that's opening up all kinds of possibilities for new ways to program and learn PySimpleGUI. Stayed tuned, much more to be posted about this in the near future. +This is an exciting new development that's opening up all kinds of possibilities for new ways to program and learn PySimpleGUI. Stayed tuned, much more to be posted about this in the near future. Educators in particular should be interested. Students can not only post their homework easily for their teacher to access, but teachers can also run the students programs online. No downloading needed. Run it and check the results. @@ -151,273 +123,273 @@ Depending on how you're viewing this document, you may or may not see an embedde # Support -PySimpleGUI is an active project. Bugs are fixed, features are added, often. Should you run into trouble, open an issue on the GitHub site and you'll receive help by someone in the community. +PySimpleGUI is an active project. Bugs are fixed, features are added, often. Should you run into trouble, open an issue on the GitHub site and you'll receive help by someone in the community. # Platforms It's surprising that Python GUI code is completely cross platform from Windows to Mac to Linux. No source code changes. This is true for both PySimpleGUI and PySimpleGUIQt. -However, **Macs** suck. They suck on tkinter in particular. The "Look and feel" calls are disabled for Macs. Colored buttons in particular are broken. Not in the PySimpleGUI code, of course. It's mostly because Macs suck. Consider using Qt instead of tkinter on the Mac. Or, if using tkinter, bring your own button images. +However, **Macs** suck. They suck on tkinter in particular. The "Look and feel" calls are disabled for Macs. Colored buttons in particular are broken. Not in the PySimpleGUI code, of course. It's mostly because Macs suck. Consider using Qt instead of tkinter on the Mac. Or, if using tkinter, bring your own button images. --- -Looking for a GUI package? Are you +Looking for a GUI package? Are you -* looking to take your Python code from the world of command lines and into the convenience of a GUI? * -* sitting on a Raspberry **Pi** with a touchscreen that's going to waste because you don't have the time to learn a GUI SDK? -* into Machine Learning and are sick of the command line? -* wanting to distribute your Python code to Windows users as a single .EXE file that launches straight into a GUI, much like a WinForms app? +* looking to take your Python code from the world of command lines and into the convenience of a GUI? * +* sitting on a Raspberry **Pi** with a touchscreen that's going to waste because you don't have the time to learn a GUI SDK? +* into Machine Learning and are sick of the command line? +* wanting to distribute your Python code to Windows users as a single .EXE file that launches straight into a GUI, much like a WinForms app? * would like to run a program in the system tray? * a teacher wanting to teach your students how to program using a GUI? * a student that wants to put a GUI onto their project? * looking for an active project? -Look no further, **you've found your GUI package**. +Look no further, **you've found your GUI package**. ```python -import PySimpleGUI as sg +import PySimpleGUI as sg -sg.Popup('Hello From PySimpleGUI!', 'This is the shortest GUI program ever!') +sg.Popup('Hello From PySimpleGUI!', 'This is the shortest GUI program ever!') ``` -![hello world](https://user-images.githubusercontent.com/13696193/44960047-1f7f6380-aec6-11e8-9d5e-12ef935bcade.jpg) +![hello world](https://user-images.githubusercontent.com/13696193/44960047-1f7f6380-aec6-11e8-9d5e-12ef935bcade.jpg) -Or how about a ***custom GUI*** in 1 line of code? +Or how about a ***custom GUI*** in 1 line of code? ```python -import PySimpleGUI as sg +import PySimpleGUI as sg -event, (filename,) = sg.Window('Get filename example'). Layout([[sg.Text('Filename')], [sg.Input(), sg.FileBrowse()], [sg.OK(), sg.Cancel()] ]).Read() +event, (filename,) = sg.Window('Get filename example'). Layout([[sg.Text('Filename')], [sg.Input(), sg.FileBrowse()], [sg.OK(), sg.Cancel()] ]).Read() ``` -![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, run within minutes. This is the process PySimpleGUI was designed to facilitate. +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. Your windows don't have to look like "boring" old windows. Add a few custom graphics to your windows to polish things up. ![batterup2](https://user-images.githubusercontent.com/13696193/50378902-6aa2bb00-060a-11e9-8f2f-d746694fa4ee.gif) -![uno_final](https://user-images.githubusercontent.com/13696193/49945232-67952580-feba-11e8-90c8-7dc31c5f7c67.gif) +![uno_final](https://user-images.githubusercontent.com/13696193/49945232-67952580-feba-11e8-90c8-7dc31c5f7c67.gif) -PySimpleGUI wraps tkinter or Qt so that you get all the same widgets as you would tkinter/Qt, but you interact with them in a more friendly way. It does the layout and boilerplate code for you and presents you with a simple, efficient interface. +PySimpleGUI wraps tkinter or Qt so that you get all the same widgets as you would tkinter/Qt, but you interact with them in a more friendly way. It does the layout and boilerplate code for you and presents you with a simple, efficient interface. -![everything dark theme](https://user-images.githubusercontent.com/13696193/44959854-b1d23800-aec3-11e8-90b6-5af915a86d15.jpg) +![everything dark theme](https://user-images.githubusercontent.com/13696193/44959854-b1d23800-aec3-11e8-90b6-5af915a86d15.jpg) -Perhaps you're looking for a way to interact with your **Raspberry Pi** in a more friendly way. The same for shown as on Pi (roughly the same) +Perhaps you're looking for a way to interact with your **Raspberry Pi** in a more friendly way. The same for shown as on Pi (roughly the same) -![raspberry pi everything demo](https://user-images.githubusercontent.com/13696193/44279694-5b58ce80-a220-11e8-9ab6-d6021f5a944f.jpg) +![raspberry pi everything demo](https://user-images.githubusercontent.com/13696193/44279694-5b58ce80-a220-11e8-9ab6-d6021f5a944f.jpg) -In addition to a primary GUI, you can add a Progress Meter to your code with ONE LINE of code. Slide this line into any of your `for` loops and get a nice meter: +In addition to a primary GUI, you can add a Progress Meter to your code with ONE LINE of code. Slide this line into any of your `for` loops and get a nice meter: ```python -OneLineProgressMeter('My meter title', current_value, max value, 'key') +OneLineProgressMeter('My meter title', current_value, max value, 'key') ``` -![easyprogressmeter](https://user-images.githubusercontent.com/13696193/44960065-83099100-aec6-11e8-8aa8-96e4b100a0e4.jpg) +![easyprogressmeter](https://user-images.githubusercontent.com/13696193/44960065-83099100-aec6-11e8-8aa8-96e4b100a0e4.jpg) -It's simple to show animated GIFs. +It's simple to show animated GIFs. + +![loading animation](https://user-images.githubusercontent.com/13696193/51280871-d2041e80-19ae-11e9-8757-802eb95352ed.gif) -![loading animation](https://user-images.githubusercontent.com/13696193/51280871-d2041e80-19ae-11e9-8757-802eb95352ed.gif) +How about embedding a game inside of a GUI? This game of Pong is written in tkinter and then dropped into the PySimpleGUI window creating a game that has an accompanying GUI. -How about embedding a game inside of a GUI? This game of Pong is written in tkinter and then dropped into the PySimpleGUI window creating a game that has an accompanying GUI. +![pong](https://user-images.githubusercontent.com/13696193/45860012-2d8d0b00-bd33-11e8-9efd-3eaf4c30f324.gif) -![pong](https://user-images.githubusercontent.com/13696193/45860012-2d8d0b00-bd33-11e8-9efd-3eaf4c30f324.gif) - -Combining PySimpleGUI with PyInstaller creates something truly remarkable and special, a Python program that looks like a Windows WinForms application. This application with working menu was created in 20 lines of Python code. It is a single .EXE file that launches straight into the screen you see. And more good news, the only icon you see on the taskbar is the window itself... there is no pesky shell window. - -![menu demo](https://user-images.githubusercontent.com/13696193/45923097-8fbc4c00-beaa-11e8-87d2-01a5331811c8.gif) +Combining PySimpleGUI with PyInstaller creates something truly remarkable and special, a Python program that looks like a Windows WinForms application. This application with working menu was created in 20 lines of Python code. It is a single .EXE file that launches straight into the screen you see. And more good news, the only icon you see on the taskbar is the window itself... there is no pesky shell window. + +![menu demo](https://user-images.githubusercontent.com/13696193/45923097-8fbc4c00-beaa-11e8-87d2-01a5331811c8.gif) -## 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?? +## 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 windows 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. +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. -The `PySimpleGUI` package is focused on the ***developer***. -> Create a custom GUI with as little and as simple code as possible. +The `PySimpleGUI` package is focused on the ***developer***. +> Create a custom GUI with as little and as simple code as possible. -This was the primary focus used to create PySimpleGUI. +This was the primary focus used to create PySimpleGUI. -> "Do it in a Python-like way" +> "Do it in a Python-like way" -was the second. +was the second. -## Features +## Features -While simple to use, PySimpleGUI has significant depth to be explored by more advanced programmers. The feature set goes way beyond the requirements of a beginner programmer, and into the required features needed for complex GUIs. - -Features of PySimpleGUI include: -- Support for Python versions 2.7 and 3 -- Text -- Single Line Input -- Buttons including these types: - - File Browse - - Files Browse - - Folder Browse - - SaveAs - - Non-closing return - - Close window - - Realtime - - Calendar chooser - - Color chooser - - Button Menu -- Checkboxes -- Radio Buttons -- Listbox -- Option Menu +While simple to use, PySimpleGUI has significant depth to be explored by more advanced programmers. The feature set goes way beyond the requirements of a beginner programmer, and into the required features needed for complex GUIs. + +Features of PySimpleGUI include: +- Support for Python versions 2.7 and 3 +- Text +- Single Line Input +- Buttons including these types: + - File Browse + - Files Browse + - Folder Browse + - SaveAs + - Non-closing return + - Close window + - Realtime + - Calendar chooser + - Color chooser + - Button Menu +- Checkboxes +- Radio Buttons +- Listbox +- Option Menu - Menubar -- Button Menu -- Slider +- Button Menu +- Slider - Dial -- Graph -- Frame with title -- Icons -- Multi-line Text Input -- Scroll-able Output -- Images -- Tables -- Trees -- Progress Bar Async/Non-Blocking Windows -- Tabbed windows +- Graph +- Frame with title +- Icons +- Multi-line Text Input +- Scroll-able Output +- Images +- Tables +- Trees +- Progress Bar Async/Non-Blocking Windows +- Tabbed windows - Paned windows -- Persistent Windows -- Redirect Python Output/Errors to scrolling window -- 'Higher level' APIs (e.g. MessageBox, YesNobox, ...) -- Single-Line-Of-Code Proress Bar & Debug Print -- Complete control of colors, look and feel -- Selection of pre-defined palettes -- Button images +- Persistent Windows +- Redirect Python Output/Errors to scrolling window +- 'Higher level' APIs (e.g. MessageBox, YesNobox, ...) +- Single-Line-Of-Code Proress Bar & Debug Print +- Complete control of colors, look and feel +- Selection of pre-defined palettes +- Button images - Horizontal and Verticle Separators -- Return values as dictionary -- Set focus -- Bind return key to buttons -- 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 window -- Bulk window-fill operation -- Save / Load window to/from disk -- Borderless (no titlebar) windows -- Always on top windows -- Menus with ALT-hotkey -- Right click pop-up menu -- Tooltips -- Clickable links +- Return values as dictionary +- Set focus +- Bind return key to buttons +- 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 window +- Bulk window-fill operation +- Save / Load window to/from disk +- Borderless (no titlebar) windows +- Always on top windows +- Menus with ALT-hotkey +- Right click pop-up menu +- Tooltips +- Clickable links - Transparent windows -- Movable windows +- Movable windows - Animated GIFs -- No async programming required (no callbacks to worry about) +- No async programming required (no callbacks to worry about) -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 : +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... +Start Python, copy and paste the code below into the >>> prompt and hit enter. This will pop up... -![everything example](https://user-images.githubusercontent.com/13696193/43097412-0a4652aa-8e8a-11e8-8e09-939484e3c568.jpg) +![everything example](https://user-images.githubusercontent.com/13696193/43097412-0a4652aa-8e8a-11e8-8e09-939484e3c568.jpg) ```python -import PySimpleGUI as sg - -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)], - [sg.Radio('My first Radio! ', "RADIO1", default=True), sg.Radio('My second Radio!', "RADIO1")], - [sg.Multiline(default_text='This is the default Text shoulsd you decide not to type anything',)], -[sg.InputCombo(['Combobox 1', 'Combobox 2'], size=(20, 3)), - sg.Slider(range=(1, 100), orientation='h', size=(35, 20), default_value=85)], -[sg.Listbox(values=['Listbox 1', 'Listbox 2', 'Listbox 3'], size=(30, 6)), - sg.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=25), - sg.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=75), - sg.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=10)], -[sg.Text('_' * 100, size=(70, 1))], -[sg.Text('Choose Source and Destination Folders', size=(35, 1))], -[sg.Text('Source Folder', size=(15, 1), auto_size_text=False, justification='right'), sg.InputText('Source'), - sg.FolderBrowse()], -[sg.Text('Destination Folder', size=(15, 1), auto_size_text=False, justification='right'), sg.InputText('Dest'), - sg.FolderBrowse()], -[sg.Submit(), sg.Cancel(), sg.Button('Customized', button_color=('white', 'green'))]] - -event, values = sg.Window('Everything bagel', layout, auto_size_text=True, default_element_size=(40, 1)).Read() +import PySimpleGUI as sg + +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)], + [sg.Radio('My first Radio! ', "RADIO1", default=True), sg.Radio('My second Radio!', "RADIO1")], + [sg.Multiline(default_text='This is the default Text shoulsd you decide not to type anything',)], +[sg.InputCombo(['Combobox 1', 'Combobox 2'], size=(20, 3)), + sg.Slider(range=(1, 100), orientation='h', size=(35, 20), default_value=85)], +[sg.Listbox(values=['Listbox 1', 'Listbox 2', 'Listbox 3'], size=(30, 6)), + sg.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=25), + sg.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=75), + sg.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=10)], +[sg.Text('_' * 100, size=(70, 1))], +[sg.Text('Choose Source and Destination Folders', size=(35, 1))], +[sg.Text('Source Folder', size=(15, 1), auto_size_text=False, justification='right'), sg.InputText('Source'), + sg.FolderBrowse()], +[sg.Text('Destination Folder', size=(15, 1), auto_size_text=False, justification='right'), sg.InputText('Dest'), + sg.FolderBrowse()], +[sg.Submit(), sg.Cancel(), sg.Button('Customized', button_color=('white', 'green'))]] + +event, values = sg.Window('Everything bagel', layout, auto_size_text=True, default_element_size=(40, 1)).Read() ``` ---- -### Design Goals +--- +### Design Goals -> Copy, Paste, Run. +> Copy, Paste, Run. -`PySimpleGUI's` goal with the API is to be easy on the programmer, and to function in a Python-like way. Since GUIs are visual, it was desirable for the code to visually match what's on the screen. By providing a significant amount of documentation and an easy to use Cookbook, it's possible to see your first GUI within 5 minutes of beginning the installation. +`PySimpleGUI's` goal with the API is to be easy on the programmer, and to function in a Python-like way. Since GUIs are visual, it was desirable for the code to visually match what's on the screen. By providing a significant amount of documentation and an easy to use Cookbook, it's possible to see your first GUI within 5 minutes of beginning the installation. -> Be Pythonic +> Be Pythonic -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. +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. -- 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 -- The SDK calls collapse down into a single line of Python code that presents a custom GUI and returns values -- Linear programming instead of callbacks +- 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 +- The SDK calls collapse down into a single line of Python code that presents a custom GUI and returns values +- Linear programming instead of callbacks -#### Lofty Goals +#### Lofty Goals -> Change Python +> Change Python -The hope is not that ***this*** package will become part of the Python Standard Library. +The hope is not that ***this*** package will become part of the Python Standard Library. -The hope is that Python will become ***the*** go-to language for creating GUI programs that run on Windows, Mac, and Linux *for all levels of developer*. +The hope is that Python will become ***the*** go-to language for creating GUI programs that run on Windows, Mac, and Linux *for all levels of developer*. -The hope is that beginners that are interested in graphic design will have an easy way to express themselves, right from the start of their Python experience. +The hope is that beginners that are interested in graphic design will have an easy way to express themselves, right from the start of their Python experience. -There is a noticeable gap in the Python GUI solution. Fill that gap and who knows what will happen. +There is a noticeable gap in the Python GUI solution. Fill that gap and who knows what will happen. -Maybe there's no "there there". ***Or*** maybe a simple GUI API will enable Python to dominate yet another computing discipline like it has so many others. This is my attempt to find out. +Maybe there's no "there there". ***Or*** maybe a simple GUI API will enable Python to dominate yet another computing discipline like it has so many others. This is my attempt to find out. -# Getting Started with PySimpleGUI +# Getting Started with PySimpleGUI ## Installing PySimpleGUI -### Installing Python 3 +### Installing Python 3 `pip install --upgrade PySimpleGUI` -On some systems you need to run pip3. +On some systems you need to run pip3. `pip3 install --upgrade PySimpleGUI` -On a Raspberry Pi, this is should work: +On a Raspberry Pi, this is should work: `sudo pip3 install --upgrade pysimplegui` -Some users have found that upgrading required using an extra flag on the pip `--no-cache-dir`. +Some users have found that upgrading required using an extra flag on the pip `--no-cache-dir`. -`pip install --upgrade --no-cache-dir` +`pip install --upgrade --no-cache-dir` -On some versions of Linux you will need to first install pip. Need the Chicken before you can get the Egg (get it... Egg?) +On some versions of Linux you will need to first install pip. Need the Chicken before you can get the Egg (get it... Egg?) `sudo apt install python3-pip` -If for some reason you are unable to install using `pip`, don't worry, you can still import PySimpleGUI by downloading the file PySimleGUI.py and placing it in your folder along with the application that is importing it. +If for some reason you are unable to install using `pip`, don't worry, you can still import PySimpleGUI by downloading the file PySimleGUI.py and placing it in your folder along with the application that is importing it. -`tkinter` is a requirement for PySimpleGUI (the only requirement). Some OS variants, such as Ubuntu, do not some with `tkinter` already installed. If you get an error similar to: +`tkinter` is a requirement for PySimpleGUI (the only requirement). Some OS variants, such as Ubuntu, do not some with `tkinter` already installed. If you get an error similar to: `ImportError: No module named tkinter` -then you need to install `tkinter`. +then you need to install `tkinter`. For python 2.7 @@ -429,31 +401,31 @@ For python 3 More information about installing tkinter can be found here: https://www.techinfected.net/2015/09/how-to-install-and-use-tkinter-in-ubuntu-debian-linux-mint.html -### Installing for Python 2.7 +### Installing for Python 2.7 -`pip install --upgrade PySimpleGUI27` -or -`pip2 install --upgrade PySimpleGUI27` +`pip install --upgrade PySimpleGUI27` +or +`pip2 install --upgrade PySimpleGUI27` -You may need to also install "future" for version 2.7 +You may need to also install "future" for version 2.7 `pip install future` -or +or `pip2 install future` -Python 2.7 support is relatively new and the bugs are still being worked out. I'm unsure what may need to be done to install tkinter for Python 2.7. Will update this readme when more info is available +Python 2.7 support is relatively new and the bugs are still being worked out. I'm unsure what may need to be done to install tkinter for Python 2.7. Will update this readme when more info is available -Like above, you may have to install either pip or tkinter. To do this on Python 2.7: +Like above, you may have to install either pip or tkinter. To do this on Python 2.7: -`sudo apt install python-pip` +`sudo apt install python-pip` -`sudo apt install python-tkinter` +`sudo apt install python-tkinter` -### Testing your installation +### Testing your installation -Once you have installed, or copied the .py file to your app folder, you can test the installation using python. At the command prompt start up Python. +Once you have installed, or copied the .py file to your app folder, you can test the installation using python. At the command prompt start up Python. -#### Instructions for Python 2.7: +#### Instructions for Python 2.7: ```python >>> import PySimpleGUI27 >>> PySimpleGUI27.main() @@ -470,19 +442,19 @@ You will see a sample window in the center of your screen. If it's not installe Here is the window you should see: -![sample window](https://user-images.githubusercontent.com/13696193/46097669-79efa500-c190-11e8-885c-e5d4d5d09ea6.jpg) +![sample window](https://user-images.githubusercontent.com/13696193/46097669-79efa500-c190-11e8-885c-e5d4d5d09ea6.jpg) -### Prerequisites -Python 2.7 or Python 3 -tkinter +### Prerequisites +Python 2.7 or Python 3 +tkinter -PySimpleGUI Runs on all Python3 platforms that have tkinter running on them. It has been tested on Windows, Mac, Linux, Raspberry Pi. Even runs on `pypy3`. +PySimpleGUI Runs on all Python3 platforms that have tkinter running on them. It has been tested on Windows, Mac, Linux, Raspberry Pi. Even runs on `pypy3`. ### EXE file creation -If you wish to create an EXE from your PySimpleGUI application, you will need to install `PyInstaller`. There are instructions on how to create an EXE at the bottom of this ReadMe +If you wish to create an EXE from your PySimpleGUI application, you will need to install `PyInstaller`. There are instructions on how to create an EXE at the bottom of this ReadMe ## Using - Python 3 @@ -490,55 +462,55 @@ 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 windows. +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) +![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 window 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. -## Using - Python 2.7 +## Using - Python 2.7 -Those using Python 2.7 will import a different module name -`import PySimpleGUI27 as sg` +Those using Python 2.7 will import a different module name +`import PySimpleGUI27 as sg` -## Code Samples Assume Python 3 +## Code Samples Assume Python 3 -While all of the code examples you will see in this Readme and the Cookbook assume Python 3 and thus have an `import PySimpleGUI` at the top, you can run ***all*** of this code on Python 2.7 by changing the import statement to `import PySimpleGUI27` +While all of the code examples you will see in this Readme and the Cookbook assume Python 3 and thus have an `import PySimpleGUI` at the top, you can run ***all*** of this code on Python 2.7 by changing the import statement to `import PySimpleGUI27` ---- -# APIs +--- +# APIs -PySimpleGUI can be broken down into 2 types of API's: -* High Level single call functions (The `Popup` calls) -* Custom window functions +PySimpleGUI can be broken down into 2 types of API's: +* High Level single call functions (The `Popup` calls) +* Custom window functions -### Python Language Features +### Python Language Features -There are a number of Python language features that PySimpleGUI utilizes heavily for API access that should be understood... -* Variable number of arguments to a function call -* Optional parameters to a function call -* Dictionaries +There are a number of Python language features that PySimpleGUI utilizes heavily for API access that should be understood... +* Variable number of arguments to a function call +* Optional parameters to a function call +* Dictionaries -#### Variable Number of Arguments +#### Variable Number of Arguments -The "High Level" API calls that *output* values take a variable number of arguments so that they match a "print" statement as much as possible. The idea is to make it simple for the programmer to output as many items as desired and in any format. The user need not convert the variables to be output into the strings. The PySimpleGUI functions do that for the user. +The "High Level" API calls that *output* values take a variable number of arguments so that they match a "print" statement as much as possible. The idea is to make it simple for the programmer to output as many items as desired and in any format. The user need not convert the variables to be output into the strings. The PySimpleGUI functions do that for the user. -sg.Popup('Variable number of parameters example', var1, var2, "etc") +sg.Popup('Variable number of parameters example', var1, var2, "etc") -Each new item begins on a new line in the Popup +Each new item begins on a new line in the Popup -![snap0179](https://user-images.githubusercontent.com/13696193/43658129-f6ca49c6-9725-11e8-9317-1f77443eb04a.jpg) +![snap0179](https://user-images.githubusercontent.com/13696193/43658129-f6ca49c6-9725-11e8-9317-1f77443eb04a.jpg) -#### Optional Parameters to a Function Call +#### Optional Parameters to a Function Call -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. +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. +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. ```python def Popup(*args, @@ -548,123 +520,115 @@ def Popup(*args, auto_close_duration=None, icon=DEFAULT_WINDOW_ICON, line_width=MESSAGE_BOX_LINE_WIDTH, - font=None): + font=None): ``` - -If the caller wanted to change the button color to be black on yellow, the call would look something like this: + +If the caller wanted to change the button color to be black on yellow, the call would look something like this: `sg.Popup('This box has a custom button color', button_color=('black', 'yellow'))` -![snap0180](https://user-images.githubusercontent.com/13696193/43658171-13a72bfe-9726-11e8-8c7a-0a46e46fb202.jpg) +![snap0180](https://user-images.githubusercontent.com/13696193/43658171-13a72bfe-9726-11e8-8c7a-0a46e46fb202.jpg) -#### Dictionaries +#### 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 window is read -2. To identify Elements so that they can be "updated" +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 window is read +2. To identify Elements so that they can be "updated" ---- +--- +# High Level API Calls - Popup's +"High level calls" are those that start with "Popup". They are the most basic form of communications with the user. They are named after the type of window they create, a pop-up window. These windows are meant to be short lived while, either delivering information or collecting it, and then quickly disappearing. +## Popup Output +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. -# High Level API Calls - Popup's +`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. -"High level calls" are those that start with "Popup". They are the most basic form of communications with the user. They are named after the type of window they create, a pop-up window. These windows are meant to be short lived while, either delivering information or collecting it, and then quickly disappearing. +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. -## Popup Output - -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 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. - -There are a number of Popup output calls, each with a slightly different look (e.g. different button labels). +There are a number of Popup output calls, each with a slightly different look (e.g. different button labels). The list of Popup output functions are: -- Popup -- PopupOk -- PopupYesNo -- PopupCancel -- PopupOkCancel -- PopupError -- PopupTimed, PopupAutoClose -- PopupNoWait, PopupNonBlocking +- Popup +- PopupOk +- PopupYesNo +- PopupCancel +- PopupOkCancel +- PopupError +- PopupTimed, PopupAutoClose +- PopupNoWait, PopupNonBlocking -The trailing portion of the function name after Popup indicates what buttons are shown. `PopupYesNo` shows a pair of button with Yes and No on them. `PopupCancel` has a Cancel button, etc. +The trailing portion of the function name after Popup indicates what buttons are shown. `PopupYesNo` shows a pair of button with Yes and No on them. `PopupCancel` has a Cancel button, etc. -While these are "output" windows, they do collect input in the form of buttons. The Popup functions return the button that was clicked. If the Ok button was clicked, then Popup returns the string 'Ok'. If the user clicked the X button to close the window, then the button value returned is `None`. +While these are "output" windows, they do collect input in the form of buttons. The Popup functions return the button that was clicked. If the Ok button was clicked, then Popup returns the string 'Ok'. If the user clicked the X button to close the window, then the button value returned is `None`. -The function `PopupTimed` or `PopupAutoClose` are popup windows that will automatically close after come period of time. +The function `PopupTimed` or `PopupAutoClose` are popup windows that will automatically close after come period of time. Here is a quick-reference showing how the Popup calls look. ``` -sg.Popup('Popup') - Shows OK button -sg.PopupOk('PopupOk') - Shows OK button -sg.PopupYesNo('PopupYesNo') - Shows Yes and No buttons -sg.PopupCancel('PopupCancel') - Shows Cancelled button -sg.PopupOKCancel('PopupOKCancel') - Shows OK and Cancel buttons -sg.PopupError('PopupError') - Shows red error button -sg.PopupTimed('PopupTimed') - Automatically closes -sg.PopupAutoClose('PopupAutoClose') - Same as PopupTimed +sg.Popup('Popup') - Shows OK button +sg.PopupOk('PopupOk') - Shows OK button +sg.PopupYesNo('PopupYesNo') - Shows Yes and No buttons +sg.PopupCancel('PopupCancel') - Shows Cancelled button +sg.PopupOKCancel('PopupOKCancel') - Shows OK and Cancel buttons +sg.PopupError('PopupError') - Shows red error button +sg.PopupTimed('PopupTimed') - Automatically closes +sg.PopupAutoClose('PopupAutoClose') - Same as PopupTimed ``` -Preview of popups: - -

- - - -

- -

- - - - -

+|Name|Image| +|-|-| +| Popup | ![snap0256](https://user-images.githubusercontent.com/13696193/44957394-1380ab00-aea0-11e8-98b1-1ab7d7bd5b37.jpg) | +| PopupOk | ![snap0257](https://user-images.githubusercontent.com/13696193/44957400-167b9b80-aea0-11e8-9d42-2314f24e62de.jpg) | +| PopupYesNo | ![snap0258](https://user-images.githubusercontent.com/13696193/44957399-154a6e80-aea0-11e8-9580-e716f839d400.jpg) | +| PopupCancel | ![snap0259](https://user-images.githubusercontent.com/13696193/44957398-14b1d800-aea0-11e8-9e88-c2b36a248447.jpg) | +| PopupOKCancel | ![snap0260](https://user-images.githubusercontent.com/13696193/44957397-14b1d800-aea0-11e8-950b-6d0b4f33841a.jpg) | +| PopupError | ![snap0261](https://user-images.githubusercontent.com/13696193/44957396-14194180-aea0-11e8-8eef-bb2e1193ecfa.jpg) | +| PopupTimed | ![snap0264](https://user-images.githubusercontent.com/13696193/44957595-9e15da00-aea1-11e8-8909-6b6121b74509.jpg) | +||| ``` -Popup(*args, Variable number of arguments you want to display - button_color=None, Color of buttons (text_color, background_color) - background_color=None, Color of background - text_color=None, Color of text - button_type=POPUP_BUTTONS_OK, Type of button layout - auto_close=False, If True window will automatically close - auto_close_duration=None, Number of seconds for autoclose - non_blocking=False, If True returns immediately - icon=DEFAULT_WINDOW_ICON, Icon to use on the taskbar - line_width=None, Width of lines in characters - font=None, Font to use for characters - no_titlebar=False, If True no titlebar will be shown - grab_anywhere=False, If True can move window by grabbing anywhere - keep_on_top=False, If True window will be on top of other windows - location=(None,None)): (x,y) coordinates to show the window +Popup(*args, Variable number of arguments you want to display + button_color=None, Color of buttons (text_color, background_color) + background_color=None, Color of background + text_color=None, Color of text + button_type=POPUP_BUTTONS_OK, Type of button layout + auto_close=False, If True window will automatically close + auto_close_duration=None, Number of seconds for autoclose + non_blocking=False, If True returns immediately + icon=DEFAULT_WINDOW_ICON, Icon to use on the taskbar + line_width=None, Width of lines in characters + font=None, Font to use for characters + no_titlebar=False, If True no titlebar will be shown + grab_anywhere=False, If True can move window by grabbing anywhere + keep_on_top=False, If True window will be on top of other windows + location=(None,None)): (x,y) coordinates to show the window ``` -The other output Popups are variations on parameters. Usually the button_type parameter is the primary one changed. +The other output Popups are variations on parameters. Usually the button_type parameter is the primary one changed. -The choices for button_type are: -``` -POPUP_BUTTONS_YES_NO -POPUP_BUTTONS_CANCELLED -POPUP_BUTTONS_ERROR -POPUP_BUTTONS_OK_CANCEL -POPUP_BUTTONS_OK -POPUP_BUTTONS_NO_BUTTONS -``` -Note that you should not call Popup yourself with different button_types. Rely on the Popup function named that sets that value for you. For example PopupYesNo will set the button type to POPUP_BUTTONS_YES_NO for you. +The choices for button_type are: +``` +POPUP_BUTTONS_YES_NO +POPUP_BUTTONS_CANCELLED +POPUP_BUTTONS_ERROR +POPUP_BUTTONS_OK_CANCEL +POPUP_BUTTONS_OK +POPUP_BUTTONS_NO_BUTTONS +``` +Note that you should not call Popup yourself with different button_types. Rely on the Popup function named that sets that value for you. For example PopupYesNo will set the button type to POPUP_BUTTONS_YES_NO for you. -#### Scrolled Output -There is a scrolled version of Popups should you have a lot of information to display. +#### Scrolled Output +There is a scrolled version of Popups should you have a lot of information to display. ```python PopupScrolled(*args, button_color=None, yes_no=False, auto_close=False, auto_close_duration=None, size=(None, None), location=(None, None), title=None, non_blocking=False) -``` +``` Typical usage: ```python @@ -672,138 +636,138 @@ sg.PopupScrolled(my_text) ``` -![scrolledtextbox 2](https://user-images.githubusercontent.com/13696193/43667324-712aa0d4-9745-11e8-83a9-a0d0570d0865.jpg) +![scrolledtextbox 2](https://user-images.githubusercontent.com/13696193/43667324-712aa0d4-9745-11e8-83a9-a0d0570d0865.jpg) -The `PopupScrolled` will auto-fit the window size to the size of the text. Specify `None` in the height field of a `size` parameter to get auto-sized height. +The `PopupScrolled` will auto-fit the window size to the size of the text. Specify `None` in the height field of a `size` parameter to get auto-sized height. -This call will create a scrolled box 80 characters wide and a height dependent upon the number of lines of text. +This call will create a scrolled box 80 characters wide and a height dependent upon the number of lines of text. -sg.PopupScrolled(my_text, size=(80, None)) +sg.PopupScrolled(my_text, size=(80, None)) -Note that the default max number of lines before scrolling happens is set to 50. At 50 lines the scrolling will begin. +Note that the default max number of lines before scrolling happens is set to 50. At 50 lines the scrolling will begin. If `non_blocking` parameter is set, then the call will not blocking waiting for the user to close the window. Execution will immediately return to the user. Handy when you want to dump out debug info without disrupting the program flow. -### PopupNoWait +### PopupNoWait -The Popup call PopupNoWait or PopupNonBlocking will create a popup window and then immediately return control back to you. All other popup functions will block, waiting for the user to close the popup window. +The Popup call PopupNoWait or PopupNonBlocking will create a popup window and then immediately return control back to you. All other popup functions will block, waiting for the user to close the popup window. -This function is very handy for when you're **debugging** and want to display something as output but don't want to change the programs's overall timing by blocking. Think of it like a `print` statement. There are no return values on one of these Popups. +This function is very handy for when you're **debugging** and want to display something as output but don't want to change the programs's overall timing by blocking. Think of it like a `print` statement. There are no return values on one of these Popups. -## Popup Input +## Popup Input -There are Popup calls for single-item inputs. These follow the pattern of `Popup` followed by `Get` and then the type of item to get. There are 3 of these input Popups to choose from, each with settings enabling customization. +There are Popup calls for single-item inputs. These follow the pattern of `Popup` followed by `Get` and then the type of item to get. There are 3 of these input Popups to choose from, each with settings enabling customization. -- `PopupGetText` - get a single line of text -- `PopupGetFile` - get a filename -- `PopupGetFolder` - get a folder name +- `PopupGetText` - get a single line of text +- `PopupGetFile` - get a filename +- `PopupGetFolder` - get a folder name -Use these Popups instead of making a custom window to get one data value, call the Popup input function to get the item from the user. If you find the parameters are unable to create the kind of window you are looking for, then it's time for you to create your own window. +Use these Popups instead of making a custom window to get one data value, call the Popup input function to get the item from the user. If you find the parameters are unable to create the kind of window you are looking for, then it's time for you to create your own window. -### PopupGetText +### PopupGetText -Use this Popup to get a line of text from the user. +Use this Popup to get a line of text from the user. ``` -PopupGetText(message,The message you wish to display with the input field - default_text='', Text to initially fill into the input field - password_char='', Passwork character if this is a password field - size=(None,None), Size of the window - button_color=None, Color to use for buttons (foreground, background) - background_color=None, Background color for window - text_color=None, Text color for window - icon=DEFAULT_WINDOW_ICON, Icon to display on taskbar - font=None, Font to use for text - no_titlebar=False, If True no titlebar will be shown - grab_anywhere=False, If True can grab anywhere to move the window - keep_on_top=False, If True window will stay on top of other windows - location=(None,None)) Location on screen to display window +PopupGetText(message,The message you wish to display with the input field + default_text='', Text to initially fill into the input field + password_char='', Passwork character if this is a password field + size=(None,None), Size of the window + button_color=None, Color to use for buttons (foreground, background) + background_color=None, Background color for window + text_color=None, Text color for window + icon=DEFAULT_WINDOW_ICON, Icon to display on taskbar + font=None, Font to use for text + no_titlebar=False, If True no titlebar will be shown + grab_anywhere=False, If True can grab anywhere to move the window + keep_on_top=False, If True window will stay on top of other windows + location=(None,None)) Location on screen to display window ``` ```python -import PySimpleGUI as sg +import PySimpleGUI as sg -text = sg.PopupGetText('Title', 'Please input something') -sg.Popup('Results', 'The value returned from PopupGetText', text) +text = sg.PopupGetText('Title', 'Please input something') +sg.Popup('Results', 'The value returned from PopupGetText', text) ``` -![popupgettext](https://user-images.githubusercontent.com/13696193/44957281-8721b880-ae9e-11e8-98cd-d06369f4187e.jpg) +![popupgettext](https://user-images.githubusercontent.com/13696193/44957281-8721b880-ae9e-11e8-98cd-d06369f4187e.jpg) -![popup gettext response](https://user-images.githubusercontent.com/13696193/44957282-8721b880-ae9e-11e8-84ae-dc8bb30504a0.jpg) +![popup gettext response](https://user-images.githubusercontent.com/13696193/44957282-8721b880-ae9e-11e8-84ae-dc8bb30504a0.jpg) -### PopupGetFile +### PopupGetFile -Gets a filename from the user. There are options to configure the type of dialog box to show. Normally an "Open File" dialog box is shown +Gets a filename from the user. There are options to configure the type of dialog box to show. Normally an "Open File" dialog box is shown ``` -PopupGetFile(message, Message to show in the window - default_path='', Path browsing should start from - default_extension='', Which filetype is the default - save_as=False, Determines which dialog box stype to show - file_types=(("ALL Files", "*.*"),), Which filetypes are displayed - no_window=False, if True no window is displayed except the dialog box - size=(None,None), Size of window - button_color=None, Color of buttons - background_color=None, Color of window background - text_color=None, Color of text in window - icon=DEFAULT_WINDOW_ICON, Icon to show on taskbar - font=None, Font to use - no_titlebar=False, If True does not display a titlebar - grab_anywhere=False, if True can grab window anywhere to move it - keep_on_top=False, if True window will be on top of others - location=(None,None)) Location on screen to show window -``` +PopupGetFile(message, Message to show in the window + default_path='', Path browsing should start from + default_extension='', Which filetype is the default + save_as=False, Determines which dialog box stype to show + file_types=(("ALL Files", "*.*"),), Which filetypes are displayed + no_window=False, if True no window is displayed except the dialog box + size=(None,None), Size of window + button_color=None, Color of buttons + background_color=None, Color of window background + text_color=None, Color of text in window + icon=DEFAULT_WINDOW_ICON, Icon to show on taskbar + font=None, Font to use + no_titlebar=False, If True does not display a titlebar + grab_anywhere=False, if True can grab window anywhere to move it + keep_on_top=False, if True window will be on top of others + location=(None,None)) Location on screen to show window +``` -If configured as an Open File Popup then (save_as is not True) the dialog box will look like this +If configured as an Open File Popup then (save_as is not True) the dialog box will look like this -![snag-0060](https://user-images.githubusercontent.com/13696193/46761050-9831c680-cca1-11e8-8de9-68b15efe2c46.jpg) +![snag-0060](https://user-images.githubusercontent.com/13696193/46761050-9831c680-cca1-11e8-8de9-68b15efe2c46.jpg) -If you set the parameter save_As to True, then the dialog box looks like this: +If you set the parameter save_As to True, then the dialog box looks like this: -![snag-0061](https://user-images.githubusercontent.com/13696193/46761330-2b6afc00-cca2-11e8-953b-f6b5c5ce57f5.jpg) +![snag-0061](https://user-images.githubusercontent.com/13696193/46761330-2b6afc00-cca2-11e8-953b-f6b5c5ce57f5.jpg) -If you choose a filename that already exists, you'll get a warning popup box asking if it's OK. You can also specify a file that doesn't exist. With an "Open" dialog box you cannot choose a non-existing file. +If you choose a filename that already exists, you'll get a warning popup box asking if it's OK. You can also specify a file that doesn't exist. With an "Open" dialog box you cannot choose a non-existing file. -A typical call produces this window. +A typical call produces this window. ```python -text = sg.PopupGetFile('Please enter a file name') -sg.Popup('Results', 'The value returned from PopupGetFile', text) +text = sg.PopupGetFile('Please enter a file name') +sg.Popup('Results', 'The value returned from PopupGetFile', text) ``` -![popupgetfile](https://user-images.githubusercontent.com/13696193/44957857-2fd31680-aea5-11e8-8eb7-f6b91c202cc8.jpg) +![popupgetfile](https://user-images.githubusercontent.com/13696193/44957857-2fd31680-aea5-11e8-8eb7-f6b91c202cc8.jpg) -### PopupGetFolder +### PopupGetFolder -The window created to get a folder name looks the same as the get a file name. The difference is in what the browse button does. `PopupGetFile` shows an Open File dialog box while `PopupGetFolder` shows an Open Folder dialog box. +The window created to get a folder name looks the same as the get a file name. The difference is in what the browse button does. `PopupGetFile` shows an Open File dialog box while `PopupGetFolder` shows an Open Folder dialog box. -``` -PopupGetFolder(message, Message to display in window - default_path='', Path to start browsing - no_window=False, If True no window will be shown - size=(None,None), Size of window - button_color=None, Color of buttons - background_color=None, Background color of window - text_color=None, Color of window text - icon=DEFAULT_WINDOW_ICON, Icon to show on taskbar - font=None, Font to use for window - no_titlebar=False, If True no titlebar will be shown - grab_anywhere=False, If True can grab anywhere on window to move - keep_on_top=False, If True window will be on top - location=(None, None)) Location on screen to create window -``` +``` +PopupGetFolder(message, Message to display in window + default_path='', Path to start browsing + no_window=False, If True no window will be shown + size=(None,None), Size of window + button_color=None, Color of buttons + background_color=None, Background color of window + text_color=None, Color of window text + icon=DEFAULT_WINDOW_ICON, Icon to show on taskbar + font=None, Font to use for window + no_titlebar=False, If True no titlebar will be shown + grab_anywhere=False, If True can grab anywhere on window to move + keep_on_top=False, If True window will be on top + location=(None, None)) Location on screen to create window +``` -This is a typpical call +This is a typpical call ```python - text = sg.PopupGetFolder('Please enter a folder name') - sg.Popup('Results', 'The value returned from PopupGetFolder', text) + text = sg.PopupGetFolder('Please enter a folder name') + sg.Popup('Results', 'The value returned from PopupGetFolder', text) ``` -![popupgetfolder](https://user-images.githubusercontent.com/13696193/44957861-45484080-aea5-11e8-926c-cf607a45251c.jpg) +![popupgetfolder](https://user-images.githubusercontent.com/13696193/44957861-45484080-aea5-11e8-926c-cf607a45251c.jpg) ### PopupAnimated @@ -813,259 +777,259 @@ This is a typpical call The animated Popup enables you to easily display a "loading" style animation specified through a GIF file that is either stored in a file or a base64 variable. ```python -def PopupAnimated(image_source, +def PopupAnimated(image_source, message=None, - background_color=None, - text_color=None, - font=None, - no_titlebar=True, - grab_anywhere=True, - keep_on_top=True, - location=(None, None), + background_color=None, + text_color=None, + font=None, + no_titlebar=True, + grab_anywhere=True, + keep_on_top=True, + location=(None, None), alpha_channel=.8, time_between_frames=0) ``` | name | meaning | |-|-| -|image_source | The GIF file specified as a string filename or a base64 variable | -|message | optional text message to be displayed under the animation | -|background_color | the background color to use for the window and all of the other parts of the window | -|text_color | color to use for optional text | -|font | font to use for the optional text | -|no_titlebar | no titlebar window setting | -|location | location to show the window | -|alpha_channel | alpha channel to use for the window | -|time_between_frames | amount of time in milliseconds to use between frames | +|image_source | The GIF file specified as a string filename or a base64 variable | +|message | optional text message to be displayed under the animation | +|background_color | the background color to use for the window and all of the other parts of the window | +|text_color | color to use for optional text | +|font | font to use for the optional text | +|no_titlebar | no titlebar window setting | +|location | location to show the window | +|alpha_channel | alpha channel to use for the window | +|time_between_frames | amount of time in milliseconds to use between frames | ||| ***To close animated popups***, call PopupAnimated with `image_source=None`. This will close all of the currently open PopupAnimated windows. -# Progress Meters! -We all have loops in our code. 'Isn't it joyful waiting, watching a counter scrolling past in a text window? How about one line of code to get a progress meter, that contains statistics about your code? +# Progress Meters! +We all have loops in our code. 'Isn't it joyful waiting, watching a counter scrolling past in a text window? How about one line of code to get a progress meter, that contains statistics about your code? ``` -OneLineProgressMeter(title, - current_value, - max_value, - key, - *args, - orientation=None, - bar_color=DEFAULT_PROGRESS_BAR_COLOR, - button_color=None, - size=DEFAULT_PROGRESS_BAR_SIZE, - border_width=DEFAULT_PROGRESS_BAR_BORDER_WIDTH): +OneLineProgressMeter(title, + current_value, + max_value, + key, + *args, + orientation=None, + bar_color=DEFAULT_PROGRESS_BAR_COLOR, + button_color=None, + size=DEFAULT_PROGRESS_BAR_SIZE, + border_width=DEFAULT_PROGRESS_BAR_BORDER_WIDTH): ``` - -Here's the one-line Progress Meter in action! + +Here's the one-line Progress Meter in action! ```python -for i in range(1,10000): - sg.OneLineProgressMeter('My Meter', i+1, 10000, 'key','Optional message') +for i in range(1,10000): + sg.OneLineProgressMeter('My Meter', i+1, 10000, 'key','Optional message') ``` -That line of code resulted in this window popping up and updating. +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 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. + +# Debug Output +Another call in the 'Easy' families of APIs is `EasyPrint`. It will output to a debug window. If the debug window isn't open, then the first call will open it. No need to do anything but stick a 'print' call in your code. You can even replace your 'print' calls with calls to EasyPrint by simply sticking the statement + +```python +print = sg.EasyPrint +``` + +at the top of your code. -![preogress meter](https://user-images.githubusercontent.com/13696193/43667625-d47da702-9746-11e8-91e6-e5177883abae.jpg) +There are a number of names for the same EasyPrint function. `Print` is one of the better ones to use as it's easy to remember. It is simply `print` with a capital P. + +```python +import PySimpleGUI as sg + +for i in range(100): + sg.Print(i) +``` -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 window. The cancel button results in a `False` return value from `OneLineProgressMeter`. It normally returns `True`. +![snap0125](https://user-images.githubusercontent.com/13696193/43114979-a696189e-8ecf-11e8-83c7-473fcf0ccc66.jpg) -***Be sure and add one to your loop counter*** so that your counter goes from 1 to the max value. If you do not add one, your counter will never hit the max value. Instead it will go from 0 to max-1. - -# Debug Output -Another call in the 'Easy' families of APIs is `EasyPrint`. It will output to a debug window. If the debug window isn't open, then the first call will open it. No need to do anything but stick a 'print' call in your code. You can even replace your 'print' calls with calls to EasyPrint by simply sticking the statement +Or if you didn't want to change your code: ```python -print = sg.EasyPrint +import PySimpleGUI as sg + +print=sg.Print +for i in range(100): +print(i) ``` -at the top of your code. +Just like the standard print call, `EasyPrint` supports the `sep` and `end` keyword arguments. Other names that can be used to call `EasyPrint` include `Print`, `eprint`, If you want to close the window, call the function `EasyPrintClose`. -There are a number of names for the same EasyPrint function. `Print` is one of the better ones to use as it's easy to remember. It is simply `print` with a capital P. - -```python -import PySimpleGUI as sg - -for i in range(100): - sg.Print(i) -``` - -![snap0125](https://user-images.githubusercontent.com/13696193/43114979-a696189e-8ecf-11e8-83c7-473fcf0ccc66.jpg) - -Or if you didn't want to change your code: - -```python -import PySimpleGUI as sg - -print=sg.Print -for i in range(100): -print(i) -``` - -Just like the standard print call, `EasyPrint` supports the `sep` and `end` keyword arguments. Other names that can be used to call `EasyPrint` include `Print`, `eprint`, If you want to close the window, call the function `EasyPrintClose`. - -You can change the size of the debug window using the `SetOptions` call with the `debug_win_size` parameter. +You can change the size of the debug window using the `SetOptions` call with the `debug_win_size` parameter. There is an option to tell PySimpleGUI to reroute all of your stdout and stderr output to this window. To do so call EasyPrint with the parameter `do_not_reroute_stdout` set to True. After calling it once with this parameter set to True, all future calls to a normal`print` will go to the debug window. If you close the debug window it will re-open the next time you Print to it. ---- -# Custom window API Calls (Your First window) +--- +# 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 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 windows is for your typical, blocking, non-persistent 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. +This first section on custom windows is for your typical, blocking, non-persistent 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 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. +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. +It's both not enjoyable nor helpful to immediately jump into tweaking each and every little thing available to you. -## The window Designer +## 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, no downloads, and everyone knows how to use it. +The good news to newcomers to GUI programming is that PySimpleGUI has a window designer. Better yet, the window designer requires no training, no downloads, and everyone knows how to use it. -![gui0_1](https://user-images.githubusercontent.com/13696193/44159598-e2257400-a085-11e8-9b02-343e72cc75c3.JPG) +![gui0_1](https://user-images.githubusercontent.com/13696193/44159598-e2257400-a085-11e8-9b02-343e72cc75c3.JPG) -It's a manual process, but if you follow the instructions, it will take only a minute to do and the result will be a nice looking GUI. The steps you'll take are: -1. Sketch your GUI on paper -2. Divide your GUI up into rows -3. Label each Element with the Element name -4. Write your Python code using the labels as pseudo-code +It's a manual process, but if you follow the instructions, it will take only a minute to do and the result will be a nice looking GUI. The steps you'll take are: +1. Sketch your GUI on paper +2. Divide your GUI up into rows +3. Label each Element with the Element name +4. Write your Python code using the labels as pseudo-code -Let's take a couple of examples. +Let's take a couple of examples. -**Enter a number**.... Popular beginner programs are often based on a game or logic puzzle that requires the user to enter something, like a number. The "high-low" answer game comes to mind where you try to guess the number based on high or low tips. +**Enter a number**.... Popular beginner programs are often based on a game or logic puzzle that requires the user to enter something, like a number. The "high-low" answer game comes to mind where you try to guess the number based on high or low tips. -**Step 1- Sketch the GUI** -![gui1_1](https://user-images.githubusercontent.com/13696193/44160127-6a584900-a087-11e8-8fec-09099a8e16f6.JPG) +**Step 1- Sketch the GUI** +![gui1_1](https://user-images.githubusercontent.com/13696193/44160127-6a584900-a087-11e8-8fec-09099a8e16f6.JPG) -**Step 2 - Divide into rows** +**Step 2 - Divide into rows** -![gui2_1](https://user-images.githubusercontent.com/13696193/44160128-6a584900-a087-11e8-9973-af866fb94c56.JPG) +![gui2_1](https://user-images.githubusercontent.com/13696193/44160128-6a584900-a087-11e8-9973-af866fb94c56.JPG) -Step 3 - Label elements +Step 3 - Label elements -![gui6_1](https://user-images.githubusercontent.com/13696193/44160116-64626800-a087-11e8-8b57-671c0461b508.JPG) +![gui6_1](https://user-images.githubusercontent.com/13696193/44160116-64626800-a087-11e8-8b57-671c0461b508.JPG) -Step 4 - Write the code -The code we're writing is the layout of the GUI itself. This tutorial only focuses on getting the window code written, not the stuff to display it, get results. +Step 4 - Write the code +The code we're writing is the layout of the GUI itself. This tutorial only focuses on getting the window code written, not the stuff to display it, get results. -We have only 1 element on the first row, some text. Rows are written as a "list of elements", so we'll need [ ] to make a list. Here's the code for row 1 +We have only 1 element on the first row, some text. Rows are written as a "list of elements", so we'll need [ ] to make a list. Here's the code for row 1 ``` -[ sg.Text('Enter a number') ] +[ sg.Text('Enter a number') ] ``` - -Row 2 has 1 elements, an input field. + +Row 2 has 1 elements, an input field. ``` -[ sg.Input() ] +[ sg.Input() ] ``` -Row 3 has an OK button - +Row 3 has an OK button + ``` -[ sg.OK() ] +[ sg.OK() ] +``` + +Now that we've got the 3 rows defined, they are put into a list that represents the entire window. + +``` +layout = [ [sg.Text('Enter a Number')], + [sg.Input()], + [sg.OK()] ] ``` -Now that we've got the 3 rows defined, they are put into a list that represents the entire window. - -``` -layout = [ [sg.Text('Enter a Number')], - [sg.Input()], - [sg.OK()] ] -``` - -Finally we can put it all together into a program that will display our window. +Finally we can put it all together into a program that will display our window. ```python -import PySimpleGUI as sg - -layout = [[sg.Text('Enter a Number')], - [sg.Input()], - [sg.OK()] ] - -event, (number,) = sg.Window('Enter a number example', layout).Read() - -sg.Popup(event, number) +import PySimpleGUI as sg + +layout = [[sg.Text('Enter a Number')], + [sg.Input()], + [sg.OK()] ] + +event, (number,) = sg.Window('Enter a number example', layout).Read() + +sg.Popup(event, 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 window on paper, break it up into rows, label the elements. +### 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 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) +![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 window 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. ```python -import PySimpleGUI as sg - -layout = [[sg.Text('Filename')], - [sg.Input(), sg.FileBrowse()], - [sg.OK(), sg.Cancel()] ] - -event, (number,) = sg.Window('Get filename example', layout).Read() - -sg.Popup(event, number) +import PySimpleGUI as sg + +layout = [[sg.Text('Filename')], + [sg.Input(), sg.FileBrowse()], + [sg.OK(), sg.Cancel()] ] + +event, (number,) = sg.Window('Get filename example', layout).Read() + +sg.Popup(event, number) ``` -Read on for detailed instructions on the calls that show the window and return your results. +Read on for detailed instructions on the calls that show the window and return your results. -# Copy these design patterns! +# Copy these design patterns! -All of your PySimpleGUI programs will utilize one of these 2 design patterns depending on the type of window you're implementing. +All of your PySimpleGUI programs will utilize one of these 2 design patterns depending on the type of window you're implementing. -## Pattern 1 - "One-shot Window" - Read into list or dictionary (**The Most Common** Pattern) +## Pattern 1 - "One-shot Window" - Read into list or dictionary (**The Most Common** Pattern) This will be the most common pattern you'll follow if you are not using an "event loop" (not reading the window multiple times). The window is read and closes. -It's unusual to assign the values returned from the read call directly into user variables. Usually the variables are grouped together into a list or dictionary of multiple return values. +It's unusual to assign the values returned from the read call directly into user variables. Usually the variables are grouped together into a list or dictionary of multiple return values. -```python -import PySimpleGUI as sg - -window_rows = [[sg.Text('SHA-1 and SHA-256 Hashes for the file')], - [sg.InputText(), sg.FileBrowse()], - [sg.Submit(), sg.Cancel()]] - -window = sg.Window('SHA-1 & 256 Hash', window_rows) - -event, values = window.Read() +```python +import PySimpleGUI as sg + +window_rows = [[sg.Text('SHA-1 and SHA-256 Hashes for the file')], + [sg.InputText(), sg.FileBrowse()], + [sg.Submit(), sg.Cancel()]] + +window = sg.Window('SHA-1 & 256 Hash', window_rows) + +event, values = window.Read() window.Close() - -source_filename = values[0] + +source_filename = values[0] ``` -## Pattern 2 A - Persistent window (multiple reads using an event loop) +## Pattern 2 A - Persistent window (multiple reads using an event loop) -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. +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 code will present a window and will print values until the user clicks the exit button or closes window using an X. - -```python -import PySimpleGUI as sg - -layout = [[sg.Text('Persistent window')], - [sg.Input(do_not_clear=True)], - [sg.Button('Read'), sg.Exit()]] +This code will present a window and will print values until the user clicks the exit button or closes window using an X. +```python +import PySimpleGUI as sg + +layout = [[sg.Text('Persistent window')], + [sg.Input(do_not_clear=True)], + [sg.Button('Read'), sg.Exit()]] + window = sg.Window('Window that stays open', layout) - -while True: - event, values = window.Read() - if event is None or event == 'Exit': - break - print(event, values) + +while True: + event, values = window.Read() + if event is None or event == 'Exit': + break + print(event, values) window.Close() -``` +``` -## Pattern 2 B - Persistent window (multiple reads using an event loop + updates data in window) +## Pattern 2 B - Persistent window (multiple reads using an event loop + updates data in window) This is a slightly more complex, but maybe more realistic version that reads input from the user and displays that input as text in the window. Your program is likely to be doing both of those activities so this will give you a big jump-start. @@ -1074,25 +1038,25 @@ Do not worry yet what all of these statements mean. Just copy it so you can be A final note... the parameter `do_not_clear` in the input call determines the action of the input field after a button event. If this value is True, the input value remains visible following button clicks. If False, then the input field is CLEARED of whatever was input. If you are building a "Form" type of window with data entry, you likely want False, the default setting (you can remove the parameter completely). ```python -import sys -if sys.version_info[0] >= 3: - import PySimpleGUI as sg -else: - import PySimpleGUI27 as sg - -layout = [[sg.Text('Your typed chars appear here:'), sg.Text('', key='_OUTPUT_') ], - [sg.Input(do_not_clear=True, key='_IN_')], - [sg.Button('Show'), sg.Button('Exit')]] - -window = sg.Window('Window Title', layout) - -while True: # Event Loop - event, values = window.Read() +import sys +if sys.version_info[0] >= 3: + import PySimpleGUI as sg +else: + import PySimpleGUI27 as sg + +layout = [[sg.Text('Your typed chars appear here:'), sg.Text('', key='_OUTPUT_') ], + [sg.Input(do_not_clear=True, key='_IN_')], + [sg.Button('Show'), sg.Button('Exit')]] + +window = sg.Window('Window Title', layout) + +while True: # Event Loop + event, values = window.Read() print(event, values) - if event is None or event == 'Exit': - break - if event == 'Show': - # change the "output" element to be the value of "input" element + if event is None or event == 'Exit': + break + if event == 'Show': + # change the "output" element to be the value of "input" element window.Element('_OUTPUT_').Update(values['_IN_']) window.Close() @@ -1100,109 +1064,109 @@ window.Close() -## How GUI Programming in Python Should Look? At least for beginners ? +## How GUI Programming in Python Should Look? At least for beginners ? -While one goal was making it simple to create a GUI another just as important goal was to do it in a Pythonic manner. Whether it achieved these goals is debatable, but it was an attempt just the same. +While one goal was making it simple to create a GUI another just as important goal was to do it in a Pythonic manner. Whether it achieved these goals is debatable, but it was an attempt just the same. -The key to custom windows in PySimpleGUI is to view windows as ROWS of GUI Elements. Each row is specified as a list of these Elements. Put the rows together and you've got a window. This means the GUI is defined as a series of Lists, a Pythonic way of looking at things. +The key to custom windows in PySimpleGUI is to view windows as ROWS of GUI Elements. Each row is specified as a list of these Elements. Put the rows together and you've got a window. This means the GUI is defined as a series of Lists, a Pythonic way of looking at things. -Let's dissect this little program +Let's dissect this little program ```python -import PySimpleGUI as sg +import PySimpleGUI as sg + +layout = [[sg.Text('Rename files or folders')], + [sg.Text('Source for Folders', size=(15, 1)), sg.InputText(), sg.FolderBrowse()], + [sg.Text('Source for Files ', size=(15, 1)), sg.InputText(), sg.FolderBrowse()], + [sg.Submit(), sg.Cancel()]] + +window = sg.Window('Rename Files or Folders', layout) + +event, values = window.Read() +``` -layout = [[sg.Text('Rename files or folders')], - [sg.Text('Source for Folders', size=(15, 1)), sg.InputText(), sg.FolderBrowse()], - [sg.Text('Source for Files ', size=(15, 1)), sg.InputText(), sg.FolderBrowse()], - [sg.Submit(), sg.Cancel()]] -window = sg.Window('Rename Files or Folders', layout) +![snap0131](https://user-images.githubusercontent.com/13696193/43417007-df6d8408-9407-11e8-9986-30f0415f08a5.jpg) -event, values = window.Read() +Let's agree the window has 4 rows. + +The first row only has **text** that reads `Rename files or folders` + +The second row has 3 elements in it. First the **text** `Source for Folders`, then an **input** field, then a **browse** button. + +Now let's look at how those 2 rows and the other two row from Python code: + +```python +layout = [[sg.Text('Rename files or folders')], + [sg.Text('Source for Folders', size=(15, 1)), sg.InputText(), sg.FolderBrowse()], + [sg.Text('Source for Files ', size=(15, 1)), sg.InputText(), sg.FolderBrowse()], + [sg.Submit(), sg.Cancel()]] ``` +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. -![snap0131](https://user-images.githubusercontent.com/13696193/43417007-df6d8408-9407-11e8-9986-30f0415f08a5.jpg) +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. -Let's agree the window has 4 rows. +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. -The first row only has **text** that reads `Rename files or folders` +In our example window, there are 2 fields, so the return values from this window will be a list with 2 values in it. +```python +event, values = window.Read() +folder_path, file_path = values +``` -The second row has 3 elements in it. First the **text** `Source for Folders`, then an **input** field, then a **browse** button. +In one statement we both show the window and read the user's inputs. In the next the *list* of return values is split into individual variables `folder_path` and `file_path`. -Now let's look at how those 2 rows and the other two row from Python code: - -```python -layout = [[sg.Text('Rename files or folders')], - [sg.Text('Source for Folders', size=(15, 1)), sg.InputText(), sg.FolderBrowse()], - [sg.Text('Source for Files ', size=(15, 1)), sg.InputText(), sg.FolderBrowse()], - [sg.Submit(), sg.Cancel()]] -``` - -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 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 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 window, there are 2 fields, so the return values from this window will be a list with 2 values in it. -```python -event, values = window.Read() -folder_path, file_path = values -``` - -In one statement we both show the window and read the user's inputs. In the next the *list* of return values is split into individual variables `folder_path` and `file_path`. - -Isn't this what a 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? Most would choose 4. +Isn't this what a 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? Most would choose 4. -## Return values +## Return values -As of version 2.8 there are 2 forms of return values, list and dictionary. +As of version 2.8 there are 2 forms of return values, list and dictionary. -### Two Return Values +### Two Return Values -All Window Read calls return 2 values. By convention a read statement is written: -```python -event, values = window.Read() -``` +All Window Read calls return 2 values. By convention a read statement is written: +```python +event, values = window.Read() +``` -You don't HAVE to write your reads in this way. You can name your variables however you want. But if you want to code them in a way that other programmers using PySimpleGUI are used to, then use these statements. +You don't HAVE to write your reads in this way. You can name your variables however you want. But if you want to code them in a way that other programmers using PySimpleGUI are used to, then use these statements. ## Events -The first parameter `event` describes **why** the read completed. Events are one of these: +The first parameter `event` describes **why** the read completed. Events are one of these: -For all Windows: +For all Windows: -* Button click -* Window closed using X +* Button click +* Window closed using X -For Windows that have specifically enabled these. Please see the appropriate section in this document to learn about how to enable these and what the event return values are. +For Windows that have specifically enabled these. Please see the appropriate section in this document to learn about how to enable these and what the event return values are. -* Keyboard key press -* Mouse wheel up/down -* Menu item selected -* An Element Changed (slider, spinner, etc) -* A list item was clicked -* Return key was pressed in input element +* Keyboard key press +* Mouse wheel up/down +* Menu item selected +* An Element Changed (slider, spinner, etc) +* A list item was clicked +* Return key was pressed in input element * Timeout waiting for event * Text was clicked * Combobox item chosen * Table row selected * etc -***Most*** of the time the event will be a button click or the window was closed. +***Most*** of the time the event will be a button click or the window was closed. ### Window closed event -Another convention to follow is the check for windows being closed with an X. This is an important event to catch. If you don't check for this and you attempt to use the window, your program will crash. Please check for closed window and exit your program gracefully. - -To check for a closed window use this line of code: +Another convention to follow is the check for windows being closed with an X. This is an important event to catch. If you don't check for this and you attempt to use the window, your program will crash. Please check for closed window and exit your program gracefully. +To check for a closed window use this line of code: + ```python -if event is None: +if event is None: ``` - + Putting it all together we end up with an "event loop" that looks something like this: ```python while True: @@ -1216,21 +1180,21 @@ By default buttons will always return a click event, or in the case of realtime You can enable an additional "Button Modified" event by setting `enable_events=True` in the Button call. These events are triggered when something 'writes' to a button, ***usually*** it's because the button is listed as a "target" in another button. -The button value from a Read call will be one of 2 values: +The button value from a Read call will be one of 2 values: 1. The Button's text - Default 2. The Button's key - If a key is specified -If a button has a key set when it was 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 event value is None. +If a button has a key set when it was 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 event value is None. -### **None is returned when the user clicks the X to close a window.** - -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: +### **None is returned when the user clicks the X to close a window.** +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: + ```python -while True: - event, values = window.Read() - if event is None or event == 'Quit': - break +while True: + event, values = window.Read() + if event is None or event == 'Quit': + break ``` @@ -1279,213 +1243,213 @@ Windows are capable of returning keyboard events. These are returned as either If you set a timeout parameter in your read, then the system TIMEOUT_KEY will be returned. If you specified your own timeout key in the Read call then that value will be what's returned instead. -### The `values` Variable - Return values as a list +### The `values` Variable - Return values as a list -The second parameter from a Read call is either a list or a dictionary of the input fields on the Window. +The second parameter from a Read call is either a list or a dictionary of the input fields on the Window. -By default return values are a list of values, one entry for each input field. +By default return values are a list of values, one entry for each input field. -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. +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. -event, (filename, folder1, folder2, should_overwrite) = sg.Window('My title', window_rows).Read() +event, (filename, folder1, folder2, should_overwrite) = sg.Window('My title', window_rows).Read() -Or, more commonly, you can unpack the return results separately. +Or, more commonly, you can unpack the return results separately. -```python -event, values = sg.Window('My title', window_rows).Read() -event, value_list = window.Read() -value1 = value_list[0] -value2 = value_list[1] - ... -``` -However, this method isn't good when you have a lot of input fields. If you insert a new element into your window then you will have to shuffle your unpacks down, modifying each of the statements to reference `value_list[x] `. +```python +event, values = sg.Window('My title', window_rows).Read() +event, value_list = window.Read() +value1 = value_list[0] +value2 = value_list[1] + ... +``` +However, this method isn't good when you have a lot of input fields. If you insert a new element into your window then you will have to shuffle your unpacks down, modifying each of the statements to reference `value_list[x] `. -The more common / advanced method is to request your values be returned as a dictionary. +The more common / advanced method is to request your values be returned as a dictionary. -### `values` Variable - Return values as a dictionary +### `values` Variable - Return values as a dictionary -For those of you that have not encountered a Python dictionary, don't freak out! Just copy and paste the sample code and modify it. Follow this design pattern and you'll be fine. And you might learn something along the way. +For those of you that have not encountered a Python dictionary, don't freak out! Just copy and paste the sample code and modify it. Follow this design pattern and you'll be fine. And you might learn something along the way. -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. +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 window read statement you'll encounter looks something like this: +The most common window read statement you'll encounter looks something like this: `window = sg.Window("My title", layout).Read()` -To use a dictionary, you will need to: -* Mark each input element you wish to be in the dictionary with the keyword `key`. +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 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 window. +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 window. + ```python -import PySimpleGUI as sg - -layout = [ - [sg.Text('Please enter your Name, Address, Phone')], - [sg.Text('Name', size=(15, 1)), sg.InputText('1', key='_name_')], - [sg.Text('Address', size=(15, 1)), sg.InputText('2', key='_address_')], - [sg.Text('Phone', size=(15, 1)), sg.InputText('3', key='_phone_')], - [sg.Submit(), sg.Cancel()] - ] - -window = sg.Window('Simple data entry window', layout) -event, values = window.Read() - -sg.Popup(event, values, values['_name_'], values['_address_'], values['_phone_']) +import PySimpleGUI as sg + +layout = [ + [sg.Text('Please enter your Name, Address, Phone')], + [sg.Text('Name', size=(15, 1)), sg.InputText('1', key='_name_')], + [sg.Text('Address', size=(15, 1)), sg.InputText('2', key='_address_')], + [sg.Text('Phone', size=(15, 1)), sg.InputText('3', key='_phone_')], + [sg.Submit(), sg.Cancel()] + ] + +window = sg.Window('Simple data entry window', layout) +event, values = window.Read() + +sg.Popup(event, values, values['_name_'], values['_address_'], values['_phone_']) ``` -To get the value of an input field, you use whatever value used as the `key` value as the index value. Thus to get the value of the name field, it is written as +To get the value of an input field, you use whatever value used as the `key` value as the index value. Thus to get the value of the name field, it is written as values['name'] -Think of the variable values in the same way as you would a list, however, instead of using 0,1,2, to reference each item in the list, use the values of the key. The Name field in the window above is referenced by `values['_name_']`. +Think of the variable values in the same way as you would a list, however, instead of using 0,1,2, to reference each item in the list, use the values of the key. The Name field in the window above is referenced by `values['_name_']`. + +You will find the key field used quite heavily in most PySimpleGUI windows unless the window is very simple. + +Another convention you'll see in some of the demo programs is keys being named with an underscore at the beginning and the end. You don't HAVE to do this... your key value may look like this: +`key = 'name'` -You will find the key field used quite heavily in most PySimpleGUI windows unless the window is very simple. - -Another convention you'll see in some of the demo programs is keys being named with an underscore at the beginning and the end. You don't HAVE to do this... your key value may look like this: -`key = 'name'` - -The reason for this naming convention is that when you are scanning the code, these key values jump out at you. You instantly know it's a key. Try scanning the code above and see if those keys pop out. -`key = '_name_'` +The reason for this naming convention is that when you are scanning the code, these key values jump out at you. You instantly know it's a key. Try scanning the code above and see if those keys pop out. +`key = '_name_'` -## The Event Loop / Callback Functions +## The Event Loop / Callback Functions -All GUIs have one thing in common, an "event loop". Usually the GUI framework runs the event loop for you, but sometimes you want greater control and will run your own event loop. You often hear the term event loop when discussing embedded systems or on a Raspberry Pi. +All GUIs have one thing in common, an "event loop". Usually the GUI framework runs the event loop for you, but sometimes you want greater control and will run your own event loop. You often hear the term event loop when discussing embedded systems or on a Raspberry Pi. -With PySimpleGUI if your window will remain open following button clicks, then your code will have an event loop. If your program shows a single "one-shot" window, collects the data and then has no other GUI interaction, then you don't need an event loop. +With PySimpleGUI if your window will remain open following button clicks, then your code will have an event loop. If your program shows a single "one-shot" window, collects the data and then has no other GUI interaction, then you don't need an event loop. -There's nothing mysterious about event loops... they are loops where you take care of.... wait for it..... *events*. Events are things like button clicks, key strokes, mouse scroll-wheel up/down. +There's nothing mysterious about event loops... they are loops where you take care of.... wait for it..... *events*. Events are things like button clicks, key strokes, mouse scroll-wheel up/down. -Let's take a Pi demo program as an example. This program shows a GUI window, gets button presses, and uses them to control some LEDs. It loops, reading user input and doing something with it. +Let's take a Pi demo program as an example. This program shows a GUI window, gets button presses, and uses them to control some LEDs. It loops, reading user input and doing something with it. -This little program has a typical Event Loop +This little program has a typical Event Loop -![readme example](https://user-images.githubusercontent.com/13696193/46566965-f4d65f80-c8f6-11e8-91a3-8cebad0cba90.jpg) +![readme example](https://user-images.githubusercontent.com/13696193/46566965-f4d65f80-c8f6-11e8-91a3-8cebad0cba90.jpg) -```python -import PySimpleGUI as sg - -layout = [[sg.Text('Click read to read the input value')], - [sg.Input()], - [sg.RButton('Read'), sg.Exit()]] - -window = sg.Window('Persistent GUI Window', layout) - -while True: - event, values = window.Read() - if event is None or event == 'Exit': - break - print(event, values) +```python +import PySimpleGUI as sg + +layout = [[sg.Text('Click read to read the input value')], + [sg.Input()], + [sg.RButton('Read'), sg.Exit()]] + +window = sg.Window('Persistent GUI Window', layout) + +while True: + event, values = window.Read() + if event is None or event == 'Exit': + break + print(event, values) window.Close() -``` +``` -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) +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 asynchronous code, a concept beginners often stumble on and one that presents a barrier. +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 asynchronous code, a concept beginners often stumble on and one that presents a barrier. -There is a more communications that have to happen between parts of your program when using callbacks. Callbacks break apart your program's logic apart and scatter it. One of the larger hurdles for beginners to GUI programming are these callback functions. +There is a more communications that have to happen between parts of your program when using callbacks. Callbacks break apart your program's logic apart and scatter it. One of the larger hurdles for beginners to GUI programming are these callback functions. -PySimpleGUI was specifically designed in a way so that callbacks would not be required. There is no coordination between one function and another required. You simply read your button click and take appropriate action at the same location in the code as when you read the button value. +PySimpleGUI was specifically designed in a way so that callbacks would not be required. There is no coordination between one function and another required. You simply read your button click and take appropriate action at the same location in the code as when you read the button value. -Whether or not this is a "proper" design for GUI programs can be debated. It's not a terrible trade-off to run your own event loop and having a functioning GUI application versus one that maybe never gets written because callback functions were too much to grasp. +Whether or not this is a "proper" design for GUI programs can be debated. It's not a terrible trade-off to run your own event loop and having a functioning GUI application versus one that maybe never gets written because callback functions were too much to grasp. -## All Widgets / Elements +## All Widgets / Elements -This code utilizes many of the common Elements. It does not include Tabs/Tab Groups. -```python -import PySimpleGUI as sg +This code utilizes many of the common Elements. It does not include Tabs/Tab Groups. +```python +import PySimpleGUI as sg + +sg.ChangeLookAndFeel('GreenTan') + +# ------ Menu Definition ------ # +menu_def = [['File', ['Open', 'Save', 'Exit', 'Properties']], + ['Edit', ['Paste', ['Special', 'Normal', ], 'Undo'], ], + ['Help', 'About...'], ] + +# ------ Column Definition ------ # +column1 = [[sg.Text('Column 1', background_color='#F7F3EC', justification='center', size=(10, 1))], + [sg.Spin(values=('Spin Box 1', '2', '3'), initial_value='Spin Box 1')], + [sg.Spin(values=('Spin Box 1', '2', '3'), initial_value='Spin Box 2')], + [sg.Spin(values=('Spin Box 1', '2', '3'), initial_value='Spin Box 3')]] + +layout = [ + [sg.Menu(menu_def, tearoff=True)], + [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=[ + [sg.Checkbox('Checkbox', size=(10,1)), sg.Checkbox('My second checkbox!', default=True)], + [sg.Radio('My first Radio! ', "RADIO1", default=True, size=(10,1)), sg.Radio('My second Radio!', "RADIO1")]], title='Options',title_color='red', relief=sg.RELIEF_SUNKEN, tooltip='Use these to set flags')], + [sg.Multiline(default_text='This is the default Text should you decide not to type anything', size=(35, 3)), + sg.Multiline(default_text='A second multi-line', size=(35, 3))], + [sg.InputCombo(('Combobox 1', 'Combobox 2'), size=(20, 1)), + sg.Slider(range=(1, 100), orientation='h', size=(34, 20), default_value=85)], + [sg.InputOptionMenu(('Menu Option 1', 'Menu Option 2', 'Menu Option 3'))], + [sg.Listbox(values=('Listbox 1', 'Listbox 2', 'Listbox 3'), size=(30, 3)), + sg.Frame('Labelled Group',[[ + sg.Slider(range=(1, 100), orientation='v', size=(5, 20), default_value=25), + sg.Slider(range=(1, 100), orientation='v', size=(5, 20), default_value=75), + sg.Slider(range=(1, 100), orientation='v', size=(5, 20), default_value=10), + sg.Column(column1, background_color='#F7F3EC')]])], + [sg.Text('_' * 80)], + [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 window'), sg.Cancel()] +] + + +window = sg.Window('Everything bagel', layout, default_element_size=(40, 1), grab_anywhere=False) + +event, values = window.Read() + +sg.Popup('Title', + 'The results of the window.', + 'The button clicked was "{}"'.format(event), + 'The values are', values) +``` +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. -sg.ChangeLookAndFeel('GreenTan') +![everything bagel](https://user-images.githubusercontent.com/13696193/45914128-87163800-be0e-11e8-9a83-7ee5960e88b9.jpg) -# ------ Menu Definition ------ # -menu_def = [['File', ['Open', 'Save', 'Exit', 'Properties']], - ['Edit', ['Paste', ['Special', 'Normal', ], 'Undo'], ], - ['Help', 'About...'], ] +Clicking the Submit button caused the window call to return. The call to Popup resulted in this window. -# ------ Column Definition ------ # -column1 = [[sg.Text('Column 1', background_color='#F7F3EC', justification='center', size=(10, 1))], - [sg.Spin(values=('Spin Box 1', '2', '3'), initial_value='Spin Box 1')], - [sg.Spin(values=('Spin Box 1', '2', '3'), initial_value='Spin Box 2')], - [sg.Spin(values=('Spin Box 1', '2', '3'), initial_value='Spin Box 3')]] - -layout = [ - [sg.Menu(menu_def, tearoff=True)], - [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=[ - [sg.Checkbox('Checkbox', size=(10,1)), sg.Checkbox('My second checkbox!', default=True)], - [sg.Radio('My first Radio! ', "RADIO1", default=True, size=(10,1)), sg.Radio('My second Radio!', "RADIO1")]], title='Options',title_color='red', relief=sg.RELIEF_SUNKEN, tooltip='Use these to set flags')], - [sg.Multiline(default_text='This is the default Text should you decide not to type anything', size=(35, 3)), - sg.Multiline(default_text='A second multi-line', size=(35, 3))], - [sg.InputCombo(('Combobox 1', 'Combobox 2'), size=(20, 1)), - sg.Slider(range=(1, 100), orientation='h', size=(34, 20), default_value=85)], - [sg.InputOptionMenu(('Menu Option 1', 'Menu Option 2', 'Menu Option 3'))], - [sg.Listbox(values=('Listbox 1', 'Listbox 2', 'Listbox 3'), size=(30, 3)), - sg.Frame('Labelled Group',[[ - sg.Slider(range=(1, 100), orientation='v', size=(5, 20), default_value=25), - sg.Slider(range=(1, 100), orientation='v', size=(5, 20), default_value=75), - sg.Slider(range=(1, 100), orientation='v', size=(5, 20), default_value=10), - sg.Column(column1, background_color='#F7F3EC')]])], - [sg.Text('_' * 80)], - [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 window'), sg.Cancel()] -] +![everything bagel reseults](https://user-images.githubusercontent.com/13696193/45914129-87aece80-be0e-11e8-8aae-9a483a9ad4a6.jpg) -window = sg.Window('Everything bagel', layout, default_element_size=(40, 1), grab_anywhere=False) +**`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`. It is ***vitally*** ***important*** that your code contain the proper checks for None. Always give your users a way out of the window. Otherwise you'll end up with windows that never properly close. -event, values = window.Read() +You can see in the results Popup window 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`. -sg.Popup('Title', - 'The results of the window.', - 'The button clicked was "{}"'.format(event), - 'The values are', values) -``` -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. +# 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 -![everything bagel](https://user-images.githubusercontent.com/13696193/45914128-87163800-be0e-11e8-9a83-7ee5960e88b9.jpg) - -Clicking the Submit button caused the window call to return. The call to Popup resulted in this window. - -![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 window using something other than a button, then `button` will be `None`. It is ***vitally*** ***important*** that your code contain the proper checks for None. Always give your users a way out of the window. Otherwise you'll end up with windows that never properly close. - -You can see in the results Popup window 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 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 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. +## 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. A truly non-blocking Read call looks like this: ```python event, values = window.Read(timeout=0) ``` -You can learn more about these async / non-blocking windows toward the end of this document. +You can learn more about these async / non-blocking windows toward the end of this document. -# Window Object - Beginning a window -The first step is to create the window object using the desired window customization. +# Window Object - Beginning a window +The first step is to create the window object using the desired window customization. -This is the definition of the Window object: +This is the definition of the Window object: ```python -Window( title, +Window( title, default_element_size=DEFAULT_ELEMENT_SIZE, default_button_element_size=(None,None), auto_size_text=None, @@ -1512,10 +1476,10 @@ Window( title, resizable=False, disable_close=False, disable_minimize=False, - right_click_menu=None): -``` + right_click_menu=None): +``` -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. +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. | Name | Meaning | | - | - | @@ -1549,8 +1513,8 @@ Parameter Descriptions. You will find these same parameters specified for each | | | -### 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 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. +### 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 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. ### Window Size @@ -1565,61 +1529,61 @@ window = Window('My Title', layout).Finalize() ``` -### Element 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. +### Element 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)`. +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 window. Setting `size=(20,1)` in the window creation call will set all elements in the window 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. +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. -### No Titlebar +### No Titlebar -Should you wish to create cool looking windows that are clean with no windows titlebar, use the no_titlebar option when creating the window. +Should you wish to create cool looking windows that are clean with no windows titlebar, use the no_titlebar option when creating the window. -Be sure an provide your user an "exit" button or they will not be able to close the window! When no titlebar is enabled, there will be no icon on your taskbar for the window. Without an exit button you will need to kill via taskmanager... not fun. +Be sure an provide your user an "exit" button or they will not be able to close the window! When no titlebar is enabled, there will be no icon on your taskbar for the window. Without an exit button you will need to kill via taskmanager... not fun. -Windows with no titlebar rely on the grab anywhere option to be enabled or else you will be unable to move the window. +Windows with no titlebar rely on the grab anywhere option to be enabled or else you will be unable to move the window. -Windows without a titlebar can be used to easily create a floating launcher. +Windows without a titlebar can be used to easily create a floating launcher. -Linux users! Note that this setting has side effects for some of the other Elements. Multi-line input doesn't work at all, for example So, use with caution. +Linux users! Note that this setting has side effects for some of the other Elements. Multi-line input doesn't work at all, for example So, use with caution. -![floating launcher](https://user-images.githubusercontent.com/13696193/45258246-71bafb80-b382-11e8-9f5e-79421e6c00bb.jpg) +![floating launcher](https://user-images.githubusercontent.com/13696193/45258246-71bafb80-b382-11e8-9f5e-79421e6c00bb.jpg) -### Grab Anywhere +### Grab Anywhere -This is a feature unique to PySimpleGUI. +This is a feature unique to PySimpleGUI. -Note - 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. +Note - 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 +### Always on top -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. ### Focus PySimpleGUI will set a default focus location for you. This generally means the first input field. You can set the focus to a particular element. If you are going to set the focus yourself, then you should turn off the automatic focus by setting `use_default_focus=False` in your Window call. -### Window Methods (things you can do with a Window object) +### 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: +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) - Recommend moving away from this nethod and using layout parameter instead. 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. Can have an optional timeout - window.ReadNonBlocking() - NO LONGER USED! - 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.Close() - To close your window, if a button hasn't already closed it - window.Disable() - Use to disable the window inputwhen opening another window on top of the primnary Window - window.Enable() - Re-enable a Disabled window + window.Layout(layout) - Recommend moving away from this nethod and using layout parameter instead. 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. Can have an optional timeout + window.ReadNonBlocking() - NO LONGER USED! + 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.Close() - To close your window, if a button hasn't already closed it + window.Disable() - Use to disable the window inputwhen opening another window on top of the primnary Window + window.Enable() - Re-enable a Disabled window window.FindElement(key, silent_on_error=False) - Returns the element that has a matching key value window.Element(key, silent_on_error=False) - EXACTLY the same as calling FindElement window.Move(x,y) - Moves window to location x,y on screen' @@ -1630,30 +1594,30 @@ There are a few methods (functions) that you will see in this document that act window.CurrentLocation() - Returns current window location window.Size = w,h - Forces a window to be a particular size. Note this is a property not a method window.Size - Tuple (w,h)The size of the current window. Note this is a property - window.Minimize() - Minimizes window to taskbar + window.Minimize() - Minimizes window to taskbar -## Window Methods +## Window Methods -There are a number of operations you can do on a window after you've created the window. You call these after creating your Windows object. +There are a number of operations you can do on a window after you've created the window. You call these after creating your Windows object. -#### Layout(rows) +#### Layout(rows) -Call to set the window layout. Must be called prior to Read. Most likely "chained" in line with the Window creation. +Call to set the window layout. Must be called prior to Read. Most likely "chained" in line with the Window creation. -```python -window = sg.Window('My window title', layout) -``` +```python +window = sg.Window('My window title', layout) +``` -#### Finalize() +#### Finalize() Call to force a window to go through the final stages of initialization. This will cause the tkinter resources to be allocated so that they can then be modified. This also causes your window to appear. If you do not want your window to appear when Finalize is called, then set the Alpha to 0 in your window's creation parameters. If you want to call an element's Update method or call a Graph element's drawing primitives, you ***must*** either call `Read` or `Finalize` prior to making those calls. -#### Read(timeout=None, timeout_key='__TIMEOUT_ _ ') +#### Read(timeout=None, timeout_key='__TIMEOUT_ _ ') -Read the Window's input values and button clicks in a blocking-fashion +Read the Window's input values and button clicks in a blocking-fashion Returns event, values. Adding a timeout can be achieved by setting timeout=number of milliseconds before the Read times out after which a "timeout event" is returned. The value of timeout_key will be returned as the event. If you do not specify a timeout key, then the value `TIMEOUT_KEY` will be returned. @@ -1692,10 +1656,10 @@ Will consume 100% of your CPU if you do not have other blocking calls in your ev ||| -# Elements -"Elements" are the building blocks used to create windows. Some GUI APIs use the term "Widget" to describe these graphic elements. +# Elements +"Elements" are the building blocks used to create windows. Some GUI APIs use the term "Widget" to describe these graphic elements. -- Text +- Text - Single Line Input - Buttons including these types: - File Browse @@ -1710,9 +1674,9 @@ Will consume 100% of your CPU if you do not have other blocking calls in your ev - Listbox - Slider - Multi-line Text Input/Output -- Multi-line Text Output (Qt only) -- Scroll-able Output -- Vertical Separator +- Multi-line Text Output (Qt only) +- Scroll-able Output +- Vertical Separator - Progress Bar - Option Menu - Menu @@ -1722,255 +1686,171 @@ Will consume 100% of your CPU if you do not have other blocking calls in your ev - Graph - Image - Table -- Tree -- Tab, TabGroup +- Tree +- Tab, TabGroup - StatusBar - Pane - Stretch (Qt only) ## Common Element Parameters -Some parameters that you will see on almost all Elements are: -- key - Used with window.FindElement and with return values -- tooltip - Hover your mouse over the elemnt and you'll get a popup with this text -- size - (width, height) - usually measured in characters-wide, rows-high. Sometimes they mean pixels -- font - specifies the font family, size, etc -- colors - Color name or #RRGGBB string -- pad - Amount of padding to put around element -- enable_events - Turns on the element specific events +Some parameters that you will see on almost all Elements are: +- key - Used with window.FindElement and with return values +- tooltip - Hover your mouse over the elemnt and you'll get a popup with this text +- size - (width, height) - usually measured in characters-wide, rows-high. Sometimes they mean pixels +- font - specifies the font family, size, etc +- colors - Color name or #RRGGBB string +- pad - Amount of padding to put around element +- enable_events - Turns on the element specific events -#### 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 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`. +#### 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 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. +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. -#### Size -Specifies the amount of room reserved for the Element. For elements that are character based, such a Text, it is (# characters, # rows). Sometimes it is a pixel measurement such as the Image element. And sometimes a mix like on the Slider element (characters long by pixels wide). +#### Size +Specifies the amount of room reserved for the Element. For elements that are character based, such a Text, it is (# characters, # rows). Sometimes it is a pixel measurement such as the Image element. And sometimes a mix like on the Slider element (characters long by pixels wide). -#### Colors -A string representing color. Anytime colors are involved, you can specify the tkinter color name such as 'lightblue' or an RGB hex value '#RRGGBB'. For buttons, the color parameter is a tuple (text color, background color) +#### Colors +A string representing color. Anytime colors are involved, you can specify the tkinter color name such as 'lightblue' or an RGB hex value '#RRGGBB'. For buttons, the color parameter is a tuple (text color, background color) -#### Pad -The amount of room around the element in pixels. The default value is (5,3) which means leave 5 pixels on each side of the x-axis and 3 pixels on each side of the y-axis. You can change this on a global basis using a call to SetOptions, or on an element basis. +#### Pad +The amount of room around the element in pixels. The default value is (5,3) which means leave 5 pixels on each side of the x-axis and 3 pixels on each side of the y-axis. You can change this on a global basis using a call to SetOptions, or on an element basis. -If you want more pixels on one side than the other, then you can split the number into 2 number. If you want 200 pixels on the left side, and 3 pixels on the right, the pad would be ((200,3), 3). In this example, only the x-axis is split. +If you want more pixels on one side than the other, then you can split the number into 2 number. If you want 200 pixels on the left side, and 3 pixels on the right, the pad would be ((200,3), 3). In this example, only the x-axis is split. -#### Font -Specifies the font family, size, and style. Font families on Windows include: -* Arial -* Courier -* Comic, -* Fixedsys -* Times -* Verdana -* Helvetica (the default I think) +#### Font +Specifies the font family, size, and style. Font families on Windows include: +* Arial +* Courier +* Comic, +* Fixedsys +* Times +* Verdana +* Helvetica (the default I think) -The fonts will vary from system to system, however, Tk 8.0 automatically maps Courier, Helvetica and Times to their corresponding native family names on all platforms. Also, font families cannot cause a font specification to fail on Tk 8.0 and greater. +The fonts will vary from system to system, however, Tk 8.0 automatically maps Courier, Helvetica and Times to their corresponding native family names on all platforms. Also, font families cannot cause a font specification to fail on Tk 8.0 and greater. -If you wish to leave the font family set to the default, you can put anything not a font name as the family. The PySimpleGUI Demo programs and documentation use the family 'Any' to demonstrate this fact.. You could use "default" if that's more clear to you. +If you wish to leave the font family set to the default, you can put anything not a font name as the family. The PySimpleGUI Demo programs and documentation use the family 'Any' to demonstrate this fact.. You could use "default" if that's more clear to you. -There are 2 formats that can be used to specify a font... a string, and a tuple -Tuple - (family, size, styles) -String - "Family Size Styles" +There are 2 formats that can be used to specify a font... a string, and a tuple +Tuple - (family, size, styles) +String - "Family Size Styles" -To specify an underlined, Helvetica font with a size of 15 the values: -('Helvetica', 15, 'underline italics') -'Helvetica 15 underline italics' +To specify an underlined, Helvetica font with a size of 15 the values: +('Helvetica', 15, 'underline italics') +'Helvetica 15 underline italics' -#### Key +#### Key -If you are going to do anything beyond the basic stuff with your GUI, then you need to understand keys. -Keys are a way for you to "tag" an Element with a value that will be used to identify that element. After you put a key in an element's definition, the values returned from Read will use that key to tell you the value. For example, if you have an input field: +If you are going to do anything beyond the basic stuff with your GUI, then you need to understand keys. +Keys are a way for you to "tag" an Element with a value that will be used to identify that element. After you put a key in an element's definition, the values returned from Read will use that key to tell you the value. For example, if you have an input field: `Input(key='mykey')` And your read looks like this: `event, values = Read()` Then to get the input value from the read it would be: `values['mykey']` -You also use the same key if you want to call Update on an element. Please see the section below on Updates to understand that usage. +You also use the same key if you want to call Update on an element. Please see the section below on Updates to understand that usage. #### Visible Beginning in version 3.17 you can create Elements that are initially invisible that you can later make visible. -To create an invisible Element, place the element in the layout like you normally would and add the parameter `visible=False`. +To create an invisible Element, place the element in the layout like you normally would and add the parameter `visible=False`. Later when you want to make that Element visible you simply call the Element's `Update` method and pass in the parameter `visible=True` This feature works best on Qt, but does work on the tkinter version as well. The visible parameter can also be used with the Column and Frame "container" Elements. -### Output Elements -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: +### Output Elements +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] ] +layout = [ [row 1 element, row 1 element], + [row 2 element, row 2 element, row 2 element] ] ``` -The code is a crude representation of the GUI, laid out in text. +The code is a crude representation of the GUI, laid out in text. ## Shortcut Functions / Multiple Function Names Many of the main method calls and Element names have shortcuts. This enables you to code much quicker once you are used to using the SDK. The Text Element, for example, has 3 different names `Text`, `Txt` or`T`. InputText can also be written `Input` or `In` . `FindElement` was recently renamed to `Element` because it's a commonly used function. - -## Text Element +## Text Element ``` -layout = [[sg.Text('This is what a Text Element looks like')]] +layout = [[sg.Text('This is what a Text Element looks like')]] ``` -![simple text](https://user-images.githubusercontent.com/13696193/44959877-e9d97b00-aec3-11e8-9d24-b4405ee4a148.jpg) +![simple text](https://user-images.githubusercontent.com/13696193/44959877-e9d97b00-aec3-11e8-9d24-b4405ee4a148.jpg) -The most basic element is the Text element. It simply displays text. Many of the 'options' that can be set for a Text element are shared by other elements. - - - - +The most basic element is the Text element. It simply displays text. Many of the 'options' that can be set for a Text element are shared by other elements. ```python Text(text, - size=(None, None), + size=(None, None), auto_size_text=None, - click_submits=False, + click_submits=False, enable_events=False, relief=None, - font=None, - text_color=None, - background_color=None, - justification=None, - pad=None, - key=None, - right_click_menu=None, - tooltip=None, + font=None, + text_color=None, + background_color=None, + justification=None, + pad=None, + key=None, + right_click_menu=None, + tooltip=None, visible=True) ``` -Parameters explained: - -|Name|Meaning| -|-|-| -| text | | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| auto_size_text | True if size should fit the text length (Default value = None) | -| click_submits | (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| relief | (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| text_color | color of the text (Default value = None) | -| background_color | color of background (Default value = None) | -| justification | justification for data display (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + tooltip - string representing tooltip -Some commonly used elements have 'shorthand' versions of the functions to make the code more compact. The functions `T` and `Txt` are the same as calling `Text`. +Some commonly used elements have 'shorthand' versions of the functions to make the code more compact. The functions `T` and `Txt` are the same as calling `Text`. ### Fonts -Already discussed in the common parameters section. Either string or a tuple. +Already discussed in the common parameters section. Either string or a tuple. -### Color in PySimpleGUI are in one of two formats - color name or RGB value. +### Color in PySimpleGUI are in one of two formats - color name or RGB value. -Individual colors are specified using either the color names as defined in tkinter or an RGB string of this format: +Individual colors are specified using either the color names as defined in tkinter or an RGB string of this format: "#RRGGBB" or "darkblue" ### `auto_size_text ` -A `True` value for `auto_size_text`, when placed on Text Elements, indicates that the width of the Element should be shrunk do the width of the text. The default setting is True. +A `True` value for `auto_size_text`, when placed on Text Elements, indicates that the width of the Element should be shrunk do the width of the text. The default setting is True. -### Chortcut functions -The shorthand functions for `Text` are `Txt` and `T` +### Chortcut functions +The shorthand functions for `Text` are `Txt` and `T` ### Events `enable_events` -If you set the parameter `enable_events` or `click_submits` then you will get an event if the user clicks on the Text. +If you set the parameter `enable_events` or `click_submits` then you will get an event if the user clicks on the Text. -### Text Methods +### Text Methods -#### Update +#### Update If you want to change the text, font, or colors after the element has been created, then use the `Update` method. - - -```python -Update(value = None, background_color=None, text_color=None, font=None, visible=None) -``` +```python +Update(value = None, background_color=None, text_color=None, font=None, visible=None) +``` | name | meaning | | - | - | | value | new value to set text element to | @@ -1981,67 +1861,14 @@ Update(value = None, background_color=None, text_color=None, font=None, visible= | | | +## Multiline Text Element - -## Multiline Element +layout = [[sg.Multiline('This is what a Multi-line Text Element looks like', size=(45,5))]] -layout = [[sg.Multiline('This is what a Multi-line Text Element looks like', size=(45,5))]] +![multiline](https://user-images.githubusercontent.com/13696193/44959853-b139a180-aec3-11e8-972f-f52188510c88.jpg) -![multiline](https://user-images.githubusercontent.com/13696193/44959853-b139a180-aec3-11e8-972f-f52188510c88.jpg) +This Element doubles as both an input and output Element. -This Element doubles as both an input and output Element. - - - -```python -Multiline(default_text="", - enter_submits=False, - disabled=False, - autoscroll=False, - border_width=None, - size=(None, None), - auto_size_text=None, - background_color=None, - text_color=None, - change_submits=False, - enable_events=False, - do_not_clear=True, - key=None, - focus=False, - font=None, - pad=None, - tooltip=None, - right_click_menu=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| default_text | (Default value = '') | -| enter_submits | (Default value = False) | -| disabled | set disable state for element (Default value = False) | -| autoscroll | (Default value = False) | -| border_width | (Default value = None) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| auto_size_text | True if size should fit the text length (Default value = None) | -| background_color | color of background (Default value = None) | -| text_color | color of the text (Default value = None) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| do_not_clear | see docx (Default value = True) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| focus | if focus should be set to this (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - +||| ### Multiline Methods - - - - ```python Update(value=None, disabled=None, @@ -2086,7 +1909,7 @@ Update(value=None, text_color=None, background_color=None) -Update(self, value=None, disabled=None, append=False, font=None, text_color=None, background_color=None)value=None, disabled=None, append=False): +Update(self, value=None, disabled=None, append=False, font=None, text_color=None, background_color=None)value=None, disabled=None, append=False): ``` |name|meaning| |-|-| @@ -2094,52 +1917,19 @@ Update(self, value=None, disabled=None, append=False, font=None, text_color=None | disabled | set to True to disable the element| | append | rather than replacing the current text with new text, add the new text onto the end| ||| +## Output Element +Output re-routes `Stdout` to a scrolled text box. - -## Output Element -Output re-routes `Stdout` to a scrolled text box. - -Whatever you print will show up in this window. +Whatever you print will show up in this window. Note that you will NOT see what you print until you call either window.Read or window.Refresh. If you want to immediately see what was printed, call window.Refresh() immediately after your print statement. ```python -layout = [[sg.Output(size=(80,10)]] +layout = [[sg.Output(size=(80,10)]] ``` -![output](https://user-images.githubusercontent.com/13696193/44959863-b72f8280-aec3-11e8-8caa-7bc743149953.jpg) +![output](https://user-images.githubusercontent.com/13696193/44959863-b72f8280-aec3-11e8-8caa-7bc743149953.jpg) - - -```python -Output(size=(None, None), - background_color=None, - text_color=None, - pad=None, - font=None, - tooltip=None, - key=None, - right_click_menu=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| background_color | color of background (Default value = None) | -| text_color | color of the text (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - -## Input Elements -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 Shortcuts (Input, In) +## Input Elements +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 Shortcuts (Input, In) ```python -layout = [[sg.InputText('Default text')]] +layout = [[sg.InputText('Default text')]] ``` -![inputtext 2](https://user-images.githubusercontent.com/13696193/44959861-b5fe5580-aec3-11e8-8040-53ec241b5079.jpg) - -Shows a single line of input. +![inputtext 2](https://user-images.githubusercontent.com/13696193/44959861-b5fe5580-aec3-11e8-8040-53ec241b5079.jpg) ```python -InputText(default_text="", - size=(None, None), - disabled=False, - password_char="", - justification=None, - background_color=None, - text_color=None, - font=None, - tooltip=None, - change_submits=False, - enable_events=False, - do_not_clear=True, - key=None, - focus=False, - pad=None, - right_click_menu=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| default_text | (Default value = '') | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| disabled | set disable state for element (Default value = False) | -| password_char | Passwork character if this is a password field (Default value = '') | -| justification | justification for data display (Default value = None) | -| background_color | color of background (Default value = None) | -| text_color | color of the text (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| change_submits | If True, pressing Enter key submits window- DEPRICATED DO NOT USE! (Default value = False) | -| enable_events | Turns on the element specific events. Use this instead of change_submits (Default value = False) | -| do_not_clear | see docx (Default value = True) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| focus | if focus should be set to this (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - - - -There are two methods that can be called: +There are two methods that can be called: ``` -Input.Update(new_Value) - sets the input to new_value -Input.Get() - returns the current value of the field. +Input.Update(new_Value) - sets the input to new_value +Input.Get() - returns the current value of the field. ``` Shorthand functions that are equivalent to `InputText` are `Input` and `In` @@ -2282,75 +2022,28 @@ Get() | Get | Returns the current value for the element (you can get also from a call to Read) | ||| - -## Combo Element -Also known as a drop-down list. Only required parameter is the list of choices. The return value is a string matching what's visible on the GUI. +## Combo Element +Also known as a drop-down list. Only required parameter is the list of choices. The return value is a string matching what's visible on the GUI. + + layout = [[sg.InputCombo(['choice 1', 'choice 2'])]] + +![combobox](https://user-images.githubusercontent.com/13696193/44959860-b565bf00-aec3-11e8-82fe-dbe41252458b.jpg) -```python -layout = [[sg.InputCombo(['choice 1', 'choice 2'])]] ``` - -![combobox](https://user-images.githubusercontent.com/13696193/44959860-b565bf00-aec3-11e8-82fe-dbe41252458b.jpg) - - -ComboBox Element - -```python -Combo(values, - default_value=None, - size=(None, None), - auto_size_text=None, - background_color=None, - text_color=None, - change_submits=False, - enable_events=False, - disabled=False, - key=None, - pad=None, - tooltip=None, - readonly=False, - font=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| values | | -| default_value | (Default value = None) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| auto_size_text | True if size should fit the text length (Default value = None) | -| background_color | color of background (Default value = None) | -| text_color | color of the text (Default value = None) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| disabled | set disable state for element (Default value = False) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| readonly | make element readonly (Default value = False) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - -Shortcut functions - Combo, DropDown, Drop +Shortcut functions - Combo, DropDown, Drop -### Combo Methods -```python -Update(value=None, values=None, set_to_index=None, disabled=None, readonly=None) -``` -value - change which value is current selected -values - change list of choices -set_to_index - change selection to a particular choice -disable - if True will disable element +### Combo Methods +```python +Update(value=None, values=None, set_to_index=None, disabled=None, readonly=None) +``` +value - change which value is current selected +values - change list of choices +set_to_index - change selection to a particular choice +disable - if True will disable element readonly - if True will make element readonly + +## 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). - -## Listbox Element -The standard listbox like you'll find in most GUIs. Note that the return values from this element will be a ***list of results, not a single result***. This is because the user can select more than 1 item from the list (if you set the right mode). + layout = [[sg.Listbox(values=['Listbox 1', 'Listbox 2', 'Listbox 3'], size=(30, 6))]] -```python - layout = [[sg.Listbox(values=['Listbox 1', 'Listbox 2', 'Listbox 3'], size=(30, 6))]] -``` - -![listbox 2](https://user-images.githubusercontent.com/13696193/44959859-b4cd2880-aec3-11e8-881c-1e369d5c6337.jpg) +![listbox 2](https://user-images.githubusercontent.com/13696193/44959859-b4cd2880-aec3-11e8-881c-1e369d5c6337.jpg) -A List Box. Provide a list of values for the user to choose one or more of. Returns a list of selected rows -when a window.Read() is executed. - - - - -```python -Listbox(values, - default_values=None, - select_mode=None, - change_submits=False, - enable_events=False, - bind_return_key=False, - size=(None, None), - disabled=False, - auto_size_text=None, - font=None, - background_color=None, - text_color=None, - key=None, - pad=None, - tooltip=None, - right_click_menu=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| values | | -| default_values | (Default value = None) | -| select_mode | (Default value = None) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| bind_return_key | (Default value = False) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| disabled | set disable state for element (Default value = False) | -| auto_size_text | True if size should fit the text length (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| background_color | color of background (Default value = None) | -| text_color | color of the text (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - +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 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. -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 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. - -### Listbox Methods -```python -Update(values=None, disabled=None) -SetValue(values) -GetListValues() -``` +### Listbox Methods +```python +Update(values=None, disabled=None) +SetValue(values) +GetListValues() +``` |name|meaning| |-|-| @@ -2510,196 +2147,94 @@ GetListValues() | GetListValues | Return the list of values to choose from | ||| - -## Slider Element +## Slider Element -Sliders have a couple of slider-specific settings as well as appearance settings. Examples include the `orientation` and `range` settings. +Sliders have a couple of slider-specific settings as well as appearance settings. Examples include the `orientation` and `range` settings. - layout = [[sg.Slider(range=(1,500), default_value=222, size=(20,15), orientation='horizontal', font=('Helvetica', 12))]] + layout = [[sg.Slider(range=(1,500), default_value=222, size=(20,15), orientation='horizontal', font=('Helvetica', 12))]] -![slider](https://user-images.githubusercontent.com/13696193/44959858-b4349200-aec3-11e8-9e25-c0fcf025d19e.jpg) +![slider](https://user-images.githubusercontent.com/13696193/44959858-b4349200-aec3-11e8-9e25-c0fcf025d19e.jpg) - - - -```python -Slider(range=(None, None), - default_value=None, - resolution=None, - tick_interval=None, - orientation=None, - disable_number_display=False, - border_width=None, - relief=None, - change_submits=False, - enable_events=False, - disabled=False, - size=(None, None), - font=None, - background_color=None, - text_color=None, - key=None, - pad=None, - tooltip=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| range | (Default value = (None, None)) | -| default_value | (Default value = None) | -| resolution | (Default value = None) | -| tick_interval | (Default value = None) | -| orientation | (Default value = None) | -| disable_number_display | (Default value = False) | -| border_width | (Default value = None) | -| relief | (Default value = None) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| disabled | set disable state for element (Default value = False) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| background_color | color of background (Default value = None) | -| text_color | color of the text (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - +size - (width, height) of element in characters +disabled - Bool If True slider is disabled +auto_size_text - Bool. True if size should fit the text +background_color - color to use for the input field background +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 +tooltip - Tooltip to display when hovered over wlement ### Qt Sliders There is an important difference between Qt and tkinter sliders. On Qt, the slider values must be integer, not float. If you want your slider to go from 0.1 to 1.0, then make your slider go from 1 to 10 and divide by 10. It's an easy math thing to do and not a big deal. Just deal with it.... you're writing software after all. Presumably you know how to do these things. ;-) -### Slider Methods -```python - Update(self, value=None, range=(None, None), disabled=None, visible=None): +### Slider Methods +```python + Update(self, value=None, range=(None, None), disabled=None, visible=None): ``` -value - set current selection to value -range - change range of valid values -disabled - if True disables element +value - set current selection to value +range - change range of valid values +disabled - if True disables element - -## Radio Element +## Radio Button Element -Creates one radio button that is assigned to a group of radio buttons. Only 1 of the buttons in the group can be selected at any one time. +Creates one radio button that is assigned to a group of radio buttons. Only 1 of the buttons in the group can be selected at any one time. ```python layout = [ - [sg.Radio('My first Radio!', "RADIO1", default=True), - sg.Radio('My second radio!', "RADIO1")] + [sg.Radio('My first Radio!', "RADIO1", default=True), + sg.Radio('My second radio!', "RADIO1")] ] ``` -![radio](https://user-images.githubusercontent.com/13696193/44959857-b4349200-aec3-11e8-8e2d-e6a49ffbd0b6.jpg) +![radio](https://user-images.githubusercontent.com/13696193/44959857-b4349200-aec3-11e8-8e2d-e6a49ffbd0b6.jpg) -Radio Button Element - Used in a group of other Radio Elements to provide user with ability to select only -1 choice in a list of choices. - - - - -```python -Radio(text, - group_id, - default=False, - disabled=False, - size=(None, None), - auto_size_text=None, - background_color=None, - text_color=None, - font=None, - key=None, - pad=None, - tooltip=None, - change_submits=False, - enable_events=False, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| text | | -| group_id | | -| default | (Default value = False) | -| disabled | set disable state for element (Default value = False) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| auto_size_text | True if size should fit the text length (Default value = None) | -| background_color | color of background (Default value = None) | -| text_color | color of the text (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| visible | set visibility state of the element (Default value = True) | -||| - - - -### Radio Button Methods -```python -Update(value=None, disabled=None, visible=None) -``` + +### Radio Button Methods +```python +Update(value=None, disabled=None, visible=None) +``` |name|meaning| |-|-| @@ -2728,68 +2263,27 @@ Update(value=None, disabled=None, visible=None) | disabled | if True disables the element | ||| - -## Checkbox Element -Checkbox elements are like Radio Button elements. They return a bool indicating whether or not they are checked. +## Checkbox Element +Checkbox elements are like Radio Button elements. They return a bool indicating whether or not they are checked. - layout = [[sg.Checkbox('My first Checkbox!', default=True), sg.Checkbox('My second Checkbox!')]] + layout = [[sg.Checkbox('My first Checkbox!', default=True), sg.Checkbox('My second Checkbox!')]] -![checkbox](https://user-images.githubusercontent.com/13696193/44959906-6f5d2b00-aec4-11e8-9c8a-962c787f0286.jpg) +![checkbox](https://user-images.githubusercontent.com/13696193/44959906-6f5d2b00-aec4-11e8-9c8a-962c787f0286.jpg) - - -```python -Checkbox(text, - default=False, - size=(None, None), - auto_size_text=None, - font=None, - background_color=None, - text_color=None, - change_submits=False, - enable_events=False, - disabled=False, - key=None, - pad=None, - tooltip=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| text | | -| default | (Default value = False) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| auto_size_text | True if size should fit the text length (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| background_color | color of background (Default value = None) | -| text_color | color of the text (Default value = None) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| disabled | set disable state for element (Default value = False) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - -Shortcut functions - CBox, CB, Check +Shortcut functions - CBox, CB, Check -### Checkbox Methods -```python -Update(value=None, disabled=None, visible=None) -Get() +### Checkbox Methods +```python +Update(value=None, disabled=None, visible=None) +Get() ``` |name|meaning| @@ -2825,86 +2318,44 @@ Get() - -## Spin Element - -An up/down spinner control. The valid values are passed in as a list. - - layout = [[sg.Spin([i for i in range(1,11)], initial_value=1), sg.Text('Volume level')]] - -![spinner](https://user-images.githubusercontent.com/13696193/44959855-b1d23800-aec3-11e8-9f51-afb2109879da.jpg) - - - -```python -Spin(values, - initial_value=None, - disabled=False, - change_submits=False, - enable_events=False, - size=(None, None), - auto_size_text=None, - font=None, - background_color=None, - text_color=None, - key=None, - pad=None, - tooltip=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| values | | -| initial_value | (Default value = None) | -| disabled | set disable state for element (Default value = False) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| auto_size_text | True if size should fit the text length (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| background_color | color of background (Default value = None) | -| text_color | color of the text (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - +## Spin Element + +An up/down spinner control. The valid values are passed in as a list. + + layout = [[sg.Spin([i for i in range(1,11)], initial_value=1), sg.Text('Volume level')]] + +![spinner](https://user-images.githubusercontent.com/13696193/44959855-b1d23800-aec3-11e8-9f51-afb2109879da.jpg) + + Spin(values, + intiial_value=None, + disabled = False, + size=(None, None), + change_submits = False, + auto_size_text=None, + font=None, + background_color = None, + text_color = None, + key = None. + pad = None, + tooltip = None, + visible=True): + + + +Parameter definitions + + values - List of valid values + initial_value - String with initial value + size - (width, height) size of element in characters + auto_size_text - Bool. True if should size width to fit text + font - Font type and size for text display + disabled - Bool. If True element is disabled + background_color - color to use for the background + 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 + pad - padding around element in the window + tooltip - text to show when mouse hovered over element ### Qt Differences - `values` is a range! @@ -2913,55 +2364,19 @@ Note that Qt does not allow arbitrary spinner values. With PySimpleGUI-tkinter On Qt values is a tuple representing a range. On plain PySimpleGUI this value is a list of items. Make sure on the plain version you specify items as a list using [] and not a generator using (). - -### Spin Methods -```python -Update(value=None, values=None, disabled=None, visible=None) -``` -value - set the current value -values - set available choices -disabled - if True disables the element - - -## Image Element - -Images can be placed in your window provide they are in PNG, GIF, PPM/PGM format. JPGs cannot be shown because tkinter does not naively support JPGs. You can use the Python Imaging Library (PIL) package to convert your image to PNG prior to calling PySimpleGUI if your images are in JPG format. - - - - -```python -Image(filename=None, - data=None, - background_color=None, - size=(None, None), - pad=None, - key=None, - tooltip=None, - right_click_menu=None, - visible=True, - enable_events=False) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| filename | (Default value = None) | -| data | (Default value = None) | -| background_color | color of background (Default value = None) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -| enable_events | Turns on the element specific events.(Default value = False) | -||| - - - - + right_click_menu=None, + size_px=(None,None) + visible=True) +``` +Parameter definitions + + filename - file name if the image is in a file + data - if image is in RAM (PIL format?) + data_base64 - image in base64 format + background_color - Color of background + size - Size (Width, Height) of image in pixels + pad - Padding around Element in the window + key - Key used to find the element + tooltip - text to show when mouse if hovered over image + click_submits, enable_events - if True returns event when image is clicked + visible - if False will create image as hidden + size_px - size of image in pixels + ### `Update` Method - -Like other Elements, the Image Element has an `Update` method. Call Update if you want to change the image. - - def Update(self, filename=None, data=None, visible=None): - - -Choose **either** a filename or in-ram data image to use to replace current image + +Like other Elements, the Image Element has an `Update` method. Call Update if you want to change the image. + + def Update(self, filename=None, data=None, visible=None): + + +Choose **either** a filename or in-ram data image to use to replace current image ### `UpdateAnimation` Method for Animated GIFs @@ -3010,396 +2424,336 @@ Starting in version 3.23 you can specify an animated GIF as an image and can ani ```python UpdateAnimation(source, - time_between_frames=0) + time_between_frames=0) ``` `source` can be a filename ***or*** a base64 bytes variable (unlike other calls that split out the filename parameter and base64 parameter into 2 parameters. -`time_between_frames` is an optional parameter. It will keep track of the amount of time between frame changes for you to give you a smooth animation. With this parameter you can call the function as often as you want and it will advance to the next frame only after the correct amount of time has lapsed. +`time_between_frames` is an optional parameter. It will keep track of the amount of time between frame changes for you to give you a smooth animation. With this parameter you can call the function as often as you want and it will advance to the next frame only after the correct amount of time has lapsed. You can call the method without setting the `time_between_frames` value and it will show a frame and immediately move on to the next frame. This enables you to do the inter-frame timing. - - -## Button Element - + +## Button Element + **MAC USERS** - Macs suck when it comes to tkinter and button colors. It sucks so badly with colors that the `LookAndFeel` call is disabled. You cannot change button colors for Macs. You're stuck with the system default color if you are using the tkinter version of PySimpleGUI. The Qt version does not have this issue. - -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 -* File Browse -* Files Browse -* File SaveAs -* File Save -* Close window (normal button) -* Read window -* Realtime -* Calendar Chooser -* Color Chooser - - + +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 +* File Browse +* Files Browse +* File SaveAs +* File Save +* Close window (normal button) +* Read window +* Realtime +* Calendar Chooser +* Color Chooser + + Close window - Normal buttons like Submit, Cancel, Yes, No, do NOT close the window... they used to. Now to close a window you need to use a CloseButton / CButton. - -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. - -Calendar Chooser - Opens a graphical calendar to select a date. - -Color Chooser - Opens a color chooser dialog - -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 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. - + +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. + +Calendar Chooser - Opens a graphical calendar to select a date. + +Color Chooser - Opens a color chooser dialog + +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 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), normal Buttons which leave the windows open and CloseButtons that close the window when clicked. - -Sometimes there are multiple names for the same function. This is simply to make the job of the programmer quicker and easier. Or they are old names that are no longer used but kept around so that existing programs don't break. - -The 4 primary windows of PySimpleGUI buttons and their names are: - - 1. `Button`= `ReadButton` = `RButton` = `ReadFormButton` (old style... use Button instead) + +Sometimes there are multiple names for the same function. This is simply to make the job of the programmer quicker and easier. Or they are old names that are no longer used but kept around so that existing programs don't break. + +The 4 primary windows of PySimpleGUI buttons and their names are: + + 1. `Button`= `ReadButton` = `RButton` = `ReadFormButton` (old style... use Button instead) 2. `CloseButton` = `CButton` - 3. `RealtimeButton` + 3. `RealtimeButton` 4. `DummyButton` - -You will find the long-form names in the older programs. ReadButton for example. + +You will find the long-form names in the older programs. ReadButton for example. In Oct 2018, the definition of Button changed. Previously Button would CLOSE the window when clicked. It has been changed so the Button calls will leave the window open in exactly the same way as a ReadButton. They are the same calls now. To enables windows to be closed using buttons, a new button was added... `CloseButton` or `CButton`. - -The most basic Button element call to use is `Button` - - - -```python -Button(button_text="", - button_type=7, - target=(None, None), - tooltip=None, - file_types=(('ALL Files', '*.*'),), - initial_folder=None, - disabled=False, - change_submits=False, - enable_events=False, - image_filename=None, - image_data=None, - image_size=(None, None), - image_subsample=None, - border_width=None, - size=(None, None), - auto_size_button=None, - button_color=None, - font=None, - bind_return_key=False, - focus=False, - pad=None, - key=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| button_text | (Default value = '') | -| button_type | (Default value = BUTTON_TYPE_READ_FORM) | -| target | | -| tooltip | text, that will appear the you hover on (Default value = None) | -| file_types | (Default value = (("ALL Files", "*.*"),)) | -| initial_folder | (Default value = None) | -| disabled | set disable state for element (Default value = False) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| image_filename | (Default value = None) | -| image_data | (Default value = None) | -| image_size | (Default value = (None) | -| image_subsample | (Default value = None) | -| border_width | (Default value = None) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) | -| auto_size_button | (Default value = None) | -| button_color | (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| bind_return_key | (Default value = False) | -| focus | if focus should be set to this (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - -### Shortcut, Pre-defined Buttons -These Pre-made buttons are some of the most important elements of all because they are used so much. They all basically do the same thing, set the button text to match the function name and set the parameters to commonly used values. If you find yourself needing to create a custom button often because it's not on this list, please post a request on GitHub. . They include: - - OK - Ok - Submit - Cancel - Yes - No - Exit - Quit - Help - Save - SaveAs - FileBrowse - FilesBrowse - FileSaveAs - FolderBrowse + +The most basic Button element call to use is `Button` + + Button(button_text='' + button_type=BUTTON_TYPE_CLOSES_WIN + target=(None, None) + tooltip=None + file_types=(("ALL Files", "*.*"),) + initial_folder=None + disabled = False + image_filename=None + image_data=None + image_size=(None, None) + image_subsample=None + border_width=None + size=(None, None) + auto_size_button=None + button_color=None + default_value = None + font=None + bind_return_key=False + focus=False + pad=None + key=None, + visible=True): + +Parameters + + button_text - Text to be displayed on the button + button_type - You should NOT be setting this directly + target - key or (row,col) target for the button + tooltip - tooltip text for the button + file_types - the filetypes that will be used to match files + initial_folder - starting path for folders and files + disabled = Bool If True button is disabled + image_filename - image filename if there is a button image + image_data - in-RAM image to be displayed on button + image_size - size of button image in pixels + image_subsample - amount to reduce the size of the image + border_width - width of border around button in pixels + size - size in characters + auto_size_button - True if button size is determined by button text + button_color - (text color, backound color) + default_value - initial value for buttons that hold information + font - font to use for button text + bind_return_key - If True the return key will cause this button to fire + focus - if focus should be set to this button + pad - (x,y) padding in pixels for packing the button + key - key used for finding the element + +### Shortcut, Pre-defined Buttons +These Pre-made buttons are some of the most important elements of all because they are used so much. They all basically do the same thing, set the button text to match the function name and set the parameters to commonly used values. If you find yourself needing to create a custom button often because it's not on this list, please post a request on GitHub. . They include: + + OK + Ok + Submit + Cancel + Yes + No + Exit + Quit + Help + Save + SaveAs + FileBrowse + FilesBrowse + FileSaveAs + FolderBrowse **IMPORT NOTE ABOUT SHORTCUT BUTTONS** Prior to release 3.11.0, these buttons closed the window. Starting with 3.11 they will not close the window. They act like RButtons (return the button text and do not close the window) -If you are having trouble with these buttons closing your window, please check your installed version of PySimpleGUI by typing `pip list` at a command prompt. Prior to 3.11 these buttons close your window. +If you are having trouble with these buttons closing your window, please check your installed version of PySimpleGUI by typing `pip list` at a command prompt. Prior to 3.11 these buttons close your window. Using older versions, if you want a Submit() button that does not close the window, then you would instead use RButton('Submit'). Using the new version, if you want a Submit button that closes the window like the sold Submit() call did, you would write that as `CloseButton('Submit')` or `CButton('Submit')` - layout = [[sg.OK(), sg.Cancel()]] - -![ok cancel 3](https://user-images.githubusercontent.com/13696193/44959927-aa5f5e80-aec4-11e8-86e1-5dc0b3a2b803.jpg) + layout = [[sg.OK(), sg.Cancel()]] + +![ok cancel 3](https://user-images.githubusercontent.com/13696193/44959927-aa5f5e80-aec4-11e8-86e1-5dc0b3a2b803.jpg) + - -### Button targets - -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 -2. (row, column) - -Targets that are specified using a key will find its target element by using the target's key value. This is the "preferred" method. - -If the Target is specified using (row, column) then it utilizes a grid system. The rows in your GUI are numbered starting with 0. The target can be specified as a hard coded grid item or it can be relative to the button. - -The (row, col) targeting can only target elements that are in the same "container". Containers are the Window, Column and Frame Elements. A File Browse button located inside of a Column is unable to target elements outside of that Column. - -The default value for `target` is `(ThisRow, -1)`. `ThisRow` is a special value that tells the GUI to use the same row as the button. The Y-value of -1 means the field one value to the left of the button. For a File or Folder Browse button, the field that it fills are generally to the left of the button is most cases. (ThisRow, -1) means the Element to the left of the button, on the same row. - -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 window as an example: - - -![file browse](https://user-images.githubusercontent.com/13696193/44959944-d1b62b80-aec4-11e8-8a68-9d79d37b2c81.jpg) - - -The `InputText` element is located at (1,0)... row 1, column 0. The `Browse` button is located at position (2,0). The Target for the button could be any of these values: - - Target = (1,0) - Target = (-1,0) - -The code for the entire window could be: - - layout = [[sg.T('Source Folder')], - [sg.In()], - [sg.FolderBrowse(target=(-1, 0)), sg.OK()]] - -or if using keys, then the code would be: - - layout = [[sg.T('Source Folder')], - [sg.In(key='input')], - [sg.FolderBrowse(target='input'), sg.OK()]] - -See how much easier the key method is? - -**Save & Open Buttons** - -There are 4 different types of File/Folder open dialog box available. If you are looking for a file to open, the `FileBrowse` is what you want. If you want to save a file, `SaveAs` is the button. If you want to get a folder name, then `FolderBrowse` is the button to use. To open several files at once, use the `FilesBrowse` button. It will create a list of files that are separated by ';' - - -![open](https://user-images.githubusercontent.com/13696193/45243804-2b529780-b2c3-11e8-90dc-6c9061db2a1e.jpg) - - -![folder](https://user-images.githubusercontent.com/13696193/45243805-2b529780-b2c3-11e8-95ee-fec3c0b11319.jpg) - - -![saveas](https://user-images.githubusercontent.com/13696193/45243807-2beb2e00-b2c3-11e8-8549-ba71cdc05951.jpg) - - - -**Calendar Buttons** - -These buttons pop up a calendar chooser window. The chosen date is returned as a string. - -![calendar](https://user-images.githubusercontent.com/13696193/45243374-99965a80-b2c1-11e8-8311-49777835ca40.jpg) - -**Color Chooser Buttons** - -These buttons pop up a standard color chooser window. The result is returned as a tuple. One of the returned values is an RGB hex representation. - -![color](https://user-images.githubusercontent.com/13696193/45243375-99965a80-b2c1-11e8-9779-b71bed85fab6.jpg) - - -**Custom Buttons** -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 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. - +### Button targets + +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 +2. (row, column) + +Targets that are specified using a key will find its target element by using the target's key value. This is the "preferred" method. + +If the Target is specified using (row, column) then it utilizes a grid system. The rows in your GUI are numbered starting with 0. The target can be specified as a hard coded grid item or it can be relative to the button. + +The (row, col) targeting can only target elements that are in the same "container". Containers are the Window, Column and Frame Elements. A File Browse button located inside of a Column is unable to target elements outside of that Column. + +The default value for `target` is `(ThisRow, -1)`. `ThisRow` is a special value that tells the GUI to use the same row as the button. The Y-value of -1 means the field one value to the left of the button. For a File or Folder Browse button, the field that it fills are generally to the left of the button is most cases. (ThisRow, -1) means the Element to the left of the button, on the same row. + +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 window as an example: + + +![file browse](https://user-images.githubusercontent.com/13696193/44959944-d1b62b80-aec4-11e8-8a68-9d79d37b2c81.jpg) + + +The `InputText` element is located at (1,0)... row 1, column 0. The `Browse` button is located at position (2,0). The Target for the button could be any of these values: + + Target = (1,0) + Target = (-1,0) + +The code for the entire window could be: + + layout = [[sg.T('Source Folder')], + [sg.In()], + [sg.FolderBrowse(target=(-1, 0)), sg.OK()]] + +or if using keys, then the code would be: + + layout = [[sg.T('Source Folder')], + [sg.In(key='input')], + [sg.FolderBrowse(target='input'), sg.OK()]] + +See how much easier the key method is? + +**Save & Open Buttons** + +There are 4 different types of File/Folder open dialog box available. If you are looking for a file to open, the `FileBrowse` is what you want. If you want to save a file, `SaveAs` is the button. If you want to get a folder name, then `FolderBrowse` is the button to use. To open several files at once, use the `FilesBrowse` button. It will create a list of files that are separated by ';' + + +![open](https://user-images.githubusercontent.com/13696193/45243804-2b529780-b2c3-11e8-90dc-6c9061db2a1e.jpg) + + +![folder](https://user-images.githubusercontent.com/13696193/45243805-2b529780-b2c3-11e8-95ee-fec3c0b11319.jpg) + + +![saveas](https://user-images.githubusercontent.com/13696193/45243807-2beb2e00-b2c3-11e8-8549-ba71cdc05951.jpg) + + + +**Calendar Buttons** + +These buttons pop up a calendar chooser window. The chosen date is returned as a string. + +![calendar](https://user-images.githubusercontent.com/13696193/45243374-99965a80-b2c1-11e8-8311-49777835ca40.jpg) + +**Color Chooser Buttons** + +These buttons pop up a standard color chooser window. The result is returned as a tuple. One of the returned values is an RGB hex representation. + +![color](https://user-images.githubusercontent.com/13696193/45243375-99965a80-b2c1-11e8-9779-b71bed85fab6.jpg) + + +**Custom Buttons** +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 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. + Your button images need to be in PNG or GIF format. When you make a button with an image, set the button background to the same color as the background. There's a button color TRANSPARENT_BUTTON that you can set your button color to in order for it to blend into the background. Note that this value is currently the same as the color as the default system background on Windows. If you want to set the button background color to the current system default, use the value COLOR_SYSTEM_DEFAULT as the background color. - -This example comes from the `Demo Media Player.py` example program. Because it's a non-blocking button, it's defined as `RButton`. You also put images on blocking buttons by using `Button`. - - - sg.RButton('Restart Song', button_color=sg.TRANSPARENT_BUTTON, - image_filename=image_restart, image_size=(50, 50), image_subsample=2, border_width=0) - -Three parameters are used for button images. - - image_filename - Filename. Can be a relative path - 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 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 window + +This example comes from the `Demo Media Player.py` example program. Because it's a non-blocking button, it's defined as `RButton`. You also put images on blocking buttons by using `Button`. + + + sg.RButton('Restart Song', button_color=sg.TRANSPARENT_BUTTON, + image_filename=image_restart, image_size=(50, 50), image_subsample=2, border_width=0) + +Three parameters are used for button images. + + image_filename - Filename. Can be a relative path + 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 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 window ```python - sg.RButton('Pause', button_color=sg.TRANSPARENT_BUTTON, - image_filename=image_pause, - image_size=(50, 50), - image_subsample=2, - border_width=0) + sg.RButton('Pause', button_color=sg.TRANSPARENT_BUTTON, + image_filename=image_pause, + image_size=(50, 50), + image_subsample=2, + border_width=0) ``` -This is one you'll have to experiment with at this point. Not up for an exhaustive explanation. - - **Realtime Buttons** - - Normally buttons are considered "clicked" when the mouse button is let UP after a downward click on the button. What about times when you need to read the raw up/down button values. A classic example for this is a robotic remote control. Building a remote control using a GUI is easy enough. One button for each of the directions is a start. Perhaps something like this: - -![robot remote](https://user-images.githubusercontent.com/13696193/44959958-ff9b7000-aec4-11e8-99ea-7450926409be.jpg) - - -This window has 2 button types. There's the normal "Read Button" (Quit) and 4 "Realtime Buttons". - -Here is the code to make, show and get results from this window: +This is one you'll have to experiment with at this point. Not up for an exhaustive explanation. + + **Realtime Buttons** + + Normally buttons are considered "clicked" when the mouse button is let UP after a downward click on the button. What about times when you need to read the raw up/down button values. A classic example for this is a robotic remote control. Building a remote control using a GUI is easy enough. One button for each of the directions is a start. Perhaps something like this: + +![robot remote](https://user-images.githubusercontent.com/13696193/44959958-ff9b7000-aec4-11e8-99ea-7450926409be.jpg) + + +This window has 2 button types. There's the normal "Read Button" (Quit) and 4 "Realtime Buttons". + +Here is the code to make, show and get results from this window: ```python -import PySimpleGUI as sg - -gui_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')], - [sg.T('')], - [sg.Quit(button_color=('black', 'orange'))] - ] - -window = sg.Window('Robotics Remote Control', auto_size_text=True).Layout(gui_rows) - -# -# Some place later in your code... -# You need to perform a Read or Refresh call on your window every now and then or -# else it will apprear as if the program has locked up. -# -# your program's main loop -while (True): - # This is the code that reads and updates your window - event, values = window.Read(timeout=0) - if event is not None: - print(event) - if event == 'Quit' or values is None: - break - +import PySimpleGUI as sg + +gui_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')], + [sg.T('')], + [sg.Quit(button_color=('black', 'orange'))] + ] + +window = sg.Window('Robotics Remote Control', auto_size_text=True).Layout(gui_rows) + +# +# Some place later in your code... +# You need to perform a Read or Refresh call on your window every now and then or +# else it will apprear as if the program has locked up. +# +# your program's main loop +while (True): + # This is the code that reads and updates your window + event, values = window.Read(timeout=0) + if event is not None: + print(event) + if event == 'Quit' or values is None: + break + window.Close() # Don't forget to close your window! ``` -This loop will read button values and print them. When one of the Realtime buttons is clicked, the call to `window.Read` will return a button name matching the name on the button that was depressed or the key if there was a key assigned to the button. It will continue to return values as long as the button remains depressed. Once released, the Read will return timeout events 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 window where the Browse button only shows files of type .TXT - - layout = [[sg.In() ,sg.FileBrowse(file_types=(("Text Files", "*.txt"),))]] - +This loop will read button values and print them. When one of the Realtime buttons is clicked, the call to `window.Read` will return a button name matching the name on the button that was depressed or the key if there was a key assigned to the button. It will continue to return values as long as the button remains depressed. Once released, the Read will return timeout events 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 window where the Browse button only shows files of type .TXT + + layout = [[sg.In() ,sg.FileBrowse(file_types=(("Text Files", "*.txt"),))]] + NOTE - Mac users will not be able to use the file_types parameter. tkinter has a bug on Macs that will crash the program is a file_type is attempted so that feature had to be removed. Sorry about that! - ***The ENTER key*** - 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 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. - - -### Button Methods -```python + ***The ENTER key*** + 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 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. + + +### Button Methods +```python Update(text=None, button_color=(None, None), disabled=None, image_data=None, image_filename=None, visible=None) -GetText() -``` -Update - Change the button element - - text - sets button text - button color - (text, background) - disabled - if True disables the button - image_data - sets button image to in-ram image - image_filename - sets button image using a file +GetText() +``` +Update - Change the button element + text - sets button text + button color - (text, background) + disabled - if True disables the button + image_data - sets button image to in-ram image + image_filename - sets button image using a file + GetText - Returns the current text shown on a button - ## ButtonMenu Element The ButtonMenu element produces a unique kind of effect. It's a button, that when clicked, shows you a menu. It's like clicking one of the top-level menu items on a MenuBar. As a result, the menu definition take the format of a single menu entry from a normal menu definition. A normal menu definition is a list of lists. This definition is one of those lists. @@ -3411,73 +2765,25 @@ Here is a sample definition: The very first string normally specifies what is shown on the menu bar. In this case, the value is **not used**. You set the text for the button using a different parameter, the `button_text` parm. - - -```python -ButtonMenu(button_text, - menu_def, - tooltip=None, - disabled=False, - image_filename=None, - image_data=None, - image_size=(None, None), - image_subsample=None, - border_width=None, - size=(None, None), - auto_size_button=None, - button_color=None, - font=None, - pad=None, - key=None, - tearoff=False, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| button_text | | -| menu_def | | -| tooltip | text, that will appear the you hover on (Default value = None) | -| disabled | set disable state for element (Default value = False) | -| image_filename | (Default value = None) | -| image_data | (Default value = None) | -| image_size | (Default value = (None, None)) | -| image_subsample | (Default value = None) | -| border_width | (Default value = None) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) | -| auto_size_button | (Default value = None) | -| button_color | (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| tearoff | (Default value = False) | -| visible | set visibility state of the element (Default value = True) | -||| - - - One use of this element is to make a "fake menu bar" that has a colored background. Normal menu bars cannot have their background color changed. Not so with ButtonMenus. @@ -3491,544 +2797,366 @@ Return values for ButtonMenus are sent via the return values dictionary. If a s - -## VerticalSeparator Element +## Vertical Separator Element This element has limited usefulness and is being included more for completeness than anything else. It will draw a line between elements. - ```python VerticalSeparator(pad=None) ``` - + ![snag-0129](https://user-images.githubusercontent.com/13696193/47376041-a92a0100-d6bf-11e8-8f5b-0c0df56cf0f3.jpg) - + It works best when placed between columns or elements that span multiple rows. If on a "normal" row with elements that are only 1 row high, then it will only span that one row. - -## ProgressBar Element -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. - - sg.OneLineProgressMeter('My Meter', i+1, 1000, 'key', 'Optional message') - -The return value for `OneLineProgressMeter` is: -`True` if meter updated correctly -`False` if user clicked the Cancel button, closed the window, or vale reached the max value. - -#### 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 window - layout = [[sg.Text('A custom progress meter')], - [sg.ProgressBar(10000, orientation='h', size=(20, 20), key='progressbar')], - [sg.Cancel()]] - - # 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 - event, values = window.Read(timeout=0) - if event == 'Cancel' or event is 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 - window.Close()) - - -#### Output -The Output Element is a re-direction of Stdout. Anything "printed" will be displayed in this element. - - Output(size=(None, None)) - -Here's a complete solution for a chat-window using an Async window with an Output Element - - import PySimpleGUI as sg - - # 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))], - [sg.Multiline(size=(70, 5), enter_submits=True), - sg.RButton('SEND', button_color=(sg.YELLOWS[0], sg.BLUES[0])), - sg.Button('EXIT', button_color=(sg.YELLOWS[0], sg.GREENS[0]))]] - - 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: - event, value = window.Read() - if event == 'SEND': - print(value) - else: - break - - ChatBot() - -### ProgressBar Methods +## ProgressBar Element +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. + + sg.OneLineProgressMeter('My Meter', i+1, 1000, 'key', 'Optional message') + +The return value for `OneLineProgressMeter` is: +`True` if meter updated correctly +`False` if user clicked the Cancel button, closed the window, or vale reached the max value. + +#### 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 window + layout = [[sg.Text('A custom progress meter')], + [sg.ProgressBar(10000, orientation='h', size=(20, 20), key='progressbar')], + [sg.Cancel()]] + + # 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 + event, values = window.Read(timeout=0) + if event == 'Cancel' or event is 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 + window.Close()) + + +#### Output +The Output Element is a re-direction of Stdout. Anything "printed" will be displayed in this element. + + Output(size=(None, None)) + +Here's a complete solution for a chat-window using an Async window with an Output Element + + import PySimpleGUI as sg + + # 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))], + [sg.Multiline(size=(70, 5), enter_submits=True), + sg.RButton('SEND', button_color=(sg.YELLOWS[0], sg.BLUES[0])), + sg.Button('EXIT', button_color=(sg.YELLOWS[0], sg.GREENS[0]))]] + + 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: + event, value = window.Read() + if event == 'SEND': + print(value) + else: + break + + ChatBot() + +### ProgressBar Methods +```python +UpdateBar(current_count, max=None) +``` +current_count - sets the current value +max - changes the max value + + +## Column Element +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 window is, as a list of lists. + ```python -UpdateBar(current_count, max=None) -``` -current_count - sets the current value -max - changes the max value - - - -## Column Element -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 window is, as a list of lists. - - - -```python -Column(layout, - background_color=None, - size=(None, None), - pad=None, - scrollable=False, - vertical_scroll_only=False, - right_click_menu=None, - key=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| layout | | -| background_color | color of background (Default value = None) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| scrollable | (Default value = False) | -| vertical_scroll_only | (Default value = False) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - - - - -Columns are needed when you have an element that has a height > 1 line on the left, with single-line elements on the right. Here's an example of this kind of layout: - - -![column](https://user-images.githubusercontent.com/13696193/44959988-66b92480-aec5-11e8-9c26-316ed24a68c0.jpg) - - -This code produced the above window. - - - import PySimpleGUI as sg - - # Demo of how columns work - # 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 window layouts, they are a list of lists of elements. - - window = sg.Window('Columns') # blank window - - # Column layout - col = [[sg.Text('col Row 1')], - [sg.Text('col Row 2'), sg.Input('col input 1')], - [sg.Text('col Row 3'), sg.Input('col input 2')], - [sg.Text('col Row 4'), sg.Input('col input 3')], - [sg.Text('col Row 5'), sg.Input('col input 4')], - [sg.Text('col Row 6'), sg.Input('col input 5')], - [sg.Text('col Row 7'), sg.Input('col input 6')]] - - layout = [[sg.Slider(range=(1,100), default_value=10, orientation='v', size=(8,20)), sg.Column(col)], - [sg.In('Last input')], - [sg.OK()]] - - # 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 window display and read down to a single line of code. - event, values = sg.Window('Compact 1-line window with column').Layout(layout).Read() - - sg.Popup(event, 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 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 window, the column background will match the window background automatically. - - - ----- -## Frame Element (Labelled Frames, Frames with a title) - -Frames work exactly the same way as Columns. You create layout that is then used to initialize the Frame. +``` + + + +Columns are needed when you have an element that has a height > 1 line on the left, with single-line elements on the right. Here's an example of this kind of layout: + + +![column](https://user-images.githubusercontent.com/13696193/44959988-66b92480-aec5-11e8-9c26-316ed24a68c0.jpg) + + +This code produced the above window. + + + import PySimpleGUI as sg + + # Demo of how columns work + # 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 window layouts, they are a list of lists of elements. + + window = sg.Window('Columns') # blank window + + # Column layout + col = [[sg.Text('col Row 1')], + [sg.Text('col Row 2'), sg.Input('col input 1')], + [sg.Text('col Row 3'), sg.Input('col input 2')], + [sg.Text('col Row 4'), sg.Input('col input 3')], + [sg.Text('col Row 5'), sg.Input('col input 4')], + [sg.Text('col Row 6'), sg.Input('col input 5')], + [sg.Text('col Row 7'), sg.Input('col input 6')]] + + layout = [[sg.Slider(range=(1,100), default_value=10, orientation='v', size=(8,20)), sg.Column(col)], + [sg.In('Last input')], + [sg.OK()]] + + # 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 window display and read down to a single line of code. + event, values = sg.Window('Compact 1-line window with column').Layout(layout).Read() + + sg.Popup(event, 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 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 window, the column background will match the window background automatically. + + + +---- +## Frame Element (Labelled Frames, Frames with a title) + +Frames work exactly the same way as Columns. You create layout that is then used to initialize the Frame. ```python -Frame( title, - layout, - title_color=None, - background_color=None, +Frame( title, + layout, + title_color=None, + background_color=None, title_location=None, - relief=DEFAULT_FRAME_RELIEF, - size=(None, None), + relief=DEFAULT_FRAME_RELIEF, + size=(None, None), font=None, - pad=None, + pad=None, border_width=None, - key=None, - tooltip=None, - right_click_menu=None, + key=None, + tooltip=None, + right_click_menu=None, visible=True) -``` - def Frame(title - the label / title to put on frame - layout - list of rows of elements the frame contains - title_color - color of the title text - background_color - color of background - title_location - locations to put the title - relief - type of relief to use - size - size of Frame in characters. Do not use if you want frame to autosize - font - font to use for title - pad - element padding to use when packing - border_width - how thick the line going around frame should be - key - key used to location the element - tooltip - tooltip text - - - -This code creates a window with a Frame and 2 buttons. - - frame_layout = [ - [sg.T('Text inside of a frame')], - [sg.CB('Check 1'), sg.CB('Check 2')], - ] - layout = [ - [sg.Frame('My Frame Title', frame_layout, font='Any 12', title_color='blue')], - [sg.Submit(), sg.Cancel()] - ] - - 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 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. - - -## Canvas Element - - - - +``` + def Frame(title - the label / title to put on frame + layout - list of rows of elements the frame contains + title_color - color of the title text + background_color - color of background + title_location - locations to put the title + relief - type of relief to use + size - size of Frame in characters. Do not use if you want frame to autosize + font - font to use for title + pad - element padding to use when packing + border_width - how thick the line going around frame should be + key - key used to location the element + tooltip - tooltip text + + + +This code creates a window with a Frame and 2 buttons. + + frame_layout = [ + [sg.T('Text inside of a frame')], + [sg.CB('Check 1'), sg.CB('Check 2')], + ] + layout = [ + [sg.Frame('My Frame Title', frame_layout, font='Any 12', title_color='blue')], + [sg.Submit(), sg.Cancel()] + ] + + 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 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. + +## Canvas Element + ```python Canvas(canvas=None, - background_color=None, - size=(None, None), - pad=None, - key=None, - tooltip=None, - right_click_menu=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| canvas | (Default value = None) | -| background_color | color of background (Default value = None) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - -In my opinion, the tkinter Canvas Widget is the most powerful of the tkinter widget. While I try my best to completely isolate the user from anything that is tkinter related, the Canvas Element is the one exception. It enables integration with a number of other packages, often with spectacular results. - -### Matplotlib, Pyplot Integration - -One such integration is with Matploplib and Pyplot. There is a Demo program written that you can use as a design pattern to get an understanding of how to use the Canvas Widget once you get it. - - def Canvas(canvas - a tkinter canvasf if you created one. Normally not set - background_color - canvas color - size - size in pixels - pad - element padding for packing - key - key used to lookup element - tooltip - tooltip text - -The order of operations to obtain a tkinter Canvas Widget is: - - figure_x, figure_y, figure_w, figure_h = fig.bbox.bounds - # 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 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(window.FindElement('canvas').TKCanvas, fig) - - # show it all again and get buttons - event, values = window.Read() - -To get a tkinter Canvas Widget from PySimpleGUI, follow these steps: -* 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 `window.Read()` - Nothing will appear on your canvas until you call Read - -See `Demo_Matplotlib.py` for a Recipe you can copy. - - -### Canvas Methods - -TKCanvas - not a method but a property. Returns the tkinter Canvas Widget - - - - -## Graph Element - -All you math fans will enjoy this Element... and all you non-math fans will enjoy it too. - -I've found nothing to be less fun than dealing with a graphic's coordinate system from a GUI Framework. It's always upside down from what I want. (0,0) is in the upper left hand corner. In short, it's a **pain in the ass**. - -Graph Element to the rescue. A Graph Element creates a pixel addressable canvas using YOUR coordinate system. *You* get to define the units on the X and Y axis. - -There are 3 values you'll need to supply the Graph Element. They are: -* Size of the canvas in pixels -* The lower left (x,y) coordinate of your coordinate system -* The upper right (x,y) coordinate of your coordinate system - -After you supply those values you can scribble all of over your graph by creating Graph Figures. Graph Figures are created, and a Figure ID is obtained by calling: -* DrawCircle -* DrawLine -* DrawPoint -* DrawRectangle -* DrawOval +In my opinion, the tkinter Canvas Widget is the most powerful of the tkinter widget. While I try my best to completely isolate the user from anything that is tkinter related, the Canvas Element is the one exception. It enables integration with a number of other packages, often with spectacular results. + +### Matplotlib, Pyplot Integration + +One such integration is with Matploplib and Pyplot. There is a Demo program written that you can use as a design pattern to get an understanding of how to use the Canvas Widget once you get it. + + def Canvas(canvas - a tkinter canvasf if you created one. Normally not set + background_color - canvas color + size - size in pixels + pad - element padding for packing + key - key used to lookup element + tooltip - tooltip text + +The order of operations to obtain a tkinter Canvas Widget is: + + figure_x, figure_y, figure_w, figure_h = fig.bbox.bounds + # 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 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(window.FindElement('canvas').TKCanvas, fig) + + # show it all again and get buttons + event, values = window.Read() + +To get a tkinter Canvas Widget from PySimpleGUI, follow these steps: +* 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 `window.Read()` - Nothing will appear on your canvas until you call Read + +See `Demo_Matplotlib.py` for a Recipe you can copy. + + +### Canvas Methods + +TKCanvas - not a method but a property. Returns the tkinter Canvas Widget + + + +## Graph Element + +All you math fans will enjoy this Element... and all you non-math fans will enjoy it too. + +I've found nothing to be less fun than dealing with a graphic's coordinate system from a GUI Framework. It's always upside down from what I want. (0,0) is in the upper left hand corner. In short, it's a **pain in the ass**. + +Graph Element to the rescue. A Graph Element creates a pixel addressable canvas using YOUR coordinate system. *You* get to define the units on the X and Y axis. + +There are 3 values you'll need to supply the Graph Element. They are: +* Size of the canvas in pixels +* The lower left (x,y) coordinate of your coordinate system +* The upper right (x,y) coordinate of your coordinate system + +After you supply those values you can scribble all of over your graph by creating Graph Figures. Graph Figures are created, and a Figure ID is obtained by calling: +* DrawCircle +* DrawLine +* DrawPoint +* DrawRectangle +* DrawOval * DrawImage - -You can move your figures around on the canvas by supplying the Figure ID the x,y amount to move. - - graph.MoveFigure(my_circle, 10, 10) - -This Element is relatively new and may have some parameter additions or deletions. It shouldn't break your code however. - - - - + +You can move your figures around on the canvas by supplying the Figure ID the x,y amount to move. + + graph.MoveFigure(my_circle, 10, 10) + +This Element is relatively new and may have some parameter additions or deletions. It shouldn't break your code however. + ```python -Graph(canvas_size, - graph_bottom_left, - graph_top_right, - background_color=None, - pad=None, - change_submits=False, - drag_submits=False, - enable_events=False, - key=None, - tooltip=None, - right_click_menu=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| canvas_size | | -| graph_bottom_left | | -| graph_top_right | | -| background_color | color of background (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| drag_submits | (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - - - -### Graph Methods -```python -DrawLine(self, point_from, point_to, color='black', width=1) -DrawPoint(self, point, size=2, color='black') -DrawCircle(self, center_location, radius, fill_color=None, line_color='black') -DrawOval(self, top_left, bottom_right, fill_color=None, line_color=None) -DrawArc(self, top_left, bottom_right, extent, start_angle, style=None, arc_color='black') -DrawRectangle(self, top_left, bottom_right, fill_color=None, line_color=None) -DrawText(self, text, location, color='black', font=None, angle=0) -Erase(background_color) +``` + +### Graph Methods +```python +DrawLine(self, point_from, point_to, color='black', width=1) +DrawPoint(self, point, size=2, color='black') +DrawCircle(self, center_location, radius, fill_color=None, line_color='black') +DrawOval(self, top_left, bottom_right, fill_color=None, line_color=None) +DrawArc(self, top_left, bottom_right, extent, start_angle, style=None, arc_color='black') +DrawRectangle(self, top_left, bottom_right, fill_color=None, line_color=None) +DrawText(self, text, location, color='black', font=None, angle=0) +Erase(background_color) DeleteFigure(figure_id) -Update() -Move(self, x_direction, y_direction) -MoveFigure(self, figure, x_direction, y_direction) -RelocateFigure(self, figure, x, y) -TKCanvas -``` -All of the Drawing methods return a "***figure***" that can be used move and delete the figure - -DrawLine - draws a line -DrawPoint - draws a single point -DrawCircle - draws a circle -DrawOval - draws an oval -DrawArc - draws an arc -DrawRectangle - draws a rectangle -DrawText - draws text +Update() +Move(self, x_direction, y_direction) +MoveFigure(self, figure, x_direction, y_direction) +RelocateFigure(self, figure, x, y) +TKCanvas +``` +All of the Drawing methods return a "***figure***" that can be used move and delete the figure + +DrawLine - draws a line +DrawPoint - draws a single point +DrawCircle - draws a circle +DrawOval - draws an oval +DrawArc - draws an arc +DrawRectangle - draws a rectangle +DrawText - draws text DrawImage - places an image onto the graph -Erase - erases entire graph -Update - changes background color -Move - moves everything an x,y direction +Erase - erases entire graph +Update - changes background color +Move - moves everything an x,y direction MoveFigure - moves an individual figure by some delta -RelocateFigure - moves figure to an absolute location +RelocateFigure - moves figure to an absolute location DeleteFigure - delete an individual figure - - - -## Table Element - + + +## Table Element + Out of all of the Elements, it's the Table and the Tree that are the most "problematic" in the tkinter inter and Qt implementations. They're hard is my only defense. ### Known visualization problem.... If you click on the header, it can go into spasms for some tables. I don't understand what's causing it and it's been there evidently since the first release of Tables. - - - - + ```python -Table(values, - headings=None, - visible_column_map=None, - col_widths=None, - def_col_width=10, - auto_size_columns=True, - max_col_width=20, - select_mode=None, - display_row_numbers=False, - num_rows=None, - row_height=None, - font=None, - justification="right", - text_color=None, - background_color=None, - alternating_row_color=None, - row_colors=None, - vertical_scroll_only=True, - hide_vertical_scroll=False, - size=(None, None), - change_submits=False, - enable_events=False, - bind_return_key=False, - pad=None, - key=None, - tooltip=None, - right_click_menu=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| values | | -| headings | (Default value = None) | -| visible_column_map | (Default value = None) | -| col_widths | (Default value = None) | -| def_col_width | (Default value = 10) | -| auto_size_columns | (Default value = True) | -| max_col_width | (Default value = 20) | -| select_mode | (Default value = None) | -| display_row_numbers | (Default value = False) | -| num_rows | (Default value = None) | -| row_height | (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| justification | (Default value = 'right') | -| text_color | color of the text (Default value = None) | -| background_color | color of background (Default value = None) | -| alternating_row_color | (Default value = None) | -| row_colors | (Default value = None) | -| vertical_scroll_only | (Default value = True) | -| hide_vertical_scroll | (Default value = False) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| bind_return_key | (Default value = False) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - - - - +pad - element padding for packing +key - key used to lookup element +tooltip - tooltip text + ### Read return values from Table Element The values returned from a `Window.Read` call for the Tree Element are a list of row numbers that are currently highlighted. @@ -4099,122 +3226,61 @@ def Update(self, values=None): ``` `values` is a table containing your rows just like you passed in when creating the Table Element. - -## Tree Element - -The Tree Element and Table Element are close cousins. Many of the parameters found in the Table Element apply to Tree Elements. In particular the heading information, column widths, etc. - - - +## Tree Element + +The Tree Element and Table Element are close cousins. Many of the parameters found in the Table Element apply to Tree Elements. In particular the heading information, column widths, etc. + ```python -Tree(data=None, - headings=None, - visible_column_map=None, - col_widths=None, - col0_width=10, - def_col_width=10, - auto_size_columns=True, - max_col_width=20, - select_mode=None, - show_expanded=False, - change_submits=False, - enable_events=False, - font=None, - justification="right", - text_color=None, - background_color=None, - num_rows=None, - row_height=None, - pad=None, - key=None, - tooltip=None, - right_click_menu=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| data | (Default value = None) | -| headings | (Default value = None) | -| visible_column_map | (Default value = None) | -| col_widths | (Default value = None) | -| col0_width | (Default value = 10) | -| def_col_width | (Default value = 10) | -| auto_size_columns | (Default value = True) | -| max_col_width | (Default value = 20) | -| select_mode | (Default value = None) | -| show_expanded | (Default value = False) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| justification | (Default value = 'right') | -| text_color | color of the text (Default value = None) | -| background_color | color of background (Default value = None) | -| num_rows | (Default value = None) | -| row_height | (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - - - -Unlike Tables there is no standard format for trees. Thus the data structure passed to the Tree Element must be constructed. This is done using the TreeData class. The process is as follows: -* Get a TreeData Object -* "Insert" data into the tree -* Pass the filled in TreeData object to Tree Element +``` +class Tree(data=None - data in TreeData format + headings=None - list of strings representing your headings + visible_column_map=None - list of bools indicating which columns to display + col_widths=None - list of column widths + col0_width=10 - width of the first column which has the text data + def_col_width=10 - default column width + auto_size_columns=True - if true will autosize columns (currenly only sizes to col heading width) + max_col_width=20 - max width for columns in characters + select_mode=None - not yet used + show_expanded - Bool - if True the tree will be fully expanded when shown + font=None - the display font + justification='right' - justification for data display + text_color=None- color of text to display + background_color=None - background color + num_rows=None - number of rows to display + row_height=None - height of rows in pixels + pad=None - element padding + key=None - key for element + tooltip=None - tooltip +``` + +Unlike Tables there is no standard format for trees. Thus the data structure passed to the Tree Element must be constructed. This is done using the TreeData class. The process is as follows: +* Get a TreeData Object +* "Insert" data into the tree +* Pass the filled in TreeData object to Tree Element #### TreeData format ```python @@ -4222,25 +3288,25 @@ def TreeData() def Insert(self, parent, key, text, values, icon=None) ``` -To "insert" data into the tree the TreeData method Insert is called. - -`Insert(parent_key, key, display_text, values)` - -To indicate insertion at the head of the tree, use a parent key of "". So, every top-level node in the tree will have a parent node = "" - -This code creates a TreeData object and populates with 3 values -```python -treedata = sg.TreeData() - -treedata.Insert("", '_A_', 'A', [1,2,3]) -treedata.Insert("", '_B_', 'B', [4,5,6]) -treedata.Insert("_A_", '_A1_', 'A1', ['can','be','anything']) -``` - -Note that you ***can*** use the same values for display_text and keys. The only thing you have to watch for is that you cannot repeat keys. - -When Reading a window the Table Element will return a list of rows that are selected by the user. The list will be empty is no rows are selected. - +To "insert" data into the tree the TreeData method Insert is called. + +`Insert(parent_key, key, display_text, values)` + +To indicate insertion at the head of the tree, use a parent key of "". So, every top-level node in the tree will have a parent node = "" + +This code creates a TreeData object and populates with 3 values +```python +treedata = sg.TreeData() + +treedata.Insert("", '_A_', 'A', [1,2,3]) +treedata.Insert("", '_B_', 'B', [4,5,6]) +treedata.Insert("_A_", '_A1_', 'A1', ['can','be','anything']) +``` + +Note that you ***can*** use the same values for display_text and keys. The only thing you have to watch for is that you cannot repeat keys. + +When Reading a window the Table Element will return a list of rows that are selected by the user. The list will be empty is no rows are selected. + #### Icons on Tree Entries If you wish to show an icon next to a tree item, then you specify the icon in the call to `Insert`. You pass in a filename or a Base64 bytes string using the optional `icon` parameter. @@ -4249,141 +3315,105 @@ Here is the result of showing an icon with a tree entry. ![image](https://user-images.githubusercontent.com/13696193/51087270-2b561e80-171f-11e9-8260-6142ea9b1137.png) - -## Tab and Tab Group Elements - -Tabs have been a part of PySimpleGUI since the initial release. However, the initial implementation applied tabs at the top level only. The entire window had to be tabbed. There with other limitations that came along with that implementation. That all changed in version 3.8.0 with the new elements - Tab and TabGroup. The old implementation of Tabs was removed in version 3.8.0 as well. - -Tabs are another "Container Element". The other Container Elements include: -* Frame -* Column - -You layout a Frame in exactly the same way as a Frame or Column elements, by passing in a list of elements. - -How you place a Tab into a Window is different than Graph or Frame elements. You cannot place a tab directly into a Window's layout. It much first be placed into a TabGroup. The TabGroup can then be placed into the Window. - -Let's look at this Window as an example: - -![tabbed 1](https://user-images.githubusercontent.com/13696193/45992808-b10f6a80-c059-11e8-9746-ac71afd4d3d6.jpg) - -View of second tab: - -![tabbed 2](https://user-images.githubusercontent.com/13696193/45992809-b10f6a80-c059-11e8-94e6-3bf543c9b0bd.jpg) - - -First we have the Tab layout definitions. They mirror what you see in the screen shots. Tab 1 has 1 Text Element in it. Tab 2 has a Text and an Input Element. - - - tab1_layout = [[sg.T('This is inside tab 1')]] - - tab2_layout = [[sg.T('This is inside tab 2')], - [sg.In(key='in')]] - -The layout for the entire window looks like this: - - layout = [[sg.TabGroup([[sg.Tab('Tab 1', tab1_layout), sg.Tab('Tab 2', tab2_layout)]])], - [sg.RButton('Read')]] - -The Window layout has the TabGroup and within the tab Group are the two Tab elements. - -One important thing to notice about all of these container Elements... they all take a "list of lists" at the layout. They all have a layout that starts with `[[` - -You will want to keep this `[[ ]]` construct in your head a you're debugging your tabbed windows. It's easy to overlook one or two necessary ['s - -As mentioned earlier, the old-style Tabs were limited to being at the Window-level only. In other words, the tabs were equal in size to the entire window. This is not the case with the "new-style" tabs. This is why you're not going to be upset when you discover your old code no longer works with the new PySimpleGUI release. It'll be worth the few moments it'll take to convert your code. - -Check out what's possible with the NEW Tabs! - -![tabs tabs tabs](https://user-images.githubusercontent.com/13696193/45993438-fd0fde80-c05c-11e8-9ed0-742f14d3070f.jpg) - - -Check out Tabs 7 and 8. We've got a Window with a Column containing Tabs 5 and 6. On Tab 6 are... Tabs 7 and 8. - -As of Release 3.8.0, not all of *options* shown in the API definitions of the Tab and TabGroup Elements are working. They are there as placeholders. - -The definition of a TabGroup is - - TabGroup(layout, - title_color=None - background_color=None - font=None - pad=None - border_width=None - change_submits = False - key=None - tooltip=None) - -The definition of a Tab Element is - - Tab(title, - layout, - title_color=None, - background_color=None, - font=None, - pad=None - disabled=False - border_width=None - key=None - tooltip=None) - - -### Reading Tab Groups - -Tab Groups now return a value when a Read returns. They return which tab is currently selected. There is also a change_submits parameter that can be set that causes a Read to return if a Tab in that group is selected / changed. The key or title belonging to the Tab that was switched to will be returned as the value - - -### Tab Element Methods -```python -Update(disabled = None, visible=None) -``` + +## Tab and Tab Group Elements + +Tabs have been a part of PySimpleGUI since the initial release. However, the initial implementation applied tabs at the top level only. The entire window had to be tabbed. There with other limitations that came along with that implementation. That all changed in version 3.8.0 with the new elements - Tab and TabGroup. The old implementation of Tabs was removed in version 3.8.0 as well. + +Tabs are another "Container Element". The other Container Elements include: +* Frame +* Column + +You layout a Frame in exactly the same way as a Frame or Column elements, by passing in a list of elements. + +How you place a Tab into a Window is different than Graph or Frame elements. You cannot place a tab directly into a Window's layout. It much first be placed into a TabGroup. The TabGroup can then be placed into the Window. + +Let's look at this Window as an example: + +![tabbed 1](https://user-images.githubusercontent.com/13696193/45992808-b10f6a80-c059-11e8-9746-ac71afd4d3d6.jpg) + +View of second tab: + +![tabbed 2](https://user-images.githubusercontent.com/13696193/45992809-b10f6a80-c059-11e8-94e6-3bf543c9b0bd.jpg) + + +First we have the Tab layout definitions. They mirror what you see in the screen shots. Tab 1 has 1 Text Element in it. Tab 2 has a Text and an Input Element. + + + tab1_layout = [[sg.T('This is inside tab 1')]] + + tab2_layout = [[sg.T('This is inside tab 2')], + [sg.In(key='in')]] + +The layout for the entire window looks like this: + + layout = [[sg.TabGroup([[sg.Tab('Tab 1', tab1_layout), sg.Tab('Tab 2', tab2_layout)]])], + [sg.RButton('Read')]] + +The Window layout has the TabGroup and within the tab Group are the two Tab elements. + +One important thing to notice about all of these container Elements... they all take a "list of lists" at the layout. They all have a layout that starts with `[[` + +You will want to keep this `[[ ]]` construct in your head a you're debugging your tabbed windows. It's easy to overlook one or two necessary ['s + +As mentioned earlier, the old-style Tabs were limited to being at the Window-level only. In other words, the tabs were equal in size to the entire window. This is not the case with the "new-style" tabs. This is why you're not going to be upset when you discover your old code no longer works with the new PySimpleGUI release. It'll be worth the few moments it'll take to convert your code. + +Check out what's possible with the NEW Tabs! + +![tabs tabs tabs](https://user-images.githubusercontent.com/13696193/45993438-fd0fde80-c05c-11e8-9ed0-742f14d3070f.jpg) + + +Check out Tabs 7 and 8. We've got a Window with a Column containing Tabs 5 and 6. On Tab 6 are... Tabs 7 and 8. + +As of Release 3.8.0, not all of *options* shown in the API definitions of the Tab and TabGroup Elements are working. They are there as placeholders. + +The definition of a TabGroup is + + TabGroup(layout, + title_color=None + background_color=None + font=None + pad=None + border_width=None + change_submits = False + key=None + tooltip=None) + +The definition of a Tab Element is + + Tab(title, + layout, + title_color=None, + background_color=None, + font=None, + pad=None + disabled=False + border_width=None + key=None + tooltip=None) + + +### Reading Tab Groups + +Tab Groups now return a value when a Read returns. They return which tab is currently selected. There is also a change_submits parameter that can be set that causes a Read to return if a Tab in that group is selected / changed. The key or title belonging to the Tab that was switched to will be returned as the value + + +### Tab Element Methods +```python +Update(disabled = None, visible=None) +``` WARNING - This Update method may not be working correctly - - + ## Pane Element New in version 3.20 is the Pane Element, a super-cool tkinter feature. You won't find this one in PySimpleGUIQt, only PySimpleGUI. It's difficult to describe one of these things. Think of them as "Tabs without labels" that you can slide. ![pane3](https://user-images.githubusercontent.com/13696193/50035040-fcd50e80-ffcd-11e8-939c-df8ab8d64712.gif) - - ```python -Pane(pane_list, - background_color=None, - size=(None, None), - pad=None, - orientation="vertical", - show_handle=True, - relief="raised", - handle_size=None, - border_width=None, - key=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| pane_list | | -| background_color | color of background (Default value = None) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| orientation | (Default value = 'vertical') | -| show_handle | (Default value = True) | -| relief | (Default value = RELIEF_RAISED) | -| handle_size | (Default value = None) | -| border_width | (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - +``` ***Each "Pane" of a Pane Element must be a Column Element***. The parameter `pane_list` is a list of Column Elements. @@ -4396,35 +3426,35 @@ sg.Pane([col5, sg.Column([[sg.Pane([col1, col2, col4], handle_size=15, orientati Combing these with *visibility* make for an interesting interface with entire panes being hidden from view until neded by the user. It's one way of producing "dynamic" windows. -## Colors -Starting in version 2.5 you can change the background colors for the window and the Elements. - -Your windows can go from this: - -![snap0155](https://user-images.githubusercontent.com/13696193/43273879-a9fdc10a-90cb-11e8-8c20-4f6a244ebe2f.jpg) - - -to this... with one function call... - - -![snap0156](https://user-images.githubusercontent.com/13696193/43273880-aa1955e6-90cb-11e8-94b6-673ecdb2698c.jpg) - - - -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 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. - - SetOptions(background_color='#9FB8AD', - text_element_background_color='#9FB8AD', - element_background_color='#9FB8AD', - scrollbar_color=None, - input_elements_background_color='#F7F3EC', - progress_meter_color = ('green', 'blue') - button_color=('white','#475841')) - +## Colors +Starting in version 2.5 you can change the background colors for the window and the Elements. + +Your windows can go from this: + +![snap0155](https://user-images.githubusercontent.com/13696193/43273879-a9fdc10a-90cb-11e8-8c20-4f6a244ebe2f.jpg) + + +to this... with one function call... + + +![snap0156](https://user-images.githubusercontent.com/13696193/43273880-aa1955e6-90cb-11e8-94b6-673ecdb2698c.jpg) + + + +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 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. + + SetOptions(background_color='#9FB8AD', + text_element_background_color='#9FB8AD', + element_background_color='#9FB8AD', + scrollbar_color=None, + input_elements_background_color='#F7F3EC', + progress_meter_color = ('green', 'blue') + button_color=('white','#475841')) + # SystemTray This is a PySimpleGUIQt and PySimpleGUIWx only feature. Don't know of a way to do it using tkinter. Your source code for SystemTray is identical for the Qt and Wx implementations. You can switch frameworks by simply changing your import statement. @@ -4434,13 +3464,13 @@ In addition to running normal windows, it's now also possible to have an icon do Here is the definition of the SystemTray object. ```python -SystemTray(menu=None, filename=None, data=None, data_base64=None, tooltip=None): - ''' - SystemTray - create an icon in the system tray - :param menu: Menu definition - :param filename: filename for icon - :param data: in-ram image for icon - :param data_base64: basee-64 data for icon +SystemTray(menu=None, filename=None, data=None, data_base64=None, tooltip=None): + ''' + SystemTray - create an icon in the system tray + :param menu: Menu definition + :param filename: filename for icon + :param data: in-ram image for icon + :param data_base64: basee-64 data for icon :param tooltip: tooltip string ''' ``` @@ -4453,27 +3483,27 @@ Here is a design pattern you can use to get a jump-start. This program will create a system tray icon and perform a blocking Read. If the item "Open" is chosen from the system tray, then a popup is shown. ```python -import PySimpleGUIQt as sg - -menu_def = ['BLANK', ['&Open', '---', '&Save', ['1', '2', ['a', 'b']], '&Properties', 'E&xit']] - -tray = sg.SystemTray(menu=menu_def, filename=r'default_icon.ico') - -while True: # The event loop - menu_item = tray.Read() - print(menu_item) - if menu_item == 'Exit': - break - elif menu_item == 'Open': - sg.Popup('Menu item chosen', menu_item) - +import PySimpleGUIQt as sg + +menu_def = ['BLANK', ['&Open', '---', '&Save', ['1', '2', ['a', 'b']], '&Properties', 'E&xit']] + +tray = sg.SystemTray(menu=menu_def, filename=r'default_icon.ico') + +while True: # The event loop + menu_item = tray.Read() + print(menu_item) + if menu_item == 'Exit': + break + elif menu_item == 'Open': + sg.Popup('Menu item chosen', menu_item) + ``` The design pattern creates an icon that will display this menu: ![snag-0293](https://user-images.githubusercontent.com/13696193/49057441-8bbfe980-f1cd-11e8-93e7-1aeda9ccd173.jpg) ### Icons -When specifying "icons", you can use 3 different formats. +When specifying "icons", you can use 3 different formats. * `filename`- filename * `data_base64` - base64 byte string * '`data` - in-ram bitmap or other "raw" image @@ -4482,7 +3512,7 @@ You will find 3 parameters used to specify these 3 options on both the initializ ## Menu Definition ```python -menu_def = ['BLANK', ['&Open', '&Save', ['1', '2', ['a', 'b']], '!&Properties', 'E&xit']] +menu_def = ['BLANK', ['&Open', '&Save', ['1', '2', ['a', 'b']], '!&Properties', 'E&xit']] ``` A menu is defined using a list. A "Menu entry" is a string that specifies: @@ -4518,11 +3548,11 @@ If you want to disable a menu entry, place a `!` before the menu entry ```python def Read(timeout=None) - ''' - Reads the context menu + ''' + Reads the context menu :param timeout: Optional. Any value other than None indicates a non-blocking read - :return: String representing meny item chosen. None if nothing read. - ''' + :return: String representing meny item chosen. None if nothing read. + ''' ``` The `timeout` parameter specifies how long to wait for an event to take place. If nothing happens within the timeout period, then a "timeout event" is returned. These types of reads make it possible to run asynchronously. To run non-blocked, specify `timeout=0`on the Read call. @@ -4543,7 +3573,7 @@ TIMEOUT_KEY is returned if no events are available if the timeout value is set i Hides the icon. Note that no message balloons are shown while an icon is hidden. ```python -def Hide() +def Hide() ``` ### Close @@ -4564,7 +3594,7 @@ def UnHide() ### ShowMessage -Shows a balloon above the icon in the system tray area. You can specify your own icon to be shown in the balloon, or you can set `messageicon` to one of the preset values. +Shows a balloon above the icon in the system tray area. You can specify your own icon to be shown in the balloon, or you can set `messageicon` to one of the preset values. This message has a custom icon. @@ -4572,21 +3602,21 @@ This message has a custom icon. The preset `messageicon` values are: - SYSTEM_TRAY_MESSAGE_ICON_INFORMATION - SYSTEM_TRAY_MESSAGE_ICON_WARNING - SYSTEM_TRAY_MESSAGE_ICON_CRITICAL - SYSTEM_TRAY_MESSAGE_ICON_NOICON + SYSTEM_TRAY_MESSAGE_ICON_INFORMATION + SYSTEM_TRAY_MESSAGE_ICON_WARNING + SYSTEM_TRAY_MESSAGE_ICON_CRITICAL + SYSTEM_TRAY_MESSAGE_ICON_NOICON ```python -ShowMessage(title, message, filename=None, data=None, data_base64=None, messageicon=None, time=10000): - ''' - Shows a balloon above icon in system tray - :param title: Title shown in balloon - :param message: Message to be displayed - :param filename: Optional icon filename - :param data: Optional in-ram icon - :param data_base64: Optional base64 icon - :param time: How long to display message in milliseconds :return: +ShowMessage(title, message, filename=None, data=None, data_base64=None, messageicon=None, time=10000): + ''' + Shows a balloon above icon in system tray + :param title: Title shown in balloon + :param message: Message to be displayed + :param filename: Optional icon filename + :param data: Optional in-ram icon + :param data_base64: Optional base64 icon + :param time: How long to display message in milliseconds :return: ''' ``` Note, on windows it may be necessary to make a registry change to enable message balloons to be seen. To fix this, you must create the DWORD you see in this screenshot. @@ -4605,136 +3635,136 @@ You can update any of these items within a SystemTray object ```python Update(menu=None, tooltip=None,filename=None, data=None, data_base64=None,) - ''' - Updates the menu, tooltip or icon - :param menu: menu defintion - :param tooltip: string representing tooltip - :param filename: icon filename - :param data: icon raw image - :param data_base64: icon base 64 image - :return: + ''' + Updates the menu, tooltip or icon + :param menu: menu defintion + :param tooltip: string representing tooltip + :param filename: icon filename + :param data: icon raw image + :param data_base64: icon base 64 image + :return: ''' ``` - - -# Global Settings -**Global Settings** -Let's have some fun customizing! Make PySimpleGUI look the way you want it to look. You can set the global settings using the function `PySimpleGUI.SetOptions`. Each option has an optional parameter that's used to set it. - - SetOptions(icon=None - button_color=(None,None) - element_size=(None,None), - margins=(None,None), - element_padding=(None,None) - auto_size_text=None - auto_size_buttons=None - font=None - border_width=None - slider_border_width=None - slider_relief=None - slider_orientation=None - autoclose_time=None - message_box_line_width=None - progress_meter_border_depth=None - progress_meter_style=None - progress_meter_relief=None - progress_meter_color=None - progress_meter_size=None - text_justification=None - text_color=None - background_color=None - element_background_color=None - text_element_background_color=None - input_elements_background_color=None - element_text_color=None - input_text_color=None - scrollbar_color=None, text_color=None - debug_win_size=(None,None) - window_location=(None,None) - tooltip_time = None - -Explanation of parameters - - icon - filename of icon used for taskbar and title bar - button_color - button color (foreground, background) - element_size - element size (width, height) in characters - margins - tkinter margins around outsize - element_padding - tkinter padding around each element - auto_size_text - autosize the elements to fit their text - auto_size_buttons - autosize the buttons to fit their text - font - font used for elements - border_width - amount of bezel or border around sunken or raised elements - slider_border_width - changes the way sliders look - slider_relief - changes the way sliders look - slider_orientation - changes orientation of slider - autoclose_time - time in seconds for autoclose boxes - message_box_line_width - number of characers in a line of text in message boxes - progress_meter_border_depth - amount of border around raised or lowered progress meters - progress_meter_style - style of progress meter as defined by tkinter - progress_meter_relief - relief style - progress_meter_color - color of the bar and background of progress meters - progress_meter_size - size in (characters, pixels) - background_color - Color of the main window's background - element_background_color - Background color of the elements - text_element_background_color - Text element background color - input_elements_background_color - Input fields background color - element_text_color - Text color of elements that have text, like Radio Buttons - input_text_color - Color of the text that you type in - scrollbar_color - Color for scrollbars (may not always work) - text_color - Text element default text color - text_justification - justification to use on Text Elements. Values are strings - 'left', 'right', 'center' - debug_win_size - size of the Print output window - window_location - location on the screen (x,y) of window's top left cornder - tooltip_time - time in milliseconds to wait before showing a tooltip. Default is 400ms - - -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: - - - 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 windows (Window stays open after button click) - + + +# Global Settings +**Global Settings** +Let's have some fun customizing! Make PySimpleGUI look the way you want it to look. You can set the global settings using the function `PySimpleGUI.SetOptions`. Each option has an optional parameter that's used to set it. + + SetOptions(icon=None + button_color=(None,None) + element_size=(None,None), + margins=(None,None), + element_padding=(None,None) + auto_size_text=None + auto_size_buttons=None + font=None + border_width=None + slider_border_width=None + slider_relief=None + slider_orientation=None + autoclose_time=None + message_box_line_width=None + progress_meter_border_depth=None + progress_meter_style=None + progress_meter_relief=None + progress_meter_color=None + progress_meter_size=None + text_justification=None + text_color=None + background_color=None + element_background_color=None + text_element_background_color=None + input_elements_background_color=None + element_text_color=None + input_text_color=None + scrollbar_color=None, text_color=None + debug_win_size=(None,None) + window_location=(None,None) + tooltip_time = None + +Explanation of parameters + + icon - filename of icon used for taskbar and title bar + button_color - button color (foreground, background) + element_size - element size (width, height) in characters + margins - tkinter margins around outsize + element_padding - tkinter padding around each element + auto_size_text - autosize the elements to fit their text + auto_size_buttons - autosize the buttons to fit their text + font - font used for elements + border_width - amount of bezel or border around sunken or raised elements + slider_border_width - changes the way sliders look + slider_relief - changes the way sliders look + slider_orientation - changes orientation of slider + autoclose_time - time in seconds for autoclose boxes + message_box_line_width - number of characers in a line of text in message boxes + progress_meter_border_depth - amount of border around raised or lowered progress meters + progress_meter_style - style of progress meter as defined by tkinter + progress_meter_relief - relief style + progress_meter_color - color of the bar and background of progress meters + progress_meter_size - size in (characters, pixels) + background_color - Color of the main window's background + element_background_color - Background color of the elements + text_element_background_color - Text element background color + input_elements_background_color - Input fields background color + element_text_color - Text color of elements that have text, like Radio Buttons + input_text_color - Color of the text that you type in + scrollbar_color - Color for scrollbars (may not always work) + text_color - Text element default text color + text_justification - justification to use on Text Elements. Values are strings - 'left', 'right', 'center' + debug_win_size - size of the Print output window + window_location - location on the screen (x,y) of window's top left cornder + tooltip_time - time in milliseconds to wait before showing a tooltip. Default is 400ms + + +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: + + - 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 windows (Window stays open after button click) + Apologies that the next few pages are perhaps confusing. There have been a number of changes recently in PySimpleGUI's Read calls that added some really cool stuff, but at the expense of being not so simple. Part of the issue is an attempt to make sure existing code doesn't break. These changes are all in the area of non-blocking reads and reads with timeouts. -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. - +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 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 normal `Read` call with no parameters will block, a call with a `timeout` value of zero will not block. -Note that `InputText` and `MultiLine` Elements will be **cleared** when performing a `Read`. If you do not want your input field to be cleared after a `Read` then you can set the `do_not_clear` parameter to True when creating those elements. The clear is turned on and off on an element by element basis. +Note that `InputText` and `MultiLine` Elements will be **cleared** when performing a `Read`. If you do not want your input field to be cleared after a `Read` then you can set the `do_not_clear` parameter to True when creating those elements. The clear is turned on and off on an element by element basis. The reasoning behind this is that Persistent Windows are often "forms". When "submitting" a form you want to have all of the fields left blank so the next entry of data will start with a fresh window. Also, when implementing a "Chat Window" type of interface, after each read / send of the chat data, you want the input field cleared. Think of it as a Texting application. Would you want to have to clear your previous text if you want to send a second text? The design pattern for Persistent Windows was already shown to you earlier in the document... here it is for your convenience. -```python -import PySimpleGUI as sg - -layout = [[sg.Text('Persistent window')], - [sg.Input()], - [sg.RButton('Read'), sg.Exit()]] - -window = sg.Window('Window that stays open').Layout(layout) - -while True: - event, values = window.Read() - if event is None or event == 'Exit': - break - print(event, values) +```python +import PySimpleGUI as sg + +layout = [[sg.Text('Persistent window')], + [sg.Input()], + [sg.RButton('Read'), sg.Exit()]] + +window = sg.Window('Window that stays open').Layout(layout) + +while True: + event, values = window.Read() + if event is None or event == 'Exit': + break + print(event, values) window.Close() -``` - - +``` + + ## Read(timeout = t, timeout_key='timeout') Read with a timeout is a very good thing for your GUIs to use in a read non-blocking situation, if you can use them. If your device can wait for a little while, then use this kind of read. The longer you're able to add to the timeout value, the less CPU time you'll be taking. -One way of thinking of reads with timeouts: -> During the timeout time, you are "yielding" the processor to do other tasks. +One way of thinking of reads with timeouts: +> During the timeout time, you are "yielding" the processor to do other tasks. But it gets better than just being a good citizen....**your GUI will be more responsive than if you used a non-blocking read** @@ -4742,21 +3772,21 @@ Let's say you had a device that you want to "poll" every 100ms. The "easy way ```python # YOU SHOULD NOT DO THIS.... -while True: # Event Loop +while True: # Event Loop event, values = window.ReadNonBlocking() # DO NOT USE THIS CALL ANYMORE - read_my_hardware() # process my device here + read_my_hardware() # process my device here time.sleep(.1) # sleep 1/10 second ``` This program will quickly test for user input, then deal with the hardware. Then it'll sleep for 100ms, while your gui is non-responsive, then it'll check in with your GUI again. I fully realize this is a crude way of doing things. We're talking dirt simple stuff without trying to use threads, etc to 'get it right'. It's for demonstration purposes. -The new and better way.... +The new and better way.... using the Read Timeout mechanism, the sleep goes away. ```python # This is the right way to poll for hardware -while True: # Event Loop - event, values = window.Read(timeout = 100) +while True: # Event Loop + event, values = window.Read(timeout = 100) read_my_hardware() # process my device here ``` @@ -4777,7 +3807,7 @@ event, values = sg.Read(timeout=0) ``` You should use the new way if you're reading this for the first time. -The difference in the 2 calls is in the value of event. For ReadNonBlocking, event will be `None` if there are no other events to report. There is a "problem" with this however. With normal Read calls, an event value of None signified the window was closed. For ReadNonBlocking, the way a closed window is returned is via the values variable being set to None. +The difference in the 2 calls is in the value of event. For ReadNonBlocking, event will be `None` if there are no other events to report. There is a "problem" with this however. With normal Read calls, an event value of None signified the window was closed. For ReadNonBlocking, the way a closed window is returned is via the values variable being set to None. ## sg.TIMEOUT_KEY @@ -4787,12 +3817,12 @@ TIMEOUT_KEY = '__timeout__' If you wanted to test for "no event" in your loop, it would be written like this: ```python -while True: - event, value = window.Read(timeout=0) - if event is None: - break # the use has closed the window - if event == sg.TIMEOUT_KEY: - print("Nothing happened") +while True: + event, value = window.Read(timeout=0) + if event is None: + break # the use has closed the window + if event == sg.TIMEOUT_KEY: + print("Nothing happened") ``` @@ -4801,105 +3831,105 @@ Use async windows sparingly. It's possible to have a window that appears to be Non-blocking is generally reserved as a "last resort". Too many times people use non-blocking reads when a blocking read will do just fine. There is a hybrid approach... a read with a timeout. You'll score much higher points on the impressive meter if you're able to use a lot less CPU time by using this type of read. - + The most legit time to use a non-blocking window is when you're working directly with hardware. Maybe you're driving a serial bus. If you look at the Event Loop in the Demo_OpenCV_Webcam.py program, you'll see that the read is a non-blocking read. However, there is a place in the event loop where blocking occurs. The point in the loop where you will block is the call to read frames from the webcam. When a frame is available you want to quickly deliver it to the output device, so you don't want your GUI blocking. You want the read from the hardware to block. - + Another example can be found in the demo for controlling a robot on a Raspberry Pi. In that application you want to read the direction buttons, forward, backward, etc, and immediately take action. If you are using RealtimeButtons, your only option at the moment is to use non-blocking windows. You have to set the timeout to zero if you want the buttons to be real-time responsive. However, with these buttons, adding a sleep to your event loop will at least give other processes time to execute. It will, however, starve your GUI. The entire time you're sleeping, your GUI isn't executing. - -### Periodically Calling`Read` - -Let's say you do end up using non-blocking reads... then you've got some housekeeping to do. It's up to you to periodically "refresh" 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 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 windows the window is shown, user input is read, but your code keeps right on chugging. YOUR responsibility is to call `PySimpleGUI.Read` on a periodic basis. Several times a second or more will produce a reasonably snappy GUI. - + +### Periodically Calling`Read` + +Let's say you do end up using non-blocking reads... then you've got some housekeeping to do. It's up to you to periodically "refresh" 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 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 windows the window is shown, user input is read, but your code keeps right on chugging. YOUR responsibility is to call `PySimpleGUI.Read` on a periodic basis. Several times a second or more will produce a reasonably snappy GUI. + ## Exiting (Closing) a Persistent Window - -If your window has a button that closes the window, then PySimpleGUI will automatically close the window for you. If all of your buttons are ReadButtons, then it'll be up to you to close the window when done. + +If your window has a button that closes the window, then PySimpleGUI will automatically close the window for you. If all of your buttons are ReadButtons, then it'll be up to you to close the window when done. To close a window, call the `Close` method. ```python window.Close() ``` - + ## Persistent Window Example - Running timer that updates + +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. -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. +```python + import PySimpleGUI as sg + import time + + # ---------------- Create Form ---------------- + sg.ChangeLookAndFeel('Black') + sg.SetOptions(element_padding=(0, 0)) + + layout = [[sg.Text('')], + [sg.Text('', size=(8, 2), font=('Helvetica', 20), justification='center', key='text')], + [sg.ReadButton('Pause', key='button', button_color=('white', '#001480')), + sg.ReadButton('Reset', button_color=('white', '#007339'), key='Reset'), + sg.Exit(button_color=('white', 'firebrick4'), key='Exit')]] + + window = sg.Window('Running Timer', no_titlebar=True, auto_size_buttons=False, keep_on_top=True, grab_anywhere=True).Layout(layout) + + # ---------------- main loop ---------------- + current_time = 0 + paused = False + start_time = int(round(time.time() * 100)) + while (True): + # --------- Read and update window -------- + event, values = window.Read(timeout=10) + current_time = int(round(time.time() * 100)) - start_time + # --------- Display timer in window -------- + window.FindElement('text').Update('{:02d}:{:02d}.{:02d}'.format((current_time // 100) // 60, + (current_time // 100) % 60, + current_time % 100)) +``` + -```python - import PySimpleGUI as sg - import time +Previously this program was implemented using a sleep in the loop to control the clock tick. This version uses the new timeout parameter. The result is a window that reacts quicker then the one with the sleep and the accuracy is just as good. + - # ---------------- Create Form ---------------- - sg.ChangeLookAndFeel('Black') - sg.SetOptions(element_padding=(0, 0)) - - layout = [[sg.Text('')], - [sg.Text('', size=(8, 2), font=('Helvetica', 20), justification='center', key='text')], - [sg.ReadButton('Pause', key='button', button_color=('white', '#001480')), - sg.ReadButton('Reset', button_color=('white', '#007339'), key='Reset'), - sg.Exit(button_color=('white', 'firebrick4'), key='Exit')]] - - window = sg.Window('Running Timer', no_titlebar=True, auto_size_buttons=False, keep_on_top=True, grab_anywhere=True).Layout(layout) - - # ---------------- main loop ---------------- - current_time = 0 - paused = False - start_time = int(round(time.time() * 100)) - while (True): - # --------- Read and update window -------- - event, values = window.Read(timeout=10) - current_time = int(round(time.time() * 100)) - start_time - # --------- Display timer in window -------- - window.FindElement('text').Update('{:02d}:{:02d}.{:02d}'.format((current_time // 100) // 60, - (current_time // 100) % 60, - current_time % 100)) -``` - - -Previously this program was implemented using a sleep in the loop to control the clock tick. This version uses the new timeout parameter. The result is a window that reacts quicker then the one with the sleep and the accuracy is just as good. - - -## Instead of a Non-blocking Read --- 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 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** - -One example is you have an input field that changes as you press buttons on an on-screen keypad. - -![keypad 3](https://user-images.githubusercontent.com/13696193/45260275-a2198e80-b3b0-11e8-85fe-a4ce6484510f.jpg) - - - - -# Updating Elements (changing elements in active window) +## Instead of a Non-blocking Read --- 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 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** + +One example is you have an input field that changes as you press buttons on an on-screen keypad. + +![keypad 3](https://user-images.githubusercontent.com/13696193/45260275-a2198e80-b3b0-11e8-85fe-a4ce6484510f.jpg) + + + + +# Updating Elements (changing elements in active window) If you want to change Elements in your window after the window has been created, then you will call the Element's Update method. -**NOTE** a window **must be Read or Finalized** before any Update calls can be made. +**NOTE** a window **must be Read or Finalized** before any Update calls can be made. Here is an example of updating a Text Element ```python -import PySimpleGUI as sg - -layout = [ [sg.Text('My layout', key='_TEXT_')], - [sg.Button('Read')]] - -window = sg.Window('My new window').Layout(layout) - -while True: # Event Loop - event, values = window.Read() - if event is None: - break +import PySimpleGUI as sg + +layout = [ [sg.Text('My layout', key='_TEXT_')], + [sg.Button('Read')]] + +window = sg.Window('My new window').Layout(layout) + +while True: # Event Loop + event, values = window.Read() + if event is None: + break window.Element('_TEXT_').Update('My new text value') ``` @@ -4907,89 +3937,89 @@ Notice the placement of the Update call. If you wanted to Update the Text Eleme In this example, the Update is done prior the Read. Because of this, the Finalize call is added to the Window creation. ```python -import PySimpleGUI as sg - -layout = [ [sg.Text('My layout', key='_TEXT_')], - [sg.Button('Read')] - ] - -window = sg.Window('My new window').Layout(layout).Finalize() - -window.Element('_TEXT_').Update('My new text value') - -while True: # Event Loop - event, values = window.Read() - if event is None: - break +import PySimpleGUI as sg + +layout = [ [sg.Text('My layout', key='_TEXT_')], + [sg.Button('Read')] + ] + +window = sg.Window('My new window').Layout(layout).Finalize() + +window.Element('_TEXT_').Update('My new text value') + +while True: # Event Loop + event, values = window.Read() + if event is None: + break ``` -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). - -You can use Update to do things like: -* Have one Element (appear to) make a change to another Element -* Disable a button, slider, input field, etc -* Change a button's text -* Change an Element's text or background color -* Add text to a scrolling output window -* Change the choices in a list -* etc - -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. - -![snap0272](https://user-images.githubusercontent.com/13696193/45260249-ec4e4000-b3af-11e8-853b-9b29d0bf7797.jpg) - - -In some programs these updates happen in response to another Element. This program takes a Spinner and a Slider's input values and uses them to resize a Text Element. The Spinner and Slider are on the left, the Text element being changed is on the right. - - - # Testing async window, see if can have a slider - # that adjusts the size of text displayed - - import PySimpleGUI as sg - fontSize = 12 - layout = [[sg.Spin([sz for sz in range(6, 172)], font=('Helvetica 20'), initial_value=fontSize, change_submits=True, key='spin'), - sg.Slider(range=(6,172), orientation='h', size=(10,20), - change_submits=True, key='slider', font=('Helvetica 20')), - sg.Text("Aa", size=(2, 1), font="Helvetica " + str(fontSize), key='text')]] - - sz = fontSize - window = sg.Window("Font size selector", grab_anywhere=False).Layout(layout) - # Event Loop - while True: - event, values= window.Read() - if event is None: - break - sz_spin = int(values['spin']) - sz_slider = int(values['slider']) - sz = sz_spin if sz_spin != fontSize else sz_slider - if sz != fontSize: - fontSize = sz - font = "Helvetica " + str(fontSize) - window.FindElement('text').Update(font=font) - window.FindElement('slider').Update(sz) - window.FindElement('spin').Update(sz) - - print("Done.") - - -Inside the event loop we read the value of the Spinner and the Slider using those Elements' keys. -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: - - 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 windows. - -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 = 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 window and also to identify elements. As already mentioned, they are used as targets in Button calls. +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). + +You can use Update to do things like: +* Have one Element (appear to) make a change to another Element +* Disable a button, slider, input field, etc +* Change a button's text +* Change an Element's text or background color +* Add text to a scrolling output window +* Change the choices in a list +* etc + +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. + +![snap0272](https://user-images.githubusercontent.com/13696193/45260249-ec4e4000-b3af-11e8-853b-9b29d0bf7797.jpg) + + +In some programs these updates happen in response to another Element. This program takes a Spinner and a Slider's input values and uses them to resize a Text Element. The Spinner and Slider are on the left, the Text element being changed is on the right. + + + # Testing async window, see if can have a slider + # that adjusts the size of text displayed + + import PySimpleGUI as sg + fontSize = 12 + layout = [[sg.Spin([sz for sz in range(6, 172)], font=('Helvetica 20'), initial_value=fontSize, change_submits=True, key='spin'), + sg.Slider(range=(6,172), orientation='h', size=(10,20), + change_submits=True, key='slider', font=('Helvetica 20')), + sg.Text("Aa", size=(2, 1), font="Helvetica " + str(fontSize), key='text')]] + + sz = fontSize + window = sg.Window("Font size selector", grab_anywhere=False).Layout(layout) + # Event Loop + while True: + event, values= window.Read() + if event is None: + break + sz_spin = int(values['spin']) + sz_slider = int(values['slider']) + sz = sz_spin if sz_spin != fontSize else sz_slider + if sz != fontSize: + fontSize = sz + font = "Helvetica " + str(fontSize) + window.FindElement('text').Update(font=font) + window.FindElement('slider').Update(sz) + window.FindElement('spin').Update(sz) + + print("Done.") + + +Inside the event loop we read the value of the Spinner and the Slider using those Elements' keys. +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: + + 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 windows. + +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 = 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 window and also to identify elements. As already mentioned, they are used as targets in Button calls. ### Locating Elements @@ -4998,96 +4028,96 @@ The Window method call that's used to find an element is: or the shortened version `Element` -When you see a call to window.FindElement or window.Element, then you know an element is being addressed. Normally this is done so you can call the element's Update method. +When you see a call to window.FindElement or window.Element, then you know an element is being addressed. Normally this is done so you can call the element's Update method. ### ProgressBar / Progress Meters Note that to change a progress meter's progress, you call UpdateBar, not Update. It's an old naming convention that's left over from before the Update calls were implemented. + + + +# Keyboard & Mouse Capture +Beginning in version 2.10 you can capture keyboard key presses and mouse scroll-wheel events. Keyboard keys can be used, for example, to detect the page-up and page-down keys for a PDF viewer. To use this feature, there's a boolean setting in the Window call `return_keyboard_events` that is set to True in order to get keys returned along with buttons. + +Keys and scroll-wheel events are returned in exactly the same way as buttons. + +For scroll-wheel events, if the mouse is scrolled up, then the `button` text will be `MouseWheel:Up`. For downward scrolling, the text returned is `MouseWheel:Down` + +Keyboard keys return 2 types of key events. For "normal" keys (a,b,c, etc), a single character is returned that represents that key. Modifier and special keys are returned as a string with 2 parts: + + Key Sym:Key Code + +Key Sym is a string such as 'Control_L'. The Key Code is a numeric representation of that key. The left control key, when pressed will return the value 'Control_L:17' + + import PySimpleGUI as sg + + # 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 window: + text_elem = sg.Text("", size=(18, 1)) + layout = [[sg.Text("Press a key or scroll mouse")], + [text_elem], + [sg.Button("OK")]] + + window.Layout(layout) + # ---===--- Loop taking in user input --- # + while True: + event, value = window.Read() + + if event == "OK" or event is None: + print(event, "exiting") + break + text_elem.Update(event) + + + +You want to turn off the default focus so that there no buttons that will be selected should you press the spacebar. + +### Realtime Keyboard Capture +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 window: + layout = [[sg.Text("Hold down a key")], + [sg.Button("OK")]] + + window.Layout(layout) + + while True: + event, value = window.Read(timeout=0) + if event == "OK" or event is None: + print(event, value, "exiting") + break + if event != sg.TIMEOUT_KEY: + print(event) - -# Keyboard & Mouse Capture -Beginning in version 2.10 you can capture keyboard key presses and mouse scroll-wheel events. Keyboard keys can be used, for example, to detect the page-up and page-down keys for a PDF viewer. To use this feature, there's a boolean setting in the Window call `return_keyboard_events` that is set to True in order to get keys returned along with buttons. - -Keys and scroll-wheel events are returned in exactly the same way as buttons. - -For scroll-wheel events, if the mouse is scrolled up, then the `button` text will be `MouseWheel:Up`. For downward scrolling, the text returned is `MouseWheel:Down` - -Keyboard keys return 2 types of key events. For "normal" keys (a,b,c, etc), a single character is returned that represents that key. Modifier and special keys are returned as a string with 2 parts: - - Key Sym:Key Code - -Key Sym is a string such as 'Control_L'. The Key Code is a numeric representation of that key. The left control key, when pressed will return the value 'Control_L:17' - - import PySimpleGUI as sg - - # 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 window: - text_elem = sg.Text("", size=(18, 1)) - layout = [[sg.Text("Press a key or scroll mouse")], - [text_elem], - [sg.Button("OK")]] - - window.Layout(layout) - # ---===--- Loop taking in user input --- # - while True: - event, value = window.Read() - - if event == "OK" or event is None: - print(event, "exiting") - break - text_elem.Update(event) - - - -You want to turn off the default focus so that there no buttons that will be selected should you press the spacebar. - -### Realtime Keyboard Capture -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 window: - layout = [[sg.Text("Hold down a key")], - [sg.Button("OK")]] - - window.Layout(layout) - - while True: - event, value = window.Read(timeout=0) - if event == "OK" or event is None: - print(event, value, "exiting") - break - if event != sg.TIMEOUT_KEY: - print(event) - - -# Menus +# Menus ## MenuBar - + 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 events and as of 3.17, also as in the values dictionary. The value returned will be the entire menu entry, including the key if you specified one. - -This definition: - - menu_def = [['File', ['Open', 'Save', 'Exit',]], - ['Edit', ['Paste', ['Special', 'Normal',], 'Undo'],], - ['Help', 'About...'],] - -Note the placement of ',' and of []. It's tricky to get the nested menus correct that implement cascading menus. See how paste has Special and Normal as a list after it. This means that Paste has a cascading menu with items Special and Normal. - -They menu_def layout produced this window: - -![menu](https://user-images.githubusercontent.com/13696193/45306723-56b7cb00-b4eb-11e8-8cbd-faef0c90f8b4.jpg) - + +This definition: + + menu_def = [['File', ['Open', 'Save', 'Exit',]], + ['Edit', ['Paste', ['Special', 'Normal',], 'Undo'],], + ['Help', 'About...'],] + +Note the placement of ',' and of []. It's tricky to get the nested menus correct that implement cascading menus. See how paste has Special and Normal as a list after it. This means that Paste has a cascading menu with items Special and Normal. + +They menu_def layout produced this window: + +![menu](https://user-images.githubusercontent.com/13696193/45306723-56b7cb00-b4eb-11e8-8cbd-faef0c90f8b4.jpg) + To add a menu to a Window place the `Menu` or `MenuBar` element into your layout. - layout = [[sg.Menu(menu_def)]] + layout = [[sg.Menu(menu_def)]] It doesn't really matter where you place the Menu Element in your layout as it will always be located at the top of the window. @@ -5107,29 +4137,29 @@ right_click_menu = ['&Right', ['Right', '!&Click', '&Menu', 'E&xit', 'Properties The first string in a right click menu and a button menu is ***ignored***. It is not used. Normally you would put the string that is shown on the menu bar in that location. **Return values for right click menus are different than menu bars and button menus.** Instead of the value being returned through the values dictionary, it is instead sent back as an Event. You will not - -## Menu Shortcut keys -You have used ALT-key in other Windows programs to navigate menus. For example Alt-F+X exits the program. The Alt-F pulls down the File menu. The X selects the entry marked Exit. - -The good news is that PySimpleGUI allows you to create the same kind of menus! Your program can play with the big-boys. And, it's trivial to do. - -All that's required is for your to add an "&" in front of the letter you want to appear with an underscore. When you hold the Alt key down you will see the menu with underlines that you marked. - -One other little bit of polish you can add are separators in your list. To add a line in your list of menu choices, create a menu entry that looks like this: ` '---'` - -This is an example Menu with underlines and a separator. - -``` -# ------ Menu Definition ------ # -menu_def = [['&File', ['&Open', '&Save', '---', 'Properties', 'E&xit' ]], - ['&Edit', ['Paste', ['Special', 'Normal',], 'Undo'],], - ['&Help', '&About...'],] -``` - And this is the spiffy menu it produced: - ![menus with shortcuts](https://user-images.githubusercontent.com/13696193/46251674-f5b74f00-c427-11e8-95c6-547adc59041b.jpg) + +## Menu Shortcut keys +You have used ALT-key in other Windows programs to navigate menus. For example Alt-F+X exits the program. The Alt-F pulls down the File menu. The X selects the entry marked Exit. + +The good news is that PySimpleGUI allows you to create the same kind of menus! Your program can play with the big-boys. And, it's trivial to do. + +All that's required is for your to add an "&" in front of the letter you want to appear with an underscore. When you hold the Alt key down you will see the menu with underlines that you marked. + +One other little bit of polish you can add are separators in your list. To add a line in your list of menu choices, create a menu entry that looks like this: ` '---'` + +This is an example Menu with underlines and a separator. + +``` +# ------ Menu Definition ------ # +menu_def = [['&File', ['&Open', '&Save', '---', 'Properties', 'E&xit' ]], + ['&Edit', ['Paste', ['Special', 'Normal',], 'Undo'],], + ['&Help', '&About...'],] +``` + And this is the spiffy menu it produced: + ![menus with shortcuts](https://user-images.githubusercontent.com/13696193/46251674-f5b74f00-c427-11e8-95c6-547adc59041b.jpg) -## Disabled Menu Entries +## Disabled Menu Entries If you want one of your menu items to be disabled, then place a '!' in front of the menu entry. To disable the Paste menu entry in the previous examples, the entry would be: `['!&Edit', ['Paste', ['Special', 'Normal',], 'Undo'],]` @@ -5143,13 +4173,13 @@ Beginning in version 3.17 you can add a `key` to your menu entries. The `key` v To add the `key` `_MY_KEY_` to the Special menu entry, the code would be: `['&Edit', ['Paste', ['Special::_MY_KEY_', 'Normal',], 'Undo'],]` - - If you want to change the characters that indicate a key follows from '::' to something else, change the variable `MENU_KEY_SEPARATOR` + + If you want to change the characters that indicate a key follows from '::' to something else, change the variable `MENU_KEY_SEPARATOR` # Running Multiple Windows -If you wish to run multiple windows in your event loop, then there are 2 methods for doing this. +If you wish to run multiple windows in your event loop, then there are 2 methods for doing this. 1. First window does not remain active while second window is visible 2. First window remains active while second window is visible @@ -5168,130 +4198,128 @@ A rule of thumb to follow: ## Multi-Window Design Pattern 1 - both windows active ```python -import PySimpleGUI as sg - -# Design pattern 2 - First window remains active - -layout = [[ sg.Text('Window 1'),], - [sg.Input(do_not_clear=True)], - [sg.Text('', key='_OUTPUT_')], - [sg.Button('Launch 2'), sg.Button('Exit')]] - -win1 = sg.Window('Window 1').Layout(layout) - -win2_active = False -while True: - ev1, vals1 = win1.Read(timeout=100) - win1.FindElement('_OUTPUT_').Update(vals1[0]) - if ev1 is None or ev1 == 'Exit': - break - - if not win2_active and ev1 == 'Launch 2': - win2_active = True - layout2 = [[sg.Text('Window 2')], - [sg.Button('Exit')]] - - win2 = sg.Window('Window 2').Layout(layout2) - - if win2_active: - ev2, vals2 = win2.Read(timeout=100) - if ev2 is None or ev2 == 'Exit': - win2_active = False - win2.Close() +import PySimpleGUI as sg + +# Design pattern 2 - First window remains active + +layout = [[ sg.Text('Window 1'),], + [sg.Input(do_not_clear=True)], + [sg.Text('', key='_OUTPUT_')], + [sg.Button('Launch 2'), sg.Button('Exit')]] + +win1 = sg.Window('Window 1').Layout(layout) + +win2_active = False +while True: + ev1, vals1 = win1.Read(timeout=100) + win1.FindElement('_OUTPUT_').Update(vals1[0]) + if ev1 is None or ev1 == 'Exit': + break + + if not win2_active and ev1 == 'Launch 2': + win2_active = True + layout2 = [[sg.Text('Window 2')], + [sg.Button('Exit')]] + + win2 = sg.Window('Window 2').Layout(layout2) + + if win2_active: + ev2, vals2 = win2.Read(timeout=100) + if ev2 is None or ev2 == 'Exit': + win2_active = False + win2.Close() ``` ## Multi-Window Design Pattern 2 - only 1 active window ```python -import PySimpleGUIQt as sg - -# Design pattern 1 - First window does not remain active - -layout = [[ sg.Text('Window 1'),], - [sg.Input(do_not_clear=True)], - [sg.Text('', key='_OUTPUT_')], - [sg.Button('Launch 2')]] - -win1 = sg.Window('Window 1').Layout(layout) -win2_active=False -while True: - ev1, vals1 = win1.Read(timeout=100) - if ev1 is None: - break - win1.FindElement('_OUTPUT_').Update(vals1[0]) - - if ev1 == 'Launch 2' and not win2_active: - win2_active = True - win1.Hide() - layout2 = [[sg.Text('Window 2')], # note must create a layout from scratch every time. No reuse - [sg.Button('Exit')]] - - win2 = sg.Window('Window 2').Layout(layout2) - while True: - ev2, vals2 = win2.Read() - if ev2 is None or ev2 == 'Exit': - win2.Close() - win2_active = False - win1.UnHide() - break +import PySimpleGUIQt as sg + +# Design pattern 1 - First window does not remain active + +layout = [[ sg.Text('Window 1'),], + [sg.Input(do_not_clear=True)], + [sg.Text('', key='_OUTPUT_')], + [sg.Button('Launch 2')]] + +win1 = sg.Window('Window 1').Layout(layout) +win2_active=False +while True: + ev1, vals1 = win1.Read(timeout=100) + if ev1 is None: + break + win1.FindElement('_OUTPUT_').Update(vals1[0]) + + if ev1 == 'Launch 2' and not win2_active: + win2_active = True + win1.Hide() + layout2 = [[sg.Text('Window 2')], # note must create a layout from scratch every time. No reuse + [sg.Button('Exit')]] + + win2 = sg.Window('Window 2').Layout(layout2) + while True: + ev2, vals2 = win2.Read() + if ev2 is None or ev2 == 'Exit': + win2.Close() + win2_active = False + win1.UnHide() + break ``` - - - -# Sample Applications - + +# Sample Applications + There are too many to list!! There are over 130 sample programs to give you a jump start. -## Packages Used In Demos - - - While the core PySimpleGUI code does not utilize any 3rd party packages, some of the demos do. They add a GUI to a few popular packages. These packages include: - * [Chatterbot](https://github.com/gunthercox/ChatterBot) - * [Mido](https://github.com/olemb/mido) - * [Matplotlib](https://matplotlib.org/) - * [PyMuPDF](https://github.com/rk700/PyMuPDF) - - -# Creating a Windows .EXE File - -It's possible to create a single .EXE file that can be distributed to Windows users. There is no requirement to install the Python interpreter on the PC you wish to run it on. Everything it needs is in the one EXE file, assuming you're running a somewhat up to date version of Windows. - -Installation of the packages, you'll need to install PySimpleGUI and PyInstaller (you need to install only once) - -```bash -pip install PySimpleGUI -pip install PyInstaller - -``` - -To create your EXE file from your program that uses PySimpleGUI, `my_program.py`, enter this command in your Windows command prompt: - -```bash -pyinstaller -wF my_program.py - -``` - -You will be left with a single file, `my_program.exe`, located in a folder named `dist` under the folder where you executed the `pyinstaller` command. - -That's all... Run your `my_program.exe` file on the Windows machine of your choosing. - -> "It's just that easy." - -(famous last words that screw up just about anything being referenced) - -Your EXE file should run without creating a "shell window". Only the GUI window should show up on your taskbar. - -If you get a crash with something like: -```python -ValueError: script '.......\src\tkinter' not found -``` - -Then try adding **`--hidden-import tkinter`** to your command - -# Creating a Mac App File +## Packages Used In Demos + + + While the core PySimpleGUI code does not utilize any 3rd party packages, some of the demos do. They add a GUI to a few popular packages. These packages include: + * [Chatterbot](https://github.com/gunthercox/ChatterBot) + * [Mido](https://github.com/olemb/mido) + * [Matplotlib](https://matplotlib.org/) + * [PyMuPDF](https://github.com/rk700/PyMuPDF) + + +# Creating a Windows .EXE File + +It's possible to create a single .EXE file that can be distributed to Windows users. There is no requirement to install the Python interpreter on the PC you wish to run it on. Everything it needs is in the one EXE file, assuming you're running a somewhat up to date version of Windows. + +Installation of the packages, you'll need to install PySimpleGUI and PyInstaller (you need to install only once) + +``` +pip install PySimpleGUI +pip install PyInstaller + +``` + +To create your EXE file from your program that uses PySimpleGUI, `my_program.py`, enter this command in your Windows command prompt: + +``` +pyinstaller -wF my_program.py + +``` + +You will be left with a single file, `my_program.exe`, located in a folder named `dist` under the folder where you executed the `pyinstaller` command. + +That's all... Run your `my_program.exe` file on the Windows machine of your choosing. + +> "It's just that easy." + +(famous last words that screw up just about anything being referenced) + +Your EXE file should run without creating a "shell window". Only the GUI window should show up on your taskbar. + +If you get a crash with something like: +``` +ValueError: script '.......\src\tkinter' not found +``` + +Then try adding **`--hidden-import tkinter`** to your command + +# Creating a Mac App File There are reports that PyInstaller can be used to create App files. It's not been officially tested. @@ -5304,303 +4332,297 @@ This info was located on Reddit with the source traced back to: https://github.com/pyinstaller/pyinstaller/issues/1350 -## Fun Stuff -Here are some things to try if you're bored or want to further customize - -**Debug Output** -Be sure and check out the EasyPrint (Print) function described in the high-level API section. Leave your code the way it is, route your stdout and stderror to a scrolling window. - -For a fun time, add these lines to the top of your script - -```python - import PySimpleGUI as sg - print = sg.Print -``` -This will turn all of your print statements into prints that display in a window on your screen rather than to the terminal. - -**Look and Feel** -Dial in the look and feel that you like with the `SetOptions` function. You can change all of the defaults in one function call. One line of code to customize the entire GUI. -Or beginning in version 2.9 you can choose from a look and feel using pre-defined color schemes. Call ChangeLookAndFeel with a description string. - -```python - sg.ChangeLookAndFeel('GreenTan') - -``` - -Valid values for the description string are: - - GreenTan - LightGreen - BluePurple - Purple - BlueMono - GreenMono - BrownBlue - BrightColors - NeutralBlue - Kayak - SandyBeach - TealMono - -To see the latest list of color choices, take a look at the bottom of the `PySimpleGUI.py` file where you'll find the `ChangLookAndFeel` function. - -You can also combine the `ChangeLookAndFeel` function with the `SetOptions` function to quickly modify one of the canned color schemes. Maybe you like the colors but was more depth to your bezels. You can dial in exactly what you want. - -**ObjToString** -Ever wanted to easily display an objects contents easily? Use ObjToString to get a nicely formatted recursive walk of your objects. -This statement: - - print(sg.ObjToSting(x)) - -And this was the output - - - abc = abc - attr12 = 12 - c = - b = - a = - attr1 = 1 - attr2 = 2 - attr3 = three - attr10 = 10 - attrx = x - -You'll quickly wonder how you ever coded without it. - ---- -# Known Issues -While not an "issue" this is a ***stern warning*** - -## **Do not attempt** to call `PySimpleGUI` from multiple threads! It's `tkinter` based and `tkinter` has issues with multiple threads - -**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 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. - -## Contributing - -A MikeTheWatchGuy production... entirely responsible for this code.... unless it causes you trouble in which case I'm not at all responsible. - - - -## Versions -|Version | Description | -|--|--| -| 1.0.9 | July 10, 2018 - Initial Release | -| 1.0.21 | July 13, 2018 - Readme updates | -| 2.0.0 | July 16, 2018 - ALL optional parameters renamed from CamelCase to all_lower_case -| 2.1.1 | July 18, 2018 - Global settings exposed, fixes -| 2.2.0| July 20, 2018 - Image Elements, Print output -| 2.3.0 | July 23, 2018 - Changed form.Read return codes, Slider Elements, Listbox element. Renamed some methods but left legacy calls in place for now. -| 2.4.0 | July 24, 2018 - Button images. Fixes so can run on Raspberry Pi -| 2.5.0 | July 26, 2018 - Colors. Listbox scrollbar. tkinter Progress Bar instead of homegrown. -| 2.6.0 | July 27, 2018 - auto_size_button setting. License changed to LGPL 3+ -| 2.7.0 | July 30, 2018 - realtime buttons, window_location default setting -| 2.8.0 | Aug 9, 2018 - New None default option for Checkbox element, text color option for all elements, return values as a dictionary, setting focus, binding return key -| 2.9.0 | Aug 16,2018 - Screen flash fix, `do_not_clear` input field option, `autosize_text` defaults to `True` now, return values as ordered dict, removed text target from progress bar, rework of return values and initial return values, removed legacy Form.Refresh() method (replaced by Form.ReadNonBlockingForm()), COLUMN elements!!, colored text defaults -| 2.10.0 | Aug 25, 2018 - Keyboard & Mouse features (Return individual keys as if buttons, return mouse scroll-wheel as button, bind return-key to button, control over keyboard focus), SaveAs Button, Update & Get methods for InputText, Update for Listbox, Update & Get for Checkbox, Get for Multiline, Color options for Text Element Update, Progess bar Update can change max value, Update for Button to change text & colors, Update for Image Element, Update for Slider, Form level text justification, Turn off default focus, scroll bar for Listboxes, Images can be from filename or from in-RAM, Update for Image). Fixes - text wrapping in buttons, msg box, removed slider borders entirely and others -| 2.11.0 | Aug 29, 2018 - Lots of little changes that are needed for the demo programs to work. Buttons have their own default element size, fix for Mac default button color, padding support for all elements, option to immediately return if list box gets selected, FilesBrowse button, Canvas Element, Frame Element, Slider resolution option, Form.Refresh method, better text wrapping, 'SystemDefault' look and feel settin -| 2.20.0 | Sept 4, 2018 - Some sizable features this time around of interest to advanced users. Renaming of the MsgBox functions to Popup. Renaming GetFile, etc, to PopupGetFile. High-level windowing capabilities start with Popup, PopupNoWait/PopupNonblocking, PopupNoButtons, default icon, change_submits option for Listbox/Combobox/Slider/Spin/, New OptionMenu element, updating elements after shown, system defaul color option for progress bars, new button type (Dummy Button) that only closes a window, SCROLLABLE Columns!! (yea, playing in the Big League now), LayoutAndShow function removed, form.Fill - bulk updates to forms, FindElement - find element based on key value (ALL elements have keys now), no longer use grid packing for row elements (a potentially huge change), scrolled text box sizing changed, new look and feel themes (Dark, Dark2, Black, Tan, TanBlue, DarkTanBlue, DarkAmber, DarkBlue, Reds, Green) -| 2.30.0 | Sept 6, 2018 - Calendar Chooser (button), borderless windows, load/save form to disk -| 3.0.0 | Sept 7, 2018 - The "fix for poor choice of 2.x numbers" release. Color Chooser (button), "grab anywhere" windows are on by default, disable combo boxes, Input Element text justification (last part needed for 'tables'), Image Element changes to support OpenCV?, PopupGetFile and PopupGetFolder have better no_window option -| 3.01.01 | Sept 10, 2018 - Menus! (sort of a big deal) -| 3.01.02 | Step 11, 2018 - All Element.Update functions have a `disabled` parameter so they can be disabled. Renamed some parameters in Update function (sorry if I broke your code), fix for bug in Image.Update. Wasn't setting size correctly, changed grab_anywhere logic again,added grab anywhere option to PupupGetText (assumes disabled) -| 3.02.00 | Sept 14, 2018 - New Table Element (Beta release), MsgBox removed entirely, font setting for InputText Element, **packing change** risky change that allows some Elements to be resized,removed command parameter from Menu Element, new function names for ReadNonBlocking (Finalize, PreRead), change to text element autosizing and wrapping (yet again), lots of parameter additions to Popup functions (colors, etc). -| 3.03.00 | New feature - One Line Progress Meters, new display_row_numbers for Table Element, fixed bug in EasyProgresssMeters (function will soon go away), OneLine and Easy progress meters set to grab anywhere but can be turned off. -| 03,04.00 | Sept 18, 2018 - New features - Graph Element, Frame Element, more settings exposed to Popup calls. See notes below for more. -| 03.04.01 | Sept 18, 2018 - See release notes -| 03.05.00 | Sept 20, 2018 - See release notes -| 03.05.01 | Sept 22, 2018 - See release notes -| 03.05.02 | Sept 23, 2018 - See release notes -| 03.06.00 | Sept 23, 2018 - Goodbye FlexForm, hello Window -| 03.08.00 | Sept 25, 2018 - Tab and TabGroup Elements\ -| 01.00.00 for 2.7 | Sept 25, 2018 - First release for 2.7 -| 03.08.04 | Sept 30, 2018 - See release notes -| 03.09.00 | Oct 1, 2018 | -| 2.7 01.01.00 | Oct 1, 2018 -| 2.7 01.01.02 | Oct 8, 2018 -| 03.09.01 | Oct 8, 2018 -| 3.9.3 & 1.1.3 | Oct 11, 2018 -| 3.9.4 & 1.1.4 | Oct 16, 2018 -| 3.10.1 & 1.2.1 | Oct 20, 2018 -| 3.10.3 & 1.2.3 | Oct 23, 2018 -| 3.11.0 & 1.11.0 | Oct 28, 2018 +## Fun Stuff +Here are some things to try if you're bored or want to further customize + +**Debug Output** +Be sure and check out the EasyPrint (Print) function described in the high-level API section. Leave your code the way it is, route your stdout and stderror to a scrolling window. + +For a fun time, add these lines to the top of your script + + import PySimpleGUI as sg + print = sg.Print + +This will turn all of your print statements into prints that display in a window on your screen rather than to the terminal. + +**Look and Feel** +Dial in the look and feel that you like with the `SetOptions` function. You can change all of the defaults in one function call. One line of code to customize the entire GUI. +Or beginning in version 2.9 you can choose from a look and feel using pre-defined color schemes. Call ChangeLookAndFeel with a description string. + + sg.ChangeLookAndFeel('GreenTan') + +Valid values for the description string are: + + GreenTan + LightGreen + BluePurple + Purple + BlueMono + GreenMono + BrownBlue + BrightColors + NeutralBlue + Kayak + SandyBeach + TealMono + +To see the latest list of color choices, take a look at the bottom of the `PySimpleGUI.py` file where you'll find the `ChangLookAndFeel` function. + +You can also combine the `ChangeLookAndFeel` function with the `SetOptions` function to quickly modify one of the canned color schemes. Maybe you like the colors but was more depth to your bezels. You can dial in exactly what you want. + +**ObjToString** +Ever wanted to easily display an objects contents easily? Use ObjToString to get a nicely formatted recursive walk of your objects. +This statement: + + print(sg.ObjToSting(x)) + +And this was the output + + + abc = abc + attr12 = 12 + c = + b = + a = + attr1 = 1 + attr2 = 2 + attr3 = three + attr10 = 10 + attrx = x + +You'll quickly wonder how you ever coded without it. + +--- +# Known Issues +While not an "issue" this is a ***stern warning*** + +## **Do not attempt** to call `PySimpleGUI` from multiple threads! It's `tkinter` based and `tkinter` has issues with multiple threads + +**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 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. + +## Contributing + +A MikeTheWatchGuy production... entirely responsible for this code.... unless it causes you trouble in which case I'm not at all responsible. + +## Versions +|Version | Description | +|--|--| +| 1.0.9 | July 10, 2018 - Initial Release | +| 1.0.21 | July 13, 2018 - Readme updates | +| 2.0.0 | July 16, 2018 - ALL optional parameters renamed from CamelCase to all_lower_case +| 2.1.1 | July 18, 2018 - Global settings exposed, fixes +| 2.2.0| July 20, 2018 - Image Elements, Print output +| 2.3.0 | July 23, 2018 - Changed form.Read return codes, Slider Elements, Listbox element. Renamed some methods but left legacy calls in place for now. +| 2.4.0 | July 24, 2018 - Button images. Fixes so can run on Raspberry Pi +| 2.5.0 | July 26, 2018 - Colors. Listbox scrollbar. tkinter Progress Bar instead of homegrown. +| 2.6.0 | July 27, 2018 - auto_size_button setting. License changed to LGPL 3+ +| 2.7.0 | July 30, 2018 - realtime buttons, window_location default setting +| 2.8.0 | Aug 9, 2018 - New None default option for Checkbox element, text color option for all elements, return values as a dictionary, setting focus, binding return key +| 2.9.0 | Aug 16,2018 - Screen flash fix, `do_not_clear` input field option, `autosize_text` defaults to `True` now, return values as ordered dict, removed text target from progress bar, rework of return values and initial return values, removed legacy Form.Refresh() method (replaced by Form.ReadNonBlockingForm()), COLUMN elements!!, colored text defaults +| 2.10.0 | Aug 25, 2018 - Keyboard & Mouse features (Return individual keys as if buttons, return mouse scroll-wheel as button, bind return-key to button, control over keyboard focus), SaveAs Button, Update & Get methods for InputText, Update for Listbox, Update & Get for Checkbox, Get for Multiline, Color options for Text Element Update, Progess bar Update can change max value, Update for Button to change text & colors, Update for Image Element, Update for Slider, Form level text justification, Turn off default focus, scroll bar for Listboxes, Images can be from filename or from in-RAM, Update for Image). Fixes - text wrapping in buttons, msg box, removed slider borders entirely and others +| 2.11.0 | Aug 29, 2018 - Lots of little changes that are needed for the demo programs to work. Buttons have their own default element size, fix for Mac default button color, padding support for all elements, option to immediately return if list box gets selected, FilesBrowse button, Canvas Element, Frame Element, Slider resolution option, Form.Refresh method, better text wrapping, 'SystemDefault' look and feel settin +| 2.20.0 | Sept 4, 2018 - Some sizable features this time around of interest to advanced users. Renaming of the MsgBox functions to Popup. Renaming GetFile, etc, to PopupGetFile. High-level windowing capabilities start with Popup, PopupNoWait/PopupNonblocking, PopupNoButtons, default icon, change_submits option for Listbox/Combobox/Slider/Spin/, New OptionMenu element, updating elements after shown, system defaul color option for progress bars, new button type (Dummy Button) that only closes a window, SCROLLABLE Columns!! (yea, playing in the Big League now), LayoutAndShow function removed, form.Fill - bulk updates to forms, FindElement - find element based on key value (ALL elements have keys now), no longer use grid packing for row elements (a potentially huge change), scrolled text box sizing changed, new look and feel themes (Dark, Dark2, Black, Tan, TanBlue, DarkTanBlue, DarkAmber, DarkBlue, Reds, Green) +| 2.30.0 | Sept 6, 2018 - Calendar Chooser (button), borderless windows, load/save form to disk +| 3.0.0 | Sept 7, 2018 - The "fix for poor choice of 2.x numbers" release. Color Chooser (button), "grab anywhere" windows are on by default, disable combo boxes, Input Element text justification (last part needed for 'tables'), Image Element changes to support OpenCV?, PopupGetFile and PopupGetFolder have better no_window option +| 3.01.01 | Sept 10, 2018 - Menus! (sort of a big deal) +| 3.01.02 | Step 11, 2018 - All Element.Update functions have a `disabled` parameter so they can be disabled. Renamed some parameters in Update function (sorry if I broke your code), fix for bug in Image.Update. Wasn't setting size correctly, changed grab_anywhere logic again,added grab anywhere option to PupupGetText (assumes disabled) +| 3.02.00 | Sept 14, 2018 - New Table Element (Beta release), MsgBox removed entirely, font setting for InputText Element, **packing change** risky change that allows some Elements to be resized,removed command parameter from Menu Element, new function names for ReadNonBlocking (Finalize, PreRead), change to text element autosizing and wrapping (yet again), lots of parameter additions to Popup functions (colors, etc). +| 3.03.00 | New feature - One Line Progress Meters, new display_row_numbers for Table Element, fixed bug in EasyProgresssMeters (function will soon go away), OneLine and Easy progress meters set to grab anywhere but can be turned off. +| 03,04.00 | Sept 18, 2018 - New features - Graph Element, Frame Element, more settings exposed to Popup calls. See notes below for more. +| 03.04.01 | Sept 18, 2018 - See release notes +| 03.05.00 | Sept 20, 2018 - See release notes +| 03.05.01 | Sept 22, 2018 - See release notes +| 03.05.02 | Sept 23, 2018 - See release notes +| 03.06.00 | Sept 23, 2018 - Goodbye FlexForm, hello Window +| 03.08.00 | Sept 25, 2018 - Tab and TabGroup Elements\ +| 01.00.00 for 2.7 | Sept 25, 2018 - First release for 2.7 +| 03.08.04 | Sept 30, 2018 - See release notes +| 03.09.00 | Oct 1, 2018 | +| 2.7 01.01.00 | Oct 1, 2018 +| 2.7 01.01.02 | Oct 8, 2018 +| 03.09.01 | Oct 8, 2018 +| 3.9.3 & 1.1.3 | Oct 11, 2018 +| 3.9.4 & 1.1.4 | Oct 16, 2018 +| 3.10.1 & 1.2.1 | Oct 20, 2018 +| 3.10.3 & 1.2.3 | Oct 23, 2018 +| 3.11.0 & 1.11.0 | Oct 28, 2018 | 3.12.0 & 1.12.0 | Oct 28, 2018 | 3.13.0 & 1.13.0 | Oct 29, 2018 | 3.14.0 & 1.14.0 | Nov 2, 2018 | 3.15.0 & 1.15.0 | Nov 20, 2018 | 3.16.0 & 1.16.0 | Nov 26, 2018 | 3.17.0 & 1.17.0 | Dec 1, 2018 - -## Release Notes -2.3 - Sliders, Listbox's and Image elements (oh my!) - -If using Progress Meters, avoid cancelling them when you have another window open. It could lead to future windows being blank. It's being worked on. - -New debug printing capability. `sg.Print` - -2.5 Discovered issue with scroll bar on `Output` elements. The bar will match size of ROW not the size of the element. Normally you never notice this due to where on a form the `Output` element goes. - -Listboxes are still without scrollwheels. The mouse can drag to see more items. The mouse scrollwheel will also scroll the list and will `page up` and `page down` keys. - -2.7 Is the "feature complete" release. Pretty much all features are done and in the code - -2.8 More text color controls. The caller has more control over things like the focus and what buttons should be clicked when enter key is pressed. Return values as a dictionary! (NICE addition) - -2.9 COLUMNS! This is the biggest feature and had the biggest impact on the code base. It was a difficult feature to add, but it was worth it. Can now make even more layouts. Almost any layout is possible with this addition. - -.................. insert releases 2.9 to 2.30 ................. - -3.0 We've come a long way baby! Time for a major revision bump. One reason is that the numbers started to confuse people the latest release was 2.30, but some people read it as 2.3 and thought it went backwards. I kinda messed up the 2.x series of numbers, so why not start with a clean slate. A lot has happened anyway so it's well earned. - -One change that will set PySimpleGUI apart is the parlor trick of being able to move the window by clicking on it anywhere. This is turned on by default. It's not a common way to interact with windows. Normally you have to move using the titlebar. Not so with PySimpleGUI. Now you can drag using any part of the window. You will want to turn off for windows with sliders. This feature is enabled in the Window call. - -Related to the Grab Anywhere feature is the no_titlebar option, again found in the call to Window. Your window will be a spiffy, borderless window. It's a really interesting effect. Slight problem is that you do not have an icon on the taskbar with these types of windows, so if you don't supply a button to close the window, there's no way to close it other than task manager. - -3.0.2 Still making changes to Update methods with many more ahead in the future. Continue to mess with grab anywhere option. Needed to disable in more places such as the PopupGetText function. Any time these is text input on a form, you generally want to turn off the grab anywhere feature. - -#### 3.2.0 - Biggest change was the addition of the Table Element. Trying to make changes so that form resizing is a possibility but unknown if will work in the long run. Removed all MsgBox, Get* functions and replaced with Popup functions. Popups had multiple new parameters added to change the look and feel of a popup. - -#### 3.3.0 -OneLineProgressMeter function added which gives you not only a one-line solution to progress meters, but it also gives you the ability to have more than 1 running at the same time, something not possible with the EasyProgressMeterCall - -#### 3.4.0 - -* Frame - New Element - a labelled frame for grouping elements. Similar - to Column -* Graph (like a Canvas element except uses the caller's - coordinate system rather than tkinter's). -* initial_folder - sets starting folder for browsing type buttons (browse for file/folder). -* Buttons return key value rather than button text **If** a `key` is specified, -* - OneLineProgressMeter! Replaced EasyProgressMeter (sorry folks that's - the way progress works sometimes) - * Popup - changed ALL of the Popup calls to provide many more customization settings - * Popup - * PopupGetFolder - * PopupGetFile - * PopupGetText - * Popup - * PopupNoButtons - * PopupNonBlocking - * PopupNoTitlebar - * PopupAutoClose - * PopupCancel - * PopupOK - * PopupOKCancel - * PopupYesNo - -#### 3.4.1 -* Button.GetText - Button class method. Returns the current text being shown on a button. -* Menu - Tearoff option. Determines if menus should allow them to be torn off -* Help - Shorcut button. Like Submit, cancel, etc -* ReadButton - shortcut for ReadFormButton - -#### 3.5.0 -* Tool Tips for all elements -* Clickable text -* Text Element relief setting -* Keys as targets for buttons -* New names for buttons: - * Button = SimpleButton - * RButton = ReadButton = ReadFormButton -* Double clickable list entries -* Auto sizing table widths works now -* Feature DELETED - Scaling. Removed from all elements - -#### 3.5.1 -* Bug fix for broken PySimpleGUI if Python version < 3.6 (sorry!) -* LOTS of Readme changes - -#### 3.5.2 -* Made `Finalize()` in a way that it can be chained -* Fixed bug in return values from Frame Element contents - -#### 3.6.0 -* Renamed FlexForm to Window -* Removed LookAndFeel capability from Mac platform. - -#### 3.8.0 -* Tab and TabGroup Elements - awesome new capabilities - -#### 1.0.0 Python 2.7 -It's official. There is a 2.7 version of PySimpleGUI! - -#### 3.8.2 -* Exposed `TKOut` in Output Element -* `DrawText` added to Graph Elements -* Removed `Window.UpdateElements` -* `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) - -#### 3.8.6 - -* Fix for Menus. -* Fixed table colors. Now they work -* Fixed returning keys for tabs -* Window Hide / UnHide methods -* Changed all Popups to remove context manager -* Error checking for Graphing objects and for Element Updates - -### 3.9.0 & 1.1.0 -* The FIRST UNIFIED version of the code! -* Python 2.7 got a TON of features . Look back to 1.0 release for the list -* Tab locations - Can place Tabs on top, bottom, left, right now instead of only the top - -### 3.9.1 & 1.1.2 -* Tab features - * Themes - * Enable / Disable - * Tab text colors - * Selected tab color -* New GetListValues method for Listbox -* Can now have multiple progress bars in 1 window -* Fix for closing debug-output window with other windows open -* Topanga Look and Feel setting -* User can create new look and feel settings / can access the look and feel table -* New PopupQuick call. Shows a non-blocking popup window with auto-close -* Tree Element partially done (don't use despite it showing up) - -### 3.9.3 & 1.1.3 - -* Disabled setting when creating element for: - * Input - * Combo - * Option Menu - * Listbox - * Radio - * Checkbox - * Spinner - * Multiline - * Buttons - * Slider -* Doc strings on all Elements updated -* Buttons can take image data as well as image files -* Button Update can change images -* Images can have background color -* Table element new num_rows parameter -* Table Element new alternating_row_color parameter -* Tree Element -* Window Disappear / Reappear methods -* Popup buttons resized to same size -* Exposed look and feel table - + +## Release Notes +2.3 - Sliders, Listbox's and Image elements (oh my!) + +If using Progress Meters, avoid cancelling them when you have another window open. It could lead to future windows being blank. It's being worked on. + +New debug printing capability. `sg.Print` + +2.5 Discovered issue with scroll bar on `Output` elements. The bar will match size of ROW not the size of the element. Normally you never notice this due to where on a form the `Output` element goes. + +Listboxes are still without scrollwheels. The mouse can drag to see more items. The mouse scrollwheel will also scroll the list and will `page up` and `page down` keys. + +2.7 Is the "feature complete" release. Pretty much all features are done and in the code + +2.8 More text color controls. The caller has more control over things like the focus and what buttons should be clicked when enter key is pressed. Return values as a dictionary! (NICE addition) + +2.9 COLUMNS! This is the biggest feature and had the biggest impact on the code base. It was a difficult feature to add, but it was worth it. Can now make even more layouts. Almost any layout is possible with this addition. + +.................. insert releases 2.9 to 2.30 ................. + +3.0 We've come a long way baby! Time for a major revision bump. One reason is that the numbers started to confuse people the latest release was 2.30, but some people read it as 2.3 and thought it went backwards. I kinda messed up the 2.x series of numbers, so why not start with a clean slate. A lot has happened anyway so it's well earned. + +One change that will set PySimpleGUI apart is the parlor trick of being able to move the window by clicking on it anywhere. This is turned on by default. It's not a common way to interact with windows. Normally you have to move using the titlebar. Not so with PySimpleGUI. Now you can drag using any part of the window. You will want to turn off for windows with sliders. This feature is enabled in the Window call. + +Related to the Grab Anywhere feature is the no_titlebar option, again found in the call to Window. Your window will be a spiffy, borderless window. It's a really interesting effect. Slight problem is that you do not have an icon on the taskbar with these types of windows, so if you don't supply a button to close the window, there's no way to close it other than task manager. + +3.0.2 Still making changes to Update methods with many more ahead in the future. Continue to mess with grab anywhere option. Needed to disable in more places such as the PopupGetText function. Any time these is text input on a form, you generally want to turn off the grab anywhere feature. + +#### 3.2.0 + Biggest change was the addition of the Table Element. Trying to make changes so that form resizing is a possibility but unknown if will work in the long run. Removed all MsgBox, Get* functions and replaced with Popup functions. Popups had multiple new parameters added to change the look and feel of a popup. + +#### 3.3.0 +OneLineProgressMeter function added which gives you not only a one-line solution to progress meters, but it also gives you the ability to have more than 1 running at the same time, something not possible with the EasyProgressMeterCall + +#### 3.4.0 + +* Frame - New Element - a labelled frame for grouping elements. Similar + to Column +* Graph (like a Canvas element except uses the caller's + coordinate system rather than tkinter's). +* initial_folder - sets starting folder for browsing type buttons (browse for file/folder). +* Buttons return key value rather than button text **If** a `key` is specified, +* + OneLineProgressMeter! Replaced EasyProgressMeter (sorry folks that's + the way progress works sometimes) + * Popup - changed ALL of the Popup calls to provide many more customization settings + * Popup + * PopupGetFolder + * PopupGetFile + * PopupGetText + * Popup + * PopupNoButtons + * PopupNonBlocking + * PopupNoTitlebar + * PopupAutoClose + * PopupCancel + * PopupOK + * PopupOKCancel + * PopupYesNo + +#### 3.4.1 +* Button.GetText - Button class method. Returns the current text being shown on a button. +* Menu - Tearoff option. Determines if menus should allow them to be torn off +* Help - Shorcut button. Like Submit, cancel, etc +* ReadButton - shortcut for ReadFormButton + +#### 3.5.0 +* Tool Tips for all elements +* Clickable text +* Text Element relief setting +* Keys as targets for buttons +* New names for buttons: + * Button = SimpleButton + * RButton = ReadButton = ReadFormButton +* Double clickable list entries +* Auto sizing table widths works now +* Feature DELETED - Scaling. Removed from all elements + +#### 3.5.1 +* Bug fix for broken PySimpleGUI if Python version < 3.6 (sorry!) +* LOTS of Readme changes + +#### 3.5.2 +* Made `Finalize()` in a way that it can be chained +* Fixed bug in return values from Frame Element contents + +#### 3.6.0 +* Renamed FlexForm to Window +* Removed LookAndFeel capability from Mac platform. + +#### 3.8.0 +* Tab and TabGroup Elements - awesome new capabilities + +#### 1.0.0 Python 2.7 +It's official. There is a 2.7 version of PySimpleGUI! + +#### 3.8.2 +* Exposed `TKOut` in Output Element +* `DrawText` added to Graph Elements +* Removed `Window.UpdateElements` +* `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) + +#### 3.8.6 + +* Fix for Menus. +* Fixed table colors. Now they work +* Fixed returning keys for tabs +* Window Hide / UnHide methods +* Changed all Popups to remove context manager +* Error checking for Graphing objects and for Element Updates + +### 3.9.0 & 1.1.0 +* The FIRST UNIFIED version of the code! +* Python 2.7 got a TON of features . Look back to 1.0 release for the list +* Tab locations - Can place Tabs on top, bottom, left, right now instead of only the top + +### 3.9.1 & 1.1.2 +* Tab features + * Themes + * Enable / Disable + * Tab text colors + * Selected tab color +* New GetListValues method for Listbox +* Can now have multiple progress bars in 1 window +* Fix for closing debug-output window with other windows open +* Topanga Look and Feel setting +* User can create new look and feel settings / can access the look and feel table +* New PopupQuick call. Shows a non-blocking popup window with auto-close +* Tree Element partially done (don't use despite it showing up) + +### 3.9.3 & 1.1.3 + +* Disabled setting when creating element for: + * Input + * Combo + * Option Menu + * Listbox + * Radio + * Checkbox + * Spinner + * Multiline + * Buttons + * Slider +* Doc strings on all Elements updated +* Buttons can take image data as well as image files +* Button Update can change images +* Images can have background color +* Table element new num_rows parameter +* Table Element new alternating_row_color parameter +* Tree Element +* Window Disappear / Reappear methods +* Popup buttons resized to same size +* Exposed look and feel table + ### 3.9.4 & 1.1.4 * Parameter order change for Button.Update so that new button ext is at front @@ -5672,15 +4694,15 @@ Emergency patch release... going out same day as previous release * Option to close calendar chooser when date selected * Update for Tree Element * Scroll bars for Trees - + ### 3.14.0 & 1.14.0 -* More windowing changes... - * using a hidden root windowing (Tk()) - * all children are Toplevel() windows +* More windowing changes... + * using a hidden root windowing (Tk()) + * all children are Toplevel() windows * Read only setting for: - * Input Text - * Multiline + * Input Text + * Multiline * Font setting for InputCombo, Multiline * change_submits setting for Radio Element * SetFocus for multiline, input elements @@ -5690,19 +4712,19 @@ Emergency patch release... going out same day as previous release * Fix for closing windows using X * CurrentLocation method for Windows * Debug Window options - * location - * font - * no_button - * no_titlebar - * grab_anywhere - * keep_on_top + * location + * font + * no_button + * no_titlebar + * grab_anywhere + * keep_on_top * New Print / EasyPrint options - * location - * font - * no_button - * no_titlebar - * grab_anywhere - * keep_on_top + * location + * font + * no_button + * no_titlebar + * grab_anywhere + * keep_on_top * New popup, PopupQuickMessage * PopupGetFolder, PopupGetFile new initial_folder parm @@ -5713,16 +4735,16 @@ Emergency patch release... going out same day as previous release * Text color, background color added to multiline element.Update * Update method for Output Element - gives ability to clear the output * Graph Element - Read returns values if new flages set - * Change submits, drag submits - * Returns x,y coordinates + * Change submits, drag submits + * Returns x,y coordinates * Column element new parm vertical_scroll_only * Table element new parm - bind return key - returns if return or double click * New Window parms - size, disable_close * "Better" multiwindow capabilities * Window.Size property * Popups - new title parm, custom_text - * title sets the window title - * custom_text - single string or tuple string sets text on button(s) + * title sets the window title + * custom_text - single string or tuple string sets text on button(s) ### 3.16.0 & 1.16.0 * Bug fix in PopupScrolled @@ -5752,7 +4774,7 @@ Emergency patch release... going out same day as previous release ## 3.18.0 11-Dec-2018 NOTE - **Menus are broken** on version 2.7. Don't know how long they've been this way. Please get off legacy Python if that's what you're running. - + * Default progress bar length changed to shorter * Master window and tracking of num open windows moved from global to Window class variable * Element visibility setting (when created and when Updating element) @@ -5897,8 +4919,8 @@ Mixup.... 3.26 changes don't appear to have been correctly released so releasing * NEW Window Parameter - layout - second parameter. Can pass in layout directly now! * New shortcuts - * I = InputText - * B = Btn = Butt = Button + * I = InputText + * B = Btn = Butt = Button * Convert button text to string when creating buttons * Buttons are returned now as well as input fields when searching for element with focus @@ -5916,8 +4938,8 @@ Mixup.... 3.26 changes don't appear to have been correctly released so releasing * New Radio Element method - `Radio.ResetGroup()` sets all elements in the Radio Group to False* Added borderwidth to Multiline Element * `Button.Click()` - new method - Generates a button click even as if a user clicked a button (at the tkinter level) * Made a Graph.Images dictionary to keep track of images being used in a graph. When graph is deleted, all of the accociated images should be deleted too.' -* Added `Graph.SetFocus()` to give a Graph Element the focus just as you can input elements -* Table new parameter - `hide_vertical_scroll` if True will hide the table's vertical bars +* Added `Graph.SetFocus()` to give a Graph Element the focus just as you can input elements +* Table new parameter - `hide_vertical_scroll` if True will hide the table's vertical bars * Window - new parameter - `transparent_color`. Causes a single color to become completely transparent such that you see through the window, you can click through the window. Its like tineows never was there. * The new `Window.AllKeysDict = {}` has been adopted by all PySimpleGUI ports. It's a new method of automatically creating missing keys, storing and retrieving keys in general for a window. * Changed how `window.Maximize` is implemented previously used the '-fullscreen' attribute. Now uses the 'zoomed' state @@ -5927,7 +4949,7 @@ Mixup.... 3.26 changes don't appear to have been correctly released so releasing * An Element's Widget stored in `.Widget` attribute * Making ComboBox's ID unique by using it's Key * Changed Multiline to be sunken and have a border depth setting now -* Removed a second canvas that was being used for Graph element. +* Removed a second canvas that was being used for Graph element. * Changed how no titlebar is implemented running on Linux versus Windows. -type splash now used for Linux * PopupScrolled - Added back using CloseButton to close the window * Fixed PopupGetFolder to use correct PySimpleGUI program constructs (keys) @@ -5959,8 +4981,8 @@ A combination of user requests, and needs of new `imwatchingyou` debugger * New Debugger Icon for future built-in debugger * Fixed bug in FindBoundReturnKey - needed to also check Panes * NEW Window functions to turn on/off the Grab Anywhere feature - * `Window.GrabAnyWhereOn()` - * `Window.GrabAnyWhereOff()` + * `Window.GrabAnyWhereOn()` + * `Window.GrabAnyWhereOff()` * New "Debugger" button that's built-in like other buttons. It's a TINY button with a logo. For future use when a debugger is built into PySimpleGUI itself (SOON!) * Change Text Element Wrap Length calculation. Went fromn +40 pixels to +10 pixels in formula * PopupGetFile has new parameter - `multiple_files`. If True then allows selection of multiple files @@ -5976,7 +4998,7 @@ A combination of user requests, and needs of new `imwatchingyou` debugger * New parameters to CalendarButton - `locale`, `format` * The bulk of the built-in PySimpleGUI debugger has been added but is not yet "officially supported". Try pressing "break" or "ctrl+break" on your keyboard. * New bindings for break / pause button and debugger - * New Debug button will launch debugger. + * New Debug button will launch debugger. * New parameter `debugger_enabled` added to Window call. Default is __enabled__. * Your progam's call to Read is all that's needed to refresh debugger * New `Window` methods to control debugger access @@ -6002,9 +5024,9 @@ A combination of user requests, and needs of new `imwatchingyou` debugger ## 3.39 PySimpleGUI & 1.39 PySimpleGUI27 13-June-2019 * Ported the imwatchingyou debugger code into PySimpleGUI code - * Replaced old debugger built-in code with the newer imwatchingyou version - * Required removing all of the 'sg.' before PySimpleGUI calls since not importing - * Dynamically create the debugger object when first call to `refresh` or `show` is made + * Replaced old debugger built-in code with the newer imwatchingyou version + * Required removing all of the 'sg.' before PySimpleGUI calls since not importing + * Dynamically create the debugger object when first call to `refresh` or `show` is made * Started the procecss of renaming Class Methods that are private to start with _ * Needed for the automatic documentation generation that's being worked on * Fixed crash when clicking the Debug button @@ -6013,71 +5035,71 @@ A combination of user requests, and needs of new `imwatchingyou` debugger * New `TabGroup` method `SelectTab(index)` selects a `Tab` within a `TabGroup` * New `Table.Update` parameter - `select_rows`. List of rows to select (0 is first) * Error checking in `Window.Layout` provides error "hints" to the user - * Looks for badly placed ']' - * Looks for functions missing '()' - * Pops up a window warning user instead of crashing - * May have to revisit if the popups start getting in the way + * Looks for badly placed ']' + * Looks for functions missing '()' + * Pops up a window warning user instead of crashing + * May have to revisit if the popups start getting in the way * New implementations of `Window.Disable()` and `Window.Enable()` - * Previously did not work correctly at all - * Now using the "-disabled" attribute + * Previously did not work correctly at all + * Now using the "-disabled" attribute * Allow Comboboxes to have empty starting values - * Was crashing - * Enables application to fill these in later + * Was crashing + * Enables application to fill these in later -### Upcoming -Make suggestions people! Future release features - - -## Code Condition - - Make it run - Make it right - Make it fast - -It's a recipe for success if done right. PySimpleGUI has completed the "Make it run" phase. It's far from "right" in many ways. These are being worked on. The module is particularly poor for PEP 8 compliance. It was a learning exercise that turned into a somewhat complete GUI solution for lightweight problems. - -While the internals to PySimpleGUI are a tad sketchy, the public interfaces into the SDK are more strictly defined and comply with PEP 8 for the most part. - -Please log bugs and suggestions in the GitHub! It will only make the code stronger and better in the end, a good thing for us all, right? - -## Design - -A moment about the design-spirit of `PySimpleGUI`. From the beginning, this package was meant to take advantage of Python's capabilities with the goal of programming ease. - -**Single File** -While not the best programming practice, the implementation resulted in a single file solution. Only one file is needed, PySimpleGUI.py. You can post this file, email it, and easily import it using one statement. - -**Functions as objects** -In Python, functions behave just like object. When you're placing a Text Element into your form, you may be sometimes calling a function and other times declaring an object. If you use the word Text, then you're getting an object. If you're using `Txt`, then you're calling a function that returns a `Text` object. - -**Lists** -It seemed quite natural to use Python's powerful list constructs when possible. The form is specified as a series of lists. Each "row" of the GUI is represented as a list of Elements. When the form read returns the results to the user, all of the results are presented as a single list. This makes reading a form's values super-simple to do in a single line of Python code. - -**Dictionaries** -Want to view your form's results as a dictionary instead of a list... no problem, just use the `key` keyword on your elements. For complex forms with a lot of values that need to be changed frequently, this is by far the best way of consuming the results. - -You can also look up elements using their keys. This is an excellent way to update elements in reaction to another element. Call `form.FindElement(key)` to get the Element. - -**Named / Optional Parameters** -This is a language feature that is featured **heavily** in all of the API calls, both functions and classes. Elements are configured, in-place, by setting one or more optional parameters. For example, a Text element's color is chosen by setting the optional `text_color` parameter. +### Upcoming +Make suggestions people! Future release features + + +## Code Condition + + Make it run + Make it right + Make it fast + +It's a recipe for success if done right. PySimpleGUI has completed the "Make it run" phase. It's far from "right" in many ways. These are being worked on. The module is particularly poor for PEP 8 compliance. It was a learning exercise that turned into a somewhat complete GUI solution for lightweight problems. + +While the internals to PySimpleGUI are a tad sketchy, the public interfaces into the SDK are more strictly defined and comply with PEP 8 for the most part. + +Please log bugs and suggestions in the GitHub! It will only make the code stronger and better in the end, a good thing for us all, right? + +## Design + +A moment about the design-spirit of `PySimpleGUI`. From the beginning, this package was meant to take advantage of Python's capabilities with the goal of programming ease. + +**Single File** +While not the best programming practice, the implementation resulted in a single file solution. Only one file is needed, PySimpleGUI.py. You can post this file, email it, and easily import it using one statement. + +**Functions as objects** +In Python, functions behave just like object. When you're placing a Text Element into your form, you may be sometimes calling a function and other times declaring an object. If you use the word Text, then you're getting an object. If you're using `Txt`, then you're calling a function that returns a `Text` object. + +**Lists** +It seemed quite natural to use Python's powerful list constructs when possible. The form is specified as a series of lists. Each "row" of the GUI is represented as a list of Elements. When the form read returns the results to the user, all of the results are presented as a single list. This makes reading a form's values super-simple to do in a single line of Python code. + +**Dictionaries** +Want to view your form's results as a dictionary instead of a list... no problem, just use the `key` keyword on your elements. For complex forms with a lot of values that need to be changed frequently, this is by far the best way of consuming the results. + +You can also look up elements using their keys. This is an excellent way to update elements in reaction to another element. Call `form.FindElement(key)` to get the Element. + +**Named / Optional Parameters** +This is a language feature that is featured **heavily** in all of the API calls, both functions and classes. Elements are configured, in-place, by setting one or more optional parameters. For example, a Text element's color is chosen by setting the optional `text_color` parameter. **tkinter** tkinter is the "official" GUI that Python supports. It runs on Windows, Linux, and Mac. It was chosen as the first target GUI framework due to its ***ubiquity***. Nearly all Python installations, with the exception of Ubuntu Linux, come pre-loaded with tkinter. It is the "simplest" of the GUI frameworks to get up an running (among Qt, WxPython, Kivy, etc). From the start of the PSG project, tkinter was not meant to be the only underlying GUI framework for PySimpleGUI. It is merely a starting point. All journeys begin with one step forward and choosing tkinter was the first of many steps for PySimpleGUI. Now there are 4 ports up and running - tkinter, WxPython, Qt and Remi (web support) - -## Author + +## Author Mike - who wrote PySimpleGUI is not important. It's the software that's important + - -## License - -GNU Lesser General Public License (LGPL 3) + - -## Acknowledgments +## License + +GNU Lesser General Public License (LGPL 3) + + +## Acknowledgments #### SORRY!! Will add these back. Lost due to file length limitation - +![Documentation Status](https://readthedocs.org/projects/pysimplegui/badge/?version=latest) + ![Awesome Meter](https://img.shields.io/badge/Awesome_meter-100-yellow.svg) + ![Python Version](https://img.shields.io/badge/Python-2.7_3.x-yellow.svg) + -![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) tkinter - -[![Downloads ](https://pepy.tech/badge/pysimplegui27)](https://pepy.tech/project/pysimplegui27) tkinter 2.7 - -[![Downloads](https://pepy.tech/badge/pysimpleguiqt)](https://pepy.tech/project/pysimpleguiqt) Qt - -[![Downloads](https://pepy.tech/badge/pysimpleguiwx)](https://pepy.tech/project/pysimpleguiWx) WxPython - -[![Downloads](https://pepy.tech/badge/pysimpleguiweb)](https://pepy.tech/project/pysimpleguiWeb) Web (Remi) - - -![Documentation Status](https://readthedocs.org/projects/pysimplegui/badge/?version=latest) -![Awesome Meter](https://img.shields.io/badge/Awesome_meter-100-yellow.svg) -![Python Version](https://img.shields.io/badge/Python-2.7_3.x-yellow.svg) - - - -# PySimpleGUI - -* Create windows that look and operate _identically_ to those created directly with tkinter, Qt, WxPython, and Remi. -* Requires 1/2 to 1/5th the amount of code as underlying frameworks. -* For exampl, develop a working Qt application in 1/2 to 1/5th the number lines of code. + +# PySimpleGUI + +* Create windows that look and operate _identically_ to those created directly with tkinter, Qt, WxPython, and Remi. +* Requires 1/2 to 1/5th the amount of code as underlying frameworks. +* For exampl, develop a working Qt application in 1/2 to 1/5th the number lines of code. * The savings can be even greater depending on your application. * One afternoon is all that is required to learn the PySimpleGUI concepts and APIs. - + ## Supports both Python 2.7 & 3 when using tkinter ## Supports both PySide2 and PyQt5 (limited support) @@ -63,47 +35,47 @@ HOW DO I INSERT IMAGES ??? ## The *only* way to write both desktop and web based GUIs at the same time -![Python Version](https://img.shields.io/badge/PySimpleGUI_For_Python_3.x_Version-3.39.0-red.svg?longCache=true&style=for-the-badge) - -![Python Version](https://img.shields.io/badge/PySimpleGUI_For_Python_2.7_Version-1.39.0-blue.svg?longCache=true&style=for-the-badge) - -![Python Version](https://img.shields.io/badge/PySimpleGUIQt_Version-0.31.0-orange.svg?longCache=true&style=for-the-badge) - +![Python Version](https://img.shields.io/badge/PySimpleGUI_For_Python_3.x_Version-3.39.0-red.svg?longCache=true&style=for-the-badge) + +![Python Version](https://img.shields.io/badge/PySimpleGUI_For_Python_2.7_Version-1.39.0-blue.svg?longCache=true&style=for-the-badge) + +![Python Version](https://img.shields.io/badge/PySimpleGUIQt_Version-0.31.0-orange.svg?longCache=true&style=for-the-badge) + ![Python Version](https://img.shields.io/badge/PySimpleGUIWx_version-0.11.0-orange.svg?longCache=true&style=for-the-badge) ![Python Version](https://img.shields.io/badge/PySimpleGUIWeb_Version-0.28.1-orange.svg?longCache=true&style=for-the-badge) -[Announcements of Latest Developments](https://github.com/MikeTheWatchGuy/PySimpleGUI/issues/142) +[Announcements of Latest Developments](https://github.com/MikeTheWatchGuy/PySimpleGUI/issues/142) -[ReadTheDocs](http://pysimplegui.readthedocs.io/) +[ReadTheDocs](http://pysimplegui.readthedocs.io/) -[COOKBOOK!](https://pysimplegui.readthedocs.io/cookbook/) +[COOKBOOK!](https://pysimplegui.readthedocs.io/cookbook/) -[Brief Tutorial](https://pysimplegui.readthedocs.io/tutorial/) +[Brief Tutorial](https://pysimplegui.readthedocs.io/tutorial/) -[Latest Demos and Master Branch on GitHub](https://github.com/MikeTheWatchGuy/PySimpleGUI) +[Latest Demos and Master Branch on GitHub](https://github.com/MikeTheWatchGuy/PySimpleGUI) -[Docs in PDF Format](https://github.com/MikeTheWatchGuy/PySimpleGUI/tree/master/docs) +[Docs in PDF Format](https://github.com/MikeTheWatchGuy/PySimpleGUI/tree/master/docs) [Repl.it Home for PySimpleGUI](https://repl.it/@PySimpleGUI) -Super-simple GUI to use... Powerfully customizable +Super-simple GUI to use... Powerfully customizable -Home of the 1-line custom GUI & 1-line progress meter +Home of the 1-line custom GUI & 1-line progress meter -The native GUI framework for perfectionists with deadlines +The native GUI framework for perfectionists with deadlines Actively developed and supported (It's 2019 and still going strong) -#### 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 `PySimpleGUI27`. They are installed separately and the imports are different. See instructions in Installation section for more info. +#### 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 `PySimpleGUI27`. They are installed separately and the imports are different. See instructions in Installation section for more info. # Qt Version -Check out the new PySimpleGUI port to the Qt GUI Framework. You can learn more on the [PySimpleGUIQt GitHub site](https://github.com/MikeTheWatchGuy/PySimpleGUI/tree/master/PySimpleGUIQt). **There is a separate Readme file for the Qt version** that you'll find there. +Check out the new PySimpleGUI port to the Qt GUI Framework. You can learn more on the [PySimpleGUIQt GitHub site](https://github.com/MikeTheWatchGuy/PySimpleGUI/tree/master/PySimpleGUIQt). **There is a separate Readme file for the Qt version** that you'll find there. -Give it a shot if you're looking for something a bit more "modern". PySimpleGUIQt is currently in Alpha. All of the widgets are operational but some may not yet be full-featured. If one is missing and your project needs it, log an Issue and you'll likely get priority support. +Give it a shot if you're looking for something a bit more "modern". PySimpleGUIQt is currently in Alpha. All of the widgets are operational but some may not yet be full-featured. If one is missing and your project needs it, log an Issue and you'll likely get priority support. Here is a summary of the Qt Elements @@ -121,7 +93,7 @@ Your source code is completely portable from one platform to another by simply c Started in late December 2018 PySimpleGUIWx started with the SystemTray Icon feature. This enabled the package to have one fully functioning feature that can be used along with tkinter to provide a complete program. The System Tray feature is complete and working very well. -The Windowing code is coming together with Reads now operational which means Popups work. The elements are getting completed on a regular basis. 3 more were just checked in. At least 1 new element is getting completed a week. +The Windowing code is coming together with Reads now operational which means Popups work. The elements are getting completed on a regular basis. 3 more were just checked in. At least 1 new element is getting completed a week. # Web Version (Remi) @@ -137,11 +109,11 @@ Read on and you'll understand even more why this is an important project... ***Want to really get your mind blown?*** Check out this [PySimpleGUI program](https://repl.it/@PySimpleGUI/PySimpleGUIWeb-Demos) running in your web browser. -Thanks to the magic of repl.it and Remi it's possible to run PySimpleGUI code in a browser window without having Python running on your computer. +Thanks to the magic of repl.it and Remi it's possible to run PySimpleGUI code in a browser window without having Python running on your computer. -The programs you write using repl.it will automatically download and install the latest PySimpleGUIWeb from PyPI onto a virtual Python environment. All that is required is to type `import PySimpleGUIWeb` you'll have a Python environment up and running with the latest PyPI release of PySimpleGUIWeb. +The programs you write using repl.it will automatically download and install the latest PySimpleGUIWeb from PyPI onto a virtual Python environment. All that is required is to type `import PySimpleGUIWeb` you'll have a Python environment up and running with the latest PyPI release of PySimpleGUIWeb. -This is an exciting new development that's opening up all kinds of possibilities for new ways to program and learn PySimpleGUI. Stayed tuned, much more to be posted about this in the near future. +This is an exciting new development that's opening up all kinds of possibilities for new ways to program and learn PySimpleGUI. Stayed tuned, much more to be posted about this in the near future. Educators in particular should be interested. Students can not only post their homework easily for their teacher to access, but teachers can also run the students programs online. No downloading needed. Run it and check the results. @@ -151,273 +123,273 @@ Depending on how you're viewing this document, you may or may not see an embedde # Support -PySimpleGUI is an active project. Bugs are fixed, features are added, often. Should you run into trouble, open an issue on the GitHub site and you'll receive help by someone in the community. +PySimpleGUI is an active project. Bugs are fixed, features are added, often. Should you run into trouble, open an issue on the GitHub site and you'll receive help by someone in the community. # Platforms It's surprising that Python GUI code is completely cross platform from Windows to Mac to Linux. No source code changes. This is true for both PySimpleGUI and PySimpleGUIQt. -However, **Macs** suck. They suck on tkinter in particular. The "Look and feel" calls are disabled for Macs. Colored buttons in particular are broken. Not in the PySimpleGUI code, of course. It's mostly because Macs suck. Consider using Qt instead of tkinter on the Mac. Or, if using tkinter, bring your own button images. +However, **Macs** suck. They suck on tkinter in particular. The "Look and feel" calls are disabled for Macs. Colored buttons in particular are broken. Not in the PySimpleGUI code, of course. It's mostly because Macs suck. Consider using Qt instead of tkinter on the Mac. Or, if using tkinter, bring your own button images. --- -Looking for a GUI package? Are you +Looking for a GUI package? Are you -* looking to take your Python code from the world of command lines and into the convenience of a GUI? * -* sitting on a Raspberry **Pi** with a touchscreen that's going to waste because you don't have the time to learn a GUI SDK? -* into Machine Learning and are sick of the command line? -* wanting to distribute your Python code to Windows users as a single .EXE file that launches straight into a GUI, much like a WinForms app? +* looking to take your Python code from the world of command lines and into the convenience of a GUI? * +* sitting on a Raspberry **Pi** with a touchscreen that's going to waste because you don't have the time to learn a GUI SDK? +* into Machine Learning and are sick of the command line? +* wanting to distribute your Python code to Windows users as a single .EXE file that launches straight into a GUI, much like a WinForms app? * would like to run a program in the system tray? * a teacher wanting to teach your students how to program using a GUI? * a student that wants to put a GUI onto their project? * looking for an active project? -Look no further, **you've found your GUI package**. +Look no further, **you've found your GUI package**. ```python -import PySimpleGUI as sg +import PySimpleGUI as sg -sg.Popup('Hello From PySimpleGUI!', 'This is the shortest GUI program ever!') +sg.Popup('Hello From PySimpleGUI!', 'This is the shortest GUI program ever!') ``` -![hello world](https://user-images.githubusercontent.com/13696193/44960047-1f7f6380-aec6-11e8-9d5e-12ef935bcade.jpg) +![hello world](https://user-images.githubusercontent.com/13696193/44960047-1f7f6380-aec6-11e8-9d5e-12ef935bcade.jpg) -Or how about a ***custom GUI*** in 1 line of code? +Or how about a ***custom GUI*** in 1 line of code? ```python -import PySimpleGUI as sg +import PySimpleGUI as sg -event, (filename,) = sg.Window('Get filename example'). Layout([[sg.Text('Filename')], [sg.Input(), sg.FileBrowse()], [sg.OK(), sg.Cancel()] ]).Read() +event, (filename,) = sg.Window('Get filename example'). Layout([[sg.Text('Filename')], [sg.Input(), sg.FileBrowse()], [sg.OK(), sg.Cancel()] ]).Read() ``` -![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, run within minutes. This is the process PySimpleGUI was designed to facilitate. +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. Your windows don't have to look like "boring" old windows. Add a few custom graphics to your windows to polish things up. ![batterup2](https://user-images.githubusercontent.com/13696193/50378902-6aa2bb00-060a-11e9-8f2f-d746694fa4ee.gif) -![uno_final](https://user-images.githubusercontent.com/13696193/49945232-67952580-feba-11e8-90c8-7dc31c5f7c67.gif) +![uno_final](https://user-images.githubusercontent.com/13696193/49945232-67952580-feba-11e8-90c8-7dc31c5f7c67.gif) -PySimpleGUI wraps tkinter or Qt so that you get all the same widgets as you would tkinter/Qt, but you interact with them in a more friendly way. It does the layout and boilerplate code for you and presents you with a simple, efficient interface. +PySimpleGUI wraps tkinter or Qt so that you get all the same widgets as you would tkinter/Qt, but you interact with them in a more friendly way. It does the layout and boilerplate code for you and presents you with a simple, efficient interface. -![everything dark theme](https://user-images.githubusercontent.com/13696193/44959854-b1d23800-aec3-11e8-90b6-5af915a86d15.jpg) +![everything dark theme](https://user-images.githubusercontent.com/13696193/44959854-b1d23800-aec3-11e8-90b6-5af915a86d15.jpg) -Perhaps you're looking for a way to interact with your **Raspberry Pi** in a more friendly way. The same for shown as on Pi (roughly the same) +Perhaps you're looking for a way to interact with your **Raspberry Pi** in a more friendly way. The same for shown as on Pi (roughly the same) -![raspberry pi everything demo](https://user-images.githubusercontent.com/13696193/44279694-5b58ce80-a220-11e8-9ab6-d6021f5a944f.jpg) +![raspberry pi everything demo](https://user-images.githubusercontent.com/13696193/44279694-5b58ce80-a220-11e8-9ab6-d6021f5a944f.jpg) -In addition to a primary GUI, you can add a Progress Meter to your code with ONE LINE of code. Slide this line into any of your `for` loops and get a nice meter: +In addition to a primary GUI, you can add a Progress Meter to your code with ONE LINE of code. Slide this line into any of your `for` loops and get a nice meter: ```python -OneLineProgressMeter('My meter title', current_value, max value, 'key') +OneLineProgressMeter('My meter title', current_value, max value, 'key') ``` -![easyprogressmeter](https://user-images.githubusercontent.com/13696193/44960065-83099100-aec6-11e8-8aa8-96e4b100a0e4.jpg) +![easyprogressmeter](https://user-images.githubusercontent.com/13696193/44960065-83099100-aec6-11e8-8aa8-96e4b100a0e4.jpg) -It's simple to show animated GIFs. +It's simple to show animated GIFs. + +![loading animation](https://user-images.githubusercontent.com/13696193/51280871-d2041e80-19ae-11e9-8757-802eb95352ed.gif) -![loading animation](https://user-images.githubusercontent.com/13696193/51280871-d2041e80-19ae-11e9-8757-802eb95352ed.gif) +How about embedding a game inside of a GUI? This game of Pong is written in tkinter and then dropped into the PySimpleGUI window creating a game that has an accompanying GUI. -How about embedding a game inside of a GUI? This game of Pong is written in tkinter and then dropped into the PySimpleGUI window creating a game that has an accompanying GUI. +![pong](https://user-images.githubusercontent.com/13696193/45860012-2d8d0b00-bd33-11e8-9efd-3eaf4c30f324.gif) -![pong](https://user-images.githubusercontent.com/13696193/45860012-2d8d0b00-bd33-11e8-9efd-3eaf4c30f324.gif) - -Combining PySimpleGUI with PyInstaller creates something truly remarkable and special, a Python program that looks like a Windows WinForms application. This application with working menu was created in 20 lines of Python code. It is a single .EXE file that launches straight into the screen you see. And more good news, the only icon you see on the taskbar is the window itself... there is no pesky shell window. - -![menu demo](https://user-images.githubusercontent.com/13696193/45923097-8fbc4c00-beaa-11e8-87d2-01a5331811c8.gif) +Combining PySimpleGUI with PyInstaller creates something truly remarkable and special, a Python program that looks like a Windows WinForms application. This application with working menu was created in 20 lines of Python code. It is a single .EXE file that launches straight into the screen you see. And more good news, the only icon you see on the taskbar is the window itself... there is no pesky shell window. + +![menu demo](https://user-images.githubusercontent.com/13696193/45923097-8fbc4c00-beaa-11e8-87d2-01a5331811c8.gif) -## 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?? +## 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 windows 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. +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. -The `PySimpleGUI` package is focused on the ***developer***. -> Create a custom GUI with as little and as simple code as possible. +The `PySimpleGUI` package is focused on the ***developer***. +> Create a custom GUI with as little and as simple code as possible. -This was the primary focus used to create PySimpleGUI. +This was the primary focus used to create PySimpleGUI. -> "Do it in a Python-like way" +> "Do it in a Python-like way" -was the second. +was the second. -## Features +## Features -While simple to use, PySimpleGUI has significant depth to be explored by more advanced programmers. The feature set goes way beyond the requirements of a beginner programmer, and into the required features needed for complex GUIs. - -Features of PySimpleGUI include: -- Support for Python versions 2.7 and 3 -- Text -- Single Line Input -- Buttons including these types: - - File Browse - - Files Browse - - Folder Browse - - SaveAs - - Non-closing return - - Close window - - Realtime - - Calendar chooser - - Color chooser - - Button Menu -- Checkboxes -- Radio Buttons -- Listbox -- Option Menu +While simple to use, PySimpleGUI has significant depth to be explored by more advanced programmers. The feature set goes way beyond the requirements of a beginner programmer, and into the required features needed for complex GUIs. + +Features of PySimpleGUI include: +- Support for Python versions 2.7 and 3 +- Text +- Single Line Input +- Buttons including these types: + - File Browse + - Files Browse + - Folder Browse + - SaveAs + - Non-closing return + - Close window + - Realtime + - Calendar chooser + - Color chooser + - Button Menu +- Checkboxes +- Radio Buttons +- Listbox +- Option Menu - Menubar -- Button Menu -- Slider +- Button Menu +- Slider - Dial -- Graph -- Frame with title -- Icons -- Multi-line Text Input -- Scroll-able Output -- Images -- Tables -- Trees -- Progress Bar Async/Non-Blocking Windows -- Tabbed windows +- Graph +- Frame with title +- Icons +- Multi-line Text Input +- Scroll-able Output +- Images +- Tables +- Trees +- Progress Bar Async/Non-Blocking Windows +- Tabbed windows - Paned windows -- Persistent Windows -- Redirect Python Output/Errors to scrolling window -- 'Higher level' APIs (e.g. MessageBox, YesNobox, ...) -- Single-Line-Of-Code Proress Bar & Debug Print -- Complete control of colors, look and feel -- Selection of pre-defined palettes -- Button images +- Persistent Windows +- Redirect Python Output/Errors to scrolling window +- 'Higher level' APIs (e.g. MessageBox, YesNobox, ...) +- Single-Line-Of-Code Proress Bar & Debug Print +- Complete control of colors, look and feel +- Selection of pre-defined palettes +- Button images - Horizontal and Verticle Separators -- Return values as dictionary -- Set focus -- Bind return key to buttons -- 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 window -- Bulk window-fill operation -- Save / Load window to/from disk -- Borderless (no titlebar) windows -- Always on top windows -- Menus with ALT-hotkey -- Right click pop-up menu -- Tooltips -- Clickable links +- Return values as dictionary +- Set focus +- Bind return key to buttons +- 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 window +- Bulk window-fill operation +- Save / Load window to/from disk +- Borderless (no titlebar) windows +- Always on top windows +- Menus with ALT-hotkey +- Right click pop-up menu +- Tooltips +- Clickable links - Transparent windows -- Movable windows +- Movable windows - Animated GIFs -- No async programming required (no callbacks to worry about) +- No async programming required (no callbacks to worry about) -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 : +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... +Start Python, copy and paste the code below into the >>> prompt and hit enter. This will pop up... -![everything example](https://user-images.githubusercontent.com/13696193/43097412-0a4652aa-8e8a-11e8-8e09-939484e3c568.jpg) +![everything example](https://user-images.githubusercontent.com/13696193/43097412-0a4652aa-8e8a-11e8-8e09-939484e3c568.jpg) ```python -import PySimpleGUI as sg - -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)], - [sg.Radio('My first Radio! ', "RADIO1", default=True), sg.Radio('My second Radio!', "RADIO1")], - [sg.Multiline(default_text='This is the default Text shoulsd you decide not to type anything',)], -[sg.InputCombo(['Combobox 1', 'Combobox 2'], size=(20, 3)), - sg.Slider(range=(1, 100), orientation='h', size=(35, 20), default_value=85)], -[sg.Listbox(values=['Listbox 1', 'Listbox 2', 'Listbox 3'], size=(30, 6)), - sg.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=25), - sg.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=75), - sg.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=10)], -[sg.Text('_' * 100, size=(70, 1))], -[sg.Text('Choose Source and Destination Folders', size=(35, 1))], -[sg.Text('Source Folder', size=(15, 1), auto_size_text=False, justification='right'), sg.InputText('Source'), - sg.FolderBrowse()], -[sg.Text('Destination Folder', size=(15, 1), auto_size_text=False, justification='right'), sg.InputText('Dest'), - sg.FolderBrowse()], -[sg.Submit(), sg.Cancel(), sg.Button('Customized', button_color=('white', 'green'))]] - -event, values = sg.Window('Everything bagel', layout, auto_size_text=True, default_element_size=(40, 1)).Read() +import PySimpleGUI as sg + +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)], + [sg.Radio('My first Radio! ', "RADIO1", default=True), sg.Radio('My second Radio!', "RADIO1")], + [sg.Multiline(default_text='This is the default Text shoulsd you decide not to type anything',)], +[sg.InputCombo(['Combobox 1', 'Combobox 2'], size=(20, 3)), + sg.Slider(range=(1, 100), orientation='h', size=(35, 20), default_value=85)], +[sg.Listbox(values=['Listbox 1', 'Listbox 2', 'Listbox 3'], size=(30, 6)), + sg.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=25), + sg.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=75), + sg.Slider(range=(1, 100), orientation='v', size=(10, 20), default_value=10)], +[sg.Text('_' * 100, size=(70, 1))], +[sg.Text('Choose Source and Destination Folders', size=(35, 1))], +[sg.Text('Source Folder', size=(15, 1), auto_size_text=False, justification='right'), sg.InputText('Source'), + sg.FolderBrowse()], +[sg.Text('Destination Folder', size=(15, 1), auto_size_text=False, justification='right'), sg.InputText('Dest'), + sg.FolderBrowse()], +[sg.Submit(), sg.Cancel(), sg.Button('Customized', button_color=('white', 'green'))]] + +event, values = sg.Window('Everything bagel', layout, auto_size_text=True, default_element_size=(40, 1)).Read() ``` ---- -### Design Goals +--- +### Design Goals -> Copy, Paste, Run. +> Copy, Paste, Run. -`PySimpleGUI's` goal with the API is to be easy on the programmer, and to function in a Python-like way. Since GUIs are visual, it was desirable for the code to visually match what's on the screen. By providing a significant amount of documentation and an easy to use Cookbook, it's possible to see your first GUI within 5 minutes of beginning the installation. +`PySimpleGUI's` goal with the API is to be easy on the programmer, and to function in a Python-like way. Since GUIs are visual, it was desirable for the code to visually match what's on the screen. By providing a significant amount of documentation and an easy to use Cookbook, it's possible to see your first GUI within 5 minutes of beginning the installation. -> Be Pythonic +> Be Pythonic -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. +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. -- 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 -- The SDK calls collapse down into a single line of Python code that presents a custom GUI and returns values -- Linear programming instead of callbacks +- 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 +- The SDK calls collapse down into a single line of Python code that presents a custom GUI and returns values +- Linear programming instead of callbacks -#### Lofty Goals +#### Lofty Goals -> Change Python +> Change Python -The hope is not that ***this*** package will become part of the Python Standard Library. +The hope is not that ***this*** package will become part of the Python Standard Library. -The hope is that Python will become ***the*** go-to language for creating GUI programs that run on Windows, Mac, and Linux *for all levels of developer*. +The hope is that Python will become ***the*** go-to language for creating GUI programs that run on Windows, Mac, and Linux *for all levels of developer*. -The hope is that beginners that are interested in graphic design will have an easy way to express themselves, right from the start of their Python experience. +The hope is that beginners that are interested in graphic design will have an easy way to express themselves, right from the start of their Python experience. -There is a noticeable gap in the Python GUI solution. Fill that gap and who knows what will happen. +There is a noticeable gap in the Python GUI solution. Fill that gap and who knows what will happen. -Maybe there's no "there there". ***Or*** maybe a simple GUI API will enable Python to dominate yet another computing discipline like it has so many others. This is my attempt to find out. +Maybe there's no "there there". ***Or*** maybe a simple GUI API will enable Python to dominate yet another computing discipline like it has so many others. This is my attempt to find out. -# Getting Started with PySimpleGUI +# Getting Started with PySimpleGUI ## Installing PySimpleGUI -### Installing Python 3 +### Installing Python 3 `pip install --upgrade PySimpleGUI` -On some systems you need to run pip3. +On some systems you need to run pip3. `pip3 install --upgrade PySimpleGUI` -On a Raspberry Pi, this is should work: +On a Raspberry Pi, this is should work: `sudo pip3 install --upgrade pysimplegui` -Some users have found that upgrading required using an extra flag on the pip `--no-cache-dir`. +Some users have found that upgrading required using an extra flag on the pip `--no-cache-dir`. -`pip install --upgrade --no-cache-dir` +`pip install --upgrade --no-cache-dir` -On some versions of Linux you will need to first install pip. Need the Chicken before you can get the Egg (get it... Egg?) +On some versions of Linux you will need to first install pip. Need the Chicken before you can get the Egg (get it... Egg?) `sudo apt install python3-pip` -If for some reason you are unable to install using `pip`, don't worry, you can still import PySimpleGUI by downloading the file PySimleGUI.py and placing it in your folder along with the application that is importing it. +If for some reason you are unable to install using `pip`, don't worry, you can still import PySimpleGUI by downloading the file PySimleGUI.py and placing it in your folder along with the application that is importing it. -`tkinter` is a requirement for PySimpleGUI (the only requirement). Some OS variants, such as Ubuntu, do not some with `tkinter` already installed. If you get an error similar to: +`tkinter` is a requirement for PySimpleGUI (the only requirement). Some OS variants, such as Ubuntu, do not some with `tkinter` already installed. If you get an error similar to: `ImportError: No module named tkinter` -then you need to install `tkinter`. +then you need to install `tkinter`. For python 2.7 @@ -429,31 +401,31 @@ For python 3 More information about installing tkinter can be found here: https://www.techinfected.net/2015/09/how-to-install-and-use-tkinter-in-ubuntu-debian-linux-mint.html -### Installing for Python 2.7 +### Installing for Python 2.7 -`pip install --upgrade PySimpleGUI27` -or -`pip2 install --upgrade PySimpleGUI27` +`pip install --upgrade PySimpleGUI27` +or +`pip2 install --upgrade PySimpleGUI27` -You may need to also install "future" for version 2.7 +You may need to also install "future" for version 2.7 `pip install future` -or +or `pip2 install future` -Python 2.7 support is relatively new and the bugs are still being worked out. I'm unsure what may need to be done to install tkinter for Python 2.7. Will update this readme when more info is available +Python 2.7 support is relatively new and the bugs are still being worked out. I'm unsure what may need to be done to install tkinter for Python 2.7. Will update this readme when more info is available -Like above, you may have to install either pip or tkinter. To do this on Python 2.7: +Like above, you may have to install either pip or tkinter. To do this on Python 2.7: -`sudo apt install python-pip` +`sudo apt install python-pip` -`sudo apt install python-tkinter` +`sudo apt install python-tkinter` -### Testing your installation +### Testing your installation -Once you have installed, or copied the .py file to your app folder, you can test the installation using python. At the command prompt start up Python. +Once you have installed, or copied the .py file to your app folder, you can test the installation using python. At the command prompt start up Python. -#### Instructions for Python 2.7: +#### Instructions for Python 2.7: ```python >>> import PySimpleGUI27 >>> PySimpleGUI27.main() @@ -470,19 +442,19 @@ You will see a sample window in the center of your screen. If it's not installe Here is the window you should see: -![sample window](https://user-images.githubusercontent.com/13696193/46097669-79efa500-c190-11e8-885c-e5d4d5d09ea6.jpg) +![sample window](https://user-images.githubusercontent.com/13696193/46097669-79efa500-c190-11e8-885c-e5d4d5d09ea6.jpg) -### Prerequisites -Python 2.7 or Python 3 -tkinter +### Prerequisites +Python 2.7 or Python 3 +tkinter -PySimpleGUI Runs on all Python3 platforms that have tkinter running on them. It has been tested on Windows, Mac, Linux, Raspberry Pi. Even runs on `pypy3`. +PySimpleGUI Runs on all Python3 platforms that have tkinter running on them. It has been tested on Windows, Mac, Linux, Raspberry Pi. Even runs on `pypy3`. ### EXE file creation -If you wish to create an EXE from your PySimpleGUI application, you will need to install `PyInstaller`. There are instructions on how to create an EXE at the bottom of this ReadMe +If you wish to create an EXE from your PySimpleGUI application, you will need to install `PyInstaller`. There are instructions on how to create an EXE at the bottom of this ReadMe ## Using - Python 3 @@ -490,55 +462,55 @@ 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 windows. +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) +![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 window 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. -## Using - Python 2.7 +## Using - Python 2.7 -Those using Python 2.7 will import a different module name -`import PySimpleGUI27 as sg` +Those using Python 2.7 will import a different module name +`import PySimpleGUI27 as sg` -## Code Samples Assume Python 3 +## Code Samples Assume Python 3 -While all of the code examples you will see in this Readme and the Cookbook assume Python 3 and thus have an `import PySimpleGUI` at the top, you can run ***all*** of this code on Python 2.7 by changing the import statement to `import PySimpleGUI27` +While all of the code examples you will see in this Readme and the Cookbook assume Python 3 and thus have an `import PySimpleGUI` at the top, you can run ***all*** of this code on Python 2.7 by changing the import statement to `import PySimpleGUI27` ---- -# APIs +--- +# APIs -PySimpleGUI can be broken down into 2 types of API's: -* High Level single call functions (The `Popup` calls) -* Custom window functions +PySimpleGUI can be broken down into 2 types of API's: +* High Level single call functions (The `Popup` calls) +* Custom window functions -### Python Language Features +### Python Language Features -There are a number of Python language features that PySimpleGUI utilizes heavily for API access that should be understood... -* Variable number of arguments to a function call -* Optional parameters to a function call -* Dictionaries +There are a number of Python language features that PySimpleGUI utilizes heavily for API access that should be understood... +* Variable number of arguments to a function call +* Optional parameters to a function call +* Dictionaries -#### Variable Number of Arguments +#### Variable Number of Arguments -The "High Level" API calls that *output* values take a variable number of arguments so that they match a "print" statement as much as possible. The idea is to make it simple for the programmer to output as many items as desired and in any format. The user need not convert the variables to be output into the strings. The PySimpleGUI functions do that for the user. +The "High Level" API calls that *output* values take a variable number of arguments so that they match a "print" statement as much as possible. The idea is to make it simple for the programmer to output as many items as desired and in any format. The user need not convert the variables to be output into the strings. The PySimpleGUI functions do that for the user. -sg.Popup('Variable number of parameters example', var1, var2, "etc") +sg.Popup('Variable number of parameters example', var1, var2, "etc") -Each new item begins on a new line in the Popup +Each new item begins on a new line in the Popup -![snap0179](https://user-images.githubusercontent.com/13696193/43658129-f6ca49c6-9725-11e8-9317-1f77443eb04a.jpg) +![snap0179](https://user-images.githubusercontent.com/13696193/43658129-f6ca49c6-9725-11e8-9317-1f77443eb04a.jpg) -#### Optional Parameters to a Function Call +#### Optional Parameters to a Function Call -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. +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. +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. ```python def Popup(*args, @@ -548,123 +520,115 @@ def Popup(*args, auto_close_duration=None, icon=DEFAULT_WINDOW_ICON, line_width=MESSAGE_BOX_LINE_WIDTH, - font=None): + font=None): ``` - -If the caller wanted to change the button color to be black on yellow, the call would look something like this: + +If the caller wanted to change the button color to be black on yellow, the call would look something like this: `sg.Popup('This box has a custom button color', button_color=('black', 'yellow'))` -![snap0180](https://user-images.githubusercontent.com/13696193/43658171-13a72bfe-9726-11e8-8c7a-0a46e46fb202.jpg) +![snap0180](https://user-images.githubusercontent.com/13696193/43658171-13a72bfe-9726-11e8-8c7a-0a46e46fb202.jpg) -#### Dictionaries +#### 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 window is read -2. To identify Elements so that they can be "updated" +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 window is read +2. To identify Elements so that they can be "updated" ---- +--- +# High Level API Calls - Popup's +"High level calls" are those that start with "Popup". They are the most basic form of communications with the user. They are named after the type of window they create, a pop-up window. These windows are meant to be short lived while, either delivering information or collecting it, and then quickly disappearing. +## Popup Output +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. -# High Level API Calls - Popup's +`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. -"High level calls" are those that start with "Popup". They are the most basic form of communications with the user. They are named after the type of window they create, a pop-up window. These windows are meant to be short lived while, either delivering information or collecting it, and then quickly disappearing. +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. -## Popup Output - -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 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. - -There are a number of Popup output calls, each with a slightly different look (e.g. different button labels). +There are a number of Popup output calls, each with a slightly different look (e.g. different button labels). The list of Popup output functions are: -- Popup -- PopupOk -- PopupYesNo -- PopupCancel -- PopupOkCancel -- PopupError -- PopupTimed, PopupAutoClose -- PopupNoWait, PopupNonBlocking +- Popup +- PopupOk +- PopupYesNo +- PopupCancel +- PopupOkCancel +- PopupError +- PopupTimed, PopupAutoClose +- PopupNoWait, PopupNonBlocking -The trailing portion of the function name after Popup indicates what buttons are shown. `PopupYesNo` shows a pair of button with Yes and No on them. `PopupCancel` has a Cancel button, etc. +The trailing portion of the function name after Popup indicates what buttons are shown. `PopupYesNo` shows a pair of button with Yes and No on them. `PopupCancel` has a Cancel button, etc. -While these are "output" windows, they do collect input in the form of buttons. The Popup functions return the button that was clicked. If the Ok button was clicked, then Popup returns the string 'Ok'. If the user clicked the X button to close the window, then the button value returned is `None`. +While these are "output" windows, they do collect input in the form of buttons. The Popup functions return the button that was clicked. If the Ok button was clicked, then Popup returns the string 'Ok'. If the user clicked the X button to close the window, then the button value returned is `None`. -The function `PopupTimed` or `PopupAutoClose` are popup windows that will automatically close after come period of time. +The function `PopupTimed` or `PopupAutoClose` are popup windows that will automatically close after come period of time. Here is a quick-reference showing how the Popup calls look. ``` -sg.Popup('Popup') - Shows OK button -sg.PopupOk('PopupOk') - Shows OK button -sg.PopupYesNo('PopupYesNo') - Shows Yes and No buttons -sg.PopupCancel('PopupCancel') - Shows Cancelled button -sg.PopupOKCancel('PopupOKCancel') - Shows OK and Cancel buttons -sg.PopupError('PopupError') - Shows red error button -sg.PopupTimed('PopupTimed') - Automatically closes -sg.PopupAutoClose('PopupAutoClose') - Same as PopupTimed +sg.Popup('Popup') - Shows OK button +sg.PopupOk('PopupOk') - Shows OK button +sg.PopupYesNo('PopupYesNo') - Shows Yes and No buttons +sg.PopupCancel('PopupCancel') - Shows Cancelled button +sg.PopupOKCancel('PopupOKCancel') - Shows OK and Cancel buttons +sg.PopupError('PopupError') - Shows red error button +sg.PopupTimed('PopupTimed') - Automatically closes +sg.PopupAutoClose('PopupAutoClose') - Same as PopupTimed ``` -Preview of popups: - -

- - - -

- -

- - - - -

+|Name|Image| +|-|-| +| Popup | ![snap0256](https://user-images.githubusercontent.com/13696193/44957394-1380ab00-aea0-11e8-98b1-1ab7d7bd5b37.jpg) | +| PopupOk | ![snap0257](https://user-images.githubusercontent.com/13696193/44957400-167b9b80-aea0-11e8-9d42-2314f24e62de.jpg) | +| PopupYesNo | ![snap0258](https://user-images.githubusercontent.com/13696193/44957399-154a6e80-aea0-11e8-9580-e716f839d400.jpg) | +| PopupCancel | ![snap0259](https://user-images.githubusercontent.com/13696193/44957398-14b1d800-aea0-11e8-9e88-c2b36a248447.jpg) | +| PopupOKCancel | ![snap0260](https://user-images.githubusercontent.com/13696193/44957397-14b1d800-aea0-11e8-950b-6d0b4f33841a.jpg) | +| PopupError | ![snap0261](https://user-images.githubusercontent.com/13696193/44957396-14194180-aea0-11e8-8eef-bb2e1193ecfa.jpg) | +| PopupTimed | ![snap0264](https://user-images.githubusercontent.com/13696193/44957595-9e15da00-aea1-11e8-8909-6b6121b74509.jpg) | +||| ``` -Popup(*args, Variable number of arguments you want to display - button_color=None, Color of buttons (text_color, background_color) - background_color=None, Color of background - text_color=None, Color of text - button_type=POPUP_BUTTONS_OK, Type of button layout - auto_close=False, If True window will automatically close - auto_close_duration=None, Number of seconds for autoclose - non_blocking=False, If True returns immediately - icon=DEFAULT_WINDOW_ICON, Icon to use on the taskbar - line_width=None, Width of lines in characters - font=None, Font to use for characters - no_titlebar=False, If True no titlebar will be shown - grab_anywhere=False, If True can move window by grabbing anywhere - keep_on_top=False, If True window will be on top of other windows - location=(None,None)): (x,y) coordinates to show the window +Popup(*args, Variable number of arguments you want to display + button_color=None, Color of buttons (text_color, background_color) + background_color=None, Color of background + text_color=None, Color of text + button_type=POPUP_BUTTONS_OK, Type of button layout + auto_close=False, If True window will automatically close + auto_close_duration=None, Number of seconds for autoclose + non_blocking=False, If True returns immediately + icon=DEFAULT_WINDOW_ICON, Icon to use on the taskbar + line_width=None, Width of lines in characters + font=None, Font to use for characters + no_titlebar=False, If True no titlebar will be shown + grab_anywhere=False, If True can move window by grabbing anywhere + keep_on_top=False, If True window will be on top of other windows + location=(None,None)): (x,y) coordinates to show the window ``` -The other output Popups are variations on parameters. Usually the button_type parameter is the primary one changed. +The other output Popups are variations on parameters. Usually the button_type parameter is the primary one changed. -The choices for button_type are: -``` -POPUP_BUTTONS_YES_NO -POPUP_BUTTONS_CANCELLED -POPUP_BUTTONS_ERROR -POPUP_BUTTONS_OK_CANCEL -POPUP_BUTTONS_OK -POPUP_BUTTONS_NO_BUTTONS -``` -Note that you should not call Popup yourself with different button_types. Rely on the Popup function named that sets that value for you. For example PopupYesNo will set the button type to POPUP_BUTTONS_YES_NO for you. +The choices for button_type are: +``` +POPUP_BUTTONS_YES_NO +POPUP_BUTTONS_CANCELLED +POPUP_BUTTONS_ERROR +POPUP_BUTTONS_OK_CANCEL +POPUP_BUTTONS_OK +POPUP_BUTTONS_NO_BUTTONS +``` +Note that you should not call Popup yourself with different button_types. Rely on the Popup function named that sets that value for you. For example PopupYesNo will set the button type to POPUP_BUTTONS_YES_NO for you. -#### Scrolled Output -There is a scrolled version of Popups should you have a lot of information to display. +#### Scrolled Output +There is a scrolled version of Popups should you have a lot of information to display. ```python PopupScrolled(*args, button_color=None, yes_no=False, auto_close=False, auto_close_duration=None, size=(None, None), location=(None, None), title=None, non_blocking=False) -``` +``` Typical usage: ```python @@ -672,138 +636,138 @@ sg.PopupScrolled(my_text) ``` -![scrolledtextbox 2](https://user-images.githubusercontent.com/13696193/43667324-712aa0d4-9745-11e8-83a9-a0d0570d0865.jpg) +![scrolledtextbox 2](https://user-images.githubusercontent.com/13696193/43667324-712aa0d4-9745-11e8-83a9-a0d0570d0865.jpg) -The `PopupScrolled` will auto-fit the window size to the size of the text. Specify `None` in the height field of a `size` parameter to get auto-sized height. +The `PopupScrolled` will auto-fit the window size to the size of the text. Specify `None` in the height field of a `size` parameter to get auto-sized height. -This call will create a scrolled box 80 characters wide and a height dependent upon the number of lines of text. +This call will create a scrolled box 80 characters wide and a height dependent upon the number of lines of text. -sg.PopupScrolled(my_text, size=(80, None)) +sg.PopupScrolled(my_text, size=(80, None)) -Note that the default max number of lines before scrolling happens is set to 50. At 50 lines the scrolling will begin. +Note that the default max number of lines before scrolling happens is set to 50. At 50 lines the scrolling will begin. If `non_blocking` parameter is set, then the call will not blocking waiting for the user to close the window. Execution will immediately return to the user. Handy when you want to dump out debug info without disrupting the program flow. -### PopupNoWait +### PopupNoWait -The Popup call PopupNoWait or PopupNonBlocking will create a popup window and then immediately return control back to you. All other popup functions will block, waiting for the user to close the popup window. +The Popup call PopupNoWait or PopupNonBlocking will create a popup window and then immediately return control back to you. All other popup functions will block, waiting for the user to close the popup window. -This function is very handy for when you're **debugging** and want to display something as output but don't want to change the programs's overall timing by blocking. Think of it like a `print` statement. There are no return values on one of these Popups. +This function is very handy for when you're **debugging** and want to display something as output but don't want to change the programs's overall timing by blocking. Think of it like a `print` statement. There are no return values on one of these Popups. -## Popup Input +## Popup Input -There are Popup calls for single-item inputs. These follow the pattern of `Popup` followed by `Get` and then the type of item to get. There are 3 of these input Popups to choose from, each with settings enabling customization. +There are Popup calls for single-item inputs. These follow the pattern of `Popup` followed by `Get` and then the type of item to get. There are 3 of these input Popups to choose from, each with settings enabling customization. -- `PopupGetText` - get a single line of text -- `PopupGetFile` - get a filename -- `PopupGetFolder` - get a folder name +- `PopupGetText` - get a single line of text +- `PopupGetFile` - get a filename +- `PopupGetFolder` - get a folder name -Use these Popups instead of making a custom window to get one data value, call the Popup input function to get the item from the user. If you find the parameters are unable to create the kind of window you are looking for, then it's time for you to create your own window. +Use these Popups instead of making a custom window to get one data value, call the Popup input function to get the item from the user. If you find the parameters are unable to create the kind of window you are looking for, then it's time for you to create your own window. -### PopupGetText +### PopupGetText -Use this Popup to get a line of text from the user. +Use this Popup to get a line of text from the user. ``` -PopupGetText(message,The message you wish to display with the input field - default_text='', Text to initially fill into the input field - password_char='', Passwork character if this is a password field - size=(None,None), Size of the window - button_color=None, Color to use for buttons (foreground, background) - background_color=None, Background color for window - text_color=None, Text color for window - icon=DEFAULT_WINDOW_ICON, Icon to display on taskbar - font=None, Font to use for text - no_titlebar=False, If True no titlebar will be shown - grab_anywhere=False, If True can grab anywhere to move the window - keep_on_top=False, If True window will stay on top of other windows - location=(None,None)) Location on screen to display window +PopupGetText(message,The message you wish to display with the input field + default_text='', Text to initially fill into the input field + password_char='', Passwork character if this is a password field + size=(None,None), Size of the window + button_color=None, Color to use for buttons (foreground, background) + background_color=None, Background color for window + text_color=None, Text color for window + icon=DEFAULT_WINDOW_ICON, Icon to display on taskbar + font=None, Font to use for text + no_titlebar=False, If True no titlebar will be shown + grab_anywhere=False, If True can grab anywhere to move the window + keep_on_top=False, If True window will stay on top of other windows + location=(None,None)) Location on screen to display window ``` ```python -import PySimpleGUI as sg +import PySimpleGUI as sg -text = sg.PopupGetText('Title', 'Please input something') -sg.Popup('Results', 'The value returned from PopupGetText', text) +text = sg.PopupGetText('Title', 'Please input something') +sg.Popup('Results', 'The value returned from PopupGetText', text) ``` -![popupgettext](https://user-images.githubusercontent.com/13696193/44957281-8721b880-ae9e-11e8-98cd-d06369f4187e.jpg) +![popupgettext](https://user-images.githubusercontent.com/13696193/44957281-8721b880-ae9e-11e8-98cd-d06369f4187e.jpg) -![popup gettext response](https://user-images.githubusercontent.com/13696193/44957282-8721b880-ae9e-11e8-84ae-dc8bb30504a0.jpg) +![popup gettext response](https://user-images.githubusercontent.com/13696193/44957282-8721b880-ae9e-11e8-84ae-dc8bb30504a0.jpg) -### PopupGetFile +### PopupGetFile -Gets a filename from the user. There are options to configure the type of dialog box to show. Normally an "Open File" dialog box is shown +Gets a filename from the user. There are options to configure the type of dialog box to show. Normally an "Open File" dialog box is shown ``` -PopupGetFile(message, Message to show in the window - default_path='', Path browsing should start from - default_extension='', Which filetype is the default - save_as=False, Determines which dialog box stype to show - file_types=(("ALL Files", "*.*"),), Which filetypes are displayed - no_window=False, if True no window is displayed except the dialog box - size=(None,None), Size of window - button_color=None, Color of buttons - background_color=None, Color of window background - text_color=None, Color of text in window - icon=DEFAULT_WINDOW_ICON, Icon to show on taskbar - font=None, Font to use - no_titlebar=False, If True does not display a titlebar - grab_anywhere=False, if True can grab window anywhere to move it - keep_on_top=False, if True window will be on top of others - location=(None,None)) Location on screen to show window -``` +PopupGetFile(message, Message to show in the window + default_path='', Path browsing should start from + default_extension='', Which filetype is the default + save_as=False, Determines which dialog box stype to show + file_types=(("ALL Files", "*.*"),), Which filetypes are displayed + no_window=False, if True no window is displayed except the dialog box + size=(None,None), Size of window + button_color=None, Color of buttons + background_color=None, Color of window background + text_color=None, Color of text in window + icon=DEFAULT_WINDOW_ICON, Icon to show on taskbar + font=None, Font to use + no_titlebar=False, If True does not display a titlebar + grab_anywhere=False, if True can grab window anywhere to move it + keep_on_top=False, if True window will be on top of others + location=(None,None)) Location on screen to show window +``` -If configured as an Open File Popup then (save_as is not True) the dialog box will look like this +If configured as an Open File Popup then (save_as is not True) the dialog box will look like this -![snag-0060](https://user-images.githubusercontent.com/13696193/46761050-9831c680-cca1-11e8-8de9-68b15efe2c46.jpg) +![snag-0060](https://user-images.githubusercontent.com/13696193/46761050-9831c680-cca1-11e8-8de9-68b15efe2c46.jpg) -If you set the parameter save_As to True, then the dialog box looks like this: +If you set the parameter save_As to True, then the dialog box looks like this: -![snag-0061](https://user-images.githubusercontent.com/13696193/46761330-2b6afc00-cca2-11e8-953b-f6b5c5ce57f5.jpg) +![snag-0061](https://user-images.githubusercontent.com/13696193/46761330-2b6afc00-cca2-11e8-953b-f6b5c5ce57f5.jpg) -If you choose a filename that already exists, you'll get a warning popup box asking if it's OK. You can also specify a file that doesn't exist. With an "Open" dialog box you cannot choose a non-existing file. +If you choose a filename that already exists, you'll get a warning popup box asking if it's OK. You can also specify a file that doesn't exist. With an "Open" dialog box you cannot choose a non-existing file. -A typical call produces this window. +A typical call produces this window. ```python -text = sg.PopupGetFile('Please enter a file name') -sg.Popup('Results', 'The value returned from PopupGetFile', text) +text = sg.PopupGetFile('Please enter a file name') +sg.Popup('Results', 'The value returned from PopupGetFile', text) ``` -![popupgetfile](https://user-images.githubusercontent.com/13696193/44957857-2fd31680-aea5-11e8-8eb7-f6b91c202cc8.jpg) +![popupgetfile](https://user-images.githubusercontent.com/13696193/44957857-2fd31680-aea5-11e8-8eb7-f6b91c202cc8.jpg) -### PopupGetFolder +### PopupGetFolder -The window created to get a folder name looks the same as the get a file name. The difference is in what the browse button does. `PopupGetFile` shows an Open File dialog box while `PopupGetFolder` shows an Open Folder dialog box. +The window created to get a folder name looks the same as the get a file name. The difference is in what the browse button does. `PopupGetFile` shows an Open File dialog box while `PopupGetFolder` shows an Open Folder dialog box. -``` -PopupGetFolder(message, Message to display in window - default_path='', Path to start browsing - no_window=False, If True no window will be shown - size=(None,None), Size of window - button_color=None, Color of buttons - background_color=None, Background color of window - text_color=None, Color of window text - icon=DEFAULT_WINDOW_ICON, Icon to show on taskbar - font=None, Font to use for window - no_titlebar=False, If True no titlebar will be shown - grab_anywhere=False, If True can grab anywhere on window to move - keep_on_top=False, If True window will be on top - location=(None, None)) Location on screen to create window -``` +``` +PopupGetFolder(message, Message to display in window + default_path='', Path to start browsing + no_window=False, If True no window will be shown + size=(None,None), Size of window + button_color=None, Color of buttons + background_color=None, Background color of window + text_color=None, Color of window text + icon=DEFAULT_WINDOW_ICON, Icon to show on taskbar + font=None, Font to use for window + no_titlebar=False, If True no titlebar will be shown + grab_anywhere=False, If True can grab anywhere on window to move + keep_on_top=False, If True window will be on top + location=(None, None)) Location on screen to create window +``` -This is a typpical call +This is a typpical call ```python - text = sg.PopupGetFolder('Please enter a folder name') - sg.Popup('Results', 'The value returned from PopupGetFolder', text) + text = sg.PopupGetFolder('Please enter a folder name') + sg.Popup('Results', 'The value returned from PopupGetFolder', text) ``` -![popupgetfolder](https://user-images.githubusercontent.com/13696193/44957861-45484080-aea5-11e8-926c-cf607a45251c.jpg) +![popupgetfolder](https://user-images.githubusercontent.com/13696193/44957861-45484080-aea5-11e8-926c-cf607a45251c.jpg) ### PopupAnimated @@ -813,259 +777,259 @@ This is a typpical call The animated Popup enables you to easily display a "loading" style animation specified through a GIF file that is either stored in a file or a base64 variable. ```python -def PopupAnimated(image_source, +def PopupAnimated(image_source, message=None, - background_color=None, - text_color=None, - font=None, - no_titlebar=True, - grab_anywhere=True, - keep_on_top=True, - location=(None, None), + background_color=None, + text_color=None, + font=None, + no_titlebar=True, + grab_anywhere=True, + keep_on_top=True, + location=(None, None), alpha_channel=.8, time_between_frames=0) ``` | name | meaning | |-|-| -|image_source | The GIF file specified as a string filename or a base64 variable | -|message | optional text message to be displayed under the animation | -|background_color | the background color to use for the window and all of the other parts of the window | -|text_color | color to use for optional text | -|font | font to use for the optional text | -|no_titlebar | no titlebar window setting | -|location | location to show the window | -|alpha_channel | alpha channel to use for the window | -|time_between_frames | amount of time in milliseconds to use between frames | +|image_source | The GIF file specified as a string filename or a base64 variable | +|message | optional text message to be displayed under the animation | +|background_color | the background color to use for the window and all of the other parts of the window | +|text_color | color to use for optional text | +|font | font to use for the optional text | +|no_titlebar | no titlebar window setting | +|location | location to show the window | +|alpha_channel | alpha channel to use for the window | +|time_between_frames | amount of time in milliseconds to use between frames | ||| ***To close animated popups***, call PopupAnimated with `image_source=None`. This will close all of the currently open PopupAnimated windows. -# Progress Meters! -We all have loops in our code. 'Isn't it joyful waiting, watching a counter scrolling past in a text window? How about one line of code to get a progress meter, that contains statistics about your code? +# Progress Meters! +We all have loops in our code. 'Isn't it joyful waiting, watching a counter scrolling past in a text window? How about one line of code to get a progress meter, that contains statistics about your code? ``` -OneLineProgressMeter(title, - current_value, - max_value, - key, - *args, - orientation=None, - bar_color=DEFAULT_PROGRESS_BAR_COLOR, - button_color=None, - size=DEFAULT_PROGRESS_BAR_SIZE, - border_width=DEFAULT_PROGRESS_BAR_BORDER_WIDTH): +OneLineProgressMeter(title, + current_value, + max_value, + key, + *args, + orientation=None, + bar_color=DEFAULT_PROGRESS_BAR_COLOR, + button_color=None, + size=DEFAULT_PROGRESS_BAR_SIZE, + border_width=DEFAULT_PROGRESS_BAR_BORDER_WIDTH): ``` - -Here's the one-line Progress Meter in action! + +Here's the one-line Progress Meter in action! ```python -for i in range(1,10000): - sg.OneLineProgressMeter('My Meter', i+1, 10000, 'key','Optional message') +for i in range(1,10000): + sg.OneLineProgressMeter('My Meter', i+1, 10000, 'key','Optional message') ``` -That line of code resulted in this window popping up and updating. +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 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. + +# Debug Output +Another call in the 'Easy' families of APIs is `EasyPrint`. It will output to a debug window. If the debug window isn't open, then the first call will open it. No need to do anything but stick a 'print' call in your code. You can even replace your 'print' calls with calls to EasyPrint by simply sticking the statement + +```python +print = sg.EasyPrint +``` + +at the top of your code. -![preogress meter](https://user-images.githubusercontent.com/13696193/43667625-d47da702-9746-11e8-91e6-e5177883abae.jpg) +There are a number of names for the same EasyPrint function. `Print` is one of the better ones to use as it's easy to remember. It is simply `print` with a capital P. + +```python +import PySimpleGUI as sg + +for i in range(100): + sg.Print(i) +``` -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 window. The cancel button results in a `False` return value from `OneLineProgressMeter`. It normally returns `True`. +![snap0125](https://user-images.githubusercontent.com/13696193/43114979-a696189e-8ecf-11e8-83c7-473fcf0ccc66.jpg) -***Be sure and add one to your loop counter*** so that your counter goes from 1 to the max value. If you do not add one, your counter will never hit the max value. Instead it will go from 0 to max-1. - -# Debug Output -Another call in the 'Easy' families of APIs is `EasyPrint`. It will output to a debug window. If the debug window isn't open, then the first call will open it. No need to do anything but stick a 'print' call in your code. You can even replace your 'print' calls with calls to EasyPrint by simply sticking the statement +Or if you didn't want to change your code: ```python -print = sg.EasyPrint +import PySimpleGUI as sg + +print=sg.Print +for i in range(100): +print(i) ``` -at the top of your code. +Just like the standard print call, `EasyPrint` supports the `sep` and `end` keyword arguments. Other names that can be used to call `EasyPrint` include `Print`, `eprint`, If you want to close the window, call the function `EasyPrintClose`. -There are a number of names for the same EasyPrint function. `Print` is one of the better ones to use as it's easy to remember. It is simply `print` with a capital P. - -```python -import PySimpleGUI as sg - -for i in range(100): - sg.Print(i) -``` - -![snap0125](https://user-images.githubusercontent.com/13696193/43114979-a696189e-8ecf-11e8-83c7-473fcf0ccc66.jpg) - -Or if you didn't want to change your code: - -```python -import PySimpleGUI as sg - -print=sg.Print -for i in range(100): -print(i) -``` - -Just like the standard print call, `EasyPrint` supports the `sep` and `end` keyword arguments. Other names that can be used to call `EasyPrint` include `Print`, `eprint`, If you want to close the window, call the function `EasyPrintClose`. - -You can change the size of the debug window using the `SetOptions` call with the `debug_win_size` parameter. +You can change the size of the debug window using the `SetOptions` call with the `debug_win_size` parameter. There is an option to tell PySimpleGUI to reroute all of your stdout and stderr output to this window. To do so call EasyPrint with the parameter `do_not_reroute_stdout` set to True. After calling it once with this parameter set to True, all future calls to a normal`print` will go to the debug window. If you close the debug window it will re-open the next time you Print to it. ---- -# Custom window API Calls (Your First window) +--- +# 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 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 windows is for your typical, blocking, non-persistent 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. +This first section on custom windows is for your typical, blocking, non-persistent 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 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. +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. +It's both not enjoyable nor helpful to immediately jump into tweaking each and every little thing available to you. -## The window Designer +## 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, no downloads, and everyone knows how to use it. +The good news to newcomers to GUI programming is that PySimpleGUI has a window designer. Better yet, the window designer requires no training, no downloads, and everyone knows how to use it. -![gui0_1](https://user-images.githubusercontent.com/13696193/44159598-e2257400-a085-11e8-9b02-343e72cc75c3.JPG) +![gui0_1](https://user-images.githubusercontent.com/13696193/44159598-e2257400-a085-11e8-9b02-343e72cc75c3.JPG) -It's a manual process, but if you follow the instructions, it will take only a minute to do and the result will be a nice looking GUI. The steps you'll take are: -1. Sketch your GUI on paper -2. Divide your GUI up into rows -3. Label each Element with the Element name -4. Write your Python code using the labels as pseudo-code +It's a manual process, but if you follow the instructions, it will take only a minute to do and the result will be a nice looking GUI. The steps you'll take are: +1. Sketch your GUI on paper +2. Divide your GUI up into rows +3. Label each Element with the Element name +4. Write your Python code using the labels as pseudo-code -Let's take a couple of examples. +Let's take a couple of examples. -**Enter a number**.... Popular beginner programs are often based on a game or logic puzzle that requires the user to enter something, like a number. The "high-low" answer game comes to mind where you try to guess the number based on high or low tips. +**Enter a number**.... Popular beginner programs are often based on a game or logic puzzle that requires the user to enter something, like a number. The "high-low" answer game comes to mind where you try to guess the number based on high or low tips. -**Step 1- Sketch the GUI** -![gui1_1](https://user-images.githubusercontent.com/13696193/44160127-6a584900-a087-11e8-8fec-09099a8e16f6.JPG) +**Step 1- Sketch the GUI** +![gui1_1](https://user-images.githubusercontent.com/13696193/44160127-6a584900-a087-11e8-8fec-09099a8e16f6.JPG) -**Step 2 - Divide into rows** +**Step 2 - Divide into rows** -![gui2_1](https://user-images.githubusercontent.com/13696193/44160128-6a584900-a087-11e8-9973-af866fb94c56.JPG) +![gui2_1](https://user-images.githubusercontent.com/13696193/44160128-6a584900-a087-11e8-9973-af866fb94c56.JPG) -Step 3 - Label elements +Step 3 - Label elements -![gui6_1](https://user-images.githubusercontent.com/13696193/44160116-64626800-a087-11e8-8b57-671c0461b508.JPG) +![gui6_1](https://user-images.githubusercontent.com/13696193/44160116-64626800-a087-11e8-8b57-671c0461b508.JPG) -Step 4 - Write the code -The code we're writing is the layout of the GUI itself. This tutorial only focuses on getting the window code written, not the stuff to display it, get results. +Step 4 - Write the code +The code we're writing is the layout of the GUI itself. This tutorial only focuses on getting the window code written, not the stuff to display it, get results. -We have only 1 element on the first row, some text. Rows are written as a "list of elements", so we'll need [ ] to make a list. Here's the code for row 1 +We have only 1 element on the first row, some text. Rows are written as a "list of elements", so we'll need [ ] to make a list. Here's the code for row 1 ``` -[ sg.Text('Enter a number') ] +[ sg.Text('Enter a number') ] ``` - -Row 2 has 1 elements, an input field. + +Row 2 has 1 elements, an input field. ``` -[ sg.Input() ] +[ sg.Input() ] ``` -Row 3 has an OK button - +Row 3 has an OK button + ``` -[ sg.OK() ] +[ sg.OK() ] +``` + +Now that we've got the 3 rows defined, they are put into a list that represents the entire window. + +``` +layout = [ [sg.Text('Enter a Number')], + [sg.Input()], + [sg.OK()] ] ``` -Now that we've got the 3 rows defined, they are put into a list that represents the entire window. - -``` -layout = [ [sg.Text('Enter a Number')], - [sg.Input()], - [sg.OK()] ] -``` - -Finally we can put it all together into a program that will display our window. +Finally we can put it all together into a program that will display our window. ```python -import PySimpleGUI as sg - -layout = [[sg.Text('Enter a Number')], - [sg.Input()], - [sg.OK()] ] - -event, (number,) = sg.Window('Enter a number example', layout).Read() - -sg.Popup(event, number) +import PySimpleGUI as sg + +layout = [[sg.Text('Enter a Number')], + [sg.Input()], + [sg.OK()] ] + +event, (number,) = sg.Window('Enter a number example', layout).Read() + +sg.Popup(event, 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 window on paper, break it up into rows, label the elements. +### 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 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) +![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 window 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. ```python -import PySimpleGUI as sg - -layout = [[sg.Text('Filename')], - [sg.Input(), sg.FileBrowse()], - [sg.OK(), sg.Cancel()] ] - -event, (number,) = sg.Window('Get filename example', layout).Read() - -sg.Popup(event, number) +import PySimpleGUI as sg + +layout = [[sg.Text('Filename')], + [sg.Input(), sg.FileBrowse()], + [sg.OK(), sg.Cancel()] ] + +event, (number,) = sg.Window('Get filename example', layout).Read() + +sg.Popup(event, number) ``` -Read on for detailed instructions on the calls that show the window and return your results. +Read on for detailed instructions on the calls that show the window and return your results. -# Copy these design patterns! +# Copy these design patterns! -All of your PySimpleGUI programs will utilize one of these 2 design patterns depending on the type of window you're implementing. +All of your PySimpleGUI programs will utilize one of these 2 design patterns depending on the type of window you're implementing. -## Pattern 1 - "One-shot Window" - Read into list or dictionary (**The Most Common** Pattern) +## Pattern 1 - "One-shot Window" - Read into list or dictionary (**The Most Common** Pattern) This will be the most common pattern you'll follow if you are not using an "event loop" (not reading the window multiple times). The window is read and closes. -It's unusual to assign the values returned from the read call directly into user variables. Usually the variables are grouped together into a list or dictionary of multiple return values. +It's unusual to assign the values returned from the read call directly into user variables. Usually the variables are grouped together into a list or dictionary of multiple return values. -```python -import PySimpleGUI as sg - -window_rows = [[sg.Text('SHA-1 and SHA-256 Hashes for the file')], - [sg.InputText(), sg.FileBrowse()], - [sg.Submit(), sg.Cancel()]] - -window = sg.Window('SHA-1 & 256 Hash', window_rows) - -event, values = window.Read() +```python +import PySimpleGUI as sg + +window_rows = [[sg.Text('SHA-1 and SHA-256 Hashes for the file')], + [sg.InputText(), sg.FileBrowse()], + [sg.Submit(), sg.Cancel()]] + +window = sg.Window('SHA-1 & 256 Hash', window_rows) + +event, values = window.Read() window.Close() - -source_filename = values[0] + +source_filename = values[0] ``` -## Pattern 2 A - Persistent window (multiple reads using an event loop) +## Pattern 2 A - Persistent window (multiple reads using an event loop) -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. +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 code will present a window and will print values until the user clicks the exit button or closes window using an X. - -```python -import PySimpleGUI as sg - -layout = [[sg.Text('Persistent window')], - [sg.Input(do_not_clear=True)], - [sg.Button('Read'), sg.Exit()]] +This code will present a window and will print values until the user clicks the exit button or closes window using an X. +```python +import PySimpleGUI as sg + +layout = [[sg.Text('Persistent window')], + [sg.Input(do_not_clear=True)], + [sg.Button('Read'), sg.Exit()]] + window = sg.Window('Window that stays open', layout) - -while True: - event, values = window.Read() - if event is None or event == 'Exit': - break - print(event, values) + +while True: + event, values = window.Read() + if event is None or event == 'Exit': + break + print(event, values) window.Close() -``` +``` -## Pattern 2 B - Persistent window (multiple reads using an event loop + updates data in window) +## Pattern 2 B - Persistent window (multiple reads using an event loop + updates data in window) This is a slightly more complex, but maybe more realistic version that reads input from the user and displays that input as text in the window. Your program is likely to be doing both of those activities so this will give you a big jump-start. @@ -1074,25 +1038,25 @@ Do not worry yet what all of these statements mean. Just copy it so you can be A final note... the parameter `do_not_clear` in the input call determines the action of the input field after a button event. If this value is True, the input value remains visible following button clicks. If False, then the input field is CLEARED of whatever was input. If you are building a "Form" type of window with data entry, you likely want False, the default setting (you can remove the parameter completely). ```python -import sys -if sys.version_info[0] >= 3: - import PySimpleGUI as sg -else: - import PySimpleGUI27 as sg - -layout = [[sg.Text('Your typed chars appear here:'), sg.Text('', key='_OUTPUT_') ], - [sg.Input(do_not_clear=True, key='_IN_')], - [sg.Button('Show'), sg.Button('Exit')]] - -window = sg.Window('Window Title', layout) - -while True: # Event Loop - event, values = window.Read() +import sys +if sys.version_info[0] >= 3: + import PySimpleGUI as sg +else: + import PySimpleGUI27 as sg + +layout = [[sg.Text('Your typed chars appear here:'), sg.Text('', key='_OUTPUT_') ], + [sg.Input(do_not_clear=True, key='_IN_')], + [sg.Button('Show'), sg.Button('Exit')]] + +window = sg.Window('Window Title', layout) + +while True: # Event Loop + event, values = window.Read() print(event, values) - if event is None or event == 'Exit': - break - if event == 'Show': - # change the "output" element to be the value of "input" element + if event is None or event == 'Exit': + break + if event == 'Show': + # change the "output" element to be the value of "input" element window.Element('_OUTPUT_').Update(values['_IN_']) window.Close() @@ -1100,109 +1064,109 @@ window.Close() -## How GUI Programming in Python Should Look? At least for beginners ? +## How GUI Programming in Python Should Look? At least for beginners ? -While one goal was making it simple to create a GUI another just as important goal was to do it in a Pythonic manner. Whether it achieved these goals is debatable, but it was an attempt just the same. +While one goal was making it simple to create a GUI another just as important goal was to do it in a Pythonic manner. Whether it achieved these goals is debatable, but it was an attempt just the same. -The key to custom windows in PySimpleGUI is to view windows as ROWS of GUI Elements. Each row is specified as a list of these Elements. Put the rows together and you've got a window. This means the GUI is defined as a series of Lists, a Pythonic way of looking at things. +The key to custom windows in PySimpleGUI is to view windows as ROWS of GUI Elements. Each row is specified as a list of these Elements. Put the rows together and you've got a window. This means the GUI is defined as a series of Lists, a Pythonic way of looking at things. -Let's dissect this little program +Let's dissect this little program ```python -import PySimpleGUI as sg +import PySimpleGUI as sg + +layout = [[sg.Text('Rename files or folders')], + [sg.Text('Source for Folders', size=(15, 1)), sg.InputText(), sg.FolderBrowse()], + [sg.Text('Source for Files ', size=(15, 1)), sg.InputText(), sg.FolderBrowse()], + [sg.Submit(), sg.Cancel()]] + +window = sg.Window('Rename Files or Folders', layout) + +event, values = window.Read() +``` -layout = [[sg.Text('Rename files or folders')], - [sg.Text('Source for Folders', size=(15, 1)), sg.InputText(), sg.FolderBrowse()], - [sg.Text('Source for Files ', size=(15, 1)), sg.InputText(), sg.FolderBrowse()], - [sg.Submit(), sg.Cancel()]] -window = sg.Window('Rename Files or Folders', layout) +![snap0131](https://user-images.githubusercontent.com/13696193/43417007-df6d8408-9407-11e8-9986-30f0415f08a5.jpg) -event, values = window.Read() +Let's agree the window has 4 rows. + +The first row only has **text** that reads `Rename files or folders` + +The second row has 3 elements in it. First the **text** `Source for Folders`, then an **input** field, then a **browse** button. + +Now let's look at how those 2 rows and the other two row from Python code: + +```python +layout = [[sg.Text('Rename files or folders')], + [sg.Text('Source for Folders', size=(15, 1)), sg.InputText(), sg.FolderBrowse()], + [sg.Text('Source for Files ', size=(15, 1)), sg.InputText(), sg.FolderBrowse()], + [sg.Submit(), sg.Cancel()]] ``` +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. -![snap0131](https://user-images.githubusercontent.com/13696193/43417007-df6d8408-9407-11e8-9986-30f0415f08a5.jpg) +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. -Let's agree the window has 4 rows. +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. -The first row only has **text** that reads `Rename files or folders` +In our example window, there are 2 fields, so the return values from this window will be a list with 2 values in it. +```python +event, values = window.Read() +folder_path, file_path = values +``` -The second row has 3 elements in it. First the **text** `Source for Folders`, then an **input** field, then a **browse** button. +In one statement we both show the window and read the user's inputs. In the next the *list* of return values is split into individual variables `folder_path` and `file_path`. -Now let's look at how those 2 rows and the other two row from Python code: - -```python -layout = [[sg.Text('Rename files or folders')], - [sg.Text('Source for Folders', size=(15, 1)), sg.InputText(), sg.FolderBrowse()], - [sg.Text('Source for Files ', size=(15, 1)), sg.InputText(), sg.FolderBrowse()], - [sg.Submit(), sg.Cancel()]] -``` - -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 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 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 window, there are 2 fields, so the return values from this window will be a list with 2 values in it. -```python -event, values = window.Read() -folder_path, file_path = values -``` - -In one statement we both show the window and read the user's inputs. In the next the *list* of return values is split into individual variables `folder_path` and `file_path`. - -Isn't this what a 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? Most would choose 4. +Isn't this what a 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? Most would choose 4. -## Return values +## Return values -As of version 2.8 there are 2 forms of return values, list and dictionary. +As of version 2.8 there are 2 forms of return values, list and dictionary. -### Two Return Values +### Two Return Values -All Window Read calls return 2 values. By convention a read statement is written: -```python -event, values = window.Read() -``` +All Window Read calls return 2 values. By convention a read statement is written: +```python +event, values = window.Read() +``` -You don't HAVE to write your reads in this way. You can name your variables however you want. But if you want to code them in a way that other programmers using PySimpleGUI are used to, then use these statements. +You don't HAVE to write your reads in this way. You can name your variables however you want. But if you want to code them in a way that other programmers using PySimpleGUI are used to, then use these statements. ## Events -The first parameter `event` describes **why** the read completed. Events are one of these: +The first parameter `event` describes **why** the read completed. Events are one of these: -For all Windows: +For all Windows: -* Button click -* Window closed using X +* Button click +* Window closed using X -For Windows that have specifically enabled these. Please see the appropriate section in this document to learn about how to enable these and what the event return values are. +For Windows that have specifically enabled these. Please see the appropriate section in this document to learn about how to enable these and what the event return values are. -* Keyboard key press -* Mouse wheel up/down -* Menu item selected -* An Element Changed (slider, spinner, etc) -* A list item was clicked -* Return key was pressed in input element +* Keyboard key press +* Mouse wheel up/down +* Menu item selected +* An Element Changed (slider, spinner, etc) +* A list item was clicked +* Return key was pressed in input element * Timeout waiting for event * Text was clicked * Combobox item chosen * Table row selected * etc -***Most*** of the time the event will be a button click or the window was closed. +***Most*** of the time the event will be a button click or the window was closed. ### Window closed event -Another convention to follow is the check for windows being closed with an X. This is an important event to catch. If you don't check for this and you attempt to use the window, your program will crash. Please check for closed window and exit your program gracefully. - -To check for a closed window use this line of code: +Another convention to follow is the check for windows being closed with an X. This is an important event to catch. If you don't check for this and you attempt to use the window, your program will crash. Please check for closed window and exit your program gracefully. +To check for a closed window use this line of code: + ```python -if event is None: +if event is None: ``` - + Putting it all together we end up with an "event loop" that looks something like this: ```python while True: @@ -1216,21 +1180,21 @@ By default buttons will always return a click event, or in the case of realtime You can enable an additional "Button Modified" event by setting `enable_events=True` in the Button call. These events are triggered when something 'writes' to a button, ***usually*** it's because the button is listed as a "target" in another button. -The button value from a Read call will be one of 2 values: +The button value from a Read call will be one of 2 values: 1. The Button's text - Default 2. The Button's key - If a key is specified -If a button has a key set when it was 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 event value is None. +If a button has a key set when it was 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 event value is None. -### **None is returned when the user clicks the X to close a window.** - -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: +### **None is returned when the user clicks the X to close a window.** +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: + ```python -while True: - event, values = window.Read() - if event is None or event == 'Quit': - break +while True: + event, values = window.Read() + if event is None or event == 'Quit': + break ``` @@ -1279,213 +1243,213 @@ Windows are capable of returning keyboard events. These are returned as either If you set a timeout parameter in your read, then the system TIMEOUT_KEY will be returned. If you specified your own timeout key in the Read call then that value will be what's returned instead. -### The `values` Variable - Return values as a list +### The `values` Variable - Return values as a list -The second parameter from a Read call is either a list or a dictionary of the input fields on the Window. +The second parameter from a Read call is either a list or a dictionary of the input fields on the Window. -By default return values are a list of values, one entry for each input field. +By default return values are a list of values, one entry for each input field. -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. +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. -event, (filename, folder1, folder2, should_overwrite) = sg.Window('My title', window_rows).Read() +event, (filename, folder1, folder2, should_overwrite) = sg.Window('My title', window_rows).Read() -Or, more commonly, you can unpack the return results separately. +Or, more commonly, you can unpack the return results separately. -```python -event, values = sg.Window('My title', window_rows).Read() -event, value_list = window.Read() -value1 = value_list[0] -value2 = value_list[1] - ... -``` -However, this method isn't good when you have a lot of input fields. If you insert a new element into your window then you will have to shuffle your unpacks down, modifying each of the statements to reference `value_list[x] `. +```python +event, values = sg.Window('My title', window_rows).Read() +event, value_list = window.Read() +value1 = value_list[0] +value2 = value_list[1] + ... +``` +However, this method isn't good when you have a lot of input fields. If you insert a new element into your window then you will have to shuffle your unpacks down, modifying each of the statements to reference `value_list[x] `. -The more common / advanced method is to request your values be returned as a dictionary. +The more common / advanced method is to request your values be returned as a dictionary. -### `values` Variable - Return values as a dictionary +### `values` Variable - Return values as a dictionary -For those of you that have not encountered a Python dictionary, don't freak out! Just copy and paste the sample code and modify it. Follow this design pattern and you'll be fine. And you might learn something along the way. +For those of you that have not encountered a Python dictionary, don't freak out! Just copy and paste the sample code and modify it. Follow this design pattern and you'll be fine. And you might learn something along the way. -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. +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 window read statement you'll encounter looks something like this: +The most common window read statement you'll encounter looks something like this: `window = sg.Window("My title", layout).Read()` -To use a dictionary, you will need to: -* Mark each input element you wish to be in the dictionary with the keyword `key`. +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 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 window. +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 window. + ```python -import PySimpleGUI as sg - -layout = [ - [sg.Text('Please enter your Name, Address, Phone')], - [sg.Text('Name', size=(15, 1)), sg.InputText('1', key='_name_')], - [sg.Text('Address', size=(15, 1)), sg.InputText('2', key='_address_')], - [sg.Text('Phone', size=(15, 1)), sg.InputText('3', key='_phone_')], - [sg.Submit(), sg.Cancel()] - ] - -window = sg.Window('Simple data entry window', layout) -event, values = window.Read() - -sg.Popup(event, values, values['_name_'], values['_address_'], values['_phone_']) +import PySimpleGUI as sg + +layout = [ + [sg.Text('Please enter your Name, Address, Phone')], + [sg.Text('Name', size=(15, 1)), sg.InputText('1', key='_name_')], + [sg.Text('Address', size=(15, 1)), sg.InputText('2', key='_address_')], + [sg.Text('Phone', size=(15, 1)), sg.InputText('3', key='_phone_')], + [sg.Submit(), sg.Cancel()] + ] + +window = sg.Window('Simple data entry window', layout) +event, values = window.Read() + +sg.Popup(event, values, values['_name_'], values['_address_'], values['_phone_']) ``` -To get the value of an input field, you use whatever value used as the `key` value as the index value. Thus to get the value of the name field, it is written as +To get the value of an input field, you use whatever value used as the `key` value as the index value. Thus to get the value of the name field, it is written as values['name'] -Think of the variable values in the same way as you would a list, however, instead of using 0,1,2, to reference each item in the list, use the values of the key. The Name field in the window above is referenced by `values['_name_']`. +Think of the variable values in the same way as you would a list, however, instead of using 0,1,2, to reference each item in the list, use the values of the key. The Name field in the window above is referenced by `values['_name_']`. + +You will find the key field used quite heavily in most PySimpleGUI windows unless the window is very simple. + +Another convention you'll see in some of the demo programs is keys being named with an underscore at the beginning and the end. You don't HAVE to do this... your key value may look like this: +`key = 'name'` -You will find the key field used quite heavily in most PySimpleGUI windows unless the window is very simple. - -Another convention you'll see in some of the demo programs is keys being named with an underscore at the beginning and the end. You don't HAVE to do this... your key value may look like this: -`key = 'name'` - -The reason for this naming convention is that when you are scanning the code, these key values jump out at you. You instantly know it's a key. Try scanning the code above and see if those keys pop out. -`key = '_name_'` +The reason for this naming convention is that when you are scanning the code, these key values jump out at you. You instantly know it's a key. Try scanning the code above and see if those keys pop out. +`key = '_name_'` -## The Event Loop / Callback Functions +## The Event Loop / Callback Functions -All GUIs have one thing in common, an "event loop". Usually the GUI framework runs the event loop for you, but sometimes you want greater control and will run your own event loop. You often hear the term event loop when discussing embedded systems or on a Raspberry Pi. +All GUIs have one thing in common, an "event loop". Usually the GUI framework runs the event loop for you, but sometimes you want greater control and will run your own event loop. You often hear the term event loop when discussing embedded systems or on a Raspberry Pi. -With PySimpleGUI if your window will remain open following button clicks, then your code will have an event loop. If your program shows a single "one-shot" window, collects the data and then has no other GUI interaction, then you don't need an event loop. +With PySimpleGUI if your window will remain open following button clicks, then your code will have an event loop. If your program shows a single "one-shot" window, collects the data and then has no other GUI interaction, then you don't need an event loop. -There's nothing mysterious about event loops... they are loops where you take care of.... wait for it..... *events*. Events are things like button clicks, key strokes, mouse scroll-wheel up/down. +There's nothing mysterious about event loops... they are loops where you take care of.... wait for it..... *events*. Events are things like button clicks, key strokes, mouse scroll-wheel up/down. -Let's take a Pi demo program as an example. This program shows a GUI window, gets button presses, and uses them to control some LEDs. It loops, reading user input and doing something with it. +Let's take a Pi demo program as an example. This program shows a GUI window, gets button presses, and uses them to control some LEDs. It loops, reading user input and doing something with it. -This little program has a typical Event Loop +This little program has a typical Event Loop -![readme example](https://user-images.githubusercontent.com/13696193/46566965-f4d65f80-c8f6-11e8-91a3-8cebad0cba90.jpg) +![readme example](https://user-images.githubusercontent.com/13696193/46566965-f4d65f80-c8f6-11e8-91a3-8cebad0cba90.jpg) -```python -import PySimpleGUI as sg - -layout = [[sg.Text('Click read to read the input value')], - [sg.Input()], - [sg.RButton('Read'), sg.Exit()]] - -window = sg.Window('Persistent GUI Window', layout) - -while True: - event, values = window.Read() - if event is None or event == 'Exit': - break - print(event, values) +```python +import PySimpleGUI as sg + +layout = [[sg.Text('Click read to read the input value')], + [sg.Input()], + [sg.RButton('Read'), sg.Exit()]] + +window = sg.Window('Persistent GUI Window', layout) + +while True: + event, values = window.Read() + if event is None or event == 'Exit': + break + print(event, values) window.Close() -``` +``` -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) +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 asynchronous code, a concept beginners often stumble on and one that presents a barrier. +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 asynchronous code, a concept beginners often stumble on and one that presents a barrier. -There is a more communications that have to happen between parts of your program when using callbacks. Callbacks break apart your program's logic apart and scatter it. One of the larger hurdles for beginners to GUI programming are these callback functions. +There is a more communications that have to happen between parts of your program when using callbacks. Callbacks break apart your program's logic apart and scatter it. One of the larger hurdles for beginners to GUI programming are these callback functions. -PySimpleGUI was specifically designed in a way so that callbacks would not be required. There is no coordination between one function and another required. You simply read your button click and take appropriate action at the same location in the code as when you read the button value. +PySimpleGUI was specifically designed in a way so that callbacks would not be required. There is no coordination between one function and another required. You simply read your button click and take appropriate action at the same location in the code as when you read the button value. -Whether or not this is a "proper" design for GUI programs can be debated. It's not a terrible trade-off to run your own event loop and having a functioning GUI application versus one that maybe never gets written because callback functions were too much to grasp. +Whether or not this is a "proper" design for GUI programs can be debated. It's not a terrible trade-off to run your own event loop and having a functioning GUI application versus one that maybe never gets written because callback functions were too much to grasp. -## All Widgets / Elements +## All Widgets / Elements -This code utilizes many of the common Elements. It does not include Tabs/Tab Groups. -```python -import PySimpleGUI as sg +This code utilizes many of the common Elements. It does not include Tabs/Tab Groups. +```python +import PySimpleGUI as sg + +sg.ChangeLookAndFeel('GreenTan') + +# ------ Menu Definition ------ # +menu_def = [['File', ['Open', 'Save', 'Exit', 'Properties']], + ['Edit', ['Paste', ['Special', 'Normal', ], 'Undo'], ], + ['Help', 'About...'], ] + +# ------ Column Definition ------ # +column1 = [[sg.Text('Column 1', background_color='#F7F3EC', justification='center', size=(10, 1))], + [sg.Spin(values=('Spin Box 1', '2', '3'), initial_value='Spin Box 1')], + [sg.Spin(values=('Spin Box 1', '2', '3'), initial_value='Spin Box 2')], + [sg.Spin(values=('Spin Box 1', '2', '3'), initial_value='Spin Box 3')]] + +layout = [ + [sg.Menu(menu_def, tearoff=True)], + [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=[ + [sg.Checkbox('Checkbox', size=(10,1)), sg.Checkbox('My second checkbox!', default=True)], + [sg.Radio('My first Radio! ', "RADIO1", default=True, size=(10,1)), sg.Radio('My second Radio!', "RADIO1")]], title='Options',title_color='red', relief=sg.RELIEF_SUNKEN, tooltip='Use these to set flags')], + [sg.Multiline(default_text='This is the default Text should you decide not to type anything', size=(35, 3)), + sg.Multiline(default_text='A second multi-line', size=(35, 3))], + [sg.InputCombo(('Combobox 1', 'Combobox 2'), size=(20, 1)), + sg.Slider(range=(1, 100), orientation='h', size=(34, 20), default_value=85)], + [sg.InputOptionMenu(('Menu Option 1', 'Menu Option 2', 'Menu Option 3'))], + [sg.Listbox(values=('Listbox 1', 'Listbox 2', 'Listbox 3'), size=(30, 3)), + sg.Frame('Labelled Group',[[ + sg.Slider(range=(1, 100), orientation='v', size=(5, 20), default_value=25), + sg.Slider(range=(1, 100), orientation='v', size=(5, 20), default_value=75), + sg.Slider(range=(1, 100), orientation='v', size=(5, 20), default_value=10), + sg.Column(column1, background_color='#F7F3EC')]])], + [sg.Text('_' * 80)], + [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 window'), sg.Cancel()] +] + + +window = sg.Window('Everything bagel', layout, default_element_size=(40, 1), grab_anywhere=False) + +event, values = window.Read() + +sg.Popup('Title', + 'The results of the window.', + 'The button clicked was "{}"'.format(event), + 'The values are', values) +``` +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. -sg.ChangeLookAndFeel('GreenTan') +![everything bagel](https://user-images.githubusercontent.com/13696193/45914128-87163800-be0e-11e8-9a83-7ee5960e88b9.jpg) -# ------ Menu Definition ------ # -menu_def = [['File', ['Open', 'Save', 'Exit', 'Properties']], - ['Edit', ['Paste', ['Special', 'Normal', ], 'Undo'], ], - ['Help', 'About...'], ] +Clicking the Submit button caused the window call to return. The call to Popup resulted in this window. -# ------ Column Definition ------ # -column1 = [[sg.Text('Column 1', background_color='#F7F3EC', justification='center', size=(10, 1))], - [sg.Spin(values=('Spin Box 1', '2', '3'), initial_value='Spin Box 1')], - [sg.Spin(values=('Spin Box 1', '2', '3'), initial_value='Spin Box 2')], - [sg.Spin(values=('Spin Box 1', '2', '3'), initial_value='Spin Box 3')]] - -layout = [ - [sg.Menu(menu_def, tearoff=True)], - [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=[ - [sg.Checkbox('Checkbox', size=(10,1)), sg.Checkbox('My second checkbox!', default=True)], - [sg.Radio('My first Radio! ', "RADIO1", default=True, size=(10,1)), sg.Radio('My second Radio!', "RADIO1")]], title='Options',title_color='red', relief=sg.RELIEF_SUNKEN, tooltip='Use these to set flags')], - [sg.Multiline(default_text='This is the default Text should you decide not to type anything', size=(35, 3)), - sg.Multiline(default_text='A second multi-line', size=(35, 3))], - [sg.InputCombo(('Combobox 1', 'Combobox 2'), size=(20, 1)), - sg.Slider(range=(1, 100), orientation='h', size=(34, 20), default_value=85)], - [sg.InputOptionMenu(('Menu Option 1', 'Menu Option 2', 'Menu Option 3'))], - [sg.Listbox(values=('Listbox 1', 'Listbox 2', 'Listbox 3'), size=(30, 3)), - sg.Frame('Labelled Group',[[ - sg.Slider(range=(1, 100), orientation='v', size=(5, 20), default_value=25), - sg.Slider(range=(1, 100), orientation='v', size=(5, 20), default_value=75), - sg.Slider(range=(1, 100), orientation='v', size=(5, 20), default_value=10), - sg.Column(column1, background_color='#F7F3EC')]])], - [sg.Text('_' * 80)], - [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 window'), sg.Cancel()] -] +![everything bagel reseults](https://user-images.githubusercontent.com/13696193/45914129-87aece80-be0e-11e8-8aae-9a483a9ad4a6.jpg) -window = sg.Window('Everything bagel', layout, default_element_size=(40, 1), grab_anywhere=False) +**`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`. It is ***vitally*** ***important*** that your code contain the proper checks for None. Always give your users a way out of the window. Otherwise you'll end up with windows that never properly close. -event, values = window.Read() +You can see in the results Popup window 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`. -sg.Popup('Title', - 'The results of the window.', - 'The button clicked was "{}"'.format(event), - 'The values are', values) -``` -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. +# 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 -![everything bagel](https://user-images.githubusercontent.com/13696193/45914128-87163800-be0e-11e8-9a83-7ee5960e88b9.jpg) - -Clicking the Submit button caused the window call to return. The call to Popup resulted in this window. - -![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 window using something other than a button, then `button` will be `None`. It is ***vitally*** ***important*** that your code contain the proper checks for None. Always give your users a way out of the window. Otherwise you'll end up with windows that never properly close. - -You can see in the results Popup window 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 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 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. +## 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. A truly non-blocking Read call looks like this: ```python event, values = window.Read(timeout=0) ``` -You can learn more about these async / non-blocking windows toward the end of this document. +You can learn more about these async / non-blocking windows toward the end of this document. -# Window Object - Beginning a window -The first step is to create the window object using the desired window customization. +# Window Object - Beginning a window +The first step is to create the window object using the desired window customization. -This is the definition of the Window object: +This is the definition of the Window object: ```python -Window( title, +Window( title, default_element_size=DEFAULT_ELEMENT_SIZE, default_button_element_size=(None,None), auto_size_text=None, @@ -1512,10 +1476,10 @@ Window( title, resizable=False, disable_close=False, disable_minimize=False, - right_click_menu=None): -``` + right_click_menu=None): +``` -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. +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. | Name | Meaning | | - | - | @@ -1549,8 +1513,8 @@ Parameter Descriptions. You will find these same parameters specified for each | | | -### 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 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. +### 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 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. ### Window Size @@ -1565,61 +1529,61 @@ window = Window('My Title', layout).Finalize() ``` -### Element 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. +### Element 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)`. +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 window. Setting `size=(20,1)` in the window creation call will set all elements in the window 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. +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. -### No Titlebar +### No Titlebar -Should you wish to create cool looking windows that are clean with no windows titlebar, use the no_titlebar option when creating the window. +Should you wish to create cool looking windows that are clean with no windows titlebar, use the no_titlebar option when creating the window. -Be sure an provide your user an "exit" button or they will not be able to close the window! When no titlebar is enabled, there will be no icon on your taskbar for the window. Without an exit button you will need to kill via taskmanager... not fun. +Be sure an provide your user an "exit" button or they will not be able to close the window! When no titlebar is enabled, there will be no icon on your taskbar for the window. Without an exit button you will need to kill via taskmanager... not fun. -Windows with no titlebar rely on the grab anywhere option to be enabled or else you will be unable to move the window. +Windows with no titlebar rely on the grab anywhere option to be enabled or else you will be unable to move the window. -Windows without a titlebar can be used to easily create a floating launcher. +Windows without a titlebar can be used to easily create a floating launcher. -Linux users! Note that this setting has side effects for some of the other Elements. Multi-line input doesn't work at all, for example So, use with caution. +Linux users! Note that this setting has side effects for some of the other Elements. Multi-line input doesn't work at all, for example So, use with caution. -![floating launcher](https://user-images.githubusercontent.com/13696193/45258246-71bafb80-b382-11e8-9f5e-79421e6c00bb.jpg) +![floating launcher](https://user-images.githubusercontent.com/13696193/45258246-71bafb80-b382-11e8-9f5e-79421e6c00bb.jpg) -### Grab Anywhere +### Grab Anywhere -This is a feature unique to PySimpleGUI. +This is a feature unique to PySimpleGUI. -Note - 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. +Note - 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 +### Always on top -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. ### Focus PySimpleGUI will set a default focus location for you. This generally means the first input field. You can set the focus to a particular element. If you are going to set the focus yourself, then you should turn off the automatic focus by setting `use_default_focus=False` in your Window call. -### Window Methods (things you can do with a Window object) +### 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: +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) - Recommend moving away from this nethod and using layout parameter instead. 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. Can have an optional timeout - window.ReadNonBlocking() - NO LONGER USED! - 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.Close() - To close your window, if a button hasn't already closed it - window.Disable() - Use to disable the window inputwhen opening another window on top of the primnary Window - window.Enable() - Re-enable a Disabled window + window.Layout(layout) - Recommend moving away from this nethod and using layout parameter instead. 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. Can have an optional timeout + window.ReadNonBlocking() - NO LONGER USED! + 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.Close() - To close your window, if a button hasn't already closed it + window.Disable() - Use to disable the window inputwhen opening another window on top of the primnary Window + window.Enable() - Re-enable a Disabled window window.FindElement(key, silent_on_error=False) - Returns the element that has a matching key value window.Element(key, silent_on_error=False) - EXACTLY the same as calling FindElement window.Move(x,y) - Moves window to location x,y on screen' @@ -1630,30 +1594,30 @@ There are a few methods (functions) that you will see in this document that act window.CurrentLocation() - Returns current window location window.Size = w,h - Forces a window to be a particular size. Note this is a property not a method window.Size - Tuple (w,h)The size of the current window. Note this is a property - window.Minimize() - Minimizes window to taskbar + window.Minimize() - Minimizes window to taskbar -## Window Methods +## Window Methods -There are a number of operations you can do on a window after you've created the window. You call these after creating your Windows object. +There are a number of operations you can do on a window after you've created the window. You call these after creating your Windows object. -#### Layout(rows) +#### Layout(rows) -Call to set the window layout. Must be called prior to Read. Most likely "chained" in line with the Window creation. +Call to set the window layout. Must be called prior to Read. Most likely "chained" in line with the Window creation. -```python -window = sg.Window('My window title', layout) -``` +```python +window = sg.Window('My window title', layout) +``` -#### Finalize() +#### Finalize() Call to force a window to go through the final stages of initialization. This will cause the tkinter resources to be allocated so that they can then be modified. This also causes your window to appear. If you do not want your window to appear when Finalize is called, then set the Alpha to 0 in your window's creation parameters. If you want to call an element's Update method or call a Graph element's drawing primitives, you ***must*** either call `Read` or `Finalize` prior to making those calls. -#### Read(timeout=None, timeout_key='__TIMEOUT_ _ ') +#### Read(timeout=None, timeout_key='__TIMEOUT_ _ ') -Read the Window's input values and button clicks in a blocking-fashion +Read the Window's input values and button clicks in a blocking-fashion Returns event, values. Adding a timeout can be achieved by setting timeout=number of milliseconds before the Read times out after which a "timeout event" is returned. The value of timeout_key will be returned as the event. If you do not specify a timeout key, then the value `TIMEOUT_KEY` will be returned. @@ -1692,10 +1656,10 @@ Will consume 100% of your CPU if you do not have other blocking calls in your ev ||| -# Elements -"Elements" are the building blocks used to create windows. Some GUI APIs use the term "Widget" to describe these graphic elements. +# Elements +"Elements" are the building blocks used to create windows. Some GUI APIs use the term "Widget" to describe these graphic elements. -- Text +- Text - Single Line Input - Buttons including these types: - File Browse @@ -1710,9 +1674,9 @@ Will consume 100% of your CPU if you do not have other blocking calls in your ev - Listbox - Slider - Multi-line Text Input/Output -- Multi-line Text Output (Qt only) -- Scroll-able Output -- Vertical Separator +- Multi-line Text Output (Qt only) +- Scroll-able Output +- Vertical Separator - Progress Bar - Option Menu - Menu @@ -1722,255 +1686,171 @@ Will consume 100% of your CPU if you do not have other blocking calls in your ev - Graph - Image - Table -- Tree -- Tab, TabGroup +- Tree +- Tab, TabGroup - StatusBar - Pane - Stretch (Qt only) ## Common Element Parameters -Some parameters that you will see on almost all Elements are: -- key - Used with window.FindElement and with return values -- tooltip - Hover your mouse over the elemnt and you'll get a popup with this text -- size - (width, height) - usually measured in characters-wide, rows-high. Sometimes they mean pixels -- font - specifies the font family, size, etc -- colors - Color name or #RRGGBB string -- pad - Amount of padding to put around element -- enable_events - Turns on the element specific events +Some parameters that you will see on almost all Elements are: +- key - Used with window.FindElement and with return values +- tooltip - Hover your mouse over the elemnt and you'll get a popup with this text +- size - (width, height) - usually measured in characters-wide, rows-high. Sometimes they mean pixels +- font - specifies the font family, size, etc +- colors - Color name or #RRGGBB string +- pad - Amount of padding to put around element +- enable_events - Turns on the element specific events -#### 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 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`. +#### 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 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. +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. -#### Size -Specifies the amount of room reserved for the Element. For elements that are character based, such a Text, it is (# characters, # rows). Sometimes it is a pixel measurement such as the Image element. And sometimes a mix like on the Slider element (characters long by pixels wide). +#### Size +Specifies the amount of room reserved for the Element. For elements that are character based, such a Text, it is (# characters, # rows). Sometimes it is a pixel measurement such as the Image element. And sometimes a mix like on the Slider element (characters long by pixels wide). -#### Colors -A string representing color. Anytime colors are involved, you can specify the tkinter color name such as 'lightblue' or an RGB hex value '#RRGGBB'. For buttons, the color parameter is a tuple (text color, background color) +#### Colors +A string representing color. Anytime colors are involved, you can specify the tkinter color name such as 'lightblue' or an RGB hex value '#RRGGBB'. For buttons, the color parameter is a tuple (text color, background color) -#### Pad -The amount of room around the element in pixels. The default value is (5,3) which means leave 5 pixels on each side of the x-axis and 3 pixels on each side of the y-axis. You can change this on a global basis using a call to SetOptions, or on an element basis. +#### Pad +The amount of room around the element in pixels. The default value is (5,3) which means leave 5 pixels on each side of the x-axis and 3 pixels on each side of the y-axis. You can change this on a global basis using a call to SetOptions, or on an element basis. -If you want more pixels on one side than the other, then you can split the number into 2 number. If you want 200 pixels on the left side, and 3 pixels on the right, the pad would be ((200,3), 3). In this example, only the x-axis is split. +If you want more pixels on one side than the other, then you can split the number into 2 number. If you want 200 pixels on the left side, and 3 pixels on the right, the pad would be ((200,3), 3). In this example, only the x-axis is split. -#### Font -Specifies the font family, size, and style. Font families on Windows include: -* Arial -* Courier -* Comic, -* Fixedsys -* Times -* Verdana -* Helvetica (the default I think) +#### Font +Specifies the font family, size, and style. Font families on Windows include: +* Arial +* Courier +* Comic, +* Fixedsys +* Times +* Verdana +* Helvetica (the default I think) -The fonts will vary from system to system, however, Tk 8.0 automatically maps Courier, Helvetica and Times to their corresponding native family names on all platforms. Also, font families cannot cause a font specification to fail on Tk 8.0 and greater. +The fonts will vary from system to system, however, Tk 8.0 automatically maps Courier, Helvetica and Times to their corresponding native family names on all platforms. Also, font families cannot cause a font specification to fail on Tk 8.0 and greater. -If you wish to leave the font family set to the default, you can put anything not a font name as the family. The PySimpleGUI Demo programs and documentation use the family 'Any' to demonstrate this fact.. You could use "default" if that's more clear to you. +If you wish to leave the font family set to the default, you can put anything not a font name as the family. The PySimpleGUI Demo programs and documentation use the family 'Any' to demonstrate this fact.. You could use "default" if that's more clear to you. -There are 2 formats that can be used to specify a font... a string, and a tuple -Tuple - (family, size, styles) -String - "Family Size Styles" +There are 2 formats that can be used to specify a font... a string, and a tuple +Tuple - (family, size, styles) +String - "Family Size Styles" -To specify an underlined, Helvetica font with a size of 15 the values: -('Helvetica', 15, 'underline italics') -'Helvetica 15 underline italics' +To specify an underlined, Helvetica font with a size of 15 the values: +('Helvetica', 15, 'underline italics') +'Helvetica 15 underline italics' -#### Key +#### Key -If you are going to do anything beyond the basic stuff with your GUI, then you need to understand keys. -Keys are a way for you to "tag" an Element with a value that will be used to identify that element. After you put a key in an element's definition, the values returned from Read will use that key to tell you the value. For example, if you have an input field: +If you are going to do anything beyond the basic stuff with your GUI, then you need to understand keys. +Keys are a way for you to "tag" an Element with a value that will be used to identify that element. After you put a key in an element's definition, the values returned from Read will use that key to tell you the value. For example, if you have an input field: `Input(key='mykey')` And your read looks like this: `event, values = Read()` Then to get the input value from the read it would be: `values['mykey']` -You also use the same key if you want to call Update on an element. Please see the section below on Updates to understand that usage. +You also use the same key if you want to call Update on an element. Please see the section below on Updates to understand that usage. #### Visible Beginning in version 3.17 you can create Elements that are initially invisible that you can later make visible. -To create an invisible Element, place the element in the layout like you normally would and add the parameter `visible=False`. +To create an invisible Element, place the element in the layout like you normally would and add the parameter `visible=False`. Later when you want to make that Element visible you simply call the Element's `Update` method and pass in the parameter `visible=True` This feature works best on Qt, but does work on the tkinter version as well. The visible parameter can also be used with the Column and Frame "container" Elements. -### Output Elements -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: +### Output Elements +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] ] +layout = [ [row 1 element, row 1 element], + [row 2 element, row 2 element, row 2 element] ] ``` -The code is a crude representation of the GUI, laid out in text. +The code is a crude representation of the GUI, laid out in text. ## Shortcut Functions / Multiple Function Names Many of the main method calls and Element names have shortcuts. This enables you to code much quicker once you are used to using the SDK. The Text Element, for example, has 3 different names `Text`, `Txt` or`T`. InputText can also be written `Input` or `In` . `FindElement` was recently renamed to `Element` because it's a commonly used function. - -## Text Element +## Text Element ``` -layout = [[sg.Text('This is what a Text Element looks like')]] +layout = [[sg.Text('This is what a Text Element looks like')]] ``` -![simple text](https://user-images.githubusercontent.com/13696193/44959877-e9d97b00-aec3-11e8-9d24-b4405ee4a148.jpg) +![simple text](https://user-images.githubusercontent.com/13696193/44959877-e9d97b00-aec3-11e8-9d24-b4405ee4a148.jpg) -The most basic element is the Text element. It simply displays text. Many of the 'options' that can be set for a Text element are shared by other elements. - - - - +The most basic element is the Text element. It simply displays text. Many of the 'options' that can be set for a Text element are shared by other elements. ```python Text(text, - size=(None, None), + size=(None, None), auto_size_text=None, - click_submits=False, + click_submits=False, enable_events=False, relief=None, - font=None, - text_color=None, - background_color=None, - justification=None, - pad=None, - key=None, - right_click_menu=None, - tooltip=None, + font=None, + text_color=None, + background_color=None, + justification=None, + pad=None, + key=None, + right_click_menu=None, + tooltip=None, visible=True) ``` -Parameters explained: - -|Name|Meaning| -|-|-| -| text | | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| auto_size_text | True if size should fit the text length (Default value = None) | -| click_submits | (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| relief | (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| text_color | color of the text (Default value = None) | -| background_color | color of background (Default value = None) | -| justification | justification for data display (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + tooltip - string representing tooltip -Some commonly used elements have 'shorthand' versions of the functions to make the code more compact. The functions `T` and `Txt` are the same as calling `Text`. +Some commonly used elements have 'shorthand' versions of the functions to make the code more compact. The functions `T` and `Txt` are the same as calling `Text`. ### Fonts -Already discussed in the common parameters section. Either string or a tuple. +Already discussed in the common parameters section. Either string or a tuple. -### Color in PySimpleGUI are in one of two formats - color name or RGB value. +### Color in PySimpleGUI are in one of two formats - color name or RGB value. -Individual colors are specified using either the color names as defined in tkinter or an RGB string of this format: +Individual colors are specified using either the color names as defined in tkinter or an RGB string of this format: "#RRGGBB" or "darkblue" ### `auto_size_text ` -A `True` value for `auto_size_text`, when placed on Text Elements, indicates that the width of the Element should be shrunk do the width of the text. The default setting is True. +A `True` value for `auto_size_text`, when placed on Text Elements, indicates that the width of the Element should be shrunk do the width of the text. The default setting is True. -### Chortcut functions -The shorthand functions for `Text` are `Txt` and `T` +### Chortcut functions +The shorthand functions for `Text` are `Txt` and `T` ### Events `enable_events` -If you set the parameter `enable_events` or `click_submits` then you will get an event if the user clicks on the Text. +If you set the parameter `enable_events` or `click_submits` then you will get an event if the user clicks on the Text. -### Text Methods +### Text Methods -#### Update +#### Update If you want to change the text, font, or colors after the element has been created, then use the `Update` method. - - -```python -Update(value = None, background_color=None, text_color=None, font=None, visible=None) -``` +```python +Update(value = None, background_color=None, text_color=None, font=None, visible=None) +``` | name | meaning | | - | - | | value | new value to set text element to | @@ -1981,67 +1861,14 @@ Update(value = None, background_color=None, text_color=None, font=None, visible= | | | +## Multiline Text Element - -## Multiline Element +layout = [[sg.Multiline('This is what a Multi-line Text Element looks like', size=(45,5))]] -layout = [[sg.Multiline('This is what a Multi-line Text Element looks like', size=(45,5))]] +![multiline](https://user-images.githubusercontent.com/13696193/44959853-b139a180-aec3-11e8-972f-f52188510c88.jpg) -![multiline](https://user-images.githubusercontent.com/13696193/44959853-b139a180-aec3-11e8-972f-f52188510c88.jpg) +This Element doubles as both an input and output Element. -This Element doubles as both an input and output Element. - - - -```python -Multiline(default_text="", - enter_submits=False, - disabled=False, - autoscroll=False, - border_width=None, - size=(None, None), - auto_size_text=None, - background_color=None, - text_color=None, - change_submits=False, - enable_events=False, - do_not_clear=True, - key=None, - focus=False, - font=None, - pad=None, - tooltip=None, - right_click_menu=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| default_text | (Default value = '') | -| enter_submits | (Default value = False) | -| disabled | set disable state for element (Default value = False) | -| autoscroll | (Default value = False) | -| border_width | (Default value = None) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| auto_size_text | True if size should fit the text length (Default value = None) | -| background_color | color of background (Default value = None) | -| text_color | color of the text (Default value = None) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| do_not_clear | see docx (Default value = True) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| focus | if focus should be set to this (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - +||| ### Multiline Methods - - - - ```python Update(value=None, disabled=None, @@ -2086,7 +1909,7 @@ Update(value=None, text_color=None, background_color=None) -Update(self, value=None, disabled=None, append=False, font=None, text_color=None, background_color=None)value=None, disabled=None, append=False): +Update(self, value=None, disabled=None, append=False, font=None, text_color=None, background_color=None)value=None, disabled=None, append=False): ``` |name|meaning| |-|-| @@ -2094,52 +1917,19 @@ Update(self, value=None, disabled=None, append=False, font=None, text_color=None | disabled | set to True to disable the element| | append | rather than replacing the current text with new text, add the new text onto the end| ||| +## Output Element +Output re-routes `Stdout` to a scrolled text box. - -## Output Element -Output re-routes `Stdout` to a scrolled text box. - -Whatever you print will show up in this window. +Whatever you print will show up in this window. Note that you will NOT see what you print until you call either window.Read or window.Refresh. If you want to immediately see what was printed, call window.Refresh() immediately after your print statement. ```python -layout = [[sg.Output(size=(80,10)]] +layout = [[sg.Output(size=(80,10)]] ``` -![output](https://user-images.githubusercontent.com/13696193/44959863-b72f8280-aec3-11e8-8caa-7bc743149953.jpg) +![output](https://user-images.githubusercontent.com/13696193/44959863-b72f8280-aec3-11e8-8caa-7bc743149953.jpg) - - -```python -Output(size=(None, None), - background_color=None, - text_color=None, - pad=None, - font=None, - tooltip=None, - key=None, - right_click_menu=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| background_color | color of background (Default value = None) | -| text_color | color of the text (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - -## Input Elements -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 Shortcuts (Input, In) +## Input Elements +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 Shortcuts (Input, In) ```python -layout = [[sg.InputText('Default text')]] +layout = [[sg.InputText('Default text')]] ``` -![inputtext 2](https://user-images.githubusercontent.com/13696193/44959861-b5fe5580-aec3-11e8-8040-53ec241b5079.jpg) - -Shows a single line of input. +![inputtext 2](https://user-images.githubusercontent.com/13696193/44959861-b5fe5580-aec3-11e8-8040-53ec241b5079.jpg) ```python -InputText(default_text="", - size=(None, None), - disabled=False, - password_char="", - justification=None, - background_color=None, - text_color=None, - font=None, - tooltip=None, - change_submits=False, - enable_events=False, - do_not_clear=True, - key=None, - focus=False, - pad=None, - right_click_menu=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| default_text | (Default value = '') | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| disabled | set disable state for element (Default value = False) | -| password_char | Passwork character if this is a password field (Default value = '') | -| justification | justification for data display (Default value = None) | -| background_color | color of background (Default value = None) | -| text_color | color of the text (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| change_submits | If True, pressing Enter key submits window- DEPRICATED DO NOT USE! (Default value = False) | -| enable_events | Turns on the element specific events. Use this instead of change_submits (Default value = False) | -| do_not_clear | see docx (Default value = True) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| focus | if focus should be set to this (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - - - -There are two methods that can be called: +There are two methods that can be called: ``` -Input.Update(new_Value) - sets the input to new_value -Input.Get() - returns the current value of the field. +Input.Update(new_Value) - sets the input to new_value +Input.Get() - returns the current value of the field. ``` Shorthand functions that are equivalent to `InputText` are `Input` and `In` @@ -2282,75 +2022,28 @@ Get() | Get | Returns the current value for the element (you can get also from a call to Read) | ||| - -## Combo Element -Also known as a drop-down list. Only required parameter is the list of choices. The return value is a string matching what's visible on the GUI. +## Combo Element +Also known as a drop-down list. Only required parameter is the list of choices. The return value is a string matching what's visible on the GUI. + + layout = [[sg.InputCombo(['choice 1', 'choice 2'])]] + +![combobox](https://user-images.githubusercontent.com/13696193/44959860-b565bf00-aec3-11e8-82fe-dbe41252458b.jpg) -```python -layout = [[sg.InputCombo(['choice 1', 'choice 2'])]] ``` - -![combobox](https://user-images.githubusercontent.com/13696193/44959860-b565bf00-aec3-11e8-82fe-dbe41252458b.jpg) - - -ComboBox Element - -```python -Combo(values, - default_value=None, - size=(None, None), - auto_size_text=None, - background_color=None, - text_color=None, - change_submits=False, - enable_events=False, - disabled=False, - key=None, - pad=None, - tooltip=None, - readonly=False, - font=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| values | | -| default_value | (Default value = None) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| auto_size_text | True if size should fit the text length (Default value = None) | -| background_color | color of background (Default value = None) | -| text_color | color of the text (Default value = None) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| disabled | set disable state for element (Default value = False) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| readonly | make element readonly (Default value = False) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - -Shortcut functions - Combo, DropDown, Drop +Shortcut functions - Combo, DropDown, Drop -### Combo Methods -```python -Update(value=None, values=None, set_to_index=None, disabled=None, readonly=None) -``` -value - change which value is current selected -values - change list of choices -set_to_index - change selection to a particular choice -disable - if True will disable element +### Combo Methods +```python +Update(value=None, values=None, set_to_index=None, disabled=None, readonly=None) +``` +value - change which value is current selected +values - change list of choices +set_to_index - change selection to a particular choice +disable - if True will disable element readonly - if True will make element readonly + +## 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). - -## Listbox Element -The standard listbox like you'll find in most GUIs. Note that the return values from this element will be a ***list of results, not a single result***. This is because the user can select more than 1 item from the list (if you set the right mode). + layout = [[sg.Listbox(values=['Listbox 1', 'Listbox 2', 'Listbox 3'], size=(30, 6))]] -```python - layout = [[sg.Listbox(values=['Listbox 1', 'Listbox 2', 'Listbox 3'], size=(30, 6))]] -``` - -![listbox 2](https://user-images.githubusercontent.com/13696193/44959859-b4cd2880-aec3-11e8-881c-1e369d5c6337.jpg) +![listbox 2](https://user-images.githubusercontent.com/13696193/44959859-b4cd2880-aec3-11e8-881c-1e369d5c6337.jpg) -A List Box. Provide a list of values for the user to choose one or more of. Returns a list of selected rows -when a window.Read() is executed. - - - - -```python -Listbox(values, - default_values=None, - select_mode=None, - change_submits=False, - enable_events=False, - bind_return_key=False, - size=(None, None), - disabled=False, - auto_size_text=None, - font=None, - background_color=None, - text_color=None, - key=None, - pad=None, - tooltip=None, - right_click_menu=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| values | | -| default_values | (Default value = None) | -| select_mode | (Default value = None) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| bind_return_key | (Default value = False) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| disabled | set disable state for element (Default value = False) | -| auto_size_text | True if size should fit the text length (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| background_color | color of background (Default value = None) | -| text_color | color of the text (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - +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 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. -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 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. - -### Listbox Methods -```python -Update(values=None, disabled=None) -SetValue(values) -GetListValues() -``` +### Listbox Methods +```python +Update(values=None, disabled=None) +SetValue(values) +GetListValues() +``` |name|meaning| |-|-| @@ -2510,196 +2147,94 @@ GetListValues() | GetListValues | Return the list of values to choose from | ||| - -## Slider Element +## Slider Element -Sliders have a couple of slider-specific settings as well as appearance settings. Examples include the `orientation` and `range` settings. +Sliders have a couple of slider-specific settings as well as appearance settings. Examples include the `orientation` and `range` settings. - layout = [[sg.Slider(range=(1,500), default_value=222, size=(20,15), orientation='horizontal', font=('Helvetica', 12))]] + layout = [[sg.Slider(range=(1,500), default_value=222, size=(20,15), orientation='horizontal', font=('Helvetica', 12))]] -![slider](https://user-images.githubusercontent.com/13696193/44959858-b4349200-aec3-11e8-9e25-c0fcf025d19e.jpg) +![slider](https://user-images.githubusercontent.com/13696193/44959858-b4349200-aec3-11e8-9e25-c0fcf025d19e.jpg) - - - -```python -Slider(range=(None, None), - default_value=None, - resolution=None, - tick_interval=None, - orientation=None, - disable_number_display=False, - border_width=None, - relief=None, - change_submits=False, - enable_events=False, - disabled=False, - size=(None, None), - font=None, - background_color=None, - text_color=None, - key=None, - pad=None, - tooltip=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| range | (Default value = (None, None)) | -| default_value | (Default value = None) | -| resolution | (Default value = None) | -| tick_interval | (Default value = None) | -| orientation | (Default value = None) | -| disable_number_display | (Default value = False) | -| border_width | (Default value = None) | -| relief | (Default value = None) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| disabled | set disable state for element (Default value = False) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| background_color | color of background (Default value = None) | -| text_color | color of the text (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - +size - (width, height) of element in characters +disabled - Bool If True slider is disabled +auto_size_text - Bool. True if size should fit the text +background_color - color to use for the input field background +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 +tooltip - Tooltip to display when hovered over wlement ### Qt Sliders There is an important difference between Qt and tkinter sliders. On Qt, the slider values must be integer, not float. If you want your slider to go from 0.1 to 1.0, then make your slider go from 1 to 10 and divide by 10. It's an easy math thing to do and not a big deal. Just deal with it.... you're writing software after all. Presumably you know how to do these things. ;-) -### Slider Methods -```python - Update(self, value=None, range=(None, None), disabled=None, visible=None): +### Slider Methods +```python + Update(self, value=None, range=(None, None), disabled=None, visible=None): ``` -value - set current selection to value -range - change range of valid values -disabled - if True disables element +value - set current selection to value +range - change range of valid values +disabled - if True disables element - -## Radio Element +## Radio Button Element -Creates one radio button that is assigned to a group of radio buttons. Only 1 of the buttons in the group can be selected at any one time. +Creates one radio button that is assigned to a group of radio buttons. Only 1 of the buttons in the group can be selected at any one time. ```python layout = [ - [sg.Radio('My first Radio!', "RADIO1", default=True), - sg.Radio('My second radio!', "RADIO1")] + [sg.Radio('My first Radio!', "RADIO1", default=True), + sg.Radio('My second radio!', "RADIO1")] ] ``` -![radio](https://user-images.githubusercontent.com/13696193/44959857-b4349200-aec3-11e8-8e2d-e6a49ffbd0b6.jpg) +![radio](https://user-images.githubusercontent.com/13696193/44959857-b4349200-aec3-11e8-8e2d-e6a49ffbd0b6.jpg) -Radio Button Element - Used in a group of other Radio Elements to provide user with ability to select only -1 choice in a list of choices. - - - - -```python -Radio(text, - group_id, - default=False, - disabled=False, - size=(None, None), - auto_size_text=None, - background_color=None, - text_color=None, - font=None, - key=None, - pad=None, - tooltip=None, - change_submits=False, - enable_events=False, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| text | | -| group_id | | -| default | (Default value = False) | -| disabled | set disable state for element (Default value = False) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| auto_size_text | True if size should fit the text length (Default value = None) | -| background_color | color of background (Default value = None) | -| text_color | color of the text (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| visible | set visibility state of the element (Default value = True) | -||| - - - -### Radio Button Methods -```python -Update(value=None, disabled=None, visible=None) -``` + +### Radio Button Methods +```python +Update(value=None, disabled=None, visible=None) +``` |name|meaning| |-|-| @@ -2728,68 +2263,27 @@ Update(value=None, disabled=None, visible=None) | disabled | if True disables the element | ||| - -## Checkbox Element -Checkbox elements are like Radio Button elements. They return a bool indicating whether or not they are checked. +## Checkbox Element +Checkbox elements are like Radio Button elements. They return a bool indicating whether or not they are checked. - layout = [[sg.Checkbox('My first Checkbox!', default=True), sg.Checkbox('My second Checkbox!')]] + layout = [[sg.Checkbox('My first Checkbox!', default=True), sg.Checkbox('My second Checkbox!')]] -![checkbox](https://user-images.githubusercontent.com/13696193/44959906-6f5d2b00-aec4-11e8-9c8a-962c787f0286.jpg) +![checkbox](https://user-images.githubusercontent.com/13696193/44959906-6f5d2b00-aec4-11e8-9c8a-962c787f0286.jpg) - - -```python -Checkbox(text, - default=False, - size=(None, None), - auto_size_text=None, - font=None, - background_color=None, - text_color=None, - change_submits=False, - enable_events=False, - disabled=False, - key=None, - pad=None, - tooltip=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| text | | -| default | (Default value = False) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| auto_size_text | True if size should fit the text length (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| background_color | color of background (Default value = None) | -| text_color | color of the text (Default value = None) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| disabled | set disable state for element (Default value = False) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - -Shortcut functions - CBox, CB, Check +Shortcut functions - CBox, CB, Check -### Checkbox Methods -```python -Update(value=None, disabled=None, visible=None) -Get() +### Checkbox Methods +```python +Update(value=None, disabled=None, visible=None) +Get() ``` |name|meaning| @@ -2825,86 +2318,44 @@ Get() - -## Spin Element - -An up/down spinner control. The valid values are passed in as a list. - - layout = [[sg.Spin([i for i in range(1,11)], initial_value=1), sg.Text('Volume level')]] - -![spinner](https://user-images.githubusercontent.com/13696193/44959855-b1d23800-aec3-11e8-9f51-afb2109879da.jpg) - - - -```python -Spin(values, - initial_value=None, - disabled=False, - change_submits=False, - enable_events=False, - size=(None, None), - auto_size_text=None, - font=None, - background_color=None, - text_color=None, - key=None, - pad=None, - tooltip=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| values | | -| initial_value | (Default value = None) | -| disabled | set disable state for element (Default value = False) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| auto_size_text | True if size should fit the text length (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| background_color | color of background (Default value = None) | -| text_color | color of the text (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - +## Spin Element + +An up/down spinner control. The valid values are passed in as a list. + + layout = [[sg.Spin([i for i in range(1,11)], initial_value=1), sg.Text('Volume level')]] + +![spinner](https://user-images.githubusercontent.com/13696193/44959855-b1d23800-aec3-11e8-9f51-afb2109879da.jpg) + + Spin(values, + intiial_value=None, + disabled = False, + size=(None, None), + change_submits = False, + auto_size_text=None, + font=None, + background_color = None, + text_color = None, + key = None. + pad = None, + tooltip = None, + visible=True): + + + +Parameter definitions + + values - List of valid values + initial_value - String with initial value + size - (width, height) size of element in characters + auto_size_text - Bool. True if should size width to fit text + font - Font type and size for text display + disabled - Bool. If True element is disabled + background_color - color to use for the background + 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 + pad - padding around element in the window + tooltip - text to show when mouse hovered over element ### Qt Differences - `values` is a range! @@ -2913,55 +2364,19 @@ Note that Qt does not allow arbitrary spinner values. With PySimpleGUI-tkinter On Qt values is a tuple representing a range. On plain PySimpleGUI this value is a list of items. Make sure on the plain version you specify items as a list using [] and not a generator using (). - -### Spin Methods -```python -Update(value=None, values=None, disabled=None, visible=None) -``` -value - set the current value -values - set available choices -disabled - if True disables the element - - -## Image Element - -Images can be placed in your window provide they are in PNG, GIF, PPM/PGM format. JPGs cannot be shown because tkinter does not naively support JPGs. You can use the Python Imaging Library (PIL) package to convert your image to PNG prior to calling PySimpleGUI if your images are in JPG format. - - - - -```python -Image(filename=None, - data=None, - background_color=None, - size=(None, None), - pad=None, - key=None, - tooltip=None, - right_click_menu=None, - visible=True, - enable_events=False) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| filename | (Default value = None) | -| data | (Default value = None) | -| background_color | color of background (Default value = None) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -| enable_events | Turns on the element specific events.(Default value = False) | -||| - - - - + right_click_menu=None, + size_px=(None,None) + visible=True) +``` +Parameter definitions + + filename - file name if the image is in a file + data - if image is in RAM (PIL format?) + data_base64 - image in base64 format + background_color - Color of background + size - Size (Width, Height) of image in pixels + pad - Padding around Element in the window + key - Key used to find the element + tooltip - text to show when mouse if hovered over image + click_submits, enable_events - if True returns event when image is clicked + visible - if False will create image as hidden + size_px - size of image in pixels + ### `Update` Method - -Like other Elements, the Image Element has an `Update` method. Call Update if you want to change the image. - - def Update(self, filename=None, data=None, visible=None): - - -Choose **either** a filename or in-ram data image to use to replace current image + +Like other Elements, the Image Element has an `Update` method. Call Update if you want to change the image. + + def Update(self, filename=None, data=None, visible=None): + + +Choose **either** a filename or in-ram data image to use to replace current image ### `UpdateAnimation` Method for Animated GIFs @@ -3010,396 +2424,336 @@ Starting in version 3.23 you can specify an animated GIF as an image and can ani ```python UpdateAnimation(source, - time_between_frames=0) + time_between_frames=0) ``` `source` can be a filename ***or*** a base64 bytes variable (unlike other calls that split out the filename parameter and base64 parameter into 2 parameters. -`time_between_frames` is an optional parameter. It will keep track of the amount of time between frame changes for you to give you a smooth animation. With this parameter you can call the function as often as you want and it will advance to the next frame only after the correct amount of time has lapsed. +`time_between_frames` is an optional parameter. It will keep track of the amount of time between frame changes for you to give you a smooth animation. With this parameter you can call the function as often as you want and it will advance to the next frame only after the correct amount of time has lapsed. You can call the method without setting the `time_between_frames` value and it will show a frame and immediately move on to the next frame. This enables you to do the inter-frame timing. - - -## Button Element - + +## Button Element + **MAC USERS** - Macs suck when it comes to tkinter and button colors. It sucks so badly with colors that the `LookAndFeel` call is disabled. You cannot change button colors for Macs. You're stuck with the system default color if you are using the tkinter version of PySimpleGUI. The Qt version does not have this issue. - -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 -* File Browse -* Files Browse -* File SaveAs -* File Save -* Close window (normal button) -* Read window -* Realtime -* Calendar Chooser -* Color Chooser - - + +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 +* File Browse +* Files Browse +* File SaveAs +* File Save +* Close window (normal button) +* Read window +* Realtime +* Calendar Chooser +* Color Chooser + + Close window - Normal buttons like Submit, Cancel, Yes, No, do NOT close the window... they used to. Now to close a window you need to use a CloseButton / CButton. - -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. - -Calendar Chooser - Opens a graphical calendar to select a date. - -Color Chooser - Opens a color chooser dialog - -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 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. - + +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. + +Calendar Chooser - Opens a graphical calendar to select a date. + +Color Chooser - Opens a color chooser dialog + +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 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), normal Buttons which leave the windows open and CloseButtons that close the window when clicked. - -Sometimes there are multiple names for the same function. This is simply to make the job of the programmer quicker and easier. Or they are old names that are no longer used but kept around so that existing programs don't break. - -The 4 primary windows of PySimpleGUI buttons and their names are: - - 1. `Button`= `ReadButton` = `RButton` = `ReadFormButton` (old style... use Button instead) + +Sometimes there are multiple names for the same function. This is simply to make the job of the programmer quicker and easier. Or they are old names that are no longer used but kept around so that existing programs don't break. + +The 4 primary windows of PySimpleGUI buttons and their names are: + + 1. `Button`= `ReadButton` = `RButton` = `ReadFormButton` (old style... use Button instead) 2. `CloseButton` = `CButton` - 3. `RealtimeButton` + 3. `RealtimeButton` 4. `DummyButton` - -You will find the long-form names in the older programs. ReadButton for example. + +You will find the long-form names in the older programs. ReadButton for example. In Oct 2018, the definition of Button changed. Previously Button would CLOSE the window when clicked. It has been changed so the Button calls will leave the window open in exactly the same way as a ReadButton. They are the same calls now. To enables windows to be closed using buttons, a new button was added... `CloseButton` or `CButton`. - -The most basic Button element call to use is `Button` - - - -```python -Button(button_text="", - button_type=7, - target=(None, None), - tooltip=None, - file_types=(('ALL Files', '*.*'),), - initial_folder=None, - disabled=False, - change_submits=False, - enable_events=False, - image_filename=None, - image_data=None, - image_size=(None, None), - image_subsample=None, - border_width=None, - size=(None, None), - auto_size_button=None, - button_color=None, - font=None, - bind_return_key=False, - focus=False, - pad=None, - key=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| button_text | (Default value = '') | -| button_type | (Default value = BUTTON_TYPE_READ_FORM) | -| target | | -| tooltip | text, that will appear the you hover on (Default value = None) | -| file_types | (Default value = (("ALL Files", "*.*"),)) | -| initial_folder | (Default value = None) | -| disabled | set disable state for element (Default value = False) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| image_filename | (Default value = None) | -| image_data | (Default value = None) | -| image_size | (Default value = (None) | -| image_subsample | (Default value = None) | -| border_width | (Default value = None) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) | -| auto_size_button | (Default value = None) | -| button_color | (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| bind_return_key | (Default value = False) | -| focus | if focus should be set to this (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - -### Shortcut, Pre-defined Buttons -These Pre-made buttons are some of the most important elements of all because they are used so much. They all basically do the same thing, set the button text to match the function name and set the parameters to commonly used values. If you find yourself needing to create a custom button often because it's not on this list, please post a request on GitHub. . They include: - - OK - Ok - Submit - Cancel - Yes - No - Exit - Quit - Help - Save - SaveAs - FileBrowse - FilesBrowse - FileSaveAs - FolderBrowse + +The most basic Button element call to use is `Button` + + Button(button_text='' + button_type=BUTTON_TYPE_CLOSES_WIN + target=(None, None) + tooltip=None + file_types=(("ALL Files", "*.*"),) + initial_folder=None + disabled = False + image_filename=None + image_data=None + image_size=(None, None) + image_subsample=None + border_width=None + size=(None, None) + auto_size_button=None + button_color=None + default_value = None + font=None + bind_return_key=False + focus=False + pad=None + key=None, + visible=True): + +Parameters + + button_text - Text to be displayed on the button + button_type - You should NOT be setting this directly + target - key or (row,col) target for the button + tooltip - tooltip text for the button + file_types - the filetypes that will be used to match files + initial_folder - starting path for folders and files + disabled = Bool If True button is disabled + image_filename - image filename if there is a button image + image_data - in-RAM image to be displayed on button + image_size - size of button image in pixels + image_subsample - amount to reduce the size of the image + border_width - width of border around button in pixels + size - size in characters + auto_size_button - True if button size is determined by button text + button_color - (text color, backound color) + default_value - initial value for buttons that hold information + font - font to use for button text + bind_return_key - If True the return key will cause this button to fire + focus - if focus should be set to this button + pad - (x,y) padding in pixels for packing the button + key - key used for finding the element + +### Shortcut, Pre-defined Buttons +These Pre-made buttons are some of the most important elements of all because they are used so much. They all basically do the same thing, set the button text to match the function name and set the parameters to commonly used values. If you find yourself needing to create a custom button often because it's not on this list, please post a request on GitHub. . They include: + + OK + Ok + Submit + Cancel + Yes + No + Exit + Quit + Help + Save + SaveAs + FileBrowse + FilesBrowse + FileSaveAs + FolderBrowse **IMPORT NOTE ABOUT SHORTCUT BUTTONS** Prior to release 3.11.0, these buttons closed the window. Starting with 3.11 they will not close the window. They act like RButtons (return the button text and do not close the window) -If you are having trouble with these buttons closing your window, please check your installed version of PySimpleGUI by typing `pip list` at a command prompt. Prior to 3.11 these buttons close your window. +If you are having trouble with these buttons closing your window, please check your installed version of PySimpleGUI by typing `pip list` at a command prompt. Prior to 3.11 these buttons close your window. Using older versions, if you want a Submit() button that does not close the window, then you would instead use RButton('Submit'). Using the new version, if you want a Submit button that closes the window like the sold Submit() call did, you would write that as `CloseButton('Submit')` or `CButton('Submit')` - layout = [[sg.OK(), sg.Cancel()]] - -![ok cancel 3](https://user-images.githubusercontent.com/13696193/44959927-aa5f5e80-aec4-11e8-86e1-5dc0b3a2b803.jpg) + layout = [[sg.OK(), sg.Cancel()]] + +![ok cancel 3](https://user-images.githubusercontent.com/13696193/44959927-aa5f5e80-aec4-11e8-86e1-5dc0b3a2b803.jpg) + - -### Button targets - -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 -2. (row, column) - -Targets that are specified using a key will find its target element by using the target's key value. This is the "preferred" method. - -If the Target is specified using (row, column) then it utilizes a grid system. The rows in your GUI are numbered starting with 0. The target can be specified as a hard coded grid item or it can be relative to the button. - -The (row, col) targeting can only target elements that are in the same "container". Containers are the Window, Column and Frame Elements. A File Browse button located inside of a Column is unable to target elements outside of that Column. - -The default value for `target` is `(ThisRow, -1)`. `ThisRow` is a special value that tells the GUI to use the same row as the button. The Y-value of -1 means the field one value to the left of the button. For a File or Folder Browse button, the field that it fills are generally to the left of the button is most cases. (ThisRow, -1) means the Element to the left of the button, on the same row. - -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 window as an example: - - -![file browse](https://user-images.githubusercontent.com/13696193/44959944-d1b62b80-aec4-11e8-8a68-9d79d37b2c81.jpg) - - -The `InputText` element is located at (1,0)... row 1, column 0. The `Browse` button is located at position (2,0). The Target for the button could be any of these values: - - Target = (1,0) - Target = (-1,0) - -The code for the entire window could be: - - layout = [[sg.T('Source Folder')], - [sg.In()], - [sg.FolderBrowse(target=(-1, 0)), sg.OK()]] - -or if using keys, then the code would be: - - layout = [[sg.T('Source Folder')], - [sg.In(key='input')], - [sg.FolderBrowse(target='input'), sg.OK()]] - -See how much easier the key method is? - -**Save & Open Buttons** - -There are 4 different types of File/Folder open dialog box available. If you are looking for a file to open, the `FileBrowse` is what you want. If you want to save a file, `SaveAs` is the button. If you want to get a folder name, then `FolderBrowse` is the button to use. To open several files at once, use the `FilesBrowse` button. It will create a list of files that are separated by ';' - - -![open](https://user-images.githubusercontent.com/13696193/45243804-2b529780-b2c3-11e8-90dc-6c9061db2a1e.jpg) - - -![folder](https://user-images.githubusercontent.com/13696193/45243805-2b529780-b2c3-11e8-95ee-fec3c0b11319.jpg) - - -![saveas](https://user-images.githubusercontent.com/13696193/45243807-2beb2e00-b2c3-11e8-8549-ba71cdc05951.jpg) - - - -**Calendar Buttons** - -These buttons pop up a calendar chooser window. The chosen date is returned as a string. - -![calendar](https://user-images.githubusercontent.com/13696193/45243374-99965a80-b2c1-11e8-8311-49777835ca40.jpg) - -**Color Chooser Buttons** - -These buttons pop up a standard color chooser window. The result is returned as a tuple. One of the returned values is an RGB hex representation. - -![color](https://user-images.githubusercontent.com/13696193/45243375-99965a80-b2c1-11e8-9779-b71bed85fab6.jpg) - - -**Custom Buttons** -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 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. - +### Button targets + +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 +2. (row, column) + +Targets that are specified using a key will find its target element by using the target's key value. This is the "preferred" method. + +If the Target is specified using (row, column) then it utilizes a grid system. The rows in your GUI are numbered starting with 0. The target can be specified as a hard coded grid item or it can be relative to the button. + +The (row, col) targeting can only target elements that are in the same "container". Containers are the Window, Column and Frame Elements. A File Browse button located inside of a Column is unable to target elements outside of that Column. + +The default value for `target` is `(ThisRow, -1)`. `ThisRow` is a special value that tells the GUI to use the same row as the button. The Y-value of -1 means the field one value to the left of the button. For a File or Folder Browse button, the field that it fills are generally to the left of the button is most cases. (ThisRow, -1) means the Element to the left of the button, on the same row. + +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 window as an example: + + +![file browse](https://user-images.githubusercontent.com/13696193/44959944-d1b62b80-aec4-11e8-8a68-9d79d37b2c81.jpg) + + +The `InputText` element is located at (1,0)... row 1, column 0. The `Browse` button is located at position (2,0). The Target for the button could be any of these values: + + Target = (1,0) + Target = (-1,0) + +The code for the entire window could be: + + layout = [[sg.T('Source Folder')], + [sg.In()], + [sg.FolderBrowse(target=(-1, 0)), sg.OK()]] + +or if using keys, then the code would be: + + layout = [[sg.T('Source Folder')], + [sg.In(key='input')], + [sg.FolderBrowse(target='input'), sg.OK()]] + +See how much easier the key method is? + +**Save & Open Buttons** + +There are 4 different types of File/Folder open dialog box available. If you are looking for a file to open, the `FileBrowse` is what you want. If you want to save a file, `SaveAs` is the button. If you want to get a folder name, then `FolderBrowse` is the button to use. To open several files at once, use the `FilesBrowse` button. It will create a list of files that are separated by ';' + + +![open](https://user-images.githubusercontent.com/13696193/45243804-2b529780-b2c3-11e8-90dc-6c9061db2a1e.jpg) + + +![folder](https://user-images.githubusercontent.com/13696193/45243805-2b529780-b2c3-11e8-95ee-fec3c0b11319.jpg) + + +![saveas](https://user-images.githubusercontent.com/13696193/45243807-2beb2e00-b2c3-11e8-8549-ba71cdc05951.jpg) + + + +**Calendar Buttons** + +These buttons pop up a calendar chooser window. The chosen date is returned as a string. + +![calendar](https://user-images.githubusercontent.com/13696193/45243374-99965a80-b2c1-11e8-8311-49777835ca40.jpg) + +**Color Chooser Buttons** + +These buttons pop up a standard color chooser window. The result is returned as a tuple. One of the returned values is an RGB hex representation. + +![color](https://user-images.githubusercontent.com/13696193/45243375-99965a80-b2c1-11e8-9779-b71bed85fab6.jpg) + + +**Custom Buttons** +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 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. + Your button images need to be in PNG or GIF format. When you make a button with an image, set the button background to the same color as the background. There's a button color TRANSPARENT_BUTTON that you can set your button color to in order for it to blend into the background. Note that this value is currently the same as the color as the default system background on Windows. If you want to set the button background color to the current system default, use the value COLOR_SYSTEM_DEFAULT as the background color. - -This example comes from the `Demo Media Player.py` example program. Because it's a non-blocking button, it's defined as `RButton`. You also put images on blocking buttons by using `Button`. - - - sg.RButton('Restart Song', button_color=sg.TRANSPARENT_BUTTON, - image_filename=image_restart, image_size=(50, 50), image_subsample=2, border_width=0) - -Three parameters are used for button images. - - image_filename - Filename. Can be a relative path - 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 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 window + +This example comes from the `Demo Media Player.py` example program. Because it's a non-blocking button, it's defined as `RButton`. You also put images on blocking buttons by using `Button`. + + + sg.RButton('Restart Song', button_color=sg.TRANSPARENT_BUTTON, + image_filename=image_restart, image_size=(50, 50), image_subsample=2, border_width=0) + +Three parameters are used for button images. + + image_filename - Filename. Can be a relative path + 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 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 window ```python - sg.RButton('Pause', button_color=sg.TRANSPARENT_BUTTON, - image_filename=image_pause, - image_size=(50, 50), - image_subsample=2, - border_width=0) + sg.RButton('Pause', button_color=sg.TRANSPARENT_BUTTON, + image_filename=image_pause, + image_size=(50, 50), + image_subsample=2, + border_width=0) ``` -This is one you'll have to experiment with at this point. Not up for an exhaustive explanation. - - **Realtime Buttons** - - Normally buttons are considered "clicked" when the mouse button is let UP after a downward click on the button. What about times when you need to read the raw up/down button values. A classic example for this is a robotic remote control. Building a remote control using a GUI is easy enough. One button for each of the directions is a start. Perhaps something like this: - -![robot remote](https://user-images.githubusercontent.com/13696193/44959958-ff9b7000-aec4-11e8-99ea-7450926409be.jpg) - - -This window has 2 button types. There's the normal "Read Button" (Quit) and 4 "Realtime Buttons". - -Here is the code to make, show and get results from this window: +This is one you'll have to experiment with at this point. Not up for an exhaustive explanation. + + **Realtime Buttons** + + Normally buttons are considered "clicked" when the mouse button is let UP after a downward click on the button. What about times when you need to read the raw up/down button values. A classic example for this is a robotic remote control. Building a remote control using a GUI is easy enough. One button for each of the directions is a start. Perhaps something like this: + +![robot remote](https://user-images.githubusercontent.com/13696193/44959958-ff9b7000-aec4-11e8-99ea-7450926409be.jpg) + + +This window has 2 button types. There's the normal "Read Button" (Quit) and 4 "Realtime Buttons". + +Here is the code to make, show and get results from this window: ```python -import PySimpleGUI as sg - -gui_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')], - [sg.T('')], - [sg.Quit(button_color=('black', 'orange'))] - ] - -window = sg.Window('Robotics Remote Control', auto_size_text=True).Layout(gui_rows) - -# -# Some place later in your code... -# You need to perform a Read or Refresh call on your window every now and then or -# else it will apprear as if the program has locked up. -# -# your program's main loop -while (True): - # This is the code that reads and updates your window - event, values = window.Read(timeout=0) - if event is not None: - print(event) - if event == 'Quit' or values is None: - break - +import PySimpleGUI as sg + +gui_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')], + [sg.T('')], + [sg.Quit(button_color=('black', 'orange'))] + ] + +window = sg.Window('Robotics Remote Control', auto_size_text=True).Layout(gui_rows) + +# +# Some place later in your code... +# You need to perform a Read or Refresh call on your window every now and then or +# else it will apprear as if the program has locked up. +# +# your program's main loop +while (True): + # This is the code that reads and updates your window + event, values = window.Read(timeout=0) + if event is not None: + print(event) + if event == 'Quit' or values is None: + break + window.Close() # Don't forget to close your window! ``` -This loop will read button values and print them. When one of the Realtime buttons is clicked, the call to `window.Read` will return a button name matching the name on the button that was depressed or the key if there was a key assigned to the button. It will continue to return values as long as the button remains depressed. Once released, the Read will return timeout events 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 window where the Browse button only shows files of type .TXT - - layout = [[sg.In() ,sg.FileBrowse(file_types=(("Text Files", "*.txt"),))]] - +This loop will read button values and print them. When one of the Realtime buttons is clicked, the call to `window.Read` will return a button name matching the name on the button that was depressed or the key if there was a key assigned to the button. It will continue to return values as long as the button remains depressed. Once released, the Read will return timeout events 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 window where the Browse button only shows files of type .TXT + + layout = [[sg.In() ,sg.FileBrowse(file_types=(("Text Files", "*.txt"),))]] + NOTE - Mac users will not be able to use the file_types parameter. tkinter has a bug on Macs that will crash the program is a file_type is attempted so that feature had to be removed. Sorry about that! - ***The ENTER key*** - 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 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. - - -### Button Methods -```python + ***The ENTER key*** + 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 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. + + +### Button Methods +```python Update(text=None, button_color=(None, None), disabled=None, image_data=None, image_filename=None, visible=None) -GetText() -``` -Update - Change the button element - - text - sets button text - button color - (text, background) - disabled - if True disables the button - image_data - sets button image to in-ram image - image_filename - sets button image using a file +GetText() +``` +Update - Change the button element + text - sets button text + button color - (text, background) + disabled - if True disables the button + image_data - sets button image to in-ram image + image_filename - sets button image using a file + GetText - Returns the current text shown on a button - ## ButtonMenu Element The ButtonMenu element produces a unique kind of effect. It's a button, that when clicked, shows you a menu. It's like clicking one of the top-level menu items on a MenuBar. As a result, the menu definition take the format of a single menu entry from a normal menu definition. A normal menu definition is a list of lists. This definition is one of those lists. @@ -3411,73 +2765,25 @@ Here is a sample definition: The very first string normally specifies what is shown on the menu bar. In this case, the value is **not used**. You set the text for the button using a different parameter, the `button_text` parm. - - -```python -ButtonMenu(button_text, - menu_def, - tooltip=None, - disabled=False, - image_filename=None, - image_data=None, - image_size=(None, None), - image_subsample=None, - border_width=None, - size=(None, None), - auto_size_button=None, - button_color=None, - font=None, - pad=None, - key=None, - tearoff=False, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| button_text | | -| menu_def | | -| tooltip | text, that will appear the you hover on (Default value = None) | -| disabled | set disable state for element (Default value = False) | -| image_filename | (Default value = None) | -| image_data | (Default value = None) | -| image_size | (Default value = (None, None)) | -| image_subsample | (Default value = None) | -| border_width | (Default value = None) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None) | -| auto_size_button | (Default value = None) | -| button_color | (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| tearoff | (Default value = False) | -| visible | set visibility state of the element (Default value = True) | -||| - - - One use of this element is to make a "fake menu bar" that has a colored background. Normal menu bars cannot have their background color changed. Not so with ButtonMenus. @@ -3491,544 +2797,366 @@ Return values for ButtonMenus are sent via the return values dictionary. If a s - -## VerticalSeparator Element +## Vertical Separator Element This element has limited usefulness and is being included more for completeness than anything else. It will draw a line between elements. - ```python VerticalSeparator(pad=None) ``` - + ![snag-0129](https://user-images.githubusercontent.com/13696193/47376041-a92a0100-d6bf-11e8-8f5b-0c0df56cf0f3.jpg) - + It works best when placed between columns or elements that span multiple rows. If on a "normal" row with elements that are only 1 row high, then it will only span that one row. - -## ProgressBar Element -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. - - sg.OneLineProgressMeter('My Meter', i+1, 1000, 'key', 'Optional message') - -The return value for `OneLineProgressMeter` is: -`True` if meter updated correctly -`False` if user clicked the Cancel button, closed the window, or vale reached the max value. - -#### 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 window - layout = [[sg.Text('A custom progress meter')], - [sg.ProgressBar(10000, orientation='h', size=(20, 20), key='progressbar')], - [sg.Cancel()]] - - # 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 - event, values = window.Read(timeout=0) - if event == 'Cancel' or event is 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 - window.Close()) - - -#### Output -The Output Element is a re-direction of Stdout. Anything "printed" will be displayed in this element. - - Output(size=(None, None)) - -Here's a complete solution for a chat-window using an Async window with an Output Element - - import PySimpleGUI as sg - - # 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))], - [sg.Multiline(size=(70, 5), enter_submits=True), - sg.RButton('SEND', button_color=(sg.YELLOWS[0], sg.BLUES[0])), - sg.Button('EXIT', button_color=(sg.YELLOWS[0], sg.GREENS[0]))]] - - 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: - event, value = window.Read() - if event == 'SEND': - print(value) - else: - break - - ChatBot() - -### ProgressBar Methods +## ProgressBar Element +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. + + sg.OneLineProgressMeter('My Meter', i+1, 1000, 'key', 'Optional message') + +The return value for `OneLineProgressMeter` is: +`True` if meter updated correctly +`False` if user clicked the Cancel button, closed the window, or vale reached the max value. + +#### 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 window + layout = [[sg.Text('A custom progress meter')], + [sg.ProgressBar(10000, orientation='h', size=(20, 20), key='progressbar')], + [sg.Cancel()]] + + # 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 + event, values = window.Read(timeout=0) + if event == 'Cancel' or event is 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 + window.Close()) + + +#### Output +The Output Element is a re-direction of Stdout. Anything "printed" will be displayed in this element. + + Output(size=(None, None)) + +Here's a complete solution for a chat-window using an Async window with an Output Element + + import PySimpleGUI as sg + + # 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))], + [sg.Multiline(size=(70, 5), enter_submits=True), + sg.RButton('SEND', button_color=(sg.YELLOWS[0], sg.BLUES[0])), + sg.Button('EXIT', button_color=(sg.YELLOWS[0], sg.GREENS[0]))]] + + 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: + event, value = window.Read() + if event == 'SEND': + print(value) + else: + break + + ChatBot() + +### ProgressBar Methods +```python +UpdateBar(current_count, max=None) +``` +current_count - sets the current value +max - changes the max value + + +## Column Element +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 window is, as a list of lists. + ```python -UpdateBar(current_count, max=None) -``` -current_count - sets the current value -max - changes the max value - - - -## Column Element -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 window is, as a list of lists. - - - -```python -Column(layout, - background_color=None, - size=(None, None), - pad=None, - scrollable=False, - vertical_scroll_only=False, - right_click_menu=None, - key=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| layout | | -| background_color | color of background (Default value = None) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| scrollable | (Default value = False) | -| vertical_scroll_only | (Default value = False) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - - - - -Columns are needed when you have an element that has a height > 1 line on the left, with single-line elements on the right. Here's an example of this kind of layout: - - -![column](https://user-images.githubusercontent.com/13696193/44959988-66b92480-aec5-11e8-9c26-316ed24a68c0.jpg) - - -This code produced the above window. - - - import PySimpleGUI as sg - - # Demo of how columns work - # 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 window layouts, they are a list of lists of elements. - - window = sg.Window('Columns') # blank window - - # Column layout - col = [[sg.Text('col Row 1')], - [sg.Text('col Row 2'), sg.Input('col input 1')], - [sg.Text('col Row 3'), sg.Input('col input 2')], - [sg.Text('col Row 4'), sg.Input('col input 3')], - [sg.Text('col Row 5'), sg.Input('col input 4')], - [sg.Text('col Row 6'), sg.Input('col input 5')], - [sg.Text('col Row 7'), sg.Input('col input 6')]] - - layout = [[sg.Slider(range=(1,100), default_value=10, orientation='v', size=(8,20)), sg.Column(col)], - [sg.In('Last input')], - [sg.OK()]] - - # 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 window display and read down to a single line of code. - event, values = sg.Window('Compact 1-line window with column').Layout(layout).Read() - - sg.Popup(event, 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 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 window, the column background will match the window background automatically. - - - ----- -## Frame Element (Labelled Frames, Frames with a title) - -Frames work exactly the same way as Columns. You create layout that is then used to initialize the Frame. +``` + + + +Columns are needed when you have an element that has a height > 1 line on the left, with single-line elements on the right. Here's an example of this kind of layout: + + +![column](https://user-images.githubusercontent.com/13696193/44959988-66b92480-aec5-11e8-9c26-316ed24a68c0.jpg) + + +This code produced the above window. + + + import PySimpleGUI as sg + + # Demo of how columns work + # 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 window layouts, they are a list of lists of elements. + + window = sg.Window('Columns') # blank window + + # Column layout + col = [[sg.Text('col Row 1')], + [sg.Text('col Row 2'), sg.Input('col input 1')], + [sg.Text('col Row 3'), sg.Input('col input 2')], + [sg.Text('col Row 4'), sg.Input('col input 3')], + [sg.Text('col Row 5'), sg.Input('col input 4')], + [sg.Text('col Row 6'), sg.Input('col input 5')], + [sg.Text('col Row 7'), sg.Input('col input 6')]] + + layout = [[sg.Slider(range=(1,100), default_value=10, orientation='v', size=(8,20)), sg.Column(col)], + [sg.In('Last input')], + [sg.OK()]] + + # 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 window display and read down to a single line of code. + event, values = sg.Window('Compact 1-line window with column').Layout(layout).Read() + + sg.Popup(event, 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 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 window, the column background will match the window background automatically. + + + +---- +## Frame Element (Labelled Frames, Frames with a title) + +Frames work exactly the same way as Columns. You create layout that is then used to initialize the Frame. ```python -Frame( title, - layout, - title_color=None, - background_color=None, +Frame( title, + layout, + title_color=None, + background_color=None, title_location=None, - relief=DEFAULT_FRAME_RELIEF, - size=(None, None), + relief=DEFAULT_FRAME_RELIEF, + size=(None, None), font=None, - pad=None, + pad=None, border_width=None, - key=None, - tooltip=None, - right_click_menu=None, + key=None, + tooltip=None, + right_click_menu=None, visible=True) -``` - def Frame(title - the label / title to put on frame - layout - list of rows of elements the frame contains - title_color - color of the title text - background_color - color of background - title_location - locations to put the title - relief - type of relief to use - size - size of Frame in characters. Do not use if you want frame to autosize - font - font to use for title - pad - element padding to use when packing - border_width - how thick the line going around frame should be - key - key used to location the element - tooltip - tooltip text - - - -This code creates a window with a Frame and 2 buttons. - - frame_layout = [ - [sg.T('Text inside of a frame')], - [sg.CB('Check 1'), sg.CB('Check 2')], - ] - layout = [ - [sg.Frame('My Frame Title', frame_layout, font='Any 12', title_color='blue')], - [sg.Submit(), sg.Cancel()] - ] - - 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 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. - - -## Canvas Element - - - - +``` + def Frame(title - the label / title to put on frame + layout - list of rows of elements the frame contains + title_color - color of the title text + background_color - color of background + title_location - locations to put the title + relief - type of relief to use + size - size of Frame in characters. Do not use if you want frame to autosize + font - font to use for title + pad - element padding to use when packing + border_width - how thick the line going around frame should be + key - key used to location the element + tooltip - tooltip text + + + +This code creates a window with a Frame and 2 buttons. + + frame_layout = [ + [sg.T('Text inside of a frame')], + [sg.CB('Check 1'), sg.CB('Check 2')], + ] + layout = [ + [sg.Frame('My Frame Title', frame_layout, font='Any 12', title_color='blue')], + [sg.Submit(), sg.Cancel()] + ] + + 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 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. + +## Canvas Element + ```python Canvas(canvas=None, - background_color=None, - size=(None, None), - pad=None, - key=None, - tooltip=None, - right_click_menu=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| canvas | (Default value = None) | -| background_color | color of background (Default value = None) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - -In my opinion, the tkinter Canvas Widget is the most powerful of the tkinter widget. While I try my best to completely isolate the user from anything that is tkinter related, the Canvas Element is the one exception. It enables integration with a number of other packages, often with spectacular results. - -### Matplotlib, Pyplot Integration - -One such integration is with Matploplib and Pyplot. There is a Demo program written that you can use as a design pattern to get an understanding of how to use the Canvas Widget once you get it. - - def Canvas(canvas - a tkinter canvasf if you created one. Normally not set - background_color - canvas color - size - size in pixels - pad - element padding for packing - key - key used to lookup element - tooltip - tooltip text - -The order of operations to obtain a tkinter Canvas Widget is: - - figure_x, figure_y, figure_w, figure_h = fig.bbox.bounds - # 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 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(window.FindElement('canvas').TKCanvas, fig) - - # show it all again and get buttons - event, values = window.Read() - -To get a tkinter Canvas Widget from PySimpleGUI, follow these steps: -* 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 `window.Read()` - Nothing will appear on your canvas until you call Read - -See `Demo_Matplotlib.py` for a Recipe you can copy. - - -### Canvas Methods - -TKCanvas - not a method but a property. Returns the tkinter Canvas Widget - - - - -## Graph Element - -All you math fans will enjoy this Element... and all you non-math fans will enjoy it too. - -I've found nothing to be less fun than dealing with a graphic's coordinate system from a GUI Framework. It's always upside down from what I want. (0,0) is in the upper left hand corner. In short, it's a **pain in the ass**. - -Graph Element to the rescue. A Graph Element creates a pixel addressable canvas using YOUR coordinate system. *You* get to define the units on the X and Y axis. - -There are 3 values you'll need to supply the Graph Element. They are: -* Size of the canvas in pixels -* The lower left (x,y) coordinate of your coordinate system -* The upper right (x,y) coordinate of your coordinate system - -After you supply those values you can scribble all of over your graph by creating Graph Figures. Graph Figures are created, and a Figure ID is obtained by calling: -* DrawCircle -* DrawLine -* DrawPoint -* DrawRectangle -* DrawOval +In my opinion, the tkinter Canvas Widget is the most powerful of the tkinter widget. While I try my best to completely isolate the user from anything that is tkinter related, the Canvas Element is the one exception. It enables integration with a number of other packages, often with spectacular results. + +### Matplotlib, Pyplot Integration + +One such integration is with Matploplib and Pyplot. There is a Demo program written that you can use as a design pattern to get an understanding of how to use the Canvas Widget once you get it. + + def Canvas(canvas - a tkinter canvasf if you created one. Normally not set + background_color - canvas color + size - size in pixels + pad - element padding for packing + key - key used to lookup element + tooltip - tooltip text + +The order of operations to obtain a tkinter Canvas Widget is: + + figure_x, figure_y, figure_w, figure_h = fig.bbox.bounds + # 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 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(window.FindElement('canvas').TKCanvas, fig) + + # show it all again and get buttons + event, values = window.Read() + +To get a tkinter Canvas Widget from PySimpleGUI, follow these steps: +* 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 `window.Read()` - Nothing will appear on your canvas until you call Read + +See `Demo_Matplotlib.py` for a Recipe you can copy. + + +### Canvas Methods + +TKCanvas - not a method but a property. Returns the tkinter Canvas Widget + + + +## Graph Element + +All you math fans will enjoy this Element... and all you non-math fans will enjoy it too. + +I've found nothing to be less fun than dealing with a graphic's coordinate system from a GUI Framework. It's always upside down from what I want. (0,0) is in the upper left hand corner. In short, it's a **pain in the ass**. + +Graph Element to the rescue. A Graph Element creates a pixel addressable canvas using YOUR coordinate system. *You* get to define the units on the X and Y axis. + +There are 3 values you'll need to supply the Graph Element. They are: +* Size of the canvas in pixels +* The lower left (x,y) coordinate of your coordinate system +* The upper right (x,y) coordinate of your coordinate system + +After you supply those values you can scribble all of over your graph by creating Graph Figures. Graph Figures are created, and a Figure ID is obtained by calling: +* DrawCircle +* DrawLine +* DrawPoint +* DrawRectangle +* DrawOval * DrawImage - -You can move your figures around on the canvas by supplying the Figure ID the x,y amount to move. - - graph.MoveFigure(my_circle, 10, 10) - -This Element is relatively new and may have some parameter additions or deletions. It shouldn't break your code however. - - - - + +You can move your figures around on the canvas by supplying the Figure ID the x,y amount to move. + + graph.MoveFigure(my_circle, 10, 10) + +This Element is relatively new and may have some parameter additions or deletions. It shouldn't break your code however. + ```python -Graph(canvas_size, - graph_bottom_left, - graph_top_right, - background_color=None, - pad=None, - change_submits=False, - drag_submits=False, - enable_events=False, - key=None, - tooltip=None, - right_click_menu=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| canvas_size | | -| graph_bottom_left | | -| graph_top_right | | -| background_color | color of background (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| drag_submits | (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - - - -### Graph Methods -```python -DrawLine(self, point_from, point_to, color='black', width=1) -DrawPoint(self, point, size=2, color='black') -DrawCircle(self, center_location, radius, fill_color=None, line_color='black') -DrawOval(self, top_left, bottom_right, fill_color=None, line_color=None) -DrawArc(self, top_left, bottom_right, extent, start_angle, style=None, arc_color='black') -DrawRectangle(self, top_left, bottom_right, fill_color=None, line_color=None) -DrawText(self, text, location, color='black', font=None, angle=0) -Erase(background_color) +``` + +### Graph Methods +```python +DrawLine(self, point_from, point_to, color='black', width=1) +DrawPoint(self, point, size=2, color='black') +DrawCircle(self, center_location, radius, fill_color=None, line_color='black') +DrawOval(self, top_left, bottom_right, fill_color=None, line_color=None) +DrawArc(self, top_left, bottom_right, extent, start_angle, style=None, arc_color='black') +DrawRectangle(self, top_left, bottom_right, fill_color=None, line_color=None) +DrawText(self, text, location, color='black', font=None, angle=0) +Erase(background_color) DeleteFigure(figure_id) -Update() -Move(self, x_direction, y_direction) -MoveFigure(self, figure, x_direction, y_direction) -RelocateFigure(self, figure, x, y) -TKCanvas -``` -All of the Drawing methods return a "***figure***" that can be used move and delete the figure - -DrawLine - draws a line -DrawPoint - draws a single point -DrawCircle - draws a circle -DrawOval - draws an oval -DrawArc - draws an arc -DrawRectangle - draws a rectangle -DrawText - draws text +Update() +Move(self, x_direction, y_direction) +MoveFigure(self, figure, x_direction, y_direction) +RelocateFigure(self, figure, x, y) +TKCanvas +``` +All of the Drawing methods return a "***figure***" that can be used move and delete the figure + +DrawLine - draws a line +DrawPoint - draws a single point +DrawCircle - draws a circle +DrawOval - draws an oval +DrawArc - draws an arc +DrawRectangle - draws a rectangle +DrawText - draws text DrawImage - places an image onto the graph -Erase - erases entire graph -Update - changes background color -Move - moves everything an x,y direction +Erase - erases entire graph +Update - changes background color +Move - moves everything an x,y direction MoveFigure - moves an individual figure by some delta -RelocateFigure - moves figure to an absolute location +RelocateFigure - moves figure to an absolute location DeleteFigure - delete an individual figure - - - -## Table Element - + + +## Table Element + Out of all of the Elements, it's the Table and the Tree that are the most "problematic" in the tkinter inter and Qt implementations. They're hard is my only defense. ### Known visualization problem.... If you click on the header, it can go into spasms for some tables. I don't understand what's causing it and it's been there evidently since the first release of Tables. - - - - + ```python -Table(values, - headings=None, - visible_column_map=None, - col_widths=None, - def_col_width=10, - auto_size_columns=True, - max_col_width=20, - select_mode=None, - display_row_numbers=False, - num_rows=None, - row_height=None, - font=None, - justification="right", - text_color=None, - background_color=None, - alternating_row_color=None, - row_colors=None, - vertical_scroll_only=True, - hide_vertical_scroll=False, - size=(None, None), - change_submits=False, - enable_events=False, - bind_return_key=False, - pad=None, - key=None, - tooltip=None, - right_click_menu=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| values | | -| headings | (Default value = None) | -| visible_column_map | (Default value = None) | -| col_widths | (Default value = None) | -| def_col_width | (Default value = 10) | -| auto_size_columns | (Default value = True) | -| max_col_width | (Default value = 20) | -| select_mode | (Default value = None) | -| display_row_numbers | (Default value = False) | -| num_rows | (Default value = None) | -| row_height | (Default value = None) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| justification | (Default value = 'right') | -| text_color | color of the text (Default value = None) | -| background_color | color of background (Default value = None) | -| alternating_row_color | (Default value = None) | -| row_colors | (Default value = None) | -| vertical_scroll_only | (Default value = True) | -| hide_vertical_scroll | (Default value = False) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| bind_return_key | (Default value = False) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - - - - +pad - element padding for packing +key - key used to lookup element +tooltip - tooltip text + ### Read return values from Table Element The values returned from a `Window.Read` call for the Tree Element are a list of row numbers that are currently highlighted. @@ -4099,122 +3226,61 @@ def Update(self, values=None): ``` `values` is a table containing your rows just like you passed in when creating the Table Element. - -## Tree Element - -The Tree Element and Table Element are close cousins. Many of the parameters found in the Table Element apply to Tree Elements. In particular the heading information, column widths, etc. - - - +## Tree Element + +The Tree Element and Table Element are close cousins. Many of the parameters found in the Table Element apply to Tree Elements. In particular the heading information, column widths, etc. + ```python -Tree(data=None, - headings=None, - visible_column_map=None, - col_widths=None, - col0_width=10, - def_col_width=10, - auto_size_columns=True, - max_col_width=20, - select_mode=None, - show_expanded=False, - change_submits=False, - enable_events=False, - font=None, - justification="right", - text_color=None, - background_color=None, - num_rows=None, - row_height=None, - pad=None, - key=None, - tooltip=None, - right_click_menu=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| data | (Default value = None) | -| headings | (Default value = None) | -| visible_column_map | (Default value = None) | -| col_widths | (Default value = None) | -| col0_width | (Default value = 10) | -| def_col_width | (Default value = 10) | -| auto_size_columns | (Default value = True) | -| max_col_width | (Default value = 20) | -| select_mode | (Default value = None) | -| show_expanded | (Default value = False) | -| change_submits | If True, pressing Enter key submits window (Default value = False) | -| enable_events | Turns on the element specific events.(Default value = False) | -| font | (common_key) specifies the font family, size, etc (Default value = None) | -| justification | (Default value = 'right') | -| text_color | color of the text (Default value = None) | -| background_color | color of background (Default value = None) | -| num_rows | (Default value = None) | -| row_height | (Default value = None) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| tooltip | text, that will appear the you hover on (Default value = None) | -| right_click_menu | see "Right Click Menus" (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - - - -Unlike Tables there is no standard format for trees. Thus the data structure passed to the Tree Element must be constructed. This is done using the TreeData class. The process is as follows: -* Get a TreeData Object -* "Insert" data into the tree -* Pass the filled in TreeData object to Tree Element +``` +class Tree(data=None - data in TreeData format + headings=None - list of strings representing your headings + visible_column_map=None - list of bools indicating which columns to display + col_widths=None - list of column widths + col0_width=10 - width of the first column which has the text data + def_col_width=10 - default column width + auto_size_columns=True - if true will autosize columns (currenly only sizes to col heading width) + max_col_width=20 - max width for columns in characters + select_mode=None - not yet used + show_expanded - Bool - if True the tree will be fully expanded when shown + font=None - the display font + justification='right' - justification for data display + text_color=None- color of text to display + background_color=None - background color + num_rows=None - number of rows to display + row_height=None - height of rows in pixels + pad=None - element padding + key=None - key for element + tooltip=None - tooltip +``` + +Unlike Tables there is no standard format for trees. Thus the data structure passed to the Tree Element must be constructed. This is done using the TreeData class. The process is as follows: +* Get a TreeData Object +* "Insert" data into the tree +* Pass the filled in TreeData object to Tree Element #### TreeData format ```python @@ -4222,25 +3288,25 @@ def TreeData() def Insert(self, parent, key, text, values, icon=None) ``` -To "insert" data into the tree the TreeData method Insert is called. - -`Insert(parent_key, key, display_text, values)` - -To indicate insertion at the head of the tree, use a parent key of "". So, every top-level node in the tree will have a parent node = "" - -This code creates a TreeData object and populates with 3 values -```python -treedata = sg.TreeData() - -treedata.Insert("", '_A_', 'A', [1,2,3]) -treedata.Insert("", '_B_', 'B', [4,5,6]) -treedata.Insert("_A_", '_A1_', 'A1', ['can','be','anything']) -``` - -Note that you ***can*** use the same values for display_text and keys. The only thing you have to watch for is that you cannot repeat keys. - -When Reading a window the Table Element will return a list of rows that are selected by the user. The list will be empty is no rows are selected. - +To "insert" data into the tree the TreeData method Insert is called. + +`Insert(parent_key, key, display_text, values)` + +To indicate insertion at the head of the tree, use a parent key of "". So, every top-level node in the tree will have a parent node = "" + +This code creates a TreeData object and populates with 3 values +```python +treedata = sg.TreeData() + +treedata.Insert("", '_A_', 'A', [1,2,3]) +treedata.Insert("", '_B_', 'B', [4,5,6]) +treedata.Insert("_A_", '_A1_', 'A1', ['can','be','anything']) +``` + +Note that you ***can*** use the same values for display_text and keys. The only thing you have to watch for is that you cannot repeat keys. + +When Reading a window the Table Element will return a list of rows that are selected by the user. The list will be empty is no rows are selected. + #### Icons on Tree Entries If you wish to show an icon next to a tree item, then you specify the icon in the call to `Insert`. You pass in a filename or a Base64 bytes string using the optional `icon` parameter. @@ -4249,141 +3315,105 @@ Here is the result of showing an icon with a tree entry. ![image](https://user-images.githubusercontent.com/13696193/51087270-2b561e80-171f-11e9-8260-6142ea9b1137.png) - -## Tab and Tab Group Elements - -Tabs have been a part of PySimpleGUI since the initial release. However, the initial implementation applied tabs at the top level only. The entire window had to be tabbed. There with other limitations that came along with that implementation. That all changed in version 3.8.0 with the new elements - Tab and TabGroup. The old implementation of Tabs was removed in version 3.8.0 as well. - -Tabs are another "Container Element". The other Container Elements include: -* Frame -* Column - -You layout a Frame in exactly the same way as a Frame or Column elements, by passing in a list of elements. - -How you place a Tab into a Window is different than Graph or Frame elements. You cannot place a tab directly into a Window's layout. It much first be placed into a TabGroup. The TabGroup can then be placed into the Window. - -Let's look at this Window as an example: - -![tabbed 1](https://user-images.githubusercontent.com/13696193/45992808-b10f6a80-c059-11e8-9746-ac71afd4d3d6.jpg) - -View of second tab: - -![tabbed 2](https://user-images.githubusercontent.com/13696193/45992809-b10f6a80-c059-11e8-94e6-3bf543c9b0bd.jpg) - - -First we have the Tab layout definitions. They mirror what you see in the screen shots. Tab 1 has 1 Text Element in it. Tab 2 has a Text and an Input Element. - - - tab1_layout = [[sg.T('This is inside tab 1')]] - - tab2_layout = [[sg.T('This is inside tab 2')], - [sg.In(key='in')]] - -The layout for the entire window looks like this: - - layout = [[sg.TabGroup([[sg.Tab('Tab 1', tab1_layout), sg.Tab('Tab 2', tab2_layout)]])], - [sg.RButton('Read')]] - -The Window layout has the TabGroup and within the tab Group are the two Tab elements. - -One important thing to notice about all of these container Elements... they all take a "list of lists" at the layout. They all have a layout that starts with `[[` - -You will want to keep this `[[ ]]` construct in your head a you're debugging your tabbed windows. It's easy to overlook one or two necessary ['s - -As mentioned earlier, the old-style Tabs were limited to being at the Window-level only. In other words, the tabs were equal in size to the entire window. This is not the case with the "new-style" tabs. This is why you're not going to be upset when you discover your old code no longer works with the new PySimpleGUI release. It'll be worth the few moments it'll take to convert your code. - -Check out what's possible with the NEW Tabs! - -![tabs tabs tabs](https://user-images.githubusercontent.com/13696193/45993438-fd0fde80-c05c-11e8-9ed0-742f14d3070f.jpg) - - -Check out Tabs 7 and 8. We've got a Window with a Column containing Tabs 5 and 6. On Tab 6 are... Tabs 7 and 8. - -As of Release 3.8.0, not all of *options* shown in the API definitions of the Tab and TabGroup Elements are working. They are there as placeholders. - -The definition of a TabGroup is - - TabGroup(layout, - title_color=None - background_color=None - font=None - pad=None - border_width=None - change_submits = False - key=None - tooltip=None) - -The definition of a Tab Element is - - Tab(title, - layout, - title_color=None, - background_color=None, - font=None, - pad=None - disabled=False - border_width=None - key=None - tooltip=None) - - -### Reading Tab Groups - -Tab Groups now return a value when a Read returns. They return which tab is currently selected. There is also a change_submits parameter that can be set that causes a Read to return if a Tab in that group is selected / changed. The key or title belonging to the Tab that was switched to will be returned as the value - - -### Tab Element Methods -```python -Update(disabled = None, visible=None) -``` + +## Tab and Tab Group Elements + +Tabs have been a part of PySimpleGUI since the initial release. However, the initial implementation applied tabs at the top level only. The entire window had to be tabbed. There with other limitations that came along with that implementation. That all changed in version 3.8.0 with the new elements - Tab and TabGroup. The old implementation of Tabs was removed in version 3.8.0 as well. + +Tabs are another "Container Element". The other Container Elements include: +* Frame +* Column + +You layout a Frame in exactly the same way as a Frame or Column elements, by passing in a list of elements. + +How you place a Tab into a Window is different than Graph or Frame elements. You cannot place a tab directly into a Window's layout. It much first be placed into a TabGroup. The TabGroup can then be placed into the Window. + +Let's look at this Window as an example: + +![tabbed 1](https://user-images.githubusercontent.com/13696193/45992808-b10f6a80-c059-11e8-9746-ac71afd4d3d6.jpg) + +View of second tab: + +![tabbed 2](https://user-images.githubusercontent.com/13696193/45992809-b10f6a80-c059-11e8-94e6-3bf543c9b0bd.jpg) + + +First we have the Tab layout definitions. They mirror what you see in the screen shots. Tab 1 has 1 Text Element in it. Tab 2 has a Text and an Input Element. + + + tab1_layout = [[sg.T('This is inside tab 1')]] + + tab2_layout = [[sg.T('This is inside tab 2')], + [sg.In(key='in')]] + +The layout for the entire window looks like this: + + layout = [[sg.TabGroup([[sg.Tab('Tab 1', tab1_layout), sg.Tab('Tab 2', tab2_layout)]])], + [sg.RButton('Read')]] + +The Window layout has the TabGroup and within the tab Group are the two Tab elements. + +One important thing to notice about all of these container Elements... they all take a "list of lists" at the layout. They all have a layout that starts with `[[` + +You will want to keep this `[[ ]]` construct in your head a you're debugging your tabbed windows. It's easy to overlook one or two necessary ['s + +As mentioned earlier, the old-style Tabs were limited to being at the Window-level only. In other words, the tabs were equal in size to the entire window. This is not the case with the "new-style" tabs. This is why you're not going to be upset when you discover your old code no longer works with the new PySimpleGUI release. It'll be worth the few moments it'll take to convert your code. + +Check out what's possible with the NEW Tabs! + +![tabs tabs tabs](https://user-images.githubusercontent.com/13696193/45993438-fd0fde80-c05c-11e8-9ed0-742f14d3070f.jpg) + + +Check out Tabs 7 and 8. We've got a Window with a Column containing Tabs 5 and 6. On Tab 6 are... Tabs 7 and 8. + +As of Release 3.8.0, not all of *options* shown in the API definitions of the Tab and TabGroup Elements are working. They are there as placeholders. + +The definition of a TabGroup is + + TabGroup(layout, + title_color=None + background_color=None + font=None + pad=None + border_width=None + change_submits = False + key=None + tooltip=None) + +The definition of a Tab Element is + + Tab(title, + layout, + title_color=None, + background_color=None, + font=None, + pad=None + disabled=False + border_width=None + key=None + tooltip=None) + + +### Reading Tab Groups + +Tab Groups now return a value when a Read returns. They return which tab is currently selected. There is also a change_submits parameter that can be set that causes a Read to return if a Tab in that group is selected / changed. The key or title belonging to the Tab that was switched to will be returned as the value + + +### Tab Element Methods +```python +Update(disabled = None, visible=None) +``` WARNING - This Update method may not be working correctly - - + ## Pane Element New in version 3.20 is the Pane Element, a super-cool tkinter feature. You won't find this one in PySimpleGUIQt, only PySimpleGUI. It's difficult to describe one of these things. Think of them as "Tabs without labels" that you can slide. ![pane3](https://user-images.githubusercontent.com/13696193/50035040-fcd50e80-ffcd-11e8-939c-df8ab8d64712.gif) - - ```python -Pane(pane_list, - background_color=None, - size=(None, None), - pad=None, - orientation="vertical", - show_handle=True, - relief="raised", - handle_size=None, - border_width=None, - key=None, - visible=True) -``` - -Parameters explained: - -|Name|Meaning| -|-|-| -| pane_list | | -| background_color | color of background (Default value = None) | -| size | (common_key) (w,h) w=characters-wide, h=rows-high (Default value = (None, None)) | -| pad | (common_key) Amount of padding to put around element (Default value = None) | -| orientation | (Default value = 'vertical') | -| show_handle | (Default value = True) | -| relief | (Default value = RELIEF_RAISED) | -| handle_size | (Default value = None) | -| border_width | (Default value = None) | -| key | (common_key) Used with window.FindElement and with return values (Default value = None) | -| visible | set visibility state of the element (Default value = True) | -||| - - - +``` ***Each "Pane" of a Pane Element must be a Column Element***. The parameter `pane_list` is a list of Column Elements. @@ -4396,35 +3426,35 @@ sg.Pane([col5, sg.Column([[sg.Pane([col1, col2, col4], handle_size=15, orientati Combing these with *visibility* make for an interesting interface with entire panes being hidden from view until neded by the user. It's one way of producing "dynamic" windows. -## Colors -Starting in version 2.5 you can change the background colors for the window and the Elements. - -Your windows can go from this: - -![snap0155](https://user-images.githubusercontent.com/13696193/43273879-a9fdc10a-90cb-11e8-8c20-4f6a244ebe2f.jpg) - - -to this... with one function call... - - -![snap0156](https://user-images.githubusercontent.com/13696193/43273880-aa1955e6-90cb-11e8-94b6-673ecdb2698c.jpg) - - - -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 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. - - SetOptions(background_color='#9FB8AD', - text_element_background_color='#9FB8AD', - element_background_color='#9FB8AD', - scrollbar_color=None, - input_elements_background_color='#F7F3EC', - progress_meter_color = ('green', 'blue') - button_color=('white','#475841')) - +## Colors +Starting in version 2.5 you can change the background colors for the window and the Elements. + +Your windows can go from this: + +![snap0155](https://user-images.githubusercontent.com/13696193/43273879-a9fdc10a-90cb-11e8-8c20-4f6a244ebe2f.jpg) + + +to this... with one function call... + + +![snap0156](https://user-images.githubusercontent.com/13696193/43273880-aa1955e6-90cb-11e8-94b6-673ecdb2698c.jpg) + + + +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 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. + + SetOptions(background_color='#9FB8AD', + text_element_background_color='#9FB8AD', + element_background_color='#9FB8AD', + scrollbar_color=None, + input_elements_background_color='#F7F3EC', + progress_meter_color = ('green', 'blue') + button_color=('white','#475841')) + # SystemTray This is a PySimpleGUIQt and PySimpleGUIWx only feature. Don't know of a way to do it using tkinter. Your source code for SystemTray is identical for the Qt and Wx implementations. You can switch frameworks by simply changing your import statement. @@ -4434,13 +3464,13 @@ In addition to running normal windows, it's now also possible to have an icon do Here is the definition of the SystemTray object. ```python -SystemTray(menu=None, filename=None, data=None, data_base64=None, tooltip=None): - ''' - SystemTray - create an icon in the system tray - :param menu: Menu definition - :param filename: filename for icon - :param data: in-ram image for icon - :param data_base64: basee-64 data for icon +SystemTray(menu=None, filename=None, data=None, data_base64=None, tooltip=None): + ''' + SystemTray - create an icon in the system tray + :param menu: Menu definition + :param filename: filename for icon + :param data: in-ram image for icon + :param data_base64: basee-64 data for icon :param tooltip: tooltip string ''' ``` @@ -4453,27 +3483,27 @@ Here is a design pattern you can use to get a jump-start. This program will create a system tray icon and perform a blocking Read. If the item "Open" is chosen from the system tray, then a popup is shown. ```python -import PySimpleGUIQt as sg - -menu_def = ['BLANK', ['&Open', '---', '&Save', ['1', '2', ['a', 'b']], '&Properties', 'E&xit']] - -tray = sg.SystemTray(menu=menu_def, filename=r'default_icon.ico') - -while True: # The event loop - menu_item = tray.Read() - print(menu_item) - if menu_item == 'Exit': - break - elif menu_item == 'Open': - sg.Popup('Menu item chosen', menu_item) - +import PySimpleGUIQt as sg + +menu_def = ['BLANK', ['&Open', '---', '&Save', ['1', '2', ['a', 'b']], '&Properties', 'E&xit']] + +tray = sg.SystemTray(menu=menu_def, filename=r'default_icon.ico') + +while True: # The event loop + menu_item = tray.Read() + print(menu_item) + if menu_item == 'Exit': + break + elif menu_item == 'Open': + sg.Popup('Menu item chosen', menu_item) + ``` The design pattern creates an icon that will display this menu: ![snag-0293](https://user-images.githubusercontent.com/13696193/49057441-8bbfe980-f1cd-11e8-93e7-1aeda9ccd173.jpg) ### Icons -When specifying "icons", you can use 3 different formats. +When specifying "icons", you can use 3 different formats. * `filename`- filename * `data_base64` - base64 byte string * '`data` - in-ram bitmap or other "raw" image @@ -4482,7 +3512,7 @@ You will find 3 parameters used to specify these 3 options on both the initializ ## Menu Definition ```python -menu_def = ['BLANK', ['&Open', '&Save', ['1', '2', ['a', 'b']], '!&Properties', 'E&xit']] +menu_def = ['BLANK', ['&Open', '&Save', ['1', '2', ['a', 'b']], '!&Properties', 'E&xit']] ``` A menu is defined using a list. A "Menu entry" is a string that specifies: @@ -4518,11 +3548,11 @@ If you want to disable a menu entry, place a `!` before the menu entry ```python def Read(timeout=None) - ''' - Reads the context menu + ''' + Reads the context menu :param timeout: Optional. Any value other than None indicates a non-blocking read - :return: String representing meny item chosen. None if nothing read. - ''' + :return: String representing meny item chosen. None if nothing read. + ''' ``` The `timeout` parameter specifies how long to wait for an event to take place. If nothing happens within the timeout period, then a "timeout event" is returned. These types of reads make it possible to run asynchronously. To run non-blocked, specify `timeout=0`on the Read call. @@ -4543,7 +3573,7 @@ TIMEOUT_KEY is returned if no events are available if the timeout value is set i Hides the icon. Note that no message balloons are shown while an icon is hidden. ```python -def Hide() +def Hide() ``` ### Close @@ -4564,7 +3594,7 @@ def UnHide() ### ShowMessage -Shows a balloon above the icon in the system tray area. You can specify your own icon to be shown in the balloon, or you can set `messageicon` to one of the preset values. +Shows a balloon above the icon in the system tray area. You can specify your own icon to be shown in the balloon, or you can set `messageicon` to one of the preset values. This message has a custom icon. @@ -4572,21 +3602,21 @@ This message has a custom icon. The preset `messageicon` values are: - SYSTEM_TRAY_MESSAGE_ICON_INFORMATION - SYSTEM_TRAY_MESSAGE_ICON_WARNING - SYSTEM_TRAY_MESSAGE_ICON_CRITICAL - SYSTEM_TRAY_MESSAGE_ICON_NOICON + SYSTEM_TRAY_MESSAGE_ICON_INFORMATION + SYSTEM_TRAY_MESSAGE_ICON_WARNING + SYSTEM_TRAY_MESSAGE_ICON_CRITICAL + SYSTEM_TRAY_MESSAGE_ICON_NOICON ```python -ShowMessage(title, message, filename=None, data=None, data_base64=None, messageicon=None, time=10000): - ''' - Shows a balloon above icon in system tray - :param title: Title shown in balloon - :param message: Message to be displayed - :param filename: Optional icon filename - :param data: Optional in-ram icon - :param data_base64: Optional base64 icon - :param time: How long to display message in milliseconds :return: +ShowMessage(title, message, filename=None, data=None, data_base64=None, messageicon=None, time=10000): + ''' + Shows a balloon above icon in system tray + :param title: Title shown in balloon + :param message: Message to be displayed + :param filename: Optional icon filename + :param data: Optional in-ram icon + :param data_base64: Optional base64 icon + :param time: How long to display message in milliseconds :return: ''' ``` Note, on windows it may be necessary to make a registry change to enable message balloons to be seen. To fix this, you must create the DWORD you see in this screenshot. @@ -4605,136 +3635,136 @@ You can update any of these items within a SystemTray object ```python Update(menu=None, tooltip=None,filename=None, data=None, data_base64=None,) - ''' - Updates the menu, tooltip or icon - :param menu: menu defintion - :param tooltip: string representing tooltip - :param filename: icon filename - :param data: icon raw image - :param data_base64: icon base 64 image - :return: + ''' + Updates the menu, tooltip or icon + :param menu: menu defintion + :param tooltip: string representing tooltip + :param filename: icon filename + :param data: icon raw image + :param data_base64: icon base 64 image + :return: ''' ``` - - -# Global Settings -**Global Settings** -Let's have some fun customizing! Make PySimpleGUI look the way you want it to look. You can set the global settings using the function `PySimpleGUI.SetOptions`. Each option has an optional parameter that's used to set it. - - SetOptions(icon=None - button_color=(None,None) - element_size=(None,None), - margins=(None,None), - element_padding=(None,None) - auto_size_text=None - auto_size_buttons=None - font=None - border_width=None - slider_border_width=None - slider_relief=None - slider_orientation=None - autoclose_time=None - message_box_line_width=None - progress_meter_border_depth=None - progress_meter_style=None - progress_meter_relief=None - progress_meter_color=None - progress_meter_size=None - text_justification=None - text_color=None - background_color=None - element_background_color=None - text_element_background_color=None - input_elements_background_color=None - element_text_color=None - input_text_color=None - scrollbar_color=None, text_color=None - debug_win_size=(None,None) - window_location=(None,None) - tooltip_time = None - -Explanation of parameters - - icon - filename of icon used for taskbar and title bar - button_color - button color (foreground, background) - element_size - element size (width, height) in characters - margins - tkinter margins around outsize - element_padding - tkinter padding around each element - auto_size_text - autosize the elements to fit their text - auto_size_buttons - autosize the buttons to fit their text - font - font used for elements - border_width - amount of bezel or border around sunken or raised elements - slider_border_width - changes the way sliders look - slider_relief - changes the way sliders look - slider_orientation - changes orientation of slider - autoclose_time - time in seconds for autoclose boxes - message_box_line_width - number of characers in a line of text in message boxes - progress_meter_border_depth - amount of border around raised or lowered progress meters - progress_meter_style - style of progress meter as defined by tkinter - progress_meter_relief - relief style - progress_meter_color - color of the bar and background of progress meters - progress_meter_size - size in (characters, pixels) - background_color - Color of the main window's background - element_background_color - Background color of the elements - text_element_background_color - Text element background color - input_elements_background_color - Input fields background color - element_text_color - Text color of elements that have text, like Radio Buttons - input_text_color - Color of the text that you type in - scrollbar_color - Color for scrollbars (may not always work) - text_color - Text element default text color - text_justification - justification to use on Text Elements. Values are strings - 'left', 'right', 'center' - debug_win_size - size of the Print output window - window_location - location on the screen (x,y) of window's top left cornder - tooltip_time - time in milliseconds to wait before showing a tooltip. Default is 400ms - - -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: - - - 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 windows (Window stays open after button click) - + + +# Global Settings +**Global Settings** +Let's have some fun customizing! Make PySimpleGUI look the way you want it to look. You can set the global settings using the function `PySimpleGUI.SetOptions`. Each option has an optional parameter that's used to set it. + + SetOptions(icon=None + button_color=(None,None) + element_size=(None,None), + margins=(None,None), + element_padding=(None,None) + auto_size_text=None + auto_size_buttons=None + font=None + border_width=None + slider_border_width=None + slider_relief=None + slider_orientation=None + autoclose_time=None + message_box_line_width=None + progress_meter_border_depth=None + progress_meter_style=None + progress_meter_relief=None + progress_meter_color=None + progress_meter_size=None + text_justification=None + text_color=None + background_color=None + element_background_color=None + text_element_background_color=None + input_elements_background_color=None + element_text_color=None + input_text_color=None + scrollbar_color=None, text_color=None + debug_win_size=(None,None) + window_location=(None,None) + tooltip_time = None + +Explanation of parameters + + icon - filename of icon used for taskbar and title bar + button_color - button color (foreground, background) + element_size - element size (width, height) in characters + margins - tkinter margins around outsize + element_padding - tkinter padding around each element + auto_size_text - autosize the elements to fit their text + auto_size_buttons - autosize the buttons to fit their text + font - font used for elements + border_width - amount of bezel or border around sunken or raised elements + slider_border_width - changes the way sliders look + slider_relief - changes the way sliders look + slider_orientation - changes orientation of slider + autoclose_time - time in seconds for autoclose boxes + message_box_line_width - number of characers in a line of text in message boxes + progress_meter_border_depth - amount of border around raised or lowered progress meters + progress_meter_style - style of progress meter as defined by tkinter + progress_meter_relief - relief style + progress_meter_color - color of the bar and background of progress meters + progress_meter_size - size in (characters, pixels) + background_color - Color of the main window's background + element_background_color - Background color of the elements + text_element_background_color - Text element background color + input_elements_background_color - Input fields background color + element_text_color - Text color of elements that have text, like Radio Buttons + input_text_color - Color of the text that you type in + scrollbar_color - Color for scrollbars (may not always work) + text_color - Text element default text color + text_justification - justification to use on Text Elements. Values are strings - 'left', 'right', 'center' + debug_win_size - size of the Print output window + window_location - location on the screen (x,y) of window's top left cornder + tooltip_time - time in milliseconds to wait before showing a tooltip. Default is 400ms + + +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: + + - 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 windows (Window stays open after button click) + Apologies that the next few pages are perhaps confusing. There have been a number of changes recently in PySimpleGUI's Read calls that added some really cool stuff, but at the expense of being not so simple. Part of the issue is an attempt to make sure existing code doesn't break. These changes are all in the area of non-blocking reads and reads with timeouts. -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. - +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 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 normal `Read` call with no parameters will block, a call with a `timeout` value of zero will not block. -Note that `InputText` and `MultiLine` Elements will be **cleared** when performing a `Read`. If you do not want your input field to be cleared after a `Read` then you can set the `do_not_clear` parameter to True when creating those elements. The clear is turned on and off on an element by element basis. +Note that `InputText` and `MultiLine` Elements will be **cleared** when performing a `Read`. If you do not want your input field to be cleared after a `Read` then you can set the `do_not_clear` parameter to True when creating those elements. The clear is turned on and off on an element by element basis. The reasoning behind this is that Persistent Windows are often "forms". When "submitting" a form you want to have all of the fields left blank so the next entry of data will start with a fresh window. Also, when implementing a "Chat Window" type of interface, after each read / send of the chat data, you want the input field cleared. Think of it as a Texting application. Would you want to have to clear your previous text if you want to send a second text? The design pattern for Persistent Windows was already shown to you earlier in the document... here it is for your convenience. -```python -import PySimpleGUI as sg - -layout = [[sg.Text('Persistent window')], - [sg.Input()], - [sg.RButton('Read'), sg.Exit()]] - -window = sg.Window('Window that stays open').Layout(layout) - -while True: - event, values = window.Read() - if event is None or event == 'Exit': - break - print(event, values) +```python +import PySimpleGUI as sg + +layout = [[sg.Text('Persistent window')], + [sg.Input()], + [sg.RButton('Read'), sg.Exit()]] + +window = sg.Window('Window that stays open').Layout(layout) + +while True: + event, values = window.Read() + if event is None or event == 'Exit': + break + print(event, values) window.Close() -``` - - +``` + + ## Read(timeout = t, timeout_key='timeout') Read with a timeout is a very good thing for your GUIs to use in a read non-blocking situation, if you can use them. If your device can wait for a little while, then use this kind of read. The longer you're able to add to the timeout value, the less CPU time you'll be taking. -One way of thinking of reads with timeouts: -> During the timeout time, you are "yielding" the processor to do other tasks. +One way of thinking of reads with timeouts: +> During the timeout time, you are "yielding" the processor to do other tasks. But it gets better than just being a good citizen....**your GUI will be more responsive than if you used a non-blocking read** @@ -4742,21 +3772,21 @@ Let's say you had a device that you want to "poll" every 100ms. The "easy way ```python # YOU SHOULD NOT DO THIS.... -while True: # Event Loop +while True: # Event Loop event, values = window.ReadNonBlocking() # DO NOT USE THIS CALL ANYMORE - read_my_hardware() # process my device here + read_my_hardware() # process my device here time.sleep(.1) # sleep 1/10 second ``` This program will quickly test for user input, then deal with the hardware. Then it'll sleep for 100ms, while your gui is non-responsive, then it'll check in with your GUI again. I fully realize this is a crude way of doing things. We're talking dirt simple stuff without trying to use threads, etc to 'get it right'. It's for demonstration purposes. -The new and better way.... +The new and better way.... using the Read Timeout mechanism, the sleep goes away. ```python # This is the right way to poll for hardware -while True: # Event Loop - event, values = window.Read(timeout = 100) +while True: # Event Loop + event, values = window.Read(timeout = 100) read_my_hardware() # process my device here ``` @@ -4777,7 +3807,7 @@ event, values = sg.Read(timeout=0) ``` You should use the new way if you're reading this for the first time. -The difference in the 2 calls is in the value of event. For ReadNonBlocking, event will be `None` if there are no other events to report. There is a "problem" with this however. With normal Read calls, an event value of None signified the window was closed. For ReadNonBlocking, the way a closed window is returned is via the values variable being set to None. +The difference in the 2 calls is in the value of event. For ReadNonBlocking, event will be `None` if there are no other events to report. There is a "problem" with this however. With normal Read calls, an event value of None signified the window was closed. For ReadNonBlocking, the way a closed window is returned is via the values variable being set to None. ## sg.TIMEOUT_KEY @@ -4787,12 +3817,12 @@ TIMEOUT_KEY = '__timeout__' If you wanted to test for "no event" in your loop, it would be written like this: ```python -while True: - event, value = window.Read(timeout=0) - if event is None: - break # the use has closed the window - if event == sg.TIMEOUT_KEY: - print("Nothing happened") +while True: + event, value = window.Read(timeout=0) + if event is None: + break # the use has closed the window + if event == sg.TIMEOUT_KEY: + print("Nothing happened") ``` @@ -4801,105 +3831,105 @@ Use async windows sparingly. It's possible to have a window that appears to be Non-blocking is generally reserved as a "last resort". Too many times people use non-blocking reads when a blocking read will do just fine. There is a hybrid approach... a read with a timeout. You'll score much higher points on the impressive meter if you're able to use a lot less CPU time by using this type of read. - + The most legit time to use a non-blocking window is when you're working directly with hardware. Maybe you're driving a serial bus. If you look at the Event Loop in the Demo_OpenCV_Webcam.py program, you'll see that the read is a non-blocking read. However, there is a place in the event loop where blocking occurs. The point in the loop where you will block is the call to read frames from the webcam. When a frame is available you want to quickly deliver it to the output device, so you don't want your GUI blocking. You want the read from the hardware to block. - + Another example can be found in the demo for controlling a robot on a Raspberry Pi. In that application you want to read the direction buttons, forward, backward, etc, and immediately take action. If you are using RealtimeButtons, your only option at the moment is to use non-blocking windows. You have to set the timeout to zero if you want the buttons to be real-time responsive. However, with these buttons, adding a sleep to your event loop will at least give other processes time to execute. It will, however, starve your GUI. The entire time you're sleeping, your GUI isn't executing. - -### Periodically Calling`Read` - -Let's say you do end up using non-blocking reads... then you've got some housekeeping to do. It's up to you to periodically "refresh" 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 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 windows the window is shown, user input is read, but your code keeps right on chugging. YOUR responsibility is to call `PySimpleGUI.Read` on a periodic basis. Several times a second or more will produce a reasonably snappy GUI. - + +### Periodically Calling`Read` + +Let's say you do end up using non-blocking reads... then you've got some housekeeping to do. It's up to you to periodically "refresh" 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 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 windows the window is shown, user input is read, but your code keeps right on chugging. YOUR responsibility is to call `PySimpleGUI.Read` on a periodic basis. Several times a second or more will produce a reasonably snappy GUI. + ## Exiting (Closing) a Persistent Window - -If your window has a button that closes the window, then PySimpleGUI will automatically close the window for you. If all of your buttons are ReadButtons, then it'll be up to you to close the window when done. + +If your window has a button that closes the window, then PySimpleGUI will automatically close the window for you. If all of your buttons are ReadButtons, then it'll be up to you to close the window when done. To close a window, call the `Close` method. ```python window.Close() ``` - + ## Persistent Window Example - Running timer that updates + +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. -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. +```python + import PySimpleGUI as sg + import time + + # ---------------- Create Form ---------------- + sg.ChangeLookAndFeel('Black') + sg.SetOptions(element_padding=(0, 0)) + + layout = [[sg.Text('')], + [sg.Text('', size=(8, 2), font=('Helvetica', 20), justification='center', key='text')], + [sg.ReadButton('Pause', key='button', button_color=('white', '#001480')), + sg.ReadButton('Reset', button_color=('white', '#007339'), key='Reset'), + sg.Exit(button_color=('white', 'firebrick4'), key='Exit')]] + + window = sg.Window('Running Timer', no_titlebar=True, auto_size_buttons=False, keep_on_top=True, grab_anywhere=True).Layout(layout) + + # ---------------- main loop ---------------- + current_time = 0 + paused = False + start_time = int(round(time.time() * 100)) + while (True): + # --------- Read and update window -------- + event, values = window.Read(timeout=10) + current_time = int(round(time.time() * 100)) - start_time + # --------- Display timer in window -------- + window.FindElement('text').Update('{:02d}:{:02d}.{:02d}'.format((current_time // 100) // 60, + (current_time // 100) % 60, + current_time % 100)) +``` + -```python - import PySimpleGUI as sg - import time +Previously this program was implemented using a sleep in the loop to control the clock tick. This version uses the new timeout parameter. The result is a window that reacts quicker then the one with the sleep and the accuracy is just as good. + - # ---------------- Create Form ---------------- - sg.ChangeLookAndFeel('Black') - sg.SetOptions(element_padding=(0, 0)) - - layout = [[sg.Text('')], - [sg.Text('', size=(8, 2), font=('Helvetica', 20), justification='center', key='text')], - [sg.ReadButton('Pause', key='button', button_color=('white', '#001480')), - sg.ReadButton('Reset', button_color=('white', '#007339'), key='Reset'), - sg.Exit(button_color=('white', 'firebrick4'), key='Exit')]] - - window = sg.Window('Running Timer', no_titlebar=True, auto_size_buttons=False, keep_on_top=True, grab_anywhere=True).Layout(layout) - - # ---------------- main loop ---------------- - current_time = 0 - paused = False - start_time = int(round(time.time() * 100)) - while (True): - # --------- Read and update window -------- - event, values = window.Read(timeout=10) - current_time = int(round(time.time() * 100)) - start_time - # --------- Display timer in window -------- - window.FindElement('text').Update('{:02d}:{:02d}.{:02d}'.format((current_time // 100) // 60, - (current_time // 100) % 60, - current_time % 100)) -``` - - -Previously this program was implemented using a sleep in the loop to control the clock tick. This version uses the new timeout parameter. The result is a window that reacts quicker then the one with the sleep and the accuracy is just as good. - - -## Instead of a Non-blocking Read --- 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 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** - -One example is you have an input field that changes as you press buttons on an on-screen keypad. - -![keypad 3](https://user-images.githubusercontent.com/13696193/45260275-a2198e80-b3b0-11e8-85fe-a4ce6484510f.jpg) - - - - -# Updating Elements (changing elements in active window) +## Instead of a Non-blocking Read --- 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 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** + +One example is you have an input field that changes as you press buttons on an on-screen keypad. + +![keypad 3](https://user-images.githubusercontent.com/13696193/45260275-a2198e80-b3b0-11e8-85fe-a4ce6484510f.jpg) + + + + +# Updating Elements (changing elements in active window) If you want to change Elements in your window after the window has been created, then you will call the Element's Update method. -**NOTE** a window **must be Read or Finalized** before any Update calls can be made. +**NOTE** a window **must be Read or Finalized** before any Update calls can be made. Here is an example of updating a Text Element ```python -import PySimpleGUI as sg - -layout = [ [sg.Text('My layout', key='_TEXT_')], - [sg.Button('Read')]] - -window = sg.Window('My new window').Layout(layout) - -while True: # Event Loop - event, values = window.Read() - if event is None: - break +import PySimpleGUI as sg + +layout = [ [sg.Text('My layout', key='_TEXT_')], + [sg.Button('Read')]] + +window = sg.Window('My new window').Layout(layout) + +while True: # Event Loop + event, values = window.Read() + if event is None: + break window.Element('_TEXT_').Update('My new text value') ``` @@ -4907,89 +3937,89 @@ Notice the placement of the Update call. If you wanted to Update the Text Eleme In this example, the Update is done prior the Read. Because of this, the Finalize call is added to the Window creation. ```python -import PySimpleGUI as sg - -layout = [ [sg.Text('My layout', key='_TEXT_')], - [sg.Button('Read')] - ] - -window = sg.Window('My new window').Layout(layout).Finalize() - -window.Element('_TEXT_').Update('My new text value') - -while True: # Event Loop - event, values = window.Read() - if event is None: - break +import PySimpleGUI as sg + +layout = [ [sg.Text('My layout', key='_TEXT_')], + [sg.Button('Read')] + ] + +window = sg.Window('My new window').Layout(layout).Finalize() + +window.Element('_TEXT_').Update('My new text value') + +while True: # Event Loop + event, values = window.Read() + if event is None: + break ``` -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). - -You can use Update to do things like: -* Have one Element (appear to) make a change to another Element -* Disable a button, slider, input field, etc -* Change a button's text -* Change an Element's text or background color -* Add text to a scrolling output window -* Change the choices in a list -* etc - -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. - -![snap0272](https://user-images.githubusercontent.com/13696193/45260249-ec4e4000-b3af-11e8-853b-9b29d0bf7797.jpg) - - -In some programs these updates happen in response to another Element. This program takes a Spinner and a Slider's input values and uses them to resize a Text Element. The Spinner and Slider are on the left, the Text element being changed is on the right. - - - # Testing async window, see if can have a slider - # that adjusts the size of text displayed - - import PySimpleGUI as sg - fontSize = 12 - layout = [[sg.Spin([sz for sz in range(6, 172)], font=('Helvetica 20'), initial_value=fontSize, change_submits=True, key='spin'), - sg.Slider(range=(6,172), orientation='h', size=(10,20), - change_submits=True, key='slider', font=('Helvetica 20')), - sg.Text("Aa", size=(2, 1), font="Helvetica " + str(fontSize), key='text')]] - - sz = fontSize - window = sg.Window("Font size selector", grab_anywhere=False).Layout(layout) - # Event Loop - while True: - event, values= window.Read() - if event is None: - break - sz_spin = int(values['spin']) - sz_slider = int(values['slider']) - sz = sz_spin if sz_spin != fontSize else sz_slider - if sz != fontSize: - fontSize = sz - font = "Helvetica " + str(fontSize) - window.FindElement('text').Update(font=font) - window.FindElement('slider').Update(sz) - window.FindElement('spin').Update(sz) - - print("Done.") - - -Inside the event loop we read the value of the Spinner and the Slider using those Elements' keys. -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: - - 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 windows. - -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 = 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 window and also to identify elements. As already mentioned, they are used as targets in Button calls. +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). + +You can use Update to do things like: +* Have one Element (appear to) make a change to another Element +* Disable a button, slider, input field, etc +* Change a button's text +* Change an Element's text or background color +* Add text to a scrolling output window +* Change the choices in a list +* etc + +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. + +![snap0272](https://user-images.githubusercontent.com/13696193/45260249-ec4e4000-b3af-11e8-853b-9b29d0bf7797.jpg) + + +In some programs these updates happen in response to another Element. This program takes a Spinner and a Slider's input values and uses them to resize a Text Element. The Spinner and Slider are on the left, the Text element being changed is on the right. + + + # Testing async window, see if can have a slider + # that adjusts the size of text displayed + + import PySimpleGUI as sg + fontSize = 12 + layout = [[sg.Spin([sz for sz in range(6, 172)], font=('Helvetica 20'), initial_value=fontSize, change_submits=True, key='spin'), + sg.Slider(range=(6,172), orientation='h', size=(10,20), + change_submits=True, key='slider', font=('Helvetica 20')), + sg.Text("Aa", size=(2, 1), font="Helvetica " + str(fontSize), key='text')]] + + sz = fontSize + window = sg.Window("Font size selector", grab_anywhere=False).Layout(layout) + # Event Loop + while True: + event, values= window.Read() + if event is None: + break + sz_spin = int(values['spin']) + sz_slider = int(values['slider']) + sz = sz_spin if sz_spin != fontSize else sz_slider + if sz != fontSize: + fontSize = sz + font = "Helvetica " + str(fontSize) + window.FindElement('text').Update(font=font) + window.FindElement('slider').Update(sz) + window.FindElement('spin').Update(sz) + + print("Done.") + + +Inside the event loop we read the value of the Spinner and the Slider using those Elements' keys. +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: + + 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 windows. + +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 = 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 window and also to identify elements. As already mentioned, they are used as targets in Button calls. ### Locating Elements @@ -4998,96 +4028,96 @@ The Window method call that's used to find an element is: or the shortened version `Element` -When you see a call to window.FindElement or window.Element, then you know an element is being addressed. Normally this is done so you can call the element's Update method. +When you see a call to window.FindElement or window.Element, then you know an element is being addressed. Normally this is done so you can call the element's Update method. ### ProgressBar / Progress Meters Note that to change a progress meter's progress, you call UpdateBar, not Update. It's an old naming convention that's left over from before the Update calls were implemented. + + + +# Keyboard & Mouse Capture +Beginning in version 2.10 you can capture keyboard key presses and mouse scroll-wheel events. Keyboard keys can be used, for example, to detect the page-up and page-down keys for a PDF viewer. To use this feature, there's a boolean setting in the Window call `return_keyboard_events` that is set to True in order to get keys returned along with buttons. + +Keys and scroll-wheel events are returned in exactly the same way as buttons. + +For scroll-wheel events, if the mouse is scrolled up, then the `button` text will be `MouseWheel:Up`. For downward scrolling, the text returned is `MouseWheel:Down` + +Keyboard keys return 2 types of key events. For "normal" keys (a,b,c, etc), a single character is returned that represents that key. Modifier and special keys are returned as a string with 2 parts: + + Key Sym:Key Code + +Key Sym is a string such as 'Control_L'. The Key Code is a numeric representation of that key. The left control key, when pressed will return the value 'Control_L:17' + + import PySimpleGUI as sg + + # 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 window: + text_elem = sg.Text("", size=(18, 1)) + layout = [[sg.Text("Press a key or scroll mouse")], + [text_elem], + [sg.Button("OK")]] + + window.Layout(layout) + # ---===--- Loop taking in user input --- # + while True: + event, value = window.Read() + + if event == "OK" or event is None: + print(event, "exiting") + break + text_elem.Update(event) + + + +You want to turn off the default focus so that there no buttons that will be selected should you press the spacebar. + +### Realtime Keyboard Capture +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 window: + layout = [[sg.Text("Hold down a key")], + [sg.Button("OK")]] + + window.Layout(layout) + + while True: + event, value = window.Read(timeout=0) + if event == "OK" or event is None: + print(event, value, "exiting") + break + if event != sg.TIMEOUT_KEY: + print(event) - -# Keyboard & Mouse Capture -Beginning in version 2.10 you can capture keyboard key presses and mouse scroll-wheel events. Keyboard keys can be used, for example, to detect the page-up and page-down keys for a PDF viewer. To use this feature, there's a boolean setting in the Window call `return_keyboard_events` that is set to True in order to get keys returned along with buttons. - -Keys and scroll-wheel events are returned in exactly the same way as buttons. - -For scroll-wheel events, if the mouse is scrolled up, then the `button` text will be `MouseWheel:Up`. For downward scrolling, the text returned is `MouseWheel:Down` - -Keyboard keys return 2 types of key events. For "normal" keys (a,b,c, etc), a single character is returned that represents that key. Modifier and special keys are returned as a string with 2 parts: - - Key Sym:Key Code - -Key Sym is a string such as 'Control_L'. The Key Code is a numeric representation of that key. The left control key, when pressed will return the value 'Control_L:17' - - import PySimpleGUI as sg - - # 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 window: - text_elem = sg.Text("", size=(18, 1)) - layout = [[sg.Text("Press a key or scroll mouse")], - [text_elem], - [sg.Button("OK")]] - - window.Layout(layout) - # ---===--- Loop taking in user input --- # - while True: - event, value = window.Read() - - if event == "OK" or event is None: - print(event, "exiting") - break - text_elem.Update(event) - - - -You want to turn off the default focus so that there no buttons that will be selected should you press the spacebar. - -### Realtime Keyboard Capture -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 window: - layout = [[sg.Text("Hold down a key")], - [sg.Button("OK")]] - - window.Layout(layout) - - while True: - event, value = window.Read(timeout=0) - if event == "OK" or event is None: - print(event, value, "exiting") - break - if event != sg.TIMEOUT_KEY: - print(event) - - -# Menus +# Menus ## MenuBar - + 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 events and as of 3.17, also as in the values dictionary. The value returned will be the entire menu entry, including the key if you specified one. - -This definition: - - menu_def = [['File', ['Open', 'Save', 'Exit',]], - ['Edit', ['Paste', ['Special', 'Normal',], 'Undo'],], - ['Help', 'About...'],] - -Note the placement of ',' and of []. It's tricky to get the nested menus correct that implement cascading menus. See how paste has Special and Normal as a list after it. This means that Paste has a cascading menu with items Special and Normal. - -They menu_def layout produced this window: - -![menu](https://user-images.githubusercontent.com/13696193/45306723-56b7cb00-b4eb-11e8-8cbd-faef0c90f8b4.jpg) - + +This definition: + + menu_def = [['File', ['Open', 'Save', 'Exit',]], + ['Edit', ['Paste', ['Special', 'Normal',], 'Undo'],], + ['Help', 'About...'],] + +Note the placement of ',' and of []. It's tricky to get the nested menus correct that implement cascading menus. See how paste has Special and Normal as a list after it. This means that Paste has a cascading menu with items Special and Normal. + +They menu_def layout produced this window: + +![menu](https://user-images.githubusercontent.com/13696193/45306723-56b7cb00-b4eb-11e8-8cbd-faef0c90f8b4.jpg) + To add a menu to a Window place the `Menu` or `MenuBar` element into your layout. - layout = [[sg.Menu(menu_def)]] + layout = [[sg.Menu(menu_def)]] It doesn't really matter where you place the Menu Element in your layout as it will always be located at the top of the window. @@ -5107,29 +4137,29 @@ right_click_menu = ['&Right', ['Right', '!&Click', '&Menu', 'E&xit', 'Properties The first string in a right click menu and a button menu is ***ignored***. It is not used. Normally you would put the string that is shown on the menu bar in that location. **Return values for right click menus are different than menu bars and button menus.** Instead of the value being returned through the values dictionary, it is instead sent back as an Event. You will not - -## Menu Shortcut keys -You have used ALT-key in other Windows programs to navigate menus. For example Alt-F+X exits the program. The Alt-F pulls down the File menu. The X selects the entry marked Exit. - -The good news is that PySimpleGUI allows you to create the same kind of menus! Your program can play with the big-boys. And, it's trivial to do. - -All that's required is for your to add an "&" in front of the letter you want to appear with an underscore. When you hold the Alt key down you will see the menu with underlines that you marked. - -One other little bit of polish you can add are separators in your list. To add a line in your list of menu choices, create a menu entry that looks like this: ` '---'` - -This is an example Menu with underlines and a separator. - -``` -# ------ Menu Definition ------ # -menu_def = [['&File', ['&Open', '&Save', '---', 'Properties', 'E&xit' ]], - ['&Edit', ['Paste', ['Special', 'Normal',], 'Undo'],], - ['&Help', '&About...'],] -``` - And this is the spiffy menu it produced: - ![menus with shortcuts](https://user-images.githubusercontent.com/13696193/46251674-f5b74f00-c427-11e8-95c6-547adc59041b.jpg) + +## Menu Shortcut keys +You have used ALT-key in other Windows programs to navigate menus. For example Alt-F+X exits the program. The Alt-F pulls down the File menu. The X selects the entry marked Exit. + +The good news is that PySimpleGUI allows you to create the same kind of menus! Your program can play with the big-boys. And, it's trivial to do. + +All that's required is for your to add an "&" in front of the letter you want to appear with an underscore. When you hold the Alt key down you will see the menu with underlines that you marked. + +One other little bit of polish you can add are separators in your list. To add a line in your list of menu choices, create a menu entry that looks like this: ` '---'` + +This is an example Menu with underlines and a separator. + +``` +# ------ Menu Definition ------ # +menu_def = [['&File', ['&Open', '&Save', '---', 'Properties', 'E&xit' ]], + ['&Edit', ['Paste', ['Special', 'Normal',], 'Undo'],], + ['&Help', '&About...'],] +``` + And this is the spiffy menu it produced: + ![menus with shortcuts](https://user-images.githubusercontent.com/13696193/46251674-f5b74f00-c427-11e8-95c6-547adc59041b.jpg) -## Disabled Menu Entries +## Disabled Menu Entries If you want one of your menu items to be disabled, then place a '!' in front of the menu entry. To disable the Paste menu entry in the previous examples, the entry would be: `['!&Edit', ['Paste', ['Special', 'Normal',], 'Undo'],]` @@ -5143,13 +4173,13 @@ Beginning in version 3.17 you can add a `key` to your menu entries. The `key` v To add the `key` `_MY_KEY_` to the Special menu entry, the code would be: `['&Edit', ['Paste', ['Special::_MY_KEY_', 'Normal',], 'Undo'],]` - - If you want to change the characters that indicate a key follows from '::' to something else, change the variable `MENU_KEY_SEPARATOR` + + If you want to change the characters that indicate a key follows from '::' to something else, change the variable `MENU_KEY_SEPARATOR` # Running Multiple Windows -If you wish to run multiple windows in your event loop, then there are 2 methods for doing this. +If you wish to run multiple windows in your event loop, then there are 2 methods for doing this. 1. First window does not remain active while second window is visible 2. First window remains active while second window is visible @@ -5168,130 +4198,128 @@ A rule of thumb to follow: ## Multi-Window Design Pattern 1 - both windows active ```python -import PySimpleGUI as sg - -# Design pattern 2 - First window remains active - -layout = [[ sg.Text('Window 1'),], - [sg.Input(do_not_clear=True)], - [sg.Text('', key='_OUTPUT_')], - [sg.Button('Launch 2'), sg.Button('Exit')]] - -win1 = sg.Window('Window 1').Layout(layout) - -win2_active = False -while True: - ev1, vals1 = win1.Read(timeout=100) - win1.FindElement('_OUTPUT_').Update(vals1[0]) - if ev1 is None or ev1 == 'Exit': - break - - if not win2_active and ev1 == 'Launch 2': - win2_active = True - layout2 = [[sg.Text('Window 2')], - [sg.Button('Exit')]] - - win2 = sg.Window('Window 2').Layout(layout2) - - if win2_active: - ev2, vals2 = win2.Read(timeout=100) - if ev2 is None or ev2 == 'Exit': - win2_active = False - win2.Close() +import PySimpleGUI as sg + +# Design pattern 2 - First window remains active + +layout = [[ sg.Text('Window 1'),], + [sg.Input(do_not_clear=True)], + [sg.Text('', key='_OUTPUT_')], + [sg.Button('Launch 2'), sg.Button('Exit')]] + +win1 = sg.Window('Window 1').Layout(layout) + +win2_active = False +while True: + ev1, vals1 = win1.Read(timeout=100) + win1.FindElement('_OUTPUT_').Update(vals1[0]) + if ev1 is None or ev1 == 'Exit': + break + + if not win2_active and ev1 == 'Launch 2': + win2_active = True + layout2 = [[sg.Text('Window 2')], + [sg.Button('Exit')]] + + win2 = sg.Window('Window 2').Layout(layout2) + + if win2_active: + ev2, vals2 = win2.Read(timeout=100) + if ev2 is None or ev2 == 'Exit': + win2_active = False + win2.Close() ``` ## Multi-Window Design Pattern 2 - only 1 active window ```python -import PySimpleGUIQt as sg - -# Design pattern 1 - First window does not remain active - -layout = [[ sg.Text('Window 1'),], - [sg.Input(do_not_clear=True)], - [sg.Text('', key='_OUTPUT_')], - [sg.Button('Launch 2')]] - -win1 = sg.Window('Window 1').Layout(layout) -win2_active=False -while True: - ev1, vals1 = win1.Read(timeout=100) - if ev1 is None: - break - win1.FindElement('_OUTPUT_').Update(vals1[0]) - - if ev1 == 'Launch 2' and not win2_active: - win2_active = True - win1.Hide() - layout2 = [[sg.Text('Window 2')], # note must create a layout from scratch every time. No reuse - [sg.Button('Exit')]] - - win2 = sg.Window('Window 2').Layout(layout2) - while True: - ev2, vals2 = win2.Read() - if ev2 is None or ev2 == 'Exit': - win2.Close() - win2_active = False - win1.UnHide() - break +import PySimpleGUIQt as sg + +# Design pattern 1 - First window does not remain active + +layout = [[ sg.Text('Window 1'),], + [sg.Input(do_not_clear=True)], + [sg.Text('', key='_OUTPUT_')], + [sg.Button('Launch 2')]] + +win1 = sg.Window('Window 1').Layout(layout) +win2_active=False +while True: + ev1, vals1 = win1.Read(timeout=100) + if ev1 is None: + break + win1.FindElement('_OUTPUT_').Update(vals1[0]) + + if ev1 == 'Launch 2' and not win2_active: + win2_active = True + win1.Hide() + layout2 = [[sg.Text('Window 2')], # note must create a layout from scratch every time. No reuse + [sg.Button('Exit')]] + + win2 = sg.Window('Window 2').Layout(layout2) + while True: + ev2, vals2 = win2.Read() + if ev2 is None or ev2 == 'Exit': + win2.Close() + win2_active = False + win1.UnHide() + break ``` - - - -# Sample Applications - + +# Sample Applications + There are too many to list!! There are over 130 sample programs to give you a jump start. -## Packages Used In Demos - - - While the core PySimpleGUI code does not utilize any 3rd party packages, some of the demos do. They add a GUI to a few popular packages. These packages include: - * [Chatterbot](https://github.com/gunthercox/ChatterBot) - * [Mido](https://github.com/olemb/mido) - * [Matplotlib](https://matplotlib.org/) - * [PyMuPDF](https://github.com/rk700/PyMuPDF) - - -# Creating a Windows .EXE File - -It's possible to create a single .EXE file that can be distributed to Windows users. There is no requirement to install the Python interpreter on the PC you wish to run it on. Everything it needs is in the one EXE file, assuming you're running a somewhat up to date version of Windows. - -Installation of the packages, you'll need to install PySimpleGUI and PyInstaller (you need to install only once) - -```bash -pip install PySimpleGUI -pip install PyInstaller - -``` - -To create your EXE file from your program that uses PySimpleGUI, `my_program.py`, enter this command in your Windows command prompt: - -```bash -pyinstaller -wF my_program.py - -``` - -You will be left with a single file, `my_program.exe`, located in a folder named `dist` under the folder where you executed the `pyinstaller` command. - -That's all... Run your `my_program.exe` file on the Windows machine of your choosing. - -> "It's just that easy." - -(famous last words that screw up just about anything being referenced) - -Your EXE file should run without creating a "shell window". Only the GUI window should show up on your taskbar. - -If you get a crash with something like: -```python -ValueError: script '.......\src\tkinter' not found -``` - -Then try adding **`--hidden-import tkinter`** to your command - -# Creating a Mac App File +## Packages Used In Demos + + + While the core PySimpleGUI code does not utilize any 3rd party packages, some of the demos do. They add a GUI to a few popular packages. These packages include: + * [Chatterbot](https://github.com/gunthercox/ChatterBot) + * [Mido](https://github.com/olemb/mido) + * [Matplotlib](https://matplotlib.org/) + * [PyMuPDF](https://github.com/rk700/PyMuPDF) + + +# Creating a Windows .EXE File + +It's possible to create a single .EXE file that can be distributed to Windows users. There is no requirement to install the Python interpreter on the PC you wish to run it on. Everything it needs is in the one EXE file, assuming you're running a somewhat up to date version of Windows. + +Installation of the packages, you'll need to install PySimpleGUI and PyInstaller (you need to install only once) + +``` +pip install PySimpleGUI +pip install PyInstaller + +``` + +To create your EXE file from your program that uses PySimpleGUI, `my_program.py`, enter this command in your Windows command prompt: + +``` +pyinstaller -wF my_program.py + +``` + +You will be left with a single file, `my_program.exe`, located in a folder named `dist` under the folder where you executed the `pyinstaller` command. + +That's all... Run your `my_program.exe` file on the Windows machine of your choosing. + +> "It's just that easy." + +(famous last words that screw up just about anything being referenced) + +Your EXE file should run without creating a "shell window". Only the GUI window should show up on your taskbar. + +If you get a crash with something like: +``` +ValueError: script '.......\src\tkinter' not found +``` + +Then try adding **`--hidden-import tkinter`** to your command + +# Creating a Mac App File There are reports that PyInstaller can be used to create App files. It's not been officially tested. @@ -5304,303 +4332,297 @@ This info was located on Reddit with the source traced back to: https://github.com/pyinstaller/pyinstaller/issues/1350 -## Fun Stuff -Here are some things to try if you're bored or want to further customize - -**Debug Output** -Be sure and check out the EasyPrint (Print) function described in the high-level API section. Leave your code the way it is, route your stdout and stderror to a scrolling window. - -For a fun time, add these lines to the top of your script - -```python - import PySimpleGUI as sg - print = sg.Print -``` -This will turn all of your print statements into prints that display in a window on your screen rather than to the terminal. - -**Look and Feel** -Dial in the look and feel that you like with the `SetOptions` function. You can change all of the defaults in one function call. One line of code to customize the entire GUI. -Or beginning in version 2.9 you can choose from a look and feel using pre-defined color schemes. Call ChangeLookAndFeel with a description string. - -```python - sg.ChangeLookAndFeel('GreenTan') - -``` - -Valid values for the description string are: - - GreenTan - LightGreen - BluePurple - Purple - BlueMono - GreenMono - BrownBlue - BrightColors - NeutralBlue - Kayak - SandyBeach - TealMono - -To see the latest list of color choices, take a look at the bottom of the `PySimpleGUI.py` file where you'll find the `ChangLookAndFeel` function. - -You can also combine the `ChangeLookAndFeel` function with the `SetOptions` function to quickly modify one of the canned color schemes. Maybe you like the colors but was more depth to your bezels. You can dial in exactly what you want. - -**ObjToString** -Ever wanted to easily display an objects contents easily? Use ObjToString to get a nicely formatted recursive walk of your objects. -This statement: - - print(sg.ObjToSting(x)) - -And this was the output - - - abc = abc - attr12 = 12 - c = - b = - a = - attr1 = 1 - attr2 = 2 - attr3 = three - attr10 = 10 - attrx = x - -You'll quickly wonder how you ever coded without it. - ---- -# Known Issues -While not an "issue" this is a ***stern warning*** - -## **Do not attempt** to call `PySimpleGUI` from multiple threads! It's `tkinter` based and `tkinter` has issues with multiple threads - -**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 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. - -## Contributing - -A MikeTheWatchGuy production... entirely responsible for this code.... unless it causes you trouble in which case I'm not at all responsible. - - - -## Versions -|Version | Description | -|--|--| -| 1.0.9 | July 10, 2018 - Initial Release | -| 1.0.21 | July 13, 2018 - Readme updates | -| 2.0.0 | July 16, 2018 - ALL optional parameters renamed from CamelCase to all_lower_case -| 2.1.1 | July 18, 2018 - Global settings exposed, fixes -| 2.2.0| July 20, 2018 - Image Elements, Print output -| 2.3.0 | July 23, 2018 - Changed form.Read return codes, Slider Elements, Listbox element. Renamed some methods but left legacy calls in place for now. -| 2.4.0 | July 24, 2018 - Button images. Fixes so can run on Raspberry Pi -| 2.5.0 | July 26, 2018 - Colors. Listbox scrollbar. tkinter Progress Bar instead of homegrown. -| 2.6.0 | July 27, 2018 - auto_size_button setting. License changed to LGPL 3+ -| 2.7.0 | July 30, 2018 - realtime buttons, window_location default setting -| 2.8.0 | Aug 9, 2018 - New None default option for Checkbox element, text color option for all elements, return values as a dictionary, setting focus, binding return key -| 2.9.0 | Aug 16,2018 - Screen flash fix, `do_not_clear` input field option, `autosize_text` defaults to `True` now, return values as ordered dict, removed text target from progress bar, rework of return values and initial return values, removed legacy Form.Refresh() method (replaced by Form.ReadNonBlockingForm()), COLUMN elements!!, colored text defaults -| 2.10.0 | Aug 25, 2018 - Keyboard & Mouse features (Return individual keys as if buttons, return mouse scroll-wheel as button, bind return-key to button, control over keyboard focus), SaveAs Button, Update & Get methods for InputText, Update for Listbox, Update & Get for Checkbox, Get for Multiline, Color options for Text Element Update, Progess bar Update can change max value, Update for Button to change text & colors, Update for Image Element, Update for Slider, Form level text justification, Turn off default focus, scroll bar for Listboxes, Images can be from filename or from in-RAM, Update for Image). Fixes - text wrapping in buttons, msg box, removed slider borders entirely and others -| 2.11.0 | Aug 29, 2018 - Lots of little changes that are needed for the demo programs to work. Buttons have their own default element size, fix for Mac default button color, padding support for all elements, option to immediately return if list box gets selected, FilesBrowse button, Canvas Element, Frame Element, Slider resolution option, Form.Refresh method, better text wrapping, 'SystemDefault' look and feel settin -| 2.20.0 | Sept 4, 2018 - Some sizable features this time around of interest to advanced users. Renaming of the MsgBox functions to Popup. Renaming GetFile, etc, to PopupGetFile. High-level windowing capabilities start with Popup, PopupNoWait/PopupNonblocking, PopupNoButtons, default icon, change_submits option for Listbox/Combobox/Slider/Spin/, New OptionMenu element, updating elements after shown, system defaul color option for progress bars, new button type (Dummy Button) that only closes a window, SCROLLABLE Columns!! (yea, playing in the Big League now), LayoutAndShow function removed, form.Fill - bulk updates to forms, FindElement - find element based on key value (ALL elements have keys now), no longer use grid packing for row elements (a potentially huge change), scrolled text box sizing changed, new look and feel themes (Dark, Dark2, Black, Tan, TanBlue, DarkTanBlue, DarkAmber, DarkBlue, Reds, Green) -| 2.30.0 | Sept 6, 2018 - Calendar Chooser (button), borderless windows, load/save form to disk -| 3.0.0 | Sept 7, 2018 - The "fix for poor choice of 2.x numbers" release. Color Chooser (button), "grab anywhere" windows are on by default, disable combo boxes, Input Element text justification (last part needed for 'tables'), Image Element changes to support OpenCV?, PopupGetFile and PopupGetFolder have better no_window option -| 3.01.01 | Sept 10, 2018 - Menus! (sort of a big deal) -| 3.01.02 | Step 11, 2018 - All Element.Update functions have a `disabled` parameter so they can be disabled. Renamed some parameters in Update function (sorry if I broke your code), fix for bug in Image.Update. Wasn't setting size correctly, changed grab_anywhere logic again,added grab anywhere option to PupupGetText (assumes disabled) -| 3.02.00 | Sept 14, 2018 - New Table Element (Beta release), MsgBox removed entirely, font setting for InputText Element, **packing change** risky change that allows some Elements to be resized,removed command parameter from Menu Element, new function names for ReadNonBlocking (Finalize, PreRead), change to text element autosizing and wrapping (yet again), lots of parameter additions to Popup functions (colors, etc). -| 3.03.00 | New feature - One Line Progress Meters, new display_row_numbers for Table Element, fixed bug in EasyProgresssMeters (function will soon go away), OneLine and Easy progress meters set to grab anywhere but can be turned off. -| 03,04.00 | Sept 18, 2018 - New features - Graph Element, Frame Element, more settings exposed to Popup calls. See notes below for more. -| 03.04.01 | Sept 18, 2018 - See release notes -| 03.05.00 | Sept 20, 2018 - See release notes -| 03.05.01 | Sept 22, 2018 - See release notes -| 03.05.02 | Sept 23, 2018 - See release notes -| 03.06.00 | Sept 23, 2018 - Goodbye FlexForm, hello Window -| 03.08.00 | Sept 25, 2018 - Tab and TabGroup Elements\ -| 01.00.00 for 2.7 | Sept 25, 2018 - First release for 2.7 -| 03.08.04 | Sept 30, 2018 - See release notes -| 03.09.00 | Oct 1, 2018 | -| 2.7 01.01.00 | Oct 1, 2018 -| 2.7 01.01.02 | Oct 8, 2018 -| 03.09.01 | Oct 8, 2018 -| 3.9.3 & 1.1.3 | Oct 11, 2018 -| 3.9.4 & 1.1.4 | Oct 16, 2018 -| 3.10.1 & 1.2.1 | Oct 20, 2018 -| 3.10.3 & 1.2.3 | Oct 23, 2018 -| 3.11.0 & 1.11.0 | Oct 28, 2018 +## Fun Stuff +Here are some things to try if you're bored or want to further customize + +**Debug Output** +Be sure and check out the EasyPrint (Print) function described in the high-level API section. Leave your code the way it is, route your stdout and stderror to a scrolling window. + +For a fun time, add these lines to the top of your script + + import PySimpleGUI as sg + print = sg.Print + +This will turn all of your print statements into prints that display in a window on your screen rather than to the terminal. + +**Look and Feel** +Dial in the look and feel that you like with the `SetOptions` function. You can change all of the defaults in one function call. One line of code to customize the entire GUI. +Or beginning in version 2.9 you can choose from a look and feel using pre-defined color schemes. Call ChangeLookAndFeel with a description string. + + sg.ChangeLookAndFeel('GreenTan') + +Valid values for the description string are: + + GreenTan + LightGreen + BluePurple + Purple + BlueMono + GreenMono + BrownBlue + BrightColors + NeutralBlue + Kayak + SandyBeach + TealMono + +To see the latest list of color choices, take a look at the bottom of the `PySimpleGUI.py` file where you'll find the `ChangLookAndFeel` function. + +You can also combine the `ChangeLookAndFeel` function with the `SetOptions` function to quickly modify one of the canned color schemes. Maybe you like the colors but was more depth to your bezels. You can dial in exactly what you want. + +**ObjToString** +Ever wanted to easily display an objects contents easily? Use ObjToString to get a nicely formatted recursive walk of your objects. +This statement: + + print(sg.ObjToSting(x)) + +And this was the output + + + abc = abc + attr12 = 12 + c = + b = + a = + attr1 = 1 + attr2 = 2 + attr3 = three + attr10 = 10 + attrx = x + +You'll quickly wonder how you ever coded without it. + +--- +# Known Issues +While not an "issue" this is a ***stern warning*** + +## **Do not attempt** to call `PySimpleGUI` from multiple threads! It's `tkinter` based and `tkinter` has issues with multiple threads + +**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 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. + +## Contributing + +A MikeTheWatchGuy production... entirely responsible for this code.... unless it causes you trouble in which case I'm not at all responsible. + +## Versions +|Version | Description | +|--|--| +| 1.0.9 | July 10, 2018 - Initial Release | +| 1.0.21 | July 13, 2018 - Readme updates | +| 2.0.0 | July 16, 2018 - ALL optional parameters renamed from CamelCase to all_lower_case +| 2.1.1 | July 18, 2018 - Global settings exposed, fixes +| 2.2.0| July 20, 2018 - Image Elements, Print output +| 2.3.0 | July 23, 2018 - Changed form.Read return codes, Slider Elements, Listbox element. Renamed some methods but left legacy calls in place for now. +| 2.4.0 | July 24, 2018 - Button images. Fixes so can run on Raspberry Pi +| 2.5.0 | July 26, 2018 - Colors. Listbox scrollbar. tkinter Progress Bar instead of homegrown. +| 2.6.0 | July 27, 2018 - auto_size_button setting. License changed to LGPL 3+ +| 2.7.0 | July 30, 2018 - realtime buttons, window_location default setting +| 2.8.0 | Aug 9, 2018 - New None default option for Checkbox element, text color option for all elements, return values as a dictionary, setting focus, binding return key +| 2.9.0 | Aug 16,2018 - Screen flash fix, `do_not_clear` input field option, `autosize_text` defaults to `True` now, return values as ordered dict, removed text target from progress bar, rework of return values and initial return values, removed legacy Form.Refresh() method (replaced by Form.ReadNonBlockingForm()), COLUMN elements!!, colored text defaults +| 2.10.0 | Aug 25, 2018 - Keyboard & Mouse features (Return individual keys as if buttons, return mouse scroll-wheel as button, bind return-key to button, control over keyboard focus), SaveAs Button, Update & Get methods for InputText, Update for Listbox, Update & Get for Checkbox, Get for Multiline, Color options for Text Element Update, Progess bar Update can change max value, Update for Button to change text & colors, Update for Image Element, Update for Slider, Form level text justification, Turn off default focus, scroll bar for Listboxes, Images can be from filename or from in-RAM, Update for Image). Fixes - text wrapping in buttons, msg box, removed slider borders entirely and others +| 2.11.0 | Aug 29, 2018 - Lots of little changes that are needed for the demo programs to work. Buttons have their own default element size, fix for Mac default button color, padding support for all elements, option to immediately return if list box gets selected, FilesBrowse button, Canvas Element, Frame Element, Slider resolution option, Form.Refresh method, better text wrapping, 'SystemDefault' look and feel settin +| 2.20.0 | Sept 4, 2018 - Some sizable features this time around of interest to advanced users. Renaming of the MsgBox functions to Popup. Renaming GetFile, etc, to PopupGetFile. High-level windowing capabilities start with Popup, PopupNoWait/PopupNonblocking, PopupNoButtons, default icon, change_submits option for Listbox/Combobox/Slider/Spin/, New OptionMenu element, updating elements after shown, system defaul color option for progress bars, new button type (Dummy Button) that only closes a window, SCROLLABLE Columns!! (yea, playing in the Big League now), LayoutAndShow function removed, form.Fill - bulk updates to forms, FindElement - find element based on key value (ALL elements have keys now), no longer use grid packing for row elements (a potentially huge change), scrolled text box sizing changed, new look and feel themes (Dark, Dark2, Black, Tan, TanBlue, DarkTanBlue, DarkAmber, DarkBlue, Reds, Green) +| 2.30.0 | Sept 6, 2018 - Calendar Chooser (button), borderless windows, load/save form to disk +| 3.0.0 | Sept 7, 2018 - The "fix for poor choice of 2.x numbers" release. Color Chooser (button), "grab anywhere" windows are on by default, disable combo boxes, Input Element text justification (last part needed for 'tables'), Image Element changes to support OpenCV?, PopupGetFile and PopupGetFolder have better no_window option +| 3.01.01 | Sept 10, 2018 - Menus! (sort of a big deal) +| 3.01.02 | Step 11, 2018 - All Element.Update functions have a `disabled` parameter so they can be disabled. Renamed some parameters in Update function (sorry if I broke your code), fix for bug in Image.Update. Wasn't setting size correctly, changed grab_anywhere logic again,added grab anywhere option to PupupGetText (assumes disabled) +| 3.02.00 | Sept 14, 2018 - New Table Element (Beta release), MsgBox removed entirely, font setting for InputText Element, **packing change** risky change that allows some Elements to be resized,removed command parameter from Menu Element, new function names for ReadNonBlocking (Finalize, PreRead), change to text element autosizing and wrapping (yet again), lots of parameter additions to Popup functions (colors, etc). +| 3.03.00 | New feature - One Line Progress Meters, new display_row_numbers for Table Element, fixed bug in EasyProgresssMeters (function will soon go away), OneLine and Easy progress meters set to grab anywhere but can be turned off. +| 03,04.00 | Sept 18, 2018 - New features - Graph Element, Frame Element, more settings exposed to Popup calls. See notes below for more. +| 03.04.01 | Sept 18, 2018 - See release notes +| 03.05.00 | Sept 20, 2018 - See release notes +| 03.05.01 | Sept 22, 2018 - See release notes +| 03.05.02 | Sept 23, 2018 - See release notes +| 03.06.00 | Sept 23, 2018 - Goodbye FlexForm, hello Window +| 03.08.00 | Sept 25, 2018 - Tab and TabGroup Elements\ +| 01.00.00 for 2.7 | Sept 25, 2018 - First release for 2.7 +| 03.08.04 | Sept 30, 2018 - See release notes +| 03.09.00 | Oct 1, 2018 | +| 2.7 01.01.00 | Oct 1, 2018 +| 2.7 01.01.02 | Oct 8, 2018 +| 03.09.01 | Oct 8, 2018 +| 3.9.3 & 1.1.3 | Oct 11, 2018 +| 3.9.4 & 1.1.4 | Oct 16, 2018 +| 3.10.1 & 1.2.1 | Oct 20, 2018 +| 3.10.3 & 1.2.3 | Oct 23, 2018 +| 3.11.0 & 1.11.0 | Oct 28, 2018 | 3.12.0 & 1.12.0 | Oct 28, 2018 | 3.13.0 & 1.13.0 | Oct 29, 2018 | 3.14.0 & 1.14.0 | Nov 2, 2018 | 3.15.0 & 1.15.0 | Nov 20, 2018 | 3.16.0 & 1.16.0 | Nov 26, 2018 | 3.17.0 & 1.17.0 | Dec 1, 2018 - -## Release Notes -2.3 - Sliders, Listbox's and Image elements (oh my!) - -If using Progress Meters, avoid cancelling them when you have another window open. It could lead to future windows being blank. It's being worked on. - -New debug printing capability. `sg.Print` - -2.5 Discovered issue with scroll bar on `Output` elements. The bar will match size of ROW not the size of the element. Normally you never notice this due to where on a form the `Output` element goes. - -Listboxes are still without scrollwheels. The mouse can drag to see more items. The mouse scrollwheel will also scroll the list and will `page up` and `page down` keys. - -2.7 Is the "feature complete" release. Pretty much all features are done and in the code - -2.8 More text color controls. The caller has more control over things like the focus and what buttons should be clicked when enter key is pressed. Return values as a dictionary! (NICE addition) - -2.9 COLUMNS! This is the biggest feature and had the biggest impact on the code base. It was a difficult feature to add, but it was worth it. Can now make even more layouts. Almost any layout is possible with this addition. - -.................. insert releases 2.9 to 2.30 ................. - -3.0 We've come a long way baby! Time for a major revision bump. One reason is that the numbers started to confuse people the latest release was 2.30, but some people read it as 2.3 and thought it went backwards. I kinda messed up the 2.x series of numbers, so why not start with a clean slate. A lot has happened anyway so it's well earned. - -One change that will set PySimpleGUI apart is the parlor trick of being able to move the window by clicking on it anywhere. This is turned on by default. It's not a common way to interact with windows. Normally you have to move using the titlebar. Not so with PySimpleGUI. Now you can drag using any part of the window. You will want to turn off for windows with sliders. This feature is enabled in the Window call. - -Related to the Grab Anywhere feature is the no_titlebar option, again found in the call to Window. Your window will be a spiffy, borderless window. It's a really interesting effect. Slight problem is that you do not have an icon on the taskbar with these types of windows, so if you don't supply a button to close the window, there's no way to close it other than task manager. - -3.0.2 Still making changes to Update methods with many more ahead in the future. Continue to mess with grab anywhere option. Needed to disable in more places such as the PopupGetText function. Any time these is text input on a form, you generally want to turn off the grab anywhere feature. - -#### 3.2.0 - Biggest change was the addition of the Table Element. Trying to make changes so that form resizing is a possibility but unknown if will work in the long run. Removed all MsgBox, Get* functions and replaced with Popup functions. Popups had multiple new parameters added to change the look and feel of a popup. - -#### 3.3.0 -OneLineProgressMeter function added which gives you not only a one-line solution to progress meters, but it also gives you the ability to have more than 1 running at the same time, something not possible with the EasyProgressMeterCall - -#### 3.4.0 - -* Frame - New Element - a labelled frame for grouping elements. Similar - to Column -* Graph (like a Canvas element except uses the caller's - coordinate system rather than tkinter's). -* initial_folder - sets starting folder for browsing type buttons (browse for file/folder). -* Buttons return key value rather than button text **If** a `key` is specified, -* - OneLineProgressMeter! Replaced EasyProgressMeter (sorry folks that's - the way progress works sometimes) - * Popup - changed ALL of the Popup calls to provide many more customization settings - * Popup - * PopupGetFolder - * PopupGetFile - * PopupGetText - * Popup - * PopupNoButtons - * PopupNonBlocking - * PopupNoTitlebar - * PopupAutoClose - * PopupCancel - * PopupOK - * PopupOKCancel - * PopupYesNo - -#### 3.4.1 -* Button.GetText - Button class method. Returns the current text being shown on a button. -* Menu - Tearoff option. Determines if menus should allow them to be torn off -* Help - Shorcut button. Like Submit, cancel, etc -* ReadButton - shortcut for ReadFormButton - -#### 3.5.0 -* Tool Tips for all elements -* Clickable text -* Text Element relief setting -* Keys as targets for buttons -* New names for buttons: - * Button = SimpleButton - * RButton = ReadButton = ReadFormButton -* Double clickable list entries -* Auto sizing table widths works now -* Feature DELETED - Scaling. Removed from all elements - -#### 3.5.1 -* Bug fix for broken PySimpleGUI if Python version < 3.6 (sorry!) -* LOTS of Readme changes - -#### 3.5.2 -* Made `Finalize()` in a way that it can be chained -* Fixed bug in return values from Frame Element contents - -#### 3.6.0 -* Renamed FlexForm to Window -* Removed LookAndFeel capability from Mac platform. - -#### 3.8.0 -* Tab and TabGroup Elements - awesome new capabilities - -#### 1.0.0 Python 2.7 -It's official. There is a 2.7 version of PySimpleGUI! - -#### 3.8.2 -* Exposed `TKOut` in Output Element -* `DrawText` added to Graph Elements -* Removed `Window.UpdateElements` -* `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) - -#### 3.8.6 - -* Fix for Menus. -* Fixed table colors. Now they work -* Fixed returning keys for tabs -* Window Hide / UnHide methods -* Changed all Popups to remove context manager -* Error checking for Graphing objects and for Element Updates - -### 3.9.0 & 1.1.0 -* The FIRST UNIFIED version of the code! -* Python 2.7 got a TON of features . Look back to 1.0 release for the list -* Tab locations - Can place Tabs on top, bottom, left, right now instead of only the top - -### 3.9.1 & 1.1.2 -* Tab features - * Themes - * Enable / Disable - * Tab text colors - * Selected tab color -* New GetListValues method for Listbox -* Can now have multiple progress bars in 1 window -* Fix for closing debug-output window with other windows open -* Topanga Look and Feel setting -* User can create new look and feel settings / can access the look and feel table -* New PopupQuick call. Shows a non-blocking popup window with auto-close -* Tree Element partially done (don't use despite it showing up) - -### 3.9.3 & 1.1.3 - -* Disabled setting when creating element for: - * Input - * Combo - * Option Menu - * Listbox - * Radio - * Checkbox - * Spinner - * Multiline - * Buttons - * Slider -* Doc strings on all Elements updated -* Buttons can take image data as well as image files -* Button Update can change images -* Images can have background color -* Table element new num_rows parameter -* Table Element new alternating_row_color parameter -* Tree Element -* Window Disappear / Reappear methods -* Popup buttons resized to same size -* Exposed look and feel table - + +## Release Notes +2.3 - Sliders, Listbox's and Image elements (oh my!) + +If using Progress Meters, avoid cancelling them when you have another window open. It could lead to future windows being blank. It's being worked on. + +New debug printing capability. `sg.Print` + +2.5 Discovered issue with scroll bar on `Output` elements. The bar will match size of ROW not the size of the element. Normally you never notice this due to where on a form the `Output` element goes. + +Listboxes are still without scrollwheels. The mouse can drag to see more items. The mouse scrollwheel will also scroll the list and will `page up` and `page down` keys. + +2.7 Is the "feature complete" release. Pretty much all features are done and in the code + +2.8 More text color controls. The caller has more control over things like the focus and what buttons should be clicked when enter key is pressed. Return values as a dictionary! (NICE addition) + +2.9 COLUMNS! This is the biggest feature and had the biggest impact on the code base. It was a difficult feature to add, but it was worth it. Can now make even more layouts. Almost any layout is possible with this addition. + +.................. insert releases 2.9 to 2.30 ................. + +3.0 We've come a long way baby! Time for a major revision bump. One reason is that the numbers started to confuse people the latest release was 2.30, but some people read it as 2.3 and thought it went backwards. I kinda messed up the 2.x series of numbers, so why not start with a clean slate. A lot has happened anyway so it's well earned. + +One change that will set PySimpleGUI apart is the parlor trick of being able to move the window by clicking on it anywhere. This is turned on by default. It's not a common way to interact with windows. Normally you have to move using the titlebar. Not so with PySimpleGUI. Now you can drag using any part of the window. You will want to turn off for windows with sliders. This feature is enabled in the Window call. + +Related to the Grab Anywhere feature is the no_titlebar option, again found in the call to Window. Your window will be a spiffy, borderless window. It's a really interesting effect. Slight problem is that you do not have an icon on the taskbar with these types of windows, so if you don't supply a button to close the window, there's no way to close it other than task manager. + +3.0.2 Still making changes to Update methods with many more ahead in the future. Continue to mess with grab anywhere option. Needed to disable in more places such as the PopupGetText function. Any time these is text input on a form, you generally want to turn off the grab anywhere feature. + +#### 3.2.0 + Biggest change was the addition of the Table Element. Trying to make changes so that form resizing is a possibility but unknown if will work in the long run. Removed all MsgBox, Get* functions and replaced with Popup functions. Popups had multiple new parameters added to change the look and feel of a popup. + +#### 3.3.0 +OneLineProgressMeter function added which gives you not only a one-line solution to progress meters, but it also gives you the ability to have more than 1 running at the same time, something not possible with the EasyProgressMeterCall + +#### 3.4.0 + +* Frame - New Element - a labelled frame for grouping elements. Similar + to Column +* Graph (like a Canvas element except uses the caller's + coordinate system rather than tkinter's). +* initial_folder - sets starting folder for browsing type buttons (browse for file/folder). +* Buttons return key value rather than button text **If** a `key` is specified, +* + OneLineProgressMeter! Replaced EasyProgressMeter (sorry folks that's + the way progress works sometimes) + * Popup - changed ALL of the Popup calls to provide many more customization settings + * Popup + * PopupGetFolder + * PopupGetFile + * PopupGetText + * Popup + * PopupNoButtons + * PopupNonBlocking + * PopupNoTitlebar + * PopupAutoClose + * PopupCancel + * PopupOK + * PopupOKCancel + * PopupYesNo + +#### 3.4.1 +* Button.GetText - Button class method. Returns the current text being shown on a button. +* Menu - Tearoff option. Determines if menus should allow them to be torn off +* Help - Shorcut button. Like Submit, cancel, etc +* ReadButton - shortcut for ReadFormButton + +#### 3.5.0 +* Tool Tips for all elements +* Clickable text +* Text Element relief setting +* Keys as targets for buttons +* New names for buttons: + * Button = SimpleButton + * RButton = ReadButton = ReadFormButton +* Double clickable list entries +* Auto sizing table widths works now +* Feature DELETED - Scaling. Removed from all elements + +#### 3.5.1 +* Bug fix for broken PySimpleGUI if Python version < 3.6 (sorry!) +* LOTS of Readme changes + +#### 3.5.2 +* Made `Finalize()` in a way that it can be chained +* Fixed bug in return values from Frame Element contents + +#### 3.6.0 +* Renamed FlexForm to Window +* Removed LookAndFeel capability from Mac platform. + +#### 3.8.0 +* Tab and TabGroup Elements - awesome new capabilities + +#### 1.0.0 Python 2.7 +It's official. There is a 2.7 version of PySimpleGUI! + +#### 3.8.2 +* Exposed `TKOut` in Output Element +* `DrawText` added to Graph Elements +* Removed `Window.UpdateElements` +* `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) + +#### 3.8.6 + +* Fix for Menus. +* Fixed table colors. Now they work +* Fixed returning keys for tabs +* Window Hide / UnHide methods +* Changed all Popups to remove context manager +* Error checking for Graphing objects and for Element Updates + +### 3.9.0 & 1.1.0 +* The FIRST UNIFIED version of the code! +* Python 2.7 got a TON of features . Look back to 1.0 release for the list +* Tab locations - Can place Tabs on top, bottom, left, right now instead of only the top + +### 3.9.1 & 1.1.2 +* Tab features + * Themes + * Enable / Disable + * Tab text colors + * Selected tab color +* New GetListValues method for Listbox +* Can now have multiple progress bars in 1 window +* Fix for closing debug-output window with other windows open +* Topanga Look and Feel setting +* User can create new look and feel settings / can access the look and feel table +* New PopupQuick call. Shows a non-blocking popup window with auto-close +* Tree Element partially done (don't use despite it showing up) + +### 3.9.3 & 1.1.3 + +* Disabled setting when creating element for: + * Input + * Combo + * Option Menu + * Listbox + * Radio + * Checkbox + * Spinner + * Multiline + * Buttons + * Slider +* Doc strings on all Elements updated +* Buttons can take image data as well as image files +* Button Update can change images +* Images can have background color +* Table element new num_rows parameter +* Table Element new alternating_row_color parameter +* Tree Element +* Window Disappear / Reappear methods +* Popup buttons resized to same size +* Exposed look and feel table + ### 3.9.4 & 1.1.4 * Parameter order change for Button.Update so that new button ext is at front @@ -5672,15 +4694,15 @@ Emergency patch release... going out same day as previous release * Option to close calendar chooser when date selected * Update for Tree Element * Scroll bars for Trees - + ### 3.14.0 & 1.14.0 -* More windowing changes... - * using a hidden root windowing (Tk()) - * all children are Toplevel() windows +* More windowing changes... + * using a hidden root windowing (Tk()) + * all children are Toplevel() windows * Read only setting for: - * Input Text - * Multiline + * Input Text + * Multiline * Font setting for InputCombo, Multiline * change_submits setting for Radio Element * SetFocus for multiline, input elements @@ -5690,19 +4712,19 @@ Emergency patch release... going out same day as previous release * Fix for closing windows using X * CurrentLocation method for Windows * Debug Window options - * location - * font - * no_button - * no_titlebar - * grab_anywhere - * keep_on_top + * location + * font + * no_button + * no_titlebar + * grab_anywhere + * keep_on_top * New Print / EasyPrint options - * location - * font - * no_button - * no_titlebar - * grab_anywhere - * keep_on_top + * location + * font + * no_button + * no_titlebar + * grab_anywhere + * keep_on_top * New popup, PopupQuickMessage * PopupGetFolder, PopupGetFile new initial_folder parm @@ -5713,16 +4735,16 @@ Emergency patch release... going out same day as previous release * Text color, background color added to multiline element.Update * Update method for Output Element - gives ability to clear the output * Graph Element - Read returns values if new flages set - * Change submits, drag submits - * Returns x,y coordinates + * Change submits, drag submits + * Returns x,y coordinates * Column element new parm vertical_scroll_only * Table element new parm - bind return key - returns if return or double click * New Window parms - size, disable_close * "Better" multiwindow capabilities * Window.Size property * Popups - new title parm, custom_text - * title sets the window title - * custom_text - single string or tuple string sets text on button(s) + * title sets the window title + * custom_text - single string or tuple string sets text on button(s) ### 3.16.0 & 1.16.0 * Bug fix in PopupScrolled @@ -5752,7 +4774,7 @@ Emergency patch release... going out same day as previous release ## 3.18.0 11-Dec-2018 NOTE - **Menus are broken** on version 2.7. Don't know how long they've been this way. Please get off legacy Python if that's what you're running. - + * Default progress bar length changed to shorter * Master window and tracking of num open windows moved from global to Window class variable * Element visibility setting (when created and when Updating element) @@ -5897,8 +4919,8 @@ Mixup.... 3.26 changes don't appear to have been correctly released so releasing * NEW Window Parameter - layout - second parameter. Can pass in layout directly now! * New shortcuts - * I = InputText - * B = Btn = Butt = Button + * I = InputText + * B = Btn = Butt = Button * Convert button text to string when creating buttons * Buttons are returned now as well as input fields when searching for element with focus @@ -5916,8 +4938,8 @@ Mixup.... 3.26 changes don't appear to have been correctly released so releasing * New Radio Element method - `Radio.ResetGroup()` sets all elements in the Radio Group to False* Added borderwidth to Multiline Element * `Button.Click()` - new method - Generates a button click even as if a user clicked a button (at the tkinter level) * Made a Graph.Images dictionary to keep track of images being used in a graph. When graph is deleted, all of the accociated images should be deleted too.' -* Added `Graph.SetFocus()` to give a Graph Element the focus just as you can input elements -* Table new parameter - `hide_vertical_scroll` if True will hide the table's vertical bars +* Added `Graph.SetFocus()` to give a Graph Element the focus just as you can input elements +* Table new parameter - `hide_vertical_scroll` if True will hide the table's vertical bars * Window - new parameter - `transparent_color`. Causes a single color to become completely transparent such that you see through the window, you can click through the window. Its like tineows never was there. * The new `Window.AllKeysDict = {}` has been adopted by all PySimpleGUI ports. It's a new method of automatically creating missing keys, storing and retrieving keys in general for a window. * Changed how `window.Maximize` is implemented previously used the '-fullscreen' attribute. Now uses the 'zoomed' state @@ -5927,7 +4949,7 @@ Mixup.... 3.26 changes don't appear to have been correctly released so releasing * An Element's Widget stored in `.Widget` attribute * Making ComboBox's ID unique by using it's Key * Changed Multiline to be sunken and have a border depth setting now -* Removed a second canvas that was being used for Graph element. +* Removed a second canvas that was being used for Graph element. * Changed how no titlebar is implemented running on Linux versus Windows. -type splash now used for Linux * PopupScrolled - Added back using CloseButton to close the window * Fixed PopupGetFolder to use correct PySimpleGUI program constructs (keys) @@ -5959,8 +4981,8 @@ A combination of user requests, and needs of new `imwatchingyou` debugger * New Debugger Icon for future built-in debugger * Fixed bug in FindBoundReturnKey - needed to also check Panes * NEW Window functions to turn on/off the Grab Anywhere feature - * `Window.GrabAnyWhereOn()` - * `Window.GrabAnyWhereOff()` + * `Window.GrabAnyWhereOn()` + * `Window.GrabAnyWhereOff()` * New "Debugger" button that's built-in like other buttons. It's a TINY button with a logo. For future use when a debugger is built into PySimpleGUI itself (SOON!) * Change Text Element Wrap Length calculation. Went fromn +40 pixels to +10 pixels in formula * PopupGetFile has new parameter - `multiple_files`. If True then allows selection of multiple files @@ -5976,7 +4998,7 @@ A combination of user requests, and needs of new `imwatchingyou` debugger * New parameters to CalendarButton - `locale`, `format` * The bulk of the built-in PySimpleGUI debugger has been added but is not yet "officially supported". Try pressing "break" or "ctrl+break" on your keyboard. * New bindings for break / pause button and debugger - * New Debug button will launch debugger. + * New Debug button will launch debugger. * New parameter `debugger_enabled` added to Window call. Default is __enabled__. * Your progam's call to Read is all that's needed to refresh debugger * New `Window` methods to control debugger access @@ -6002,9 +5024,9 @@ A combination of user requests, and needs of new `imwatchingyou` debugger ## 3.39 PySimpleGUI & 1.39 PySimpleGUI27 13-June-2019 * Ported the imwatchingyou debugger code into PySimpleGUI code - * Replaced old debugger built-in code with the newer imwatchingyou version - * Required removing all of the 'sg.' before PySimpleGUI calls since not importing - * Dynamically create the debugger object when first call to `refresh` or `show` is made + * Replaced old debugger built-in code with the newer imwatchingyou version + * Required removing all of the 'sg.' before PySimpleGUI calls since not importing + * Dynamically create the debugger object when first call to `refresh` or `show` is made * Started the procecss of renaming Class Methods that are private to start with _ * Needed for the automatic documentation generation that's being worked on * Fixed crash when clicking the Debug button @@ -6013,71 +5035,71 @@ A combination of user requests, and needs of new `imwatchingyou` debugger * New `TabGroup` method `SelectTab(index)` selects a `Tab` within a `TabGroup` * New `Table.Update` parameter - `select_rows`. List of rows to select (0 is first) * Error checking in `Window.Layout` provides error "hints" to the user - * Looks for badly placed ']' - * Looks for functions missing '()' - * Pops up a window warning user instead of crashing - * May have to revisit if the popups start getting in the way + * Looks for badly placed ']' + * Looks for functions missing '()' + * Pops up a window warning user instead of crashing + * May have to revisit if the popups start getting in the way * New implementations of `Window.Disable()` and `Window.Enable()` - * Previously did not work correctly at all - * Now using the "-disabled" attribute + * Previously did not work correctly at all + * Now using the "-disabled" attribute * Allow Comboboxes to have empty starting values - * Was crashing - * Enables application to fill these in later + * Was crashing + * Enables application to fill these in later -### Upcoming -Make suggestions people! Future release features - - -## Code Condition - - Make it run - Make it right - Make it fast - -It's a recipe for success if done right. PySimpleGUI has completed the "Make it run" phase. It's far from "right" in many ways. These are being worked on. The module is particularly poor for PEP 8 compliance. It was a learning exercise that turned into a somewhat complete GUI solution for lightweight problems. - -While the internals to PySimpleGUI are a tad sketchy, the public interfaces into the SDK are more strictly defined and comply with PEP 8 for the most part. - -Please log bugs and suggestions in the GitHub! It will only make the code stronger and better in the end, a good thing for us all, right? - -## Design - -A moment about the design-spirit of `PySimpleGUI`. From the beginning, this package was meant to take advantage of Python's capabilities with the goal of programming ease. - -**Single File** -While not the best programming practice, the implementation resulted in a single file solution. Only one file is needed, PySimpleGUI.py. You can post this file, email it, and easily import it using one statement. - -**Functions as objects** -In Python, functions behave just like object. When you're placing a Text Element into your form, you may be sometimes calling a function and other times declaring an object. If you use the word Text, then you're getting an object. If you're using `Txt`, then you're calling a function that returns a `Text` object. - -**Lists** -It seemed quite natural to use Python's powerful list constructs when possible. The form is specified as a series of lists. Each "row" of the GUI is represented as a list of Elements. When the form read returns the results to the user, all of the results are presented as a single list. This makes reading a form's values super-simple to do in a single line of Python code. - -**Dictionaries** -Want to view your form's results as a dictionary instead of a list... no problem, just use the `key` keyword on your elements. For complex forms with a lot of values that need to be changed frequently, this is by far the best way of consuming the results. - -You can also look up elements using their keys. This is an excellent way to update elements in reaction to another element. Call `form.FindElement(key)` to get the Element. - -**Named / Optional Parameters** -This is a language feature that is featured **heavily** in all of the API calls, both functions and classes. Elements are configured, in-place, by setting one or more optional parameters. For example, a Text element's color is chosen by setting the optional `text_color` parameter. +### Upcoming +Make suggestions people! Future release features + + +## Code Condition + + Make it run + Make it right + Make it fast + +It's a recipe for success if done right. PySimpleGUI has completed the "Make it run" phase. It's far from "right" in many ways. These are being worked on. The module is particularly poor for PEP 8 compliance. It was a learning exercise that turned into a somewhat complete GUI solution for lightweight problems. + +While the internals to PySimpleGUI are a tad sketchy, the public interfaces into the SDK are more strictly defined and comply with PEP 8 for the most part. + +Please log bugs and suggestions in the GitHub! It will only make the code stronger and better in the end, a good thing for us all, right? + +## Design + +A moment about the design-spirit of `PySimpleGUI`. From the beginning, this package was meant to take advantage of Python's capabilities with the goal of programming ease. + +**Single File** +While not the best programming practice, the implementation resulted in a single file solution. Only one file is needed, PySimpleGUI.py. You can post this file, email it, and easily import it using one statement. + +**Functions as objects** +In Python, functions behave just like object. When you're placing a Text Element into your form, you may be sometimes calling a function and other times declaring an object. If you use the word Text, then you're getting an object. If you're using `Txt`, then you're calling a function that returns a `Text` object. + +**Lists** +It seemed quite natural to use Python's powerful list constructs when possible. The form is specified as a series of lists. Each "row" of the GUI is represented as a list of Elements. When the form read returns the results to the user, all of the results are presented as a single list. This makes reading a form's values super-simple to do in a single line of Python code. + +**Dictionaries** +Want to view your form's results as a dictionary instead of a list... no problem, just use the `key` keyword on your elements. For complex forms with a lot of values that need to be changed frequently, this is by far the best way of consuming the results. + +You can also look up elements using their keys. This is an excellent way to update elements in reaction to another element. Call `form.FindElement(key)` to get the Element. + +**Named / Optional Parameters** +This is a language feature that is featured **heavily** in all of the API calls, both functions and classes. Elements are configured, in-place, by setting one or more optional parameters. For example, a Text element's color is chosen by setting the optional `text_color` parameter. **tkinter** tkinter is the "official" GUI that Python supports. It runs on Windows, Linux, and Mac. It was chosen as the first target GUI framework due to its ***ubiquity***. Nearly all Python installations, with the exception of Ubuntu Linux, come pre-loaded with tkinter. It is the "simplest" of the GUI frameworks to get up an running (among Qt, WxPython, Kivy, etc). From the start of the PSG project, tkinter was not meant to be the only underlying GUI framework for PySimpleGUI. It is merely a starting point. All journeys begin with one step forward and choosing tkinter was the first of many steps for PySimpleGUI. Now there are 4 ports up and running - tkinter, WxPython, Qt and Remi (web support) - -## Author + +## Author Mike - who wrote PySimpleGUI is not important. It's the software that's important + - -## License - -GNU Lesser General Public License (LGPL 3) + - -## Acknowledgments +## License + +GNU Lesser General Public License (LGPL 3) + + +## Acknowledgments #### SORRY!! Will add these back. Lost due to file length limitation