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

Element.metadata turned into a property so that it's documented property

This commit is contained in:
PySimpleGUI 2021-01-17 12:38:35 -05:00
parent 5510fad39e
commit 55871d89bf
1 changed files with 26 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
PySimpleGUI.py
View File

@ -1,5 +1,5 @@
#!/usr/bin/python3 #!/usr/bin/python3
version = __version__ = "4.33.0.4 Unreleased\nAliases shown SDK reference, popup_scrolled fix, summary mode for SDK help, BIG PEP8 definition swap" version = __version__ = "4.33.0.5 Unreleased\nAliases shown SDK reference, popup_scrolled fix, summary mode for SDK help, BIG PEP8 definition swap, changed metadata into a class property, docstring change for element lookups"
__version__ = version.split()[0] # For PEP 396 and PEP 345 __version__ = version.split()[0] # For PEP 396 and PEP 345
@ -766,6 +766,8 @@ class Element():
self.TKEntry = None self.TKEntry = None
self.TKImage = None self.TKImage = None
self._metadata = None # type: Any
self.ParentForm = None # type: Window self.ParentForm = None # type: Window
self.ParentContainer = None # will be a Form, Column, or Frame element # UNBIND self.ParentContainer = None # will be a Form, Column, or Frame element # UNBIND
self.TextInputDefault = None self.TextInputDefault = None
@ -780,7 +782,7 @@ class Element():
self.Widget = None # Set when creating window. Has the main tkinter widget for element self.Widget = None # Set when creating window. Has the main tkinter widget for element
self.Tearoff = False # needed because of right click menu code self.Tearoff = False # needed because of right click menu code
self.ParentRowFrame = None # type tk.Frame self.ParentRowFrame = None # type tk.Frame
self.metadata = metadata # type: Any self.metadata = metadata
self.user_bind_dict = {} # Used when user defines a tkinter binding using bind method - convert bind string to key modifier self.user_bind_dict = {} # Used when user defines a tkinter binding using bind method - convert bind string to key modifier
self.user_bind_event = None # Used when user defines a tkinter binding using bind method - event data from tkinter self.user_bind_event = None # Used when user defines a tkinter binding using bind method - event data from tkinter
self.pad_used = (0,0) # the amount of pad used when was inserted into the layout self.pad_used = (0,0) # the amount of pad used when was inserted into the layout
@ -794,13 +796,32 @@ class Element():
def visible(self): def visible(self):
""" """
Returns visibility state for the element. This is a READONLY property Returns visibility state for the element. This is a READONLY property
To control visibility, use the element's update method
:return: Visibility state for element :return: Visibility state for element
:rtype: (bool) :rtype: (bool)
""" """
return self._visible return self._visible
@property
def metadata(self):
"""
Metadata is an Element property that you can use at any time to hold any value
:return: the current metadata value
:rtype: (Any)
"""
return self._metadata
@metadata.setter
def metadata(self, value):
"""
Metadata is an Element property that you can use at any time to hold any value
:param value: Anything you want it to be
:type value: (Any)
"""
self._metadata = value
def _RightClickMenuCallback(self, event): def _RightClickMenuCallback(self, event):
""" """
Callback function that's called when a right click happens. Shows right click menu as result Callback function that's called when a right click happens. Shows right click menu as result
@ -9262,8 +9283,8 @@ class Window:
window['element key'].Update window['element key'].Update
:param key: The key to find :param key: The key to find
:type key: str | int | tuple | object"" :type key: str | int | tuple | object
:rtype: Element | None :rtype: Element | Input | Combo | OptionMenu | Listbox | Radio | Checkbox | Spin | Multiline | Text | StatusBar | Output | Button | ButtonMenu | ProgressBar | Image | Canvas | Graph | Frame | VerticalSeparator | HorizontalSeparator | Tab | TabGroup | Slider | Column | Pane | Menu | Table | Tree | ErrorElement | None
""" """
return self.FindElement(key) return self.FindElement(key)