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

Better docstring description for icon in Window and set_options. Describes a Base64 encoded GIF as the most portable icon.

This commit is contained in:
PySimpleGUI 2021-07-04 15:07:08 -04:00
parent 93633b4a95
commit 0ebf12954e
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
PySimpleGUI.py
View File

@ -7807,7 +7807,7 @@ class Window:
:type auto_close: (bool) :type auto_close: (bool)
:param auto_close_duration: Number of seconds to wait before closing the window :param auto_close_duration: Number of seconds to wait before closing the window
:type auto_close_duration: (int) :type auto_close_duration: (int)
:param icon: Can be either a filename or Base64 value. For Windows if filename, it MUST be ICO format. For Linux, must NOT be ICO :param 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 GIF file. This works universally across all OS's
:type icon: (str | bytes) :type icon: (str | bytes)
:param force_toplevel: If True will cause this window to skip the normal use of a hidden master window :param force_toplevel: If True will cause this window to skip the normal use of a hidden master window
:type force_toplevel: (bool) :type force_toplevel: (bool)
@ -15047,7 +15047,7 @@ def set_options(icon=None, button_color=None, element_size=(None, None), button_
scrollbar_color=None, text_color=None, element_text_color=None, debug_win_size=(None, None), scrollbar_color=None, text_color=None, element_text_color=None, debug_win_size=(None, None),
window_location=(None, None), error_button_color=(None, None), tooltip_time=None, tooltip_font=None, use_ttk_buttons=None, ttk_theme=None, suppress_error_popups=None, suppress_raise_key_errors=None, suppress_key_guessing=None, enable_treeview_869_patch=None, enable_mac_notitlebar_patch=None, use_custom_titlebar=None, titlebar_background_color=None, titlebar_text_color=None, titlebar_font=None, titlebar_icon=None, user_settings_path=None, pysimplegui_settings_path=None, pysimplegui_settings_filename=None): window_location=(None, None), error_button_color=(None, None), tooltip_time=None, tooltip_font=None, use_ttk_buttons=None, ttk_theme=None, suppress_error_popups=None, suppress_raise_key_errors=None, suppress_key_guessing=None, enable_treeview_869_patch=None, enable_mac_notitlebar_patch=None, use_custom_titlebar=None, titlebar_background_color=None, titlebar_text_color=None, titlebar_font=None, titlebar_icon=None, user_settings_path=None, pysimplegui_settings_path=None, pysimplegui_settings_filename=None):
""" """
:param icon: filename or base64 string to be used for the window's icon :param 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 GIF file. This works universally across all OS's
:type icon: bytes | str :type icon: bytes | str
:param button_color: Color of the button (text, background) :param button_color: Color of the button (text, background)
:type button_color: (str, str) or str :type button_color: (str, str) or str