diff --git a/docs/call reference.md b/docs/call reference.md index 0bd8ca84..a4d55533 100644 --- a/docs/call reference.md +++ b/docs/call reference.md @@ -88,7 +88,7 @@ Parameter Descriptions: | bool | bind_return_key | If True the return key will cause this button to be pressed | | bool | focus | if True, initial focus will be put on this button | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element (left/right, top/bottom) or ((left, right), (top, bottom)) | -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element to uniquely identify this element | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | List[List[ List[str] or str ]] | right_click_menu | A list of lists of Menu items to show when this element is right clicked. See user docs for exact format. | | bool | visible | set visibility state of the element | @@ -489,7 +489,7 @@ Parameter Descriptions: | str or Tuple[str, int] | font | specifies the font family, size, etc | | str or Tuple[str, int] | item_font | specifies the font family, size, etc, for the menu items | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element (left/right, top/bottom) or ((left, right), (top, bottom)) | -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element to uniquely identify this element | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | bool | tearoff | Determines if menus should allow them to be torn off | | bool | visible | set visibility state of the element | @@ -697,7 +697,7 @@ unhide_row() Changes some of the settings for the ButtonMenu Element. Must call `Window.Read` or `Window.Finalize` prior ``` -update(menu_definition, visible = None) +update(menu_definition = None, visible = None) ``` Parameter Descriptions: @@ -765,7 +765,7 @@ Parameter Descriptions: Changes some of the settings for the ButtonMenu Element. Must call `Window.Read` or `Window.Finalize` prior ``` -Update(menu_definition, visible = None) +Update(menu_definition = None, visible = None) ``` Parameter Descriptions: @@ -803,7 +803,7 @@ Parameter Descriptions: | (int,int) or (None, None) | size | (width in char, height in rows) size in pixels to make canvas | | (int, int) or (None, None) | s | Same as size parameter. It's an alias. If EITHER of them are set, then the one that's set will be used. If BOTH are set, size will be used | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element | -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | str | tooltip | text, that will appear when mouse hovers over the element | | List[List[ List[str] or str ]] | right_click_menu | A list of lists of Menu items to show when this element is right clicked. See user docs for exact format. | @@ -1081,6 +1081,7 @@ Checkbox(text, k = None, pad = None, tooltip = None, + right_click_menu = None, visible = True, metadata = None) ``` @@ -1101,10 +1102,11 @@ Parameter Descriptions: | bool | change_submits | DO NOT USE. Only listed for backwards compat - Use enable_events instead | | bool | enable_events | Turns on the element specific events. Checkbox events happen when an item changes | | bool | disabled | set disable state | -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element (left/right, top/bottom) or ((left, right), (top, bottom)) | | str | tooltip | text, that will appear when mouse hovers over the element | +| List[List[ List[str] or str ]] | right_click_menu | A list of lists of Menu items to show when this element is right clicked. See user docs for exact format. | | bool | visible | set visibility state of the element | | Any | metadata | User metadata that can be set to ANYTHING | @@ -1837,7 +1839,7 @@ Parameter Descriptions: | bool | change_submits | DEPRICATED DO NOT USE. Use `enable_events` instead | | bool | enable_events | Turns on the element specific events. Combo event is when a choice is made | | bool | disabled | set disable state for element | -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element (left/right, top/bottom) or ((left, right), (top, bottom)) | | str | tooltip | text that will appear when mouse hovers over this element | @@ -2195,7 +2197,7 @@ Parameter Descriptions: | str | background_color | background color of the Frame | | enum | title_location | location to place the text title. Choices include: TITLE_LOCATION_TOP TITLE_LOCATION_BOTTOM TITLE_LOCATION_LEFT TITLE_LOCATION_RIGHT TITLE_LOCATION_TOP_LEFT TITLE_LOCATION_TOP_RIGHT TITLE_LOCATION_BOTTOM_LEFT TITLE_LOCATION_BOTTOM_RIGHT | | enum | relief | relief style. Values are same as other elements with reliefs. Choices include RELIEF_RAISED RELIEF_SUNKEN RELIEF_FLAT RELIEF_RIDGE RELIEF_GROOVE RELIEF_SOLID | -| (int, int) | size | (width, height) (note this parameter may not always work) | +| (int, int) | size | (width, height) DO NOT use this. Instead, place your layout in a Column element with the size set on the Column element. Set pad=(0,0) on your Column | | (int, int) or (None, None) | s | Same as size parameter. It's an alias. If EITHER of them are set, then the one that's set will be used. If BOTH are set, size will be used | | str or Tuple[str, int] | font | specifies the font family, size, etc | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element (left/right, top/bottom) or ((left, right), (top, bottom)) | @@ -3820,7 +3822,7 @@ Parameter Descriptions: | (int, int) | size | (width, height) size of image in pixels | | (int, int) or (None, None) | s | Same as size parameter. It's an alias. If EITHER of them are set, then the one that's set will be used. If BOTH are set, size will be used | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element (left/right, top/bottom) or ((left, right), (top, bottom)) | -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element to uniquely identify this element | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | str | tooltip | text, that will appear when mouse hovers over the element | | List[List[ List[str] or str ]] | right_click_menu | A list of lists of Menu items to show when this element is right clicked. See user docs for exact format. | @@ -4576,12 +4578,12 @@ Parameter Descriptions: | bool | disabled | set disable state for element | | bool | auto_size_text | True if element should be the same size as the contents | | str or (str, int) | font | specifies the font family, size, etc | -| bool | font | specifies the font family, size, etc :param no_scrollbar: Controls if a scrollbar should be shown. If True, no scrollbar will be shown | +| bool | no_scrollbar | Controls if a scrollbar should be shown. If True, no scrollbar will be shown | | str | background_color | color of background | | str | text_color | color of the text | | str | highlight_background_color | color of the background when an item is selected. Defaults to normal text color (a reverse look) | | str | highlight_text_color | color of the text when an item is selected. Defaults to the normal background color (a rerverse look) | -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element (left/right, top/bottom) or ((left, right), (top, bottom)) | | str | tooltip | text, that will appear when mouse hovers over the element | @@ -5372,7 +5374,7 @@ Parameter Descriptions: | bool | change_submits | DO NOT USE. Only listed for backwards compat - Use enable_events instead | | bool | enable_events | Turns on the element specific events. Spin events happen when an item changes | | bool | do_not_clear | if False the element will be cleared any time the Window.Read call returns | -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element to uniquely identify this element | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | bool | write_only | If True then no entry will be added to the values dictionary when the window is read | | bool | auto_refresh | If True then anytime the element is updated, the window will be refreshed so that the change is immediately displayed | @@ -5519,7 +5521,8 @@ print(args=*<1 or N object>, colors = None, t = None, b = None, - c = None) + c = None, + autoscroll = True) ``` Parameter Descriptions: @@ -5533,10 +5536,11 @@ Parameter Descriptions: | str | background_color | The background color of the line | | str | justification | text justification. left, right, center. Can use single characters l, r, c. Sets only for this value, not entire element | | str or (str, int) or (str, int, str) | font | specifies the font family, size, etc for the args being printed | -| str or str, str | colors | Either a tuple or a string that has both the text and background colors | +| str or str, str | colors | Either a tuple or a string that has both the text and background colors. Or just the text color | | str | t | Color of the text | | str | b | The background color of the line | -| str or str, str | c | Either a tuple or a string that has both the text and background colors | +| str or str, str | c | Either a tuple or a string that has both the text and background colors or just tex color (same as the color parm) | +| bool | autoscroll | If True the contents of the element will automatically scroll as more data added to the end | ### reroute_stderr_to_here @@ -5843,7 +5847,7 @@ Parameter Descriptions: | bool | auto_size_text | True if size of Element should match the contents of the items | | str | background_color | color of background | | str | text_color | color of the text | -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element (left/right, top/bottom) or ((left, right), (top, bottom)) | | str | tooltip | text that will appear when mouse hovers over this element | @@ -6175,7 +6179,7 @@ Parameter Descriptions: | bool | echo_stdout_stderr | If True then output to stdout will be output to this element AND also to the normal console location | | str or (str, int) | font | specifies the font family, size, etc | | str | tooltip | text, that will appear when mouse hovers over the element | -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element to uniquely identify this element | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | List[List[ List[str] or str ]] | right_click_menu | A list of lists of Menu items to show when this element is right clicked. See user docs for exact format. | | bool | visible | set visibility state of the element | @@ -6797,6 +6801,7 @@ ProgressBar(max_value, key = None, k = None, pad = None, + right_click_menu = None, visible = True, metadata = None) ``` @@ -6805,20 +6810,21 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| -| int | max_value | max value of progressbar | -| str | orientation | 'horizontal' or 'vertical' | -| (int, int) or (None, None) | size | Size of the bar. If horizontal (chars wide, pixels high), vert (pixels wide, rows high) | -| (int, int) or (None, None) | s | Same as size parameter. It's an alias. If EITHER of them are set, then the one that's set will be used. If BOTH are set, size will be used | -| bool | auto_size_text | Not sure why this is here | -| (str, str) or str | bar_color | The 2 colors that make up a progress bar. Easy to remember which is which if you say "ON" between colors. "red" on "green". | -| str | style | Progress bar style defined as one of these 'default', 'winnative', 'clam', 'alt', 'classic', 'vista', 'xpnative' | -| int | border_width | The amount of pixels that go around the outside of the bar | -| str | relief | relief style. Values are same as progress meter relief values. Can be a constant or a string: `RELIEF_RAISED RELIEF_SUNKEN RELIEF_FLAT RELIEF_RIDGE RELIEF_GROOVE RELIEF_SOLID` (Default value = DEFAULT_PROGRESS_BAR_RELIEF) | -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element to uniquely identify this element | -| str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | -| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element (left/right, top/bottom) or ((left, right), (top, bottom)) | -| bool | visible | set visibility state of the element | -| Any | metadata | User metadata that can be set to ANYTHING | +| int | max_value | max value of progressbar | +| str | orientation | 'horizontal' or 'vertical' | +| (int, int) or (None, None) | size | Size of the bar. If horizontal (chars wide, pixels high), vert (pixels wide, rows high) | +| (int, int) or (None, None) | s | Same as size parameter. It's an alias. If EITHER of them are set, then the one that's set will be used. If BOTH are set, size will be used | +| bool | auto_size_text | Not sure why this is here | +| (str, str) or str | bar_color | The 2 colors that make up a progress bar. Easy to remember which is which if you say "ON" between colors. "red" on "green". | +| str | style | Progress bar style defined as one of these 'default', 'winnative', 'clam', 'alt', 'classic', 'vista', 'xpnative' | +| int | border_width | The amount of pixels that go around the outside of the bar | +| str | relief | relief style. Values are same as progress meter relief values. Can be a constant or a string: `RELIEF_RAISED RELIEF_SUNKEN RELIEF_FLAT RELIEF_RIDGE RELIEF_GROOVE RELIEF_SOLID` (Default value = DEFAULT_PROGRESS_BAR_RELIEF) | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element to uniquely identify this element | +| str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | +| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element (left/right, top/bottom) or ((left, right), (top, bottom)) | +| List[List[ List[str] or str ]] | right_click_menu | A list of lists of Menu items to show when this element is right clicked. See user docs for exact format. | +| bool | visible | set visibility state of the element | +| Any | metadata | User metadata that can be set to ANYTHING | ### bind @@ -7127,6 +7133,7 @@ Radio(text, tooltip = None, change_submits = False, enable_events = False, + right_click_menu = None, visible = True, metadata = None) ``` @@ -7146,12 +7153,13 @@ Parameter Descriptions: | str | text_color | color of the text | | str | circle_color | color of background of the circle that has the dot selection indicator in it | | str or (str, int) | font | specifies the font family, size, etc | -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element (left/right, top/bottom) or ((left, right), (top, bottom)) | | str | tooltip | text, that will appear when mouse hovers over the element | | bool | change_submits | DO NOT USE. Only listed for backwards compat - Use enable_events instead | | bool | enable_events | Turns on the element specific events. Radio Button events happen when an item is selected | +| List[List[ List[str] or str ]] | right_click_menu | A list of lists of Menu items to show when this element is right clicked. See user docs for exact format. | | bool | visible | set visibility state of the element | | Any | metadata | User metadata that can be set to ANYTHING | @@ -8038,6 +8046,7 @@ Spin(values, k = None, pad = None, tooltip = None, + right_click_menu = None, visible = True, metadata = None) ``` @@ -8058,10 +8067,11 @@ Parameter Descriptions: | str or (str, int) | font | specifies the font family, size, etc | | str | background_color | color of background | | str | text_color | color of the text | -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element (left/right, top/bottom) or ((left, right), (top, bottom)) | | str | tooltip | text, that will appear when mouse hovers over the element | +| List[List[ List[str] or str ]] | right_click_menu | A list of lists of Menu items to show when this element is right clicked. See user docs for exact format. | | bool | visible | set visibility state of the element | | Any | metadata | User metadata that can be set to ANYTHING | @@ -8409,7 +8419,7 @@ Parameter Descriptions: | str | background_color | color of background | | str | justification | how string should be aligned within space provided by size. Valid choices = `left`, `right`, `center` | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element (left/right, top/bottom) or ((left, right), (top, bottom)) | -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element to uniquely identify this element | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | List[List[ List[str] or str ]] | right_click_menu | A list of lists of Menu items to show when this element is right clicked. See user docs for exact format. | | str | tooltip | text, that will appear when mouse hovers over the element | @@ -8847,6 +8857,7 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| | List[List[Element]] | rows | List[List[Element]] The list of rows | +| | **RETURN** | (Tab) used for chaining ### select @@ -9012,6 +9023,7 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| | List[List[Element]] | rows | List[List[Element]] The list of rows | +| | **RETURN** | (Tab) used for chaining ### Select @@ -9092,6 +9104,7 @@ TabGroup(layout, size = (None, None), s = (None, None), tooltip = None, + right_click_menu = None, visible = True, metadata = None) ``` @@ -9118,6 +9131,7 @@ Parameter Descriptions: | (intorNone, intorNone) | size | (width, height) w=pixels-wide, h=pixels-high. Either item in tuple can be None to indicate use the computed value and set only 1 direction | | (intorNone, intorNone) | s | Same as size parameter. It's an alias. If EITHER of them are set, then the one that's set will be used. If BOTH are set, size will be used | | str | tooltip | text, that will appear when mouse hovers over the element | +| List[List[ List[str] or str ]] | right_click_menu | A list of lists of Menu items to show when this element is right clicked. See user docs for exact format. | | bool | visible | set visibility state of the element | | Any | metadata | User metadata that can be set to ANYTHING | @@ -9492,7 +9506,7 @@ Parameter Descriptions: | bool | enable_events | Turns on the element specific events. Table events happen when row is clicked | | bool | bind_return_key | if True, pressing return key will cause event coming from Table, ALSO a left button double click will generate an event if this parameter is True | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element (left/right, top/bottom) or ((left, right), (top, bottom)) | -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element to uniquely identify this element | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | str | tooltip | text, that will appear when mouse hovers over the element | | List[List[ List[str] or str ]] | right_click_menu | A list of lists of Menu items to show when this element is right clicked. See user docs for exact format. | @@ -9844,7 +9858,7 @@ Parameter Descriptions: | int | border_width | number of pixels for the border (if using a relief) | | str | justification | how string should be aligned within space provided by size. Valid choices = `left`, `right`, `center` | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element (left/right, top/bottom) or ((left, right), (top, bottom)) | -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element to uniquely identify this element | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | List[List[ List[str] or str ]] | right_click_menu | A list of lists of Menu items to show when this element is right clicked. See user docs for exact format. | | bool | grab | If True can grab this element and move the window around. Default is False | @@ -10164,7 +10178,7 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| -| str or bytes or None | icon | Can be either a filename or Base64 value. For Windows if filename, it MUST be ICO format. For Linux, must NOT be ICO | +| str or bytes or None | icon | Can be either a filename or Base64 byte string of a PNG. For Windows if filename, it MUST be ICO format. For Linux, must NOT be ICO | | str | title | The "title" to show in the titlebar | | str or None | text_color | Text color for titlebar | | str or None | background_color | Background color for titlebar | @@ -10239,7 +10253,7 @@ Parameter Descriptions: | int | num_rows | The number of rows of the table to display at a time | | int | row_height | height of a single row in pixels | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element (left/right, top/bottom) or ((left, right), (top, bottom)) | -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element to uniquely identify this element | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | str | tooltip | text, that will appear when mouse hovers over the element | | List[List[str] or str]] | right_click_menu | A list of lists of Menu items to show when this element is right clicked. See user docs for exact format. | @@ -11165,7 +11179,7 @@ Parameter Descriptions: | int | border_depth | Default border depth (width) for all elements in the window | | bool | auto_close | If True, the window will automatically close itself | | int | auto_close_duration | Number of seconds to wait before closing the window | -| (str or bytes) | icon | Can be either a filename or Base64 value. For Windows if filename, it MUST be ICO format. For Linux, must NOT be ICO | +| (str or bytes) | icon | Can be either a filename or Base64 value. For Windows if filename, it MUST be ICO format. For Linux, must NOT be ICO. Most portable is to use a Base64 of a PNG file. This works universally across all OS's | | bool | force_toplevel | If True will cause this window to skip the normal use of a hidden master window | | float | alpha_channel | Sets the opacity of the window. 0 = invisible 1 = completely visible. Values bewteen 0 & 1 will produce semi-transparent windows in SOME environments (The Raspberry Pi always has this value at 1 and cannot change. | | bool | return_keyboard_events | if True key presses on the keyboard will be returned as Events from Read calls | @@ -11183,8 +11197,7 @@ Parameter Descriptions: | str | right_click_menu_background_color | Background color for right click menus | | str | right_click_menu_text_color | Text color for right click menus | | str | right_click_menu_disabled_text_color | Text color for disabled right click menu items | -| (str, str) or str or Tuple(int, int) or (None, None) | right_click_menu_selected_colors | Text AND background colors for a selected item. Can be a Tuple OR a color string. simplified-button-color-string "foreground on background". Can be a single color if want to set only the background. -Normally a tuple, but can be a simplified-dual-color-string "foreground on background". Can be a single color if want to set only the background. | +| (str, str) or str or Tuple(int, int) or (None, None) | right_click_menu_selected_colors | Text AND background colors for a selected item. Can be a Tuple OR a color string. simplified-button-color-string "foreground on background". Can be a single color if want to set only the background. Normally a tuple, but can be a simplified-dual-color-string "foreground on background". Can be a single color if want to set only the background. | | str or Tuple[str, int] | right_click_menu_font | Font for right click menus | | bool | right_click_menu_tearoff | If True then all right click menus can be torn off | | bool | finalize | If True then the Finalize method will be called. Use this rather than chaining .Finalize for cleaner code | @@ -11210,6 +11223,12 @@ Users, create a single layout (a list of lists) and pass as a parameter to Windo add_row(args=*<1 or N object>) ``` +Parameter Descriptions: + +|Type|Name|Meaning| +|--|--|--| +| | *args | List[Elements] | + ### add_rows Loops through a list of lists of elements and adds each row, list, to the layout. @@ -11408,16 +11427,21 @@ THIS METHOD IS NO LONGER NEEDED to be called by the user You can perform the same operation by writing this statement: element = window[key] -You can drop the entire "FindElement" function name and use [ ] instead. +You can drop the entire "find_element" function name and use [ ] instead. -Typically used in combination with a call to element's Update method (or any other element method!): -window[key].Update(new_value) +However, if you wish to perform a lookup without error checking, and don't have error popups turned +off globally, you'll need to make this call so that you can disable error checks on this call. + +find_element is yypically used in combination with a call to element's Update method (or any other element method!): +window[key].update(new_value) Versus the "old way" window.FindElement(key).Update(new_value) This call can be abbreviated to any of these: -FindElement == Element == Find +find_element = FindElement == Element == Find +With find_element being the PEP8 compliant call that should be used. + Rememeber that this call will return None if no match is found which may cause your code to crash if not checked for. @@ -11429,7 +11453,7 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element | | bool | silent_on_error | If True do not display popup nor print warning of key errors | | Element or Error Element or None | **RETURN** | Return value can be: the Element that matches the supplied key if found; an Error Element if silent_on_error is False; None if silent_on_error True; @@ -11717,8 +11741,8 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| -| str | icon | Filename or bytes object | -| str | pngbase64 | Base64 encoded image | +| str | icon | Filename or bytes object | +| bytes | pngbase64 | Base64 encoded image | ### set_min_size @@ -11832,6 +11856,12 @@ Users, create a single layout (a list of lists) and pass as a parameter to Windo AddRow(args=*<1 or N object>) ``` +Parameter Descriptions: + +|Type|Name|Meaning| +|--|--|--| +| | *args | List[Elements] | + ### AddRows Loops through a list of lists of elements and adds each row, list, to the layout. @@ -11923,16 +11953,21 @@ THIS METHOD IS NO LONGER NEEDED to be called by the user You can perform the same operation by writing this statement: element = window[key] -You can drop the entire "FindElement" function name and use [ ] instead. +You can drop the entire "find_element" function name and use [ ] instead. -Typically used in combination with a call to element's Update method (or any other element method!): -window[key].Update(new_value) +However, if you wish to perform a lookup without error checking, and don't have error popups turned +off globally, you'll need to make this call so that you can disable error checks on this call. + +find_element is yypically used in combination with a call to element's Update method (or any other element method!): +window[key].update(new_value) Versus the "old way" window.FindElement(key).Update(new_value) This call can be abbreviated to any of these: -FindElement == Element == Find +find_element = FindElement == Element == Find +With find_element being the PEP8 compliant call that should be used. + Rememeber that this call will return None if no match is found which may cause your code to crash if not checked for. @@ -11944,7 +11979,7 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element | | bool | silent_on_error | If True do not display popup nor print warning of key errors | | Element or Error Element or None | **RETURN** | Return value can be: the Element that matches the supplied key if found; an Error Element if silent_on_error is False; None if silent_on_error True; @@ -11956,16 +11991,21 @@ THIS METHOD IS NO LONGER NEEDED to be called by the user You can perform the same operation by writing this statement: element = window[key] -You can drop the entire "FindElement" function name and use [ ] instead. +You can drop the entire "find_element" function name and use [ ] instead. -Typically used in combination with a call to element's Update method (or any other element method!): -window[key].Update(new_value) +However, if you wish to perform a lookup without error checking, and don't have error popups turned +off globally, you'll need to make this call so that you can disable error checks on this call. + +find_element is yypically used in combination with a call to element's Update method (or any other element method!): +window[key].update(new_value) Versus the "old way" window.FindElement(key).Update(new_value) This call can be abbreviated to any of these: -FindElement == Element == Find +find_element = FindElement == Element == Find +With find_element being the PEP8 compliant call that should be used. + Rememeber that this call will return None if no match is found which may cause your code to crash if not checked for. @@ -11977,7 +12017,7 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element | | bool | silent_on_error | If True do not display popup nor print warning of key errors | | Element or Error Element or None | **RETURN** | Return value can be: the Element that matches the supplied key if found; an Error Element if silent_on_error is False; None if silent_on_error True; @@ -12032,16 +12072,21 @@ THIS METHOD IS NO LONGER NEEDED to be called by the user You can perform the same operation by writing this statement: element = window[key] -You can drop the entire "FindElement" function name and use [ ] instead. +You can drop the entire "find_element" function name and use [ ] instead. -Typically used in combination with a call to element's Update method (or any other element method!): -window[key].Update(new_value) +However, if you wish to perform a lookup without error checking, and don't have error popups turned +off globally, you'll need to make this call so that you can disable error checks on this call. + +find_element is yypically used in combination with a call to element's Update method (or any other element method!): +window[key].update(new_value) Versus the "old way" window.FindElement(key).Update(new_value) This call can be abbreviated to any of these: -FindElement == Element == Find +find_element = FindElement == Element == Find +With find_element being the PEP8 compliant call that should be used. + Rememeber that this call will return None if no match is found which may cause your code to crash if not checked for. @@ -12053,30 +12098,17 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element | | bool | silent_on_error | If True do not display popup nor print warning of key errors | | Element or Error Element or None | **RETURN** | Return value can be: the Element that matches the supplied key if found; an Error Element if silent_on_error is False; None if silent_on_error True; ### FindElement -Find element object associated with the provided key. -THIS METHOD IS NO LONGER NEEDED to be called by the user +** Warning ** This call will eventually be depricated. ** -You can perform the same operation by writing this statement: -element = window[key] +It is suggested that you modify your code to use the recommended window[key] lookup or the PEP8 compliant window.find_element(key) -You can drop the entire "FindElement" function name and use [ ] instead. - -Typically used in combination with a call to element's Update method (or any other element method!): -window[key].Update(new_value) - -Versus the "old way" -window.FindElement(key).Update(new_value) - -This call can be abbreviated to any of these: -FindElement == Element == Find -Rememeber that this call will return None if no match is found which may cause your code to crash if not -checked for. +For now, you'll only see a message printed and the call will continue to funcation as before. ``` FindElement(key, silent_on_error = False) @@ -12086,7 +12118,7 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element | | bool | silent_on_error | If True do not display popup nor print warning of key errors | | Element or Error Element or None | **RETURN** | Return value can be: the Element that matches the supplied key if found; an Error Element if silent_on_error is False; None if silent_on_error True; @@ -12304,8 +12336,8 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| -| str | icon | Filename or bytes object | -| str | pngbase64 | Base64 encoded image | +| str | icon | Filename or bytes object | +| bytes | pngbase64 | Base64 encoded image | ### SetTransparentColor @@ -12440,6 +12472,12 @@ Reads the context menu read(timeout = None) ``` +Parameter Descriptions: + +|Type|Name|Meaning| +|--|--|--| +| | timeout | Optional. Any value other than None indicates a non-blocking read | + ### show_message Shows a balloon above icon in system tray @@ -12526,6 +12564,12 @@ Reads the context menu Read(timeout = None) ``` +Parameter Descriptions: + +|Type|Name|Meaning| +|--|--|--| +| | timeout | Optional. Any value other than None indicates a non-blocking read | + ### ShowMessage Shows a balloon above icon in system tray @@ -12686,7 +12730,7 @@ Parameter Descriptions: | bool | bind_return_key | (Default = False) If True, then the return key will cause a the Listbox to generate an event | | bool | focus | if focus should be set to this | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | str | locale | defines the locale used to get day names | | str | format | formats result using this strftime format | @@ -12728,8 +12772,9 @@ Parameter Descriptions: | str | tooltip | text, that will appear when mouse hovers over the element | | str or Tuple[str, int] | font | specifies the font family, size, etc | | bool | bind_return_key | (Default = False) If True, then the return key will cause a the Listbox to generate an event | -| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | focus | if focus should be set to this :param pad: Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| | focus | if focus should be set to this | +| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | Anything you want to store along with this button | | (Button) | **RETURN** | returns a button @@ -12778,7 +12823,7 @@ Parameter Descriptions: | bool | bind_return_key | If True, then the return key will cause a the Listbox to generate an event | | bool | focus | Determines if initial focus should go to this element. | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | User metadata that can be set to ANYTHING | | (Button) | **RETURN** | returns a button @@ -12813,8 +12858,9 @@ Parameter Descriptions: | str or Tuple[str, int] | font | specifies the font family, size, etc | | str | tooltip | text, that will appear when mouse hovers over the element | | bool | bind_return_key | (Default = False) If True, then the return key will cause a the Listbox to generate an event | -| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | focus | if focus should be set to this :param pad: Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| | focus | if focus should be set to this | +| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | Anything you want to store along with this button | | (Button) | **RETURN** | returns a button @@ -12861,7 +12907,7 @@ Parameter Descriptions: | bool | bind_return_key | (Default = False) If True, then the return key will cause a the Listbox to generate an event | | bool | focus | if focus should be set to this | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | Anything you want to store along with this button | | (Button) | **RETURN** | returns a button @@ -12896,8 +12942,9 @@ Parameter Descriptions: | str | tooltip | text, that will appear when mouse hovers over the element | | str or Tuple[str, int] | font | specifies the font family, size, etc | | bool | bind_return_key | (Default = False) If True, then the return key will cause a the Listbox to generate an event | -| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | focus | if focus should be set to this :param pad: Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| | focus | if focus should be set to this | +| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | Anything you want to store along with this button | | (Button) | **RETURN** | returns a button @@ -12927,8 +12974,10 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| | str | button_text | text in the button (Default value = 'Browse') | -| Tuple[(str, str), ...] | target | key or (row,col) target for the button (Default value = (ThisRow, -1)) :param file_types: filter file types (Default value = (("ALL Files", "*.*"))) | -| str | initial_folder | starting path for folders and files :param tooltip: text, that will appear when mouse hovers over the element | +| str or (int, int) | target | key or (row,col) target for the button (Default value = (ThisRow, -1)) | +| Tuple[(str, str), ...] | file_types | filter file types (Default value = (("ALL Files", "*.*"))) | +| | initial_folder | starting path for folders and files | +| str | tooltip | text, that will appear when mouse hovers over the element | | (int, int) | size | (w,h) w=characters-wide, h=rows-high | | (int, int) or (None, None) | s | Same as size parameter. It's an alias. If EITHER of them are set, then the one that's set will be used. If BOTH are set, size will be used | | bool | auto_size_button | True if button size is determined by button text | @@ -12938,7 +12987,7 @@ Parameter Descriptions: | str or Tuple[str, int] | font | specifies the font family, size, etc | | bool | disabled | set disable state for element (Default = False) | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | Anything you want to store along with this button | | (Button) | **RETURN** | returns a button @@ -12969,7 +13018,8 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| | str | button_text | text in the button (Default value = 'Save As...') | -| Tuple[(str, str), ...] | target | key or (row,col) target for the button (Default value = (ThisRow, -1)) :param file_types: (Default value = (("ALL Files", "*.*"))) | +| str or (int, int) | target | key or (row,col) target for the button (Default value = (ThisRow, -1)) | +| Tuple[(str, str), ...] | file_types | (Default value = (("ALL Files", "*.*"))) | | str | default_extension | If no extension entered by user, add this to filename (only used in saveas dialogs) | | str | initial_folder | starting path for folders and files | | bool | disabled | set disable state for element (Default = False) | @@ -12982,7 +13032,7 @@ Parameter Descriptions: | bool | enable_events | Turns on the element specific events.(Default = False) | | str or Tuple[str, int] | font | specifies the font family, size, etc | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | Anything you want to store along with this button | | (Button) | **RETURN** | returns a button @@ -13015,7 +13065,8 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| | str | button_text | text in the button (Default value = 'Browse') | -| Tuple[(str, str), ...] | target | key or (row,col) target for the button (Default value = (ThisRow, -1)) :param file_types: (Default value = (("ALL Files", "*.*"))) | +| str or (int, int) | target | key or (row,col) target for the button (Default value = (ThisRow, -1)) | +| Tuple[(str, str), ...] | file_types | (Default value = (("ALL Files", "*.*"))) | | bool | disabled | set disable state for element (Default = False) | | str | initial_folder | starting path for folders and files | | str | tooltip | text, that will appear when mouse hovers over the element | @@ -13027,7 +13078,7 @@ Parameter Descriptions: | bool | enable_events | Turns on the element specific events.(Default = False) | | str or Tuple[str, int] | font | specifies the font family, size, etc | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | str | files_delimiter | String to place between files when multiple files are selected. Normally a ; | | Any | metadata | Anything you want to store along with this button | @@ -13057,18 +13108,19 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| | str | button_text | text in the button (Default value = 'Browse') | -| key or (row,col) | target | target for the button (Default value = (ThisRow, -1)) | +| str or (int, int) | target | target for the button (Default value = (ThisRow, -1)) | | str | initial_folder | starting path for folders and files | | str | tooltip | text, that will appear when mouse hovers over the element | | (int, int) | size | (w,h) w=characters-wide, h=rows-high | | (int, int) or (None, None) | s | Same as size parameter. It's an alias. If EITHER of them are set, then the one that's set will be used. If BOTH are set, size will be used | | bool | auto_size_button | True if button size is determined by button text | -| bool | button_color | button color (foreground, background) :param disabled: set disable state for element (Default = False) | +| | button_color | button color (foreground, background) | +| bool | disabled | set disable state for element (Default = False) | | bool | change_submits | If True, pressing Enter key submits window (Default = False) | | bool | enable_events | Turns on the element specific events.(Default = False) | | str or Tuple[str, int] | font | specifies the font family, size, etc | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element | -| str or int or tuple or object | key | Used with window.FindElement and with return values to uniquely identify this element | +| str or int or tuple or object | key | Used with window.find_element and with return values to uniquely identify this element | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | Anything you want to store along with this button | | (Button) | **RETURN** | The Button created @@ -13103,8 +13155,9 @@ Parameter Descriptions: | str or Tuple[str, int] | font | specifies the font family, size, etc | | str | tooltip | text, that will appear when mouse hovers over the element | | bool | bind_return_key | (Default = False) If True, then the return key will cause a the Listbox to generate an event | -| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | focus | if focus should be set to this :param pad: Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| | focus | if focus should be set to this | +| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | Anything you want to store along with this button | | (Button) | **RETURN** | returns a button @@ -13139,8 +13192,9 @@ Parameter Descriptions: | str | tooltip | text, that will appear when mouse hovers over the element | | str or Tuple[str, int] | font | specifies the font family, size, etc | | bool | bind_return_key | (Default = False) If True, then the return key will cause a the Listbox to generate an event | -| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | focus | if focus should be set to this :param pad: Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| | focus | if focus should be set to this | +| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | Anything you want to store along with this button | | (Button) | **RETURN** | returns a button @@ -13177,7 +13231,7 @@ Parameter Descriptions: | str or Tuple[str, int] | font | specifies the font family, size, etc | | idk_yetReally | focus | if focus should be set to this | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | Anything you want to store along with this button | | (Button) | **RETURN** | returns a button @@ -13242,7 +13296,7 @@ Parameter Descriptions: | str or Tuple[str, int] | font | specifies the font family, size, etc | | idk_yetReally | focus | if focus should be set to this | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | Anything you want to store along with this button | | (Button) | **RETURN** | returns a button @@ -13279,7 +13333,7 @@ Parameter Descriptions: | str or Tuple[str, int] | font | specifies the font family, size, etc | | idk_yetReally | focus | if focus should be set to this | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | Anything you want to store along with this button | | (Button) | **RETURN** | returns a button @@ -13314,8 +13368,9 @@ Parameter Descriptions: | str | tooltip | text, that will appear when mouse hovers over the element | | str or Tuple[str, int] | font | specifies the font family, size, etc | | bool | bind_return_key | (Default = False) If True, then the return key will cause a the Listbox to generate an event | -| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | focus | if focus should be set to this :param pad: Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| | focus | if focus should be set to this | +| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | Anything you want to store along with this button | | (Button) | **RETURN** | returns a button @@ -13361,7 +13416,7 @@ Parameter Descriptions: | bool | bind_return_key | (Default = False) If True, then the return key will cause a the Listbox to generate an event | | bool | focus | if focus should be set to this | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | int | border_width | width of border around element | | Any | metadata | Anything you want to store along with this button | @@ -13399,7 +13454,7 @@ Parameter Descriptions: | str or Tuple[str, int] | font | specifies the font family, size, etc | | idk_yetReally | focus | if focus should be set to this | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | Anything you want to store along with this button | | (Button) | **RETURN** | returns a button @@ -13430,7 +13485,8 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| | str | button_text | text in the button (Default value = 'Save As...') | -| Tuple[(str, str), ...] | target | key or (row,col) target for the button (Default value = (ThisRow, -1)) :param file_types: (Default value = (("ALL Files", "*.*"))) | +| str or (int, int) | target | key or (row,col) target for the button (Default value = (ThisRow, -1)) | +| Tuple[(str, str), ...] | file_types | (Default value = (("ALL Files", "*.*"))) | | str | default_extension | If no extension entered by user, add this to filename (only used in saveas dialogs) | | str | initial_folder | starting path for folders and files | | bool | disabled | set disable state for element (Default = False) | @@ -13443,7 +13499,7 @@ Parameter Descriptions: | bool | enable_events | Turns on the element specific events.(Default = False) | | str or Tuple[str, int] | font | specifies the font family, size, etc | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | Anything you want to store along with this button | | (Button) | **RETURN** | returns a button @@ -13480,7 +13536,7 @@ Parameter Descriptions: | str or Tuple[str, int] | font | specifies the font family, size, etc | | idk_yetReally | focus | if focus should be set to this | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | Anything you want to store along with this button | | (Button) | **RETURN** | returns a button @@ -13515,8 +13571,9 @@ Parameter Descriptions: | str | tooltip | text, that will appear when mouse hovers over the element | | str or Tuple[str, int] | font | specifies the font family, size, etc | | bool | bind_return_key | (Default = True) If True, then the return key will cause a the Listbox to generate an event | -| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | focus | if focus should be set to this :param pad: Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| | focus | if focus should be set to this | +| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | Anything you want to store along with this button | | (Button) | **RETURN** | returns a button @@ -13567,7 +13624,7 @@ Parameter Descriptions: | bool | disabled | set disable state for element (Default = False) | | idk_yetReally | focus | if focus should be set to this | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | int | border_width | width of border around element | | Any | metadata | Anything you want to store along with this button | @@ -13614,7 +13671,7 @@ Parameter Descriptions: | bool | disabled | set disable state for element (Default = False) | | idk_yetReally | focus | if focus should be set to this | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | int | border_width | width of border around element | | Any | metadata | Anything you want to store along with this button | @@ -13661,7 +13718,7 @@ Parameter Descriptions: | bool | disabled | set disable state for element (Default = False) | | idk_yetReally | focus | if focus should be set to this | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | Anything you want to store along with this button | | (Button) | **RETURN** | returns a button @@ -13707,7 +13764,7 @@ Parameter Descriptions: | bool | disabled | set disable state for element (Default = False) | | idk_yetReally | focus | if focus should be set to this | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) | pad | Amount of padding to put around element in pixels (left/right, top/bottom) | -| str or int or tuple or object | key | key for uniquely identify this element (for window.FindElement) | +| str or int or tuple or object | key | key for uniquely identify this element (for window.find_element) | | str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. | | Any | metadata | Anything you want to store along with this button | | (Button) | **RETURN** | returns a button @@ -14040,7 +14097,8 @@ cprint(args=*<1 or N object>, c = None, window = None, key = None, - justification = None) + justification = None, + autoscroll = True) ``` Parameter Descriptions: @@ -14051,15 +14109,16 @@ Parameter Descriptions: | str | text_color | Color of the text | | str or (str, int) or (str, int, str) | font | specifies the font family, size, etc for the value being updated | | str | background_color | The background color of the line | -| str or str, str | colors | Either a tuple or a string that has both the text and background colors | +| str or str, str | colors | Either a tuple or a string that has both the text and background colors "text on background" or just the text color | | str | t | Color of the text | | str | b | The background color of the line | -| str or str, str | c | Either a tuple or a string that has both the text and background colors | +| str or str, str | c | Either a tuple or a string. Same as the color parm | | str | end | end character | | str | sep | separator character | | Any | key | key of multiline to output to (if you want to override the one previously set) | -| str | window | Window containing the multiline to output to (if you want to override the one previously set) :param justification: text justification. left, right, center. Can use single characters l, r, c. Sets only for this value, not entire element | -| None | **RETURN** | None +| | window | Window containing the multiline to output to (if you want to override the one previously set) | +| str | justification | text justification. left, right, center. Can use single characters l, r, c. Sets only for this value, not entire element | +| bool | autoscroll | If True the contents of the element will automatically scroll as more data added to the end | Sets up the color print (cprint) output destination @@ -14089,7 +14148,8 @@ OneLineProgressMeter(title, size = (20, 20), border_width = None, grab_anywhere = False, - no_titlebar = False) + no_titlebar = False, + keep_on_top = False) ``` Parameter Descriptions: @@ -14108,6 +14168,7 @@ Parameter Descriptions: | int | border_width | width of border around element | | bool | grab_anywhere | If True: can grab anywhere to move the window (Default = False) | | bool | no_titlebar | If True: no titlebar will be shown on the window | +| bool | keep_on_top | If True the window will remain above all current windows | | (bool) | **RETURN** | True if updated successfully. False if user closed the meter with the X or Cancel button Cancels and closes a previously created One Line Progress Meter window @@ -14135,7 +14196,8 @@ one_line_progress_meter(title, size = (20, 20), border_width = None, grab_anywhere = False, - no_titlebar = False) + no_titlebar = False, + keep_on_top = False) ``` Parameter Descriptions: @@ -14154,6 +14216,7 @@ Parameter Descriptions: | int | border_width | width of border around element | | bool | grab_anywhere | If True: can grab anywhere to move the window (Default = False) | | bool | no_titlebar | If True: no titlebar will be shown on the window | +| bool | keep_on_top | If True the window will remain above all current windows | | (bool) | **RETURN** | True if updated successfully. False if user closed the meter with the X or Cancel button Cancels and closes a previously created One Line Progress Meter window @@ -14262,7 +14325,7 @@ Parameter Descriptions: | int | time_between_frames | Amount of time in milliseconds between each frame | | str | transparent_color | This color will be completely see-through in your window. Can even click through | | str | title | Title that will be shown on the window | -| str | icon | Same as Window icon parameter. Can be either a filename or Base64 value. For Windows if filename, it MUST be ICO format. For Linux, must NOT be ICO | +| str or bytes | icon | Same as Window icon parameter. Can be either a filename or Base64 byte string. For Windows if filename, it MUST be ICO format. For Linux, must NOT be ICO | | bool | **RETURN** | True if the window updated OK. False if the window was closed Popup that closes itself after some time period @@ -14425,20 +14488,20 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| -| int | start_mon | The starting month | -| int or None | start_day | The starting day - optional. Set to None or 0 if no date to be chosen at start | -| int | start_year | The starting year | -| int | begin_at_sunday_plus | Determines the left-most day in the display. 0=sunday, 1=monday, etc | -| str | icon | Same as Window icon parameter. Can be either a filename or Base64 value. For Windows if filename, it MUST be ICO format. For Linux, must NOT be ICO | -| (int, int) | location | (x,y) location on the screen to place the top left corner of your window. Default is to center on screen | -| str | title | Title that will be shown on the window | -| bool | close_when_chosen | If True, the window will close and function return when a day is clicked | -| str | locale | locale used to get the day names | -| bool | no_titlebar | If True no titlebar will be shown | -| bool | keep_on_top | If True the window will remain above all current windows | -| List[str] | month_names | optional list of month names to use (should be 12 items) | -| List[str] | day_abbreviations | optional list of abbreviations to display as the day of week | -| bool | modal | If True then makes the popup will behave like a Modal window... all other windows are non-operational until this one is closed. Default = True | +| int | start_mon | The starting month | +| int or None | start_day | The starting day - optional. Set to None or 0 if no date to be chosen at start | +| int | start_year | The starting year | +| int | begin_at_sunday_plus | Determines the left-most day in the display. 0=sunday, 1=monday, etc | +| (str or bytes) | icon | Same as Window icon parameter. Can be either a filename or Base64 value. For Windows if filename, it MUST be ICO format. For Linux, must NOT be ICO | +| (int, int) | location | (x,y) location on the screen to place the top left corner of your window. Default is to center on screen | +| str | title | Title that will be shown on the window | +| bool | close_when_chosen | If True, the window will close and function return when a day is clicked | +| str | locale | locale used to get the day names | +| bool | no_titlebar | If True no titlebar will be shown | +| bool | keep_on_top | If True the window will remain above all current windows | +| List[str] | month_names | optional list of month names to use (should be 12 items) | +| List[str] | day_abbreviations | optional list of abbreviations to display as the day of week | +| bool | modal | If True then makes the popup will behave like a Modal window... all other windows are non-operational until this one is closed. Default = True | | None or (int, int, int) | **RETURN** | Tuple containing (month, day, year) of chosen date or None if was cancelled Display popup window with text entry field and browse button so that a file can be chosen by user. @@ -15254,7 +15317,7 @@ Parameter Descriptions: | int | time_between_frames | Amount of time in milliseconds between each frame | | str | transparent_color | This color will be completely see-through in your window. Can even click through | | str | title | Title that will be shown on the window | -| str | icon | Same as Window icon parameter. Can be either a filename or Base64 value. For Windows if filename, it MUST be ICO format. For Linux, must NOT be ICO | +| str or bytes | icon | Same as Window icon parameter. Can be either a filename or Base64 byte string. For Windows if filename, it MUST be ICO format. For Linux, must NOT be ICO | | bool | **RETURN** | True if the window updated OK. False if the window was closed Display a Popup without a titlebar. Enables grab anywhere so you can move it @@ -17012,7 +17075,6 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| | bytes or str | icon | Either a Base64 byte string or a filename | -| None | **RETURN** | None ``` set_options(icon = None, @@ -17070,7 +17132,7 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| -| bytes or str | icon | filename or base64 string to be used for the window's icon | +| bytes or str | icon | Can be either a filename or Base64 value. For Windows if filename, it MUST be ICO format. For Linux, must NOT be ICO. Most portable is to use a Base64 of a PNG file. This works universally across all OS's | | (str, str) or str | button_color | Color of the button (text, background) | | (int, int) | element_size | element size (width, height) in characters | | (int, int) | button_element_size | Size of button | @@ -17135,7 +17197,6 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| | bytes or str | icon | Either a Base64 byte string or a filename | -| None | **RETURN** | None ``` SetOptions(icon = None, @@ -17193,7 +17254,7 @@ Parameter Descriptions: |Type|Name|Meaning| |--|--|--| -| bytes or str | icon | filename or base64 string to be used for the window's icon | +| bytes or str | icon | Can be either a filename or Base64 value. For Windows if filename, it MUST be ICO format. For Linux, must NOT be ICO. Most portable is to use a Base64 of a PNG file. This works universally across all OS's | | (str, str) or str | button_color | Color of the button (text, background) | | (int, int) | element_size | element size (width, height) in characters | | (int, int) | button_element_size | Size of button |