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

Changed all element.update methods to inform user that helpful function "pin" is needed when using visibility.

Browse source
This commit is contained in:
PySimpleGUI 2022-01-09 21:07:36 -05:00
parent 49013fbbbf
commit 5468b68a03
3 changed files with 629 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

136
PySimpleGUI.py
View file

@ -10,6 +10,9 @@ _change_log = """
Added OptionMenu to the list of tkinter widgets that are ignored when the grab anywhere feature is used
4.56.0.3
Slider - update the range FIRST and then the value in the update method (thank you Jason for the fix)
4.56.0.4
Updated docstrings for all Element.update methods to indicate that the helper function "pin" need to be used to keep an element
in place if visibility changes
"""
__version__ = version.split()[0] # For PEP 396 and PEP 345
@ -1563,7 +1566,10 @@ class Element():
"""
A dummy update call. This will only be called if an element hasn't implemented an update method
It is provided here for docstring purposes. If you got here by browing code via PyCharm, know
that this is not the function that will be called. Your actual element's update method will be called
that this is not the function that will be called. Your actual element's update method will be called.
If you call update, you must call window.refresh if you want the change to happen prior to your next
window.read() call. Normally uou don't do this as the window.read call is likely going to happen next.
"""
print('* Base Element Class update was called. Your element does not seem to have an update method')
@ -1691,6 +1697,10 @@ class Input(Element):
Changes some of the settings for the Input Element. Must call `Window.Read` or `Window.Finalize` prior.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param value: new text to display as default text in Input field
:type value: (str)
:param disabled: disable or enable state of the element (sets Entry Widget to readonly or normal)
@ -1858,7 +1868,13 @@ class Combo(Element):
Note that the state can be in 3 states only.... enabled, disabled, readonly even
though more combinations are available. The easy way to remember is that if you
change the readonly parameter then you are enabling the element.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param value: change which value is current selected based on new list of previous list of choices
:type value: (Any)
:param values: change list of choices
@ -2040,7 +2056,13 @@ class OptionMenu(Element):
def update(self, value=None, values=None, disabled=None, visible=None, size=(None, None)):
"""
Changes some of the settings for the OptionMenu Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param value: the value to choose by default
:type value: (Any)
:param values: Values to be displayed
@ -2208,6 +2230,11 @@ class Listbox(Element):
"""
Changes some of the settings for the Listbox Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param values: new list of choices to be shown to user
:type values: List[Any]
:param disabled: disable or enable state of the element
@ -2429,7 +2456,13 @@ class Radio(Element):
def update(self, value=None, text=None, background_color=None, text_color=None, circle_color=None, disabled=None, visible=None):
"""
Changes some of the settings for the Radio Button Element. Must call `Window.read` or `Window.finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param value: if True change to selected and set others in group to unselected
:type value: (bool)
:param text: Text to display next to radio button
@ -2629,7 +2662,13 @@ class Checkbox(Element):
"""
Changes some of the settings for the Checkbox Element. Must call `Window.Read` or `Window.Finalize` prior.
Note that changing visibility may cause element to change locations when made visible after invisible
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param value: if True checks the checkbox, False clears it
:type value: (bool)
:param text: Text to display next to checkbox
@ -2789,7 +2828,13 @@ class Spin(Element):
Note that the state can be in 3 states only.... enabled, disabled, readonly even
though more combinations are available. The easy way to remember is that if you
change the readonly parameter then you are enabling the element.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param value: set the current value from list of choices
:type value: (Any)
:param values: set available choices
@ -3005,7 +3050,13 @@ class Multiline(Element):
background_color_for_value=None, visible=None, autoscroll=None, justification=None, font_for_value=None):
"""
Changes some of the settings for the Multiline Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param value: new text to display
:type value: (Any)
:param disabled: disable or enable state of the element
@ -3349,7 +3400,13 @@ class Text(Element):
def update(self, value=None, background_color=None, text_color=None, font=None, visible=None):
"""
Changes some of the settings for the Text Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param value: new text to show
:type value: (str)
:param background_color: color of background
@ -3680,7 +3737,13 @@ class StatusBar(Element):
def update(self, value=None, background_color=None, text_color=None, font=None, visible=None):
"""
Changes some of the settings for the Status Bar Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param value: new text to show
:type value: (str)
:param background_color: color of background
@ -3999,8 +4062,13 @@ class Output(Element):
def update(self, value=None, visible=None):
"""
Changes some of the settings for the Output Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param value: string that will replace current contents of the output area
:type value: (str)
:param visible: control visibility of element
@ -4451,8 +4519,13 @@ class Button(Element):
visible=None, image_subsample=None, disabled_button_color=(None, None), image_size=None):
"""
Changes some of the settings for the Button Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param text: sets button text
:type text: (str)
:param button_color: Color of button. default is from theme or the window. Easy to remember which is which if you say "ON" between colors. "red" on "green". Normally a tuple, but can be a simplified-button-color-string "foreground on background". Can be a single color if want to set only the background.
@ -4714,8 +4787,13 @@ class ButtonMenu(Element):
def update(self, menu_definition=None, visible=None, image_source=None, image_size=(None, None), image_subsample=None):
"""
Changes some of the settings for the ButtonMenu Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param menu_definition: (New menu definition (in menu definition format)
:type menu_definition: List[List]
:param visible: control visibility of element
@ -4908,8 +4986,13 @@ class ProgressBar(Element):
"""
Changes some of the settings for the ProgressBar Element. Must call `Window.Read` or `Window.Finalize` prior
Now has the ability to modify the count so that the update_bar method is not longer needed separately
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param current_count: sets the current value
:type current_count: (int)
:param max: changes the max value
@ -5044,7 +5127,13 @@ class Image(Element):
Changes some of the settings for the Image Element. Must call `Window.Read` or `Window.Finalize` prior.
To clear an image that's been displayed, call with NONE of the options set. A blank update call will
delete the previously shown image.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param source: A filename or a base64 bytes. Will automatically detect the type and fill in filename or data for you.
:type source: str | bytes | None
:param filename: filename to the new image to display.
@ -5766,8 +5855,13 @@ class Graph(Element):
def update(self, background_color=None, visible=None):
"""
Changes some of the settings for the Graph Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param background_color: color of background
:type background_color: ???
:param visible: control visibility of element
@ -6226,8 +6320,13 @@ class Frame(Element):
def update(self, value=None, visible=None):
"""
Changes some of the settings for the Frame Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param value: New text value to show on frame
:type value: (Any)
:param visible: control visibility of element
@ -6533,8 +6632,13 @@ class Tab(Element):
def update(self, title=None, disabled=None, visible=None):
"""
Changes some of the settings for the Tab Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param title: tab title
:type title: (str)
:param disabled: disable or enable state of the element
@ -6998,8 +7102,13 @@ class Slider(Element):
def update(self, value=None, range=(None, None), disabled=None, visible=None):
"""
Changes some of the settings for the Slider Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param value: sets current slider value
:type value: int | float
:param range: Sets a new range for slider
@ -7372,8 +7481,13 @@ class Column(Element):
def update(self, visible=None):
"""
Changes some of the settings for the Column Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param visible: control visibility of element
:type visible: (bool)
"""
@ -7496,8 +7610,13 @@ class Pane(Element):
def update(self, visible=None):
"""
Changes some of the settings for the Pane Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param visible: control visibility of element
:type visible: (bool)
"""
@ -7828,8 +7947,13 @@ class Menu(Element):
def update(self, menu_definition=None, visible=None):
"""
Update a menubar - can change the menu definition and visibility. The entire menu has to be specified
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param menu_definition: The menu definition list
:type menu_definition: List[List[Tuple[str, List[str]]]
:param visible: control visibility of element
@ -8036,8 +8160,13 @@ class Table(Element):
def update(self, values=None, num_rows=None, visible=None, select_rows=None, alternating_row_color=None, row_colors=None):
"""
Changes some of the settings for the Table Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param values: A new 2-dimensional table to show
:type values: List[List[str | int | float]]
:param num_rows: How many rows to display at a time
@ -8432,8 +8561,13 @@ class Tree(Element):
def update(self, values=None, key=None, value=None, text=None, icon=None, visible=None):
"""
Changes some of the settings for the Tree Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
:param values: Representation of the tree
:type values: (TreeData)
:param key: identifies a particular item in tree to update

250
docs/call reference.md
View file

@ -368,8 +368,13 @@ unhide_row()
### update
Changes some of the settings for the Button Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(text = None,
button_color = (None, None),
@ -462,8 +467,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Button Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(text = None,
button_color = (None, None),
@ -760,8 +770,13 @@ unhide_row()
### update
Changes some of the settings for the ButtonMenu Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(menu_definition = None,
visible = None,
@ -836,8 +851,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the ButtonMenu Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(menu_definition = None,
visible = None,
@ -1400,8 +1420,13 @@ unhide_row()
Changes some of the settings for the Checkbox Element. Must call `Window.Read` or `Window.Finalize` prior.
Note that changing visibility may cause element to change locations when made visible after invisible
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
text = None,
@ -1481,8 +1506,13 @@ Parameter Descriptions:
Changes some of the settings for the Checkbox Element. Must call `Window.Read` or `Window.Finalize` prior.
Note that changing visibility may cause element to change locations when made visible after invisible
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
text = None,
@ -1795,8 +1825,13 @@ unhide_row()
### update
Changes some of the settings for the Column Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(visible = None)
```
@ -1883,8 +1918,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Column Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(visible = None)
```
@ -2157,8 +2197,13 @@ Changes some of the settings for the Combo Element. Must call `Window.Read` or `
Note that the state can be in 3 states only.... enabled, disabled, readonly even
though more combinations are available. The easy way to remember is that if you
change the readonly parameter then you are enabling the element.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
values = None,
@ -2244,8 +2289,13 @@ Changes some of the settings for the Combo Element. Must call `Window.Read` or `
Note that the state can be in 3 states only.... enabled, disabled, readonly even
though more combinations are available. The easy way to remember is that if you
change the readonly parameter then you are enabling the element.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
values = None,
@ -2545,8 +2595,13 @@ unhide_row()
### update
Changes some of the settings for the Frame Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None, visible = None)
```
@ -2634,8 +2689,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Frame Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None, visible = None)
```
@ -2712,8 +2772,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Graph Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(background_color = None, visible = None)
```
@ -3271,8 +3336,13 @@ unhide_row()
### update
Changes some of the settings for the Graph Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(background_color = None, visible = None)
```
@ -4161,8 +4231,13 @@ unhide_row()
Changes some of the settings for the Image Element. Must call `Window.Read` or `Window.Finalize` prior.
To clear an image that's been displayed, call with NONE of the options set. A blank update call will
delete the previously shown image.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(source = None,
filename = None,
@ -4264,8 +4339,13 @@ Parameter Descriptions:
Changes some of the settings for the Image Element. Must call `Window.Read` or `Window.Finalize` prior.
To clear an image that's been displayed, call with NONE of the options set. A blank update call will
delete the previously shown image.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(source = None,
filename = None,
@ -4584,6 +4664,10 @@ unhide_row()
Changes some of the settings for the Input Element. Must call `Window.Read` or `Window.Finalize` prior.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
disabled = None,
@ -4667,6 +4751,10 @@ Parameter Descriptions:
Changes some of the settings for the Input Element. Must call `Window.Read` or `Window.Finalize` prior.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
disabled = None,
@ -5007,6 +5095,10 @@ unhide_row()
Changes some of the settings for the Listbox Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(values = None,
disabled = None,
@ -5110,6 +5202,10 @@ Parameter Descriptions:
Changes some of the settings for the Listbox Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(values = None,
disabled = None,
@ -5371,8 +5467,13 @@ unhide_row()
### update
Update a menubar - can change the menu definition and visibility. The entire menu has to be specified
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(menu_definition = None, visible = None)
```
@ -5431,8 +5532,13 @@ Parameter Descriptions:
### Update
Update a menubar - can change the menu definition and visibility. The entire menu has to be specified
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(menu_definition = None, visible = None)
```
@ -5867,8 +5973,13 @@ unhide_row()
### update
Changes some of the settings for the Multiline Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
disabled = None,
@ -5958,8 +6069,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Multiline Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
disabled = None,
@ -6243,8 +6359,13 @@ unhide_row()
### update
Changes some of the settings for the OptionMenu Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
values = None,
@ -6310,8 +6431,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the OptionMenu Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
values = None,
@ -6342,6 +6468,7 @@ You can control which Multiline Element receives your stdout output as well as u
The Multiline Element is the superior and recommended method for showing the output of stdout.
The Multiline Element has been added to significantly while the Output element has not.
If you choose to use a Multiline element to replace an Output element, be sure an turn on the write_only paramter in the Multline
Of course, Output Element continues to operate and be backwards compatible, but you're missing out on
features such as routing the cprint output to the element.
@ -6595,8 +6722,13 @@ unhide_row()
### update
Changes some of the settings for the Output Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None, visible = None)
```
@ -6675,8 +6807,13 @@ Returns the TKOutput object used to create the element
### Update
Changes some of the settings for the Output Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None, visible = None)
```
@ -6922,8 +7059,13 @@ unhide_row()
### update
Changes some of the settings for the Pane Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(visible = None)
```
@ -6981,8 +7123,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Pane Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(visible = None)
```
@ -7215,8 +7362,13 @@ unhide_row()
Changes some of the settings for the ProgressBar Element. Must call `Window.Read` or `Window.Finalize` prior
Now has the ability to modify the count so that the update_bar method is not longer needed separately
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(current_count = None,
max = None,
@ -7298,8 +7450,13 @@ Parameter Descriptions:
Changes some of the settings for the ProgressBar Element. Must call `Window.Read` or `Window.Finalize` prior
Now has the ability to modify the count so that the update_bar method is not longer needed separately
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(current_count = None,
max = None,
@ -7632,8 +7789,13 @@ unhide_row()
### update
Changes some of the settings for the Radio Button Element. Must call `Window.read` or `Window.finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
text = None,
@ -7721,8 +7883,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Radio Button Element. Must call `Window.read` or `Window.finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
text = None,
@ -7979,7 +8146,10 @@ unhide_row()
A dummy update call. This will only be called if an element hasn't implemented an update method
It is provided here for docstring purposes. If you got here by browing code via PyCharm, know
that this is not the function that will be called. Your actual element's update method will be called
that this is not the function that will be called. Your actual element's update method will be called.
If you call update, you must call window.refresh if you want the change to happen prior to your next
window.read() call. Normally uou don't do this as the window.read call is likely going to happen next.
```
update(args=*<1 or N object>, kwargs)
@ -8247,8 +8417,13 @@ unhide_row()
### update
Changes some of the settings for the Slider Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
range = (None, None),
@ -8312,8 +8487,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Slider Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
range = (None, None),
@ -8589,8 +8769,13 @@ Changes some of the settings for the Spin Element. Must call `Window.Read` or `W
Note that the state can be in 3 states only.... enabled, disabled, readonly even
though more combinations are available. The easy way to remember is that if you
change the readonly parameter then you are enabling the element.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
values = None,
@ -8671,8 +8856,13 @@ Changes some of the settings for the Spin Element. Must call `Window.Read` or `W
Note that the state can be in 3 states only.... enabled, disabled, readonly even
though more combinations are available. The easy way to remember is that if you
change the readonly parameter then you are enabling the element.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
values = None,
@ -8933,8 +9123,13 @@ unhide_row()
### update
Changes some of the settings for the Status Bar Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
background_color = None,
@ -9000,8 +9195,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Status Bar Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
background_color = None,
@ -9298,8 +9498,13 @@ unhide_row()
### update
Changes some of the settings for the Tab Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(title = None,
disabled = None,
@ -9398,8 +9603,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Tab Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(title = None,
disabled = None,
@ -10082,8 +10292,13 @@ unhide_row()
### update
Changes some of the settings for the Table Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(values = None,
num_rows = None,
@ -10163,8 +10378,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Table Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(values = None,
num_rows = None,
@ -10424,8 +10644,13 @@ unhide_row()
### update
Changes some of the settings for the Text Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
background_color = None,
@ -10501,8 +10726,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Text Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
background_color = None,
@ -10864,8 +11094,13 @@ unhide_row()
### update
Changes some of the settings for the Tree Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(values = None,
key = None,
@ -10933,8 +11168,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Tree Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(values = None,
key = None,
@ -17832,7 +18072,8 @@ set_options(icon = None,
pysimplegui_settings_filename = None,
keep_on_top = None,
dpi_awareness = None,
scaling = None)
scaling = None,
disable_modal_windows = None)
```
Parameter Descriptions:
@ -17892,6 +18133,7 @@ Parameter Descriptions:
| bool | keep_on_top | If True then all windows will automatically be set to keep_on_top=True |
| bool | dpi_awareness | If True then will turn on DPI awareness (Windows only at the moment) |
| float | scaling | Sets the default scaling for all windows including popups, etc. |
| bool | disable_modal_windows | If True then all windows, including popups, will not be modal windows |
| None | **RETURN** | None
### Non PEP8 versions
@ -17962,7 +18204,8 @@ SetOptions(icon = None,
pysimplegui_settings_filename = None,
keep_on_top = None,
dpi_awareness = None,
scaling = None)
scaling = None,
disable_modal_windows = None)
```
Parameter Descriptions:
@ -18022,6 +18265,7 @@ Parameter Descriptions:
| bool | keep_on_top | If True then all windows will automatically be set to keep_on_top=True |
| bool | dpi_awareness | If True then will turn on DPI awareness (Windows only at the moment) |
| float | scaling | Sets the default scaling for all windows including popups, etc. |
| bool | disable_modal_windows | If True then all windows, including popups, will not be modal windows |
| None | **RETURN** | None
## Old Themes (Look and Feel) - Replaced by theme()

250
readme_creator/output/call reference.md
View file

@ -368,8 +368,13 @@ unhide_row()
### update
Changes some of the settings for the Button Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(text = None,
button_color = (None, None),
@ -462,8 +467,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Button Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(text = None,
button_color = (None, None),
@ -760,8 +770,13 @@ unhide_row()
### update
Changes some of the settings for the ButtonMenu Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(menu_definition = None,
visible = None,
@ -836,8 +851,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the ButtonMenu Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(menu_definition = None,
visible = None,
@ -1400,8 +1420,13 @@ unhide_row()
Changes some of the settings for the Checkbox Element. Must call `Window.Read` or `Window.Finalize` prior.
Note that changing visibility may cause element to change locations when made visible after invisible
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
text = None,
@ -1481,8 +1506,13 @@ Parameter Descriptions:
Changes some of the settings for the Checkbox Element. Must call `Window.Read` or `Window.Finalize` prior.
Note that changing visibility may cause element to change locations when made visible after invisible
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
text = None,
@ -1795,8 +1825,13 @@ unhide_row()
### update
Changes some of the settings for the Column Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(visible = None)
```
@ -1883,8 +1918,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Column Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(visible = None)
```
@ -2157,8 +2197,13 @@ Changes some of the settings for the Combo Element. Must call `Window.Read` or `
Note that the state can be in 3 states only.... enabled, disabled, readonly even
though more combinations are available. The easy way to remember is that if you
change the readonly parameter then you are enabling the element.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
values = None,
@ -2244,8 +2289,13 @@ Changes some of the settings for the Combo Element. Must call `Window.Read` or `
Note that the state can be in 3 states only.... enabled, disabled, readonly even
though more combinations are available. The easy way to remember is that if you
change the readonly parameter then you are enabling the element.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
values = None,
@ -2545,8 +2595,13 @@ unhide_row()
### update
Changes some of the settings for the Frame Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None, visible = None)
```
@ -2634,8 +2689,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Frame Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None, visible = None)
```
@ -2712,8 +2772,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Graph Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(background_color = None, visible = None)
```
@ -3271,8 +3336,13 @@ unhide_row()
### update
Changes some of the settings for the Graph Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(background_color = None, visible = None)
```
@ -4161,8 +4231,13 @@ unhide_row()
Changes some of the settings for the Image Element. Must call `Window.Read` or `Window.Finalize` prior.
To clear an image that's been displayed, call with NONE of the options set. A blank update call will
delete the previously shown image.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(source = None,
filename = None,
@ -4264,8 +4339,13 @@ Parameter Descriptions:
Changes some of the settings for the Image Element. Must call `Window.Read` or `Window.Finalize` prior.
To clear an image that's been displayed, call with NONE of the options set. A blank update call will
delete the previously shown image.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(source = None,
filename = None,
@ -4584,6 +4664,10 @@ unhide_row()
Changes some of the settings for the Input Element. Must call `Window.Read` or `Window.Finalize` prior.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
disabled = None,
@ -4667,6 +4751,10 @@ Parameter Descriptions:
Changes some of the settings for the Input Element. Must call `Window.Read` or `Window.Finalize` prior.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
disabled = None,
@ -5007,6 +5095,10 @@ unhide_row()
Changes some of the settings for the Listbox Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(values = None,
disabled = None,
@ -5110,6 +5202,10 @@ Parameter Descriptions:
Changes some of the settings for the Listbox Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(values = None,
disabled = None,
@ -5371,8 +5467,13 @@ unhide_row()
### update
Update a menubar - can change the menu definition and visibility. The entire menu has to be specified
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(menu_definition = None, visible = None)
```
@ -5431,8 +5532,13 @@ Parameter Descriptions:
### Update
Update a menubar - can change the menu definition and visibility. The entire menu has to be specified
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(menu_definition = None, visible = None)
```
@ -5867,8 +5973,13 @@ unhide_row()
### update
Changes some of the settings for the Multiline Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
disabled = None,
@ -5958,8 +6069,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Multiline Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
disabled = None,
@ -6243,8 +6359,13 @@ unhide_row()
### update
Changes some of the settings for the OptionMenu Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
values = None,
@ -6310,8 +6431,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the OptionMenu Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
values = None,
@ -6342,6 +6468,7 @@ You can control which Multiline Element receives your stdout output as well as u
The Multiline Element is the superior and recommended method for showing the output of stdout.
The Multiline Element has been added to significantly while the Output element has not.
If you choose to use a Multiline element to replace an Output element, be sure an turn on the write_only paramter in the Multline
Of course, Output Element continues to operate and be backwards compatible, but you're missing out on
features such as routing the cprint output to the element.
@ -6595,8 +6722,13 @@ unhide_row()
### update
Changes some of the settings for the Output Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None, visible = None)
```
@ -6675,8 +6807,13 @@ Returns the TKOutput object used to create the element
### Update
Changes some of the settings for the Output Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None, visible = None)
```
@ -6922,8 +7059,13 @@ unhide_row()
### update
Changes some of the settings for the Pane Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(visible = None)
```
@ -6981,8 +7123,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Pane Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(visible = None)
```
@ -7215,8 +7362,13 @@ unhide_row()
Changes some of the settings for the ProgressBar Element. Must call `Window.Read` or `Window.Finalize` prior
Now has the ability to modify the count so that the update_bar method is not longer needed separately
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(current_count = None,
max = None,
@ -7298,8 +7450,13 @@ Parameter Descriptions:
Changes some of the settings for the ProgressBar Element. Must call `Window.Read` or `Window.Finalize` prior
Now has the ability to modify the count so that the update_bar method is not longer needed separately
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(current_count = None,
max = None,
@ -7632,8 +7789,13 @@ unhide_row()
### update
Changes some of the settings for the Radio Button Element. Must call `Window.read` or `Window.finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
text = None,
@ -7721,8 +7883,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Radio Button Element. Must call `Window.read` or `Window.finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
text = None,
@ -7979,7 +8146,10 @@ unhide_row()
A dummy update call. This will only be called if an element hasn't implemented an update method
It is provided here for docstring purposes. If you got here by browing code via PyCharm, know
that this is not the function that will be called. Your actual element's update method will be called
that this is not the function that will be called. Your actual element's update method will be called.
If you call update, you must call window.refresh if you want the change to happen prior to your next
window.read() call. Normally uou don't do this as the window.read call is likely going to happen next.
```
update(args=*<1 or N object>, kwargs)
@ -8247,8 +8417,13 @@ unhide_row()
### update
Changes some of the settings for the Slider Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
range = (None, None),
@ -8312,8 +8487,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Slider Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
range = (None, None),
@ -8589,8 +8769,13 @@ Changes some of the settings for the Spin Element. Must call `Window.Read` or `W
Note that the state can be in 3 states only.... enabled, disabled, readonly even
though more combinations are available. The easy way to remember is that if you
change the readonly parameter then you are enabling the element.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
values = None,
@ -8671,8 +8856,13 @@ Changes some of the settings for the Spin Element. Must call `Window.Read` or `W
Note that the state can be in 3 states only.... enabled, disabled, readonly even
though more combinations are available. The easy way to remember is that if you
change the readonly parameter then you are enabling the element.
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
values = None,
@ -8933,8 +9123,13 @@ unhide_row()
### update
Changes some of the settings for the Status Bar Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
background_color = None,
@ -9000,8 +9195,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Status Bar Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
background_color = None,
@ -9298,8 +9498,13 @@ unhide_row()
### update
Changes some of the settings for the Tab Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(title = None,
disabled = None,
@ -9398,8 +9603,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Tab Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(title = None,
disabled = None,
@ -10082,8 +10292,13 @@ unhide_row()
### update
Changes some of the settings for the Table Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(values = None,
num_rows = None,
@ -10163,8 +10378,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Table Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(values = None,
num_rows = None,
@ -10424,8 +10644,13 @@ unhide_row()
### update
Changes some of the settings for the Text Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(value = None,
background_color = None,
@ -10501,8 +10726,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Text Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(value = None,
background_color = None,
@ -10864,8 +11094,13 @@ unhide_row()
### update
Changes some of the settings for the Tree Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
update(values = None,
key = None,
@ -10933,8 +11168,13 @@ Parameter Descriptions:
### Update
Changes some of the settings for the Tree Element. Must call `Window.Read` or `Window.Finalize` prior
Changes will not be visible in your window until you call window.read or window.refresh.
If you change visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
when made visible.
```
Update(values = None,
key = None,
@ -17832,7 +18072,8 @@ set_options(icon = None,
pysimplegui_settings_filename = None,
keep_on_top = None,
dpi_awareness = None,
scaling = None)
scaling = None,
disable_modal_windows = None)
```
Parameter Descriptions:
@ -17892,6 +18133,7 @@ Parameter Descriptions:
| bool | keep_on_top | If True then all windows will automatically be set to keep_on_top=True |
| bool | dpi_awareness | If True then will turn on DPI awareness (Windows only at the moment) |
| float | scaling | Sets the default scaling for all windows including popups, etc. |
| bool | disable_modal_windows | If True then all windows, including popups, will not be modal windows |
| None | **RETURN** | None
### Non PEP8 versions
@ -17962,7 +18204,8 @@ SetOptions(icon = None,
pysimplegui_settings_filename = None,
keep_on_top = None,
dpi_awareness = None,
scaling = None)
scaling = None,
disable_modal_windows = None)
```
Parameter Descriptions:
@ -18022,6 +18265,7 @@ Parameter Descriptions:
| bool | keep_on_top | If True then all windows will automatically be set to keep_on_top=True |
| bool | dpi_awareness | If True then will turn on DPI awareness (Windows only at the moment) |
| float | scaling | Sets the default scaling for all windows including popups, etc. |
| bool | disable_modal_windows | If True then all windows, including popups, will not be modal windows |
| None | **RETURN** | None
## Old Themes (Look and Feel) - Replaced by theme()