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

Picking up the latest Multiline & Output element feature that's on GitHub - new parameter autoscroll_only_at_bottom

This commit is contained in:
PySimpleGUI 2023-02-24 08:58:41 -05:00
parent ba0e5fed78
commit 8f74aa5c8d
2 changed files with 58 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
docs/call reference.md
View File

@ -6248,6 +6248,7 @@ Multiline(default_text = "",
enter_submits = False, enter_submits = False,
disabled = False, disabled = False,
autoscroll = False, autoscroll = False,
autoscroll_only_at_bottom = False,
border_width = None, border_width = None,
size = (None, None), size = (None, None),
s = (None, None), s = (None, None),
@ -6299,6 +6300,7 @@ Parameter Descriptions:
| bool | enter_submits | if True, the Window.read call will return is enter key is pressed in this element | | bool | enter_submits | if True, the Window.read call will return is enter key is pressed in this element |
| bool | disabled | set disable state | | bool | disabled | set disable state |
| bool | autoscroll | If True the contents of the element will automatically scroll as more data added to the end | | bool | autoscroll | If True the contents of the element will automatically scroll as more data added to the end |
| bool | autoscroll_only_at_bottom | If True the contents of the element will automatically scroll only if the scrollbar is at the bottom of the multiline |
| int | border_width | width of border around element in pixels | | int | border_width | width of border around element in pixels |
| (int, int) or (None, None) or int | size | (w, h) w=characters-wide, h=rows-high. If an int instead of a tuple is supplied, then height is auto-set to 1 | | (int, int) or (None, None) or int | size | (w, h) w=characters-wide, h=rows-high. If an int instead of a tuple is supplied, then height is auto-set to 1 |
| (int, int) or (None, None) or int | 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 (None, None) or int | 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 |
@ -7235,6 +7237,7 @@ Output(size = (None, None),
text_color = None, text_color = None,
pad = None, pad = None,
p = None, p = None,
autoscroll_only_at_bottom = False,
echo_stdout_stderr = False, echo_stdout_stderr = False,
font = None, font = None,
tooltip = None, tooltip = None,
@ -7260,31 +7263,32 @@ Parameter Descriptions:
|Type|Name|Meaning| |Type|Name|Meaning|
|--|--|--| |--|--|--|
| (int, int) or (None, None) or int | size | (w, h) w=characters-wide, h=rows-high. If an int instead of a tuple is supplied, then height is auto-set to 1 | | (int, int) or (None, None) or int | size | (w, h) w=characters-wide, h=rows-high. If an int instead of a tuple is supplied, then height is auto-set to 1 |
| (int, int) or (None, None) or int | 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 (None, None) or int | 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 | background_color | color of background | | str | background_color | color of background |
| str | text_color | color of the text | | str | text_color | color of the text |
| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) or int | pad | Amount of padding to put around element in pixels (left/right, top/bottom) or ((left, right), (top, bottom)) or an int. If an int, then it's converted into a tuple (int, int) | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) or int | pad | Amount of padding to put around element in pixels (left/right, top/bottom) or ((left, right), (top, bottom)) or an int. If an int, then it's converted into a tuple (int, int) |
| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) or int | p | Same as pad parameter. It's an alias. If EITHER of them are set, then the one that's set will be used. If BOTH are set, pad will be used | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) or int | p | Same as pad parameter. It's an alias. If EITHER of them are set, then the one that's set will be used. If BOTH are set, pad will be used |
| bool | echo_stdout_stderr | If True then output to stdout will be output to this element AND also to the normal console location | | bool | autoscroll_only_at_bottom | If True the contents of the element will automatically scroll only if the scrollbar is at the bottom of the multiline |
| (str or (str, int[, str]) or None) | font | specifies the font family, size, etc. Tuple or Single string format 'name size styles'. Styles: italic * roman bold normal underline overstrike | | bool | echo_stdout_stderr | If True then output to stdout will be output to this element AND also to the normal console location |
| str | tooltip | text, that will appear when mouse hovers over the element | | (str or (str, int[, str]) or None) | font | specifies the font family, size, etc. Tuple or Single string format 'name size styles'. Styles: italic * roman bold normal underline overstrike |
| 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 | tooltip | text, that will appear when mouse hovers over the 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 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 |
| 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 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 | expand_x | If True the element will automatically expand in the X direction to fill available space | | 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 | expand_y | If True the element will automatically expand in the Y direction to fill available space | | bool | expand_x | If True the element will automatically expand in the X direction to fill available space |
| bool | visible | set visibility state of the element | | bool | expand_y | If True the element will automatically expand in the Y direction to fill available space |
| Any | metadata | User metadata that can be set to ANYTHING | | bool | visible | set visibility state of the element |
| bool | wrap_lines | If True, the lines will be wrapped automatically. Other parms affect this setting, but this one will override them all. Default is it does nothing and uses previous settings for wrapping. | | Any | metadata | User metadata that can be set to ANYTHING |
| bool | horizontal_scroll | Controls if a horizontal scrollbar should be shown. If True, then line wrapping will be off by default | | bool | wrap_lines | If True, the lines will be wrapped automatically. Other parms affect this setting, but this one will override them all. Default is it does nothing and uses previous settings for wrapping. |
| str | sbar_trough_color | Scrollbar color of the trough | | bool | horizontal_scroll | Controls if a horizontal scrollbar should be shown. If True, then line wrapping will be off by default |
| str | sbar_background_color | Scrollbar color of the background of the arrow buttons at the ends AND the color of the "thumb" (the thing you grab and slide). Switches to arrow color when mouse is over | | str | sbar_trough_color | Scrollbar color of the trough |
| str | sbar_arrow_color | Scrollbar color of the arrow at the ends of the scrollbar (it looks like a button). Switches to background color when mouse is over | | str | sbar_background_color | Scrollbar color of the background of the arrow buttons at the ends AND the color of the "thumb" (the thing you grab and slide). Switches to arrow color when mouse is over |
| int | sbar_width | Scrollbar width in pixels | | str | sbar_arrow_color | Scrollbar color of the arrow at the ends of the scrollbar (it looks like a button). Switches to background color when mouse is over |
| int | sbar_arrow_width | Scrollbar width of the arrow on the scrollbar. It will potentially impact the overall width of the scrollbar | | int | sbar_width | Scrollbar width in pixels |
| str | sbar_frame_color | Scrollbar Color of frame around scrollbar (available only on some ttk themes) | | int | sbar_arrow_width | Scrollbar width of the arrow on the scrollbar. It will potentially impact the overall width of the scrollbar |
| str | sbar_relief | Scrollbar relief that will be used for the "thumb" of the scrollbar (the thing you grab that slides). Should be a constant that is defined at starting with "RELIEF_" - RELIEF_RAISED, RELIEF_SUNKEN, RELIEF_FLAT, RELIEF_RIDGE, RELIEF_GROOVE, RELIEF_SOLID | | str | sbar_frame_color | Scrollbar Color of frame around scrollbar (available only on some ttk themes) |
| str | sbar_relief | Scrollbar relief that will be used for the "thumb" of the scrollbar (the thing you grab that slides). Should be a constant that is defined at starting with "RELIEF_" - RELIEF_RAISED, RELIEF_SUNKEN, RELIEF_FLAT, RELIEF_RIDGE, RELIEF_GROOVE, RELIEF_SOLID |
### bind ### bind

54
readme_creator/output/call reference.md
View File

@ -6248,6 +6248,7 @@ Multiline(default_text = "",
enter_submits = False, enter_submits = False,
disabled = False, disabled = False,
autoscroll = False, autoscroll = False,
autoscroll_only_at_bottom = False,
border_width = None, border_width = None,
size = (None, None), size = (None, None),
s = (None, None), s = (None, None),
@ -6299,6 +6300,7 @@ Parameter Descriptions:
| bool | enter_submits | if True, the Window.read call will return is enter key is pressed in this element | | bool | enter_submits | if True, the Window.read call will return is enter key is pressed in this element |
| bool | disabled | set disable state | | bool | disabled | set disable state |
| bool | autoscroll | If True the contents of the element will automatically scroll as more data added to the end | | bool | autoscroll | If True the contents of the element will automatically scroll as more data added to the end |
| bool | autoscroll_only_at_bottom | If True the contents of the element will automatically scroll only if the scrollbar is at the bottom of the multiline |
| int | border_width | width of border around element in pixels | | int | border_width | width of border around element in pixels |
| (int, int) or (None, None) or int | size | (w, h) w=characters-wide, h=rows-high. If an int instead of a tuple is supplied, then height is auto-set to 1 | | (int, int) or (None, None) or int | size | (w, h) w=characters-wide, h=rows-high. If an int instead of a tuple is supplied, then height is auto-set to 1 |
| (int, int) or (None, None) or int | 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 (None, None) or int | 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 |
@ -7235,6 +7237,7 @@ Output(size = (None, None),
text_color = None, text_color = None,
pad = None, pad = None,
p = None, p = None,
autoscroll_only_at_bottom = False,
echo_stdout_stderr = False, echo_stdout_stderr = False,
font = None, font = None,
tooltip = None, tooltip = None,
@ -7260,31 +7263,32 @@ Parameter Descriptions:
|Type|Name|Meaning| |Type|Name|Meaning|
|--|--|--| |--|--|--|
| (int, int) or (None, None) or int | size | (w, h) w=characters-wide, h=rows-high. If an int instead of a tuple is supplied, then height is auto-set to 1 | | (int, int) or (None, None) or int | size | (w, h) w=characters-wide, h=rows-high. If an int instead of a tuple is supplied, then height is auto-set to 1 |
| (int, int) or (None, None) or int | 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 (None, None) or int | 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 | background_color | color of background | | str | background_color | color of background |
| str | text_color | color of the text | | str | text_color | color of the text |
| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) or int | pad | Amount of padding to put around element in pixels (left/right, top/bottom) or ((left, right), (top, bottom)) or an int. If an int, then it's converted into a tuple (int, int) | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) or int | pad | Amount of padding to put around element in pixels (left/right, top/bottom) or ((left, right), (top, bottom)) or an int. If an int, then it's converted into a tuple (int, int) |
| (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) or int | p | Same as pad parameter. It's an alias. If EITHER of them are set, then the one that's set will be used. If BOTH are set, pad will be used | | (int, int or (int, int),(int,int) or int,(int,int)) or ((int, int),int) or int | p | Same as pad parameter. It's an alias. If EITHER of them are set, then the one that's set will be used. If BOTH are set, pad will be used |
| bool | echo_stdout_stderr | If True then output to stdout will be output to this element AND also to the normal console location | | bool | autoscroll_only_at_bottom | If True the contents of the element will automatically scroll only if the scrollbar is at the bottom of the multiline |
| (str or (str, int[, str]) or None) | font | specifies the font family, size, etc. Tuple or Single string format 'name size styles'. Styles: italic * roman bold normal underline overstrike | | bool | echo_stdout_stderr | If True then output to stdout will be output to this element AND also to the normal console location |
| str | tooltip | text, that will appear when mouse hovers over the element | | (str or (str, int[, str]) or None) | font | specifies the font family, size, etc. Tuple or Single string format 'name size styles'. Styles: italic * roman bold normal underline overstrike |
| 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 | tooltip | text, that will appear when mouse hovers over the 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 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 |
| 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 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 | expand_x | If True the element will automatically expand in the X direction to fill available space | | 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 | expand_y | If True the element will automatically expand in the Y direction to fill available space | | bool | expand_x | If True the element will automatically expand in the X direction to fill available space |
| bool | visible | set visibility state of the element | | bool | expand_y | If True the element will automatically expand in the Y direction to fill available space |
| Any | metadata | User metadata that can be set to ANYTHING | | bool | visible | set visibility state of the element |
| bool | wrap_lines | If True, the lines will be wrapped automatically. Other parms affect this setting, but this one will override them all. Default is it does nothing and uses previous settings for wrapping. | | Any | metadata | User metadata that can be set to ANYTHING |
| bool | horizontal_scroll | Controls if a horizontal scrollbar should be shown. If True, then line wrapping will be off by default | | bool | wrap_lines | If True, the lines will be wrapped automatically. Other parms affect this setting, but this one will override them all. Default is it does nothing and uses previous settings for wrapping. |
| str | sbar_trough_color | Scrollbar color of the trough | | bool | horizontal_scroll | Controls if a horizontal scrollbar should be shown. If True, then line wrapping will be off by default |
| str | sbar_background_color | Scrollbar color of the background of the arrow buttons at the ends AND the color of the "thumb" (the thing you grab and slide). Switches to arrow color when mouse is over | | str | sbar_trough_color | Scrollbar color of the trough |
| str | sbar_arrow_color | Scrollbar color of the arrow at the ends of the scrollbar (it looks like a button). Switches to background color when mouse is over | | str | sbar_background_color | Scrollbar color of the background of the arrow buttons at the ends AND the color of the "thumb" (the thing you grab and slide). Switches to arrow color when mouse is over |
| int | sbar_width | Scrollbar width in pixels | | str | sbar_arrow_color | Scrollbar color of the arrow at the ends of the scrollbar (it looks like a button). Switches to background color when mouse is over |
| int | sbar_arrow_width | Scrollbar width of the arrow on the scrollbar. It will potentially impact the overall width of the scrollbar | | int | sbar_width | Scrollbar width in pixels |
| str | sbar_frame_color | Scrollbar Color of frame around scrollbar (available only on some ttk themes) | | int | sbar_arrow_width | Scrollbar width of the arrow on the scrollbar. It will potentially impact the overall width of the scrollbar |
| str | sbar_relief | Scrollbar relief that will be used for the "thumb" of the scrollbar (the thing you grab that slides). Should be a constant that is defined at starting with "RELIEF_" - RELIEF_RAISED, RELIEF_SUNKEN, RELIEF_FLAT, RELIEF_RIDGE, RELIEF_GROOVE, RELIEF_SOLID | | str | sbar_frame_color | Scrollbar Color of frame around scrollbar (available only on some ttk themes) |
| str | sbar_relief | Scrollbar relief that will be used for the "thumb" of the scrollbar (the thing you grab that slides). Should be a constant that is defined at starting with "RELIEF_" - RELIEF_RAISED, RELIEF_SUNKEN, RELIEF_FLAT, RELIEF_RIDGE, RELIEF_GROOVE, RELIEF_SOLID |
### bind ### bind