MCPcopy Index your code
hub / github.com/PySimpleGUI/PySimpleGUI / __init__

Method __init__

PySimpleGUI/PySimpleGUI.py:4709–4768  ·  view source on GitHub ↗

:param 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 :type size: (int, int) | (None, None) | int :param s: Same as size parameter.

(self, size=(None, None), s=(None, None), background_color=None, text_color=None, pad=None, p=None, autoscroll_only_at_bottom=False, echo_stdout_stderr=False, font=None, tooltip=None,
                 key=None, k=None, right_click_menu=None, expand_x=False, expand_y=False, visible=True, metadata=None, wrap_lines=None, horizontal_scroll=None,
                 sbar_trough_color=None, sbar_background_color=None, sbar_arrow_color=None,  sbar_width=None, sbar_arrow_width=None, sbar_frame_color=None, sbar_relief=None)

Source from the content-addressed store, hash-verified

4707 """
4708
4709 def __init__(self, size=(None, None), s=(None, None), background_color=None, text_color=None, pad=None, p=None, autoscroll_only_at_bottom=False, echo_stdout_stderr=False, font=None, tooltip=None,
4710 key=None, k=None, right_click_menu=None, expand_x=False, expand_y=False, visible=True, metadata=None, wrap_lines=None, horizontal_scroll=None,
4711 sbar_trough_color=None, sbar_background_color=None, sbar_arrow_color=None, sbar_width=None, sbar_arrow_width=None, sbar_frame_color=None, sbar_relief=None):
4712 """
4713 :param 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
4714 :type size: (int, int) | (None, None) | int
4715 :param 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
4716 :type s: (int, int) | (None, None) | int
4717 :param background_color: color of background
4718 :type background_color: (str)
4719 :param text_color: color of the text
4720 :type text_color: (str)
4721 :param 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)
4722 :type pad: (int, int) or ((int, int),(int,int)) or (int,(int,int)) or ((int, int),int) | int
4723 :param 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
4724 :type p: (int, int) or ((int, int),(int,int)) or (int,(int,int)) or ((int, int),int) | int
4725 :param 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
4726 :type autoscroll_only_at_bottom: (bool)
4727 :param echo_stdout_stderr: If True then output to stdout will be output to this element AND also to the normal console location
4728 :type echo_stdout_stderr: (bool)
4729 :param font: specifies the font family, size, etc. Tuple or Single string format 'name size styles'. Styles: italic * roman bold normal underline overstrike
4730 :type font: (str or (str, int[, str]) or None)
4731 :param tooltip: text, that will appear when mouse hovers over the element
4732 :type tooltip: (str)
4733 :param key: Used with window.find_element and with return values to uniquely identify this element to uniquely identify this element
4734 :type key: str | int | tuple | object
4735 :param k: Same as the Key. You can use either k or key. Which ever is set will be used.
4736 :type k: str | int | tuple | object
4737 :param right_click_menu: A list of lists of Menu items to show when this element is right clicked. See user docs for exact format.
4738 :type right_click_menu: List[List[ List[str] | str ]]
4739 :param expand_x: If True the element will automatically expand in the X direction to fill available space
4740 :type expand_x: (bool)
4741 :param expand_y: If True the element will automatically expand in the Y direction to fill available space
4742 :type expand_y: (bool)
4743 :param visible: set visibility state of the element
4744 :type visible: (bool)
4745 :param metadata: User metadata that can be set to ANYTHING
4746 :type metadata: (Any)
4747 :param 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.
4748 :type wrap_lines: (bool)
4749 :param horizontal_scroll: Controls if a horizontal scrollbar should be shown. If True, then line wrapping will be off by default
4750 :type horizontal_scroll: (bool)
4751 :param sbar_trough_color: Scrollbar color of the trough
4752 :type sbar_trough_color: (str)
4753 :param 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
4754 :type sbar_background_color: (str)
4755 :param 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
4756 :type sbar_arrow_color: (str)
4757 :param sbar_width: Scrollbar width in pixels
4758 :type sbar_width: (int)
4759 :param sbar_arrow_width: Scrollbar width of the arrow on the scrollbar. It will potentially impact the overall width of the scrollbar
4760 :type sbar_arrow_width: (int)
4761 :param sbar_frame_color: Scrollbar Color of frame around scrollbar (available only on some ttk themes)
4762 :type sbar_frame_color: (str)
4763 :param 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
4764 :type sbar_relief: (str)
4765 """
4766

Callers

nothing calls this directly

Calls 1

__init__Method · 0.45

Tested by

no test coverage detected