From 745f26916d0010ef2469e7214b0c589d1060305a Mon Sep 17 00:00:00 2001 From: PySimpleGUI Date: Sun, 27 Mar 2022 10:06:11 -0400 Subject: [PATCH] Addition to call reference documentation for new Element focus methods, new Wikndow.widget_to_element, and widget, key properties --- PySimpleGUI.py | 4 +- docs/call reference.md | 1222 +++++++++++++++++ .../markdown input files/5_call_reference.md | 347 +++++ readme_creator/output/call reference.md | 1222 +++++++++++++++++ 4 files changed, 2793 insertions(+), 2 deletions(-) diff --git a/PySimpleGUI.py b/PySimpleGUI.py index 306cdb67..01f54d36 100644 --- a/PySimpleGUI.py +++ b/PySimpleGUI.py @@ -1,6 +1,6 @@ #!/usr/bin/python3 -version = __version__ = "4.57.0.19 Unreleased" +version = __version__ = "4.57.0.20 Unreleased" _change_log = """ Changelog since 4.57.0 released to PyPI on 13-Feb-2022 @@ -55,7 +55,7 @@ _change_log = """ Oops... added back the rtype docstring for Window __getitem__ so that PyCharm doesn't generate warnings. Using Element by itself isn't enough. The entire list of possible elements is needed to that the code completion /error checking works 4.57.0.20 - Simplified Radio, Combo + Simplified Radio, Checkbox, Slider creation. Moved the command parm outside the creation and instead made a config call. """ __version__ = version.split()[0] # For PEP 396 and PEP 345 diff --git a/docs/call reference.md b/docs/call reference.md index b6b6f79c..b44e0fd5 100644 --- a/docs/call reference.md +++ b/docs/call reference.md @@ -211,6 +211,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -258,6 +278,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -413,6 +444,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -623,6 +665,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -809,6 +871,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -975,6 +1048,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -1127,6 +1220,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -1290,6 +1394,26 @@ Return the current state of this checkbox |---|---|---| |(bool)| **return** | Current state of checkbox | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -1327,6 +1451,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -1464,6 +1599,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -1667,6 +1813,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -1719,6 +1885,17 @@ Parameter Descriptions: | List[List[Element]] | rows | The rows of Elements | | (Column) | **RETURN** | Used for chaining +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -1858,6 +2035,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -2065,6 +2253,26 @@ You should be using values from your call to window.read instead. Know what you |---|---|---| |Any | None| **return** | Returns the value of what is currently chosen | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -2102,6 +2310,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -2244,6 +2463,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -2451,6 +2681,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -2503,6 +2753,17 @@ Parameter Descriptions: | List[List[Element]] | rows | The rows of Elements | | (Frame) | **RETURN** | Used for chaining +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -2629,6 +2890,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -3131,6 +3403,26 @@ Parameter Descriptions: | (int, int) or Tuple[float, float] | location | point to check | | List[int] | **RETURN** | a list of previously drawn "Figures" (returned from the drawing primitives) +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -3234,6 +3526,17 @@ Parameter Descriptions: |--|--|--| | int | figure | value returned by tkinter when creating the figure / drawing | +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -3370,6 +3673,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -3823,6 +4137,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -3860,6 +4194,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -3965,6 +4310,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -4100,6 +4456,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -4137,6 +4513,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -4306,6 +4693,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -4519,6 +4917,26 @@ Read and return the current value of the input element. Must call `Window.Read` |---|---|---| |(str)| **return** | current value of Input field or '' if error encountered | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -4556,6 +4974,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -4710,6 +5139,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -4940,6 +5380,26 @@ Returns list of Values provided by the user in the user's format |---|---|---| |List[Any]| **return** | List of values. Can be any / mixed types -> [] | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -4977,6 +5437,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -5139,6 +5610,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -5342,6 +5824,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -5379,6 +5881,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -5505,6 +6018,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -5754,6 +6278,26 @@ Return current contents of the Multiline Element |---|---|---| |(str)| **return** | current contents of the Multiline Element (used as an input type of Multiline | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -5873,6 +6417,17 @@ Restore a previously re-reouted stdout back to the original destination restore_stdout() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -6034,6 +6589,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -6222,6 +6788,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -6259,6 +6845,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -6406,6 +7003,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -6575,6 +7183,26 @@ Parameter Descriptions: | bool | expand_x | If True Element will expand in the Horizontal directions | | bool | expand_y | If True Element will expand in the Vertical directions | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -6612,6 +7240,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -6762,6 +7401,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -6936,6 +7586,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -6973,6 +7643,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -7098,6 +7779,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -7238,6 +7930,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -7275,6 +7987,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -7424,6 +8147,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -7658,6 +8392,26 @@ A snapshot of the value of Radio Button -> (bool) |---|---|---| |(bool)| **return** | True if this radio button is selected | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -7703,6 +8457,17 @@ Sets all Radio Buttons in the group to not selected reset_group() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -7840,6 +8605,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -8008,6 +8784,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -8045,6 +8841,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -8177,6 +8984,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ## Slider Element @@ -8294,6 +9112,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -8331,6 +9169,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -8462,6 +9311,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -8645,6 +9505,26 @@ item returned will be an int (not a string) |---|---|---| |(Any)| **return** | The currently visible entry | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -8682,6 +9562,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -8818,6 +9709,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -9002,6 +9904,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -9039,6 +9961,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -9172,6 +10105,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -9354,6 +10298,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -9414,6 +10378,17 @@ Create a tkinter event that mimics user clicking on a tab. Must have called wind select() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -9543,6 +10518,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -9799,6 +10785,26 @@ are using this method correctly? |---|---|---| |Any | None| **return** | The key of the currently selected tab or the tab's text if it has no key | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -9836,6 +10842,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -9955,6 +10972,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -10171,6 +11199,26 @@ user when Table was created or Updated. |---|---|---| |List[List[Any]]| **return** | the current table values (for now what was originally provided up updated) | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -10208,6 +11256,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -10343,6 +11402,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -10537,6 +11607,26 @@ Gets the current value of the displayed text |---|---|---| |(str)| **return** | The current value | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -10574,6 +11664,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -10707,6 +11808,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -10973,6 +12085,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -11010,6 +12142,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -11159,6 +12302,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -11354,6 +12508,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -11391,6 +12565,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -11496,6 +12681,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + ------------------------------ ## VPush Element (aliases include `VP` and `VStretch`) @@ -12039,6 +13235,17 @@ Maximize the window. This is done differently on a windows system versus a linux maximize() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -12338,6 +13545,21 @@ Returns True if the window was closed |---|---|---| |bool| **return** | True if the window is closed | +### widget_to_element + +Returns the element that matches a supplied tkinter widget. +If no matching element is found, then None is returned. + +``` +widget_to_element(widget) +``` + +Parameter Descriptions: + +|Type|Name|Meaning| +|--|--|--| +| Element or None | **RETURN** | Element that uses the specified widget + ### write_event_value Adds a key & value tuple to the queue that is used by threads to communicate with the window diff --git a/readme_creator/markdown input files/5_call_reference.md b/readme_creator/markdown input files/5_call_reference.md index 0bcee44f..778aae40 100644 --- a/readme_creator/markdown input files/5_call_reference.md +++ b/readme_creator/markdown input files/5_call_reference.md @@ -86,6 +86,12 @@ This section of the documentation is generated directly from the source code. A ### expand +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -101,6 +107,9 @@ This section of the documentation is generated directly from the source code. A ### hide_row +### key + + ### metadata @@ -131,6 +140,9 @@ This section of the documentation is generated directly from the source code. A ### visible +### widget + + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -168,6 +180,12 @@ The following methods are here for backwards compatibility reference. You will ### expand +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -210,6 +228,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- @@ -245,6 +266,12 @@ The following methods are here for backwards compatibility reference. You will ### expand +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -284,6 +311,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -318,6 +348,12 @@ The following methods are here for backwards compatibility reference. You will ### get +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -330,6 +366,9 @@ The following methods are here for backwards compatibility reference. You will ### hide_row +### key + + ### metadata @@ -357,6 +396,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -398,6 +440,12 @@ The following methods are here for backwards compatibility reference. You will ### expand +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -413,6 +461,9 @@ The following methods are here for backwards compatibility reference. You will ### layout +### key + + ### metadata @@ -443,6 +494,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- @@ -486,6 +540,12 @@ The following methods are here for backwards compatibility reference. You will ### get +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -498,6 +558,9 @@ The following methods are here for backwards compatibility reference. You will ### hide_row +### key + + ### metadata @@ -525,6 +588,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- @@ -564,6 +630,12 @@ The following methods are here for backwards compatibility reference. You will ### expand +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -579,6 +651,9 @@ The following methods are here for backwards compatibility reference. You will ### layout +### key + + ### metadata @@ -606,6 +681,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- @@ -692,6 +770,12 @@ The following methods are here for backwards compatibility reference. You will ### get_figures_at_location +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -716,6 +800,9 @@ The following methods are here for backwards compatibility reference. You will ### send_figure_to_back +### key + + ### metadata @@ -746,6 +833,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- @@ -833,6 +923,12 @@ The following methods are here for backwards compatibility reference. You will ### expand +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -845,6 +941,9 @@ The following methods are here for backwards compatibility reference. You will ### hide_row +### key + + ### metadata @@ -869,6 +968,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- @@ -899,6 +1001,12 @@ The following methods are here for backwards compatibility reference. You will ### expand +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -911,6 +1019,9 @@ The following methods are here for backwards compatibility reference. You will ### hide_row +### key + + ### metadata @@ -944,6 +1055,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- @@ -983,6 +1097,12 @@ The following methods are here for backwards compatibility reference. You will ### get +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -995,6 +1115,9 @@ The following methods are here for backwards compatibility reference. You will ### hide_row +### key + + ### metadata @@ -1025,6 +1148,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- @@ -1070,6 +1196,12 @@ The following methods are here for backwards compatibility reference. You will ### get_list_values +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -1082,6 +1214,9 @@ The following methods are here for backwards compatibility reference. You will ### hide_row +### key + + ### metadata @@ -1115,6 +1250,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- @@ -1156,6 +1294,12 @@ The following methods are here for backwards compatibility reference. You will ### expand +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -1168,6 +1312,9 @@ The following methods are here for backwards compatibility reference. You will ### hide_row +### key + + ### metadata @@ -1195,6 +1342,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- @@ -1242,6 +1392,12 @@ See the Column element to get a list of method calls available. The function re ### get +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -1269,6 +1425,9 @@ See the Column element to get a list of method calls available. The function re ### restore_stdout +### key + + ### metadata @@ -1299,6 +1458,9 @@ See the Column element to get a list of method calls available. The function re ### visible +### widget + + --------- @@ -1336,6 +1498,12 @@ The following methods are here for backwards compatibility reference. You will ### expand +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -1348,6 +1516,9 @@ The following methods are here for backwards compatibility reference. You will ### hide_row +### key + + ### metadata @@ -1378,6 +1549,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- @@ -1417,6 +1591,12 @@ You can control which Multiline Element receives your stdout output as well as u ### expand +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -1429,6 +1609,9 @@ You can control which Multiline Element receives your stdout output as well as u ### hide_row +### key + + ### metadata @@ -1462,6 +1645,9 @@ You can control which Multiline Element receives your stdout output as well as u ### visible +### widget + + --------- @@ -1502,6 +1688,12 @@ The following methods are here for backwards compatibility reference. You will ### expand +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -1514,6 +1706,9 @@ The following methods are here for backwards compatibility reference. You will ### hide_row +### key + + ### metadata @@ -1541,6 +1736,8 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + --------- @@ -1573,6 +1770,12 @@ The following methods are here for backwards compatibility reference. You will ### expand +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -1585,6 +1788,9 @@ The following methods are here for backwards compatibility reference. You will ### hide_row +### key + + ### metadata @@ -1615,6 +1821,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- @@ -1683,6 +1892,12 @@ A `Push` element will "push" elements on the row away from it. If you have 1 `P ### get +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -1698,6 +1913,9 @@ A `Push` element will "push" elements on the row away from it. If you have 1 `P ### reset_group +### key + + ### metadata @@ -1725,6 +1943,9 @@ A `Push` element will "push" elements on the row away from it. If you have 1 `P ### visible +### widget + + --------- @@ -1771,6 +1992,12 @@ This element is used to add more space.... more size...to a Container Element or ### expand +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -1783,6 +2010,9 @@ This element is used to add more space.... more size...to a Container Element or ### hide_row +### key + + ### metadata @@ -1813,6 +2043,9 @@ This element is used to add more space.... more size...to a Container Element or ### visible +### widget + + --------- @@ -1830,6 +2063,12 @@ This element is used to add more space.... more size...to a Container Element or ### expand +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -1842,6 +2081,9 @@ This element is used to add more space.... more size...to a Container Element or ### hide_row +### key + + ### metadata @@ -1869,6 +2111,9 @@ This element is used to add more space.... more size...to a Container Element or ### visible +### widget + + --------- @@ -1905,6 +2150,12 @@ The following methods are here for backwards compatibility reference. You will ### get +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -1917,6 +2168,9 @@ The following methods are here for backwards compatibility reference. You will ### hide_row +### key + + ### metadata @@ -1944,6 +2198,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -1979,6 +2236,12 @@ The following methods are here for backwards compatibility reference. You will ### expand +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -1991,6 +2254,9 @@ The following methods are here for backwards compatibility reference. You will ### hide_row +### key + + ### metadata @@ -2018,6 +2284,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- @@ -2053,6 +2322,12 @@ The following methods are here for backwards compatibility reference. You will ### expand +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -2071,6 +2346,9 @@ The following methods are here for backwards compatibility reference. You will ### select +### key + + ### metadata @@ -2098,6 +2376,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- @@ -2150,6 +2431,12 @@ The following methods are here for backwards compatibility reference. You will ### get +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -2162,6 +2449,9 @@ The following methods are here for backwards compatibility reference. You will ### hide_row +### key + + ### metadata @@ -2189,6 +2479,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- @@ -2229,6 +2522,12 @@ The following methods are here for backwards compatibility reference. You will ### get +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -2241,6 +2540,9 @@ The following methods are here for backwards compatibility reference. You will ### hide_row +### key + + ### metadata @@ -2268,6 +2570,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- @@ -2306,6 +2611,12 @@ The following methods are here for backwards compatibility reference. You will ### get +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -2318,6 +2629,9 @@ The following methods are here for backwards compatibility reference. You will ### hide_row +### key + + ### metadata @@ -2345,6 +2659,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + --------- @@ -2395,6 +2712,12 @@ See the Column element to get a list of method calls available. The function re ### expand +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -2407,6 +2730,9 @@ See the Column element to get a list of method calls available. The function re ### hide_row +### key + + ### metadata @@ -2437,6 +2763,9 @@ See the Column element to get a list of method calls available. The function re ### visible +### widget + + --------- @@ -2485,6 +2814,12 @@ The following methods are here for backwards compatibility reference. You will ### expand +### get_next_focus + + +### get_previous_focus + + ### get_size @@ -2497,6 +2832,9 @@ The following methods are here for backwards compatibility reference. You will ### hide_row +### key + + ### metadata @@ -2521,6 +2859,9 @@ The following methods are here for backwards compatibility reference. You will ### visible +### widget + + ------------------------------ ## VPush Element (aliases include `VP` and `VStretch`) @@ -2648,6 +2989,9 @@ Example: If first row has a `VPush`, then your layout will be At the bottom of ### maximize +### key + + ### metadata @@ -2714,6 +3058,9 @@ Example: If first row has a `VPush`, then your layout will be At the bottom of ### was_closed +### widget_to_element + + ### write_event_value diff --git a/readme_creator/output/call reference.md b/readme_creator/output/call reference.md index b6b6f79c..b44e0fd5 100644 --- a/readme_creator/output/call reference.md +++ b/readme_creator/output/call reference.md @@ -211,6 +211,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -258,6 +278,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -413,6 +444,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -623,6 +665,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -809,6 +871,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -975,6 +1048,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -1127,6 +1220,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -1290,6 +1394,26 @@ Return the current state of this checkbox |---|---|---| |(bool)| **return** | Current state of checkbox | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -1327,6 +1451,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -1464,6 +1599,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -1667,6 +1813,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -1719,6 +1885,17 @@ Parameter Descriptions: | List[List[Element]] | rows | The rows of Elements | | (Column) | **RETURN** | Used for chaining +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -1858,6 +2035,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -2065,6 +2253,26 @@ You should be using values from your call to window.read instead. Know what you |---|---|---| |Any | None| **return** | Returns the value of what is currently chosen | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -2102,6 +2310,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -2244,6 +2463,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -2451,6 +2681,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -2503,6 +2753,17 @@ Parameter Descriptions: | List[List[Element]] | rows | The rows of Elements | | (Frame) | **RETURN** | Used for chaining +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -2629,6 +2890,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -3131,6 +3403,26 @@ Parameter Descriptions: | (int, int) or Tuple[float, float] | location | point to check | | List[int] | **RETURN** | a list of previously drawn "Figures" (returned from the drawing primitives) +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -3234,6 +3526,17 @@ Parameter Descriptions: |--|--|--| | int | figure | value returned by tkinter when creating the figure / drawing | +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -3370,6 +3673,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -3823,6 +4137,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -3860,6 +4194,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -3965,6 +4310,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -4100,6 +4456,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -4137,6 +4513,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -4306,6 +4693,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -4519,6 +4917,26 @@ Read and return the current value of the input element. Must call `Window.Read` |---|---|---| |(str)| **return** | current value of Input field or '' if error encountered | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -4556,6 +4974,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -4710,6 +5139,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -4940,6 +5380,26 @@ Returns list of Values provided by the user in the user's format |---|---|---| |List[Any]| **return** | List of values. Can be any / mixed types -> [] | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -4977,6 +5437,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -5139,6 +5610,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -5342,6 +5824,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -5379,6 +5881,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -5505,6 +6018,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -5754,6 +6278,26 @@ Return current contents of the Multiline Element |---|---|---| |(str)| **return** | current contents of the Multiline Element (used as an input type of Multiline | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -5873,6 +6417,17 @@ Restore a previously re-reouted stdout back to the original destination restore_stdout() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -6034,6 +6589,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -6222,6 +6788,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -6259,6 +6845,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -6406,6 +7003,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -6575,6 +7183,26 @@ Parameter Descriptions: | bool | expand_x | If True Element will expand in the Horizontal directions | | bool | expand_y | If True Element will expand in the Vertical directions | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -6612,6 +7240,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -6762,6 +7401,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -6936,6 +7586,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -6973,6 +7643,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -7098,6 +7779,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -7238,6 +7930,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -7275,6 +7987,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -7424,6 +8147,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -7658,6 +8392,26 @@ A snapshot of the value of Radio Button -> (bool) |---|---|---| |(bool)| **return** | True if this radio button is selected | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -7703,6 +8457,17 @@ Sets all Radio Buttons in the group to not selected reset_group() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -7840,6 +8605,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -8008,6 +8784,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -8045,6 +8841,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -8177,6 +8984,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ## Slider Element @@ -8294,6 +9112,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -8331,6 +9169,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -8462,6 +9311,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -8645,6 +9505,26 @@ item returned will be an int (not a string) |---|---|---| |(Any)| **return** | The currently visible entry | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -8682,6 +9562,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -8818,6 +9709,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -9002,6 +9904,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -9039,6 +9961,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -9172,6 +10105,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -9354,6 +10298,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -9414,6 +10378,17 @@ Create a tkinter event that mimics user clicking on a tab. Must have called wind select() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -9543,6 +10518,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -9799,6 +10785,26 @@ are using this method correctly? |---|---|---| |Any | None| **return** | The key of the currently selected tab or the tab's text if it has no key | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -9836,6 +10842,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -9955,6 +10972,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -10171,6 +11199,26 @@ user when Table was created or Updated. |---|---|---| |List[List[Any]]| **return** | the current table values (for now what was originally provided up updated) | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -10208,6 +11256,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -10343,6 +11402,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -10537,6 +11607,26 @@ Gets the current value of the displayed text |---|---|---| |(str)| **return** | The current value | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -10574,6 +11664,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -10707,6 +11808,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -10973,6 +12085,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -11010,6 +12142,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -11159,6 +12302,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + --------- ### These are non-PEP8 Compliant Methods - do NOT use @@ -11354,6 +12508,26 @@ Parameter Descriptions: | bool | expand_y | If True Element will expand in the Vertical directions | | bool | expand_row | If True the row containing the element will also expand. Without this your element is "trapped" within the row | +### get_next_focus + +Gets the next element that should get focus after this element. + +`get_next_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that will get focus after this one | + +### get_previous_focus + +Gets the element that should get focus previous to this element. + +`get_previous_focus()` + +|Type|Name|Meaning| +|---|---|---| +|(Element)| **return** | Element that should get the focus before this one | + ### get_size Return the size of an element in Pixels. Care must be taken as some elements use characters to specify their size but will return pixels when calling this get_size method. @@ -11391,6 +12565,17 @@ Hide the entire row an Element is located on. hide_row() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -11496,6 +12681,17 @@ Returns visibility state for the element. This is a READONLY property |---|---|---| |(bool)| **return** | Visibility state for element | +### widget + +#### property: widget + +Returns tkinter widget for the element. This is a READONLY property. +The implementation is that the Widget member variable is returned. This is a backward compatible addition + +|Type|Name|Meaning| +|---|---|---| +|(tkinter.Widget)| **return** | The element's underlying tkinter widget | + ------------------------------ ## VPush Element (aliases include `VP` and `VStretch`) @@ -12039,6 +13235,17 @@ Maximize the window. This is done differently on a windows system versus a linux maximize() ``` +### key + +#### property: key + +Returns key for the element. This is a READONLY property. +Keys can be any hashable object (basically anything except a list... tuples are ok, but not lists) + +|Type|Name|Meaning| +|---|---|---| +|(Any)| **return** | The window's Key | + ### metadata #### property: metadata @@ -12338,6 +13545,21 @@ Returns True if the window was closed |---|---|---| |bool| **return** | True if the window is closed | +### widget_to_element + +Returns the element that matches a supplied tkinter widget. +If no matching element is found, then None is returned. + +``` +widget_to_element(widget) +``` + +Parameter Descriptions: + +|Type|Name|Meaning| +|--|--|--| +| Element or None | **RETURN** | Element that uses the specified widget + ### write_event_value Adds a key & value tuple to the queue that is used by threads to communicate with the window