From 8220b8c9e294cd68379123536dd8ee783f1c3ef6 Mon Sep 17 00:00:00 2001 From: MikeTheWatchGuy Date: Fri, 28 Jun 2019 21:21:27 -0400 Subject: [PATCH] Finished Input Tesxt doc strings. Removed the Up Arrow character from comments. --- PySimpleGUI.py | 597 ++++++++++++++++++++++++++----------------------- 1 file changed, 311 insertions(+), 286 deletions(-) diff --git a/PySimpleGUI.py b/PySimpleGUI.py index d50534c9..5ae791de 100644 --- a/PySimpleGUI.py +++ b/PySimpleGUI.py @@ -1,5 +1,5 @@ #!/usr/bin/python3 -version = __version__ = "4.1.0.2 Unreleased" +version = __version__ = "4.1.0.3 Unreleased" import sys @@ -42,16 +42,17 @@ g_time_start = 0 g_time_end = 0 g_time_delta = 0 - +# These timer routines are to help you quickly time portions of code. Please this TimerStart call at the point +# you want to start timing and the TimerStop at the end point. As you can see, TimerStop prints the time delta in ms. def TimerStart(): - """ """ + """ Time your code easily.... start the timer. """ global g_time_start g_time_start = time.time() def TimerStop(): - """ """ + """ Time your code easily.... stop the timer and print the number of ms since the timer start """ global g_time_delta, g_time_end g_time_end = time.time() @@ -225,7 +226,15 @@ MENU_KEY_SEPARATOR = '::' # ====================================================================== # # One-liner functions that are handy as f_ck # # ====================================================================== # -def RGB(red, green, blue): return '#%02x%02x%02x' % (red, green, blue) +def RGB(red, green, blue): + """ + Given integer values of Red, Green, Blue, return a color string "#RRGGBB" + :param (int) red: int: Red portion from 0 to 255 + :param (int) green: int: Green portion from 0 to 255 + :param (int) blue: int: Blue portion from 0 to 255 + :return: (str) A single RGB String in the format "#RRGGBB" where each pair is a hex number. + """ + return '#%02x%02x%02x' % (red, green, blue) # ====================================================================== # @@ -294,15 +303,17 @@ POPUP_BUTTONS_NO_BUTTONS = 5 # ------------------------------------------------------------------------- # class ToolTip: - """Create a tooltip for a given widget + """ + Create a tooltip for a given widget (inspired by https://stackoverflow.com/a/36221216) + This is an INTERNALLY USED only class. Users should not refer to this class at all. """ def __init__(self, widget, text, timeout=DEFAULT_TOOLTIP_TIME): """ - :param widget: ????????????????????????? - :param text: text in the tooltip - :param timeout: (Default value = DEFAULT_TOOLTIP_TIME) + :param widget: (widget type varies) The tkinter widget + :param text: text for the tooltip. It can inslude \n + :param timeout: (int) Time in milliseconds that mouse must remain still before tip is shown """ self.widget = widget @@ -318,8 +329,8 @@ class ToolTip: def enter(self, event=None): """ - - :param event: + Called by tkinter when mouse enters a widget + :param event: from tkinter. Has x,y coordinates of mouse """ self.x = event.x @@ -328,26 +339,32 @@ class ToolTip: def leave(self, event=None): """ - - :param event: + Called by tktiner when mouse exits a widget + :param event: from tkinter. Event info that's not used by function. """ self.unschedule() self.hidetip() def schedule(self): - """ """ + """ + Schedule a timer to time how long mouse is hovering + """ self.unschedule() self.id = self.widget.after(self.timeout, self.showtip) def unschedule(self): - """ """ + """ + Cancel timer used to time mouse hover + """ if self.id: self.widget.after_cancel(self.id) self.id = None def showtip(self): - """ """ + """ + Creates a topoltip window with the tooltip text inside of it + """ if self.tipwindow: return x = self.widget.winfo_rootx() + self.x + DEFAULT_TOOLTIP_OFFSET[0] @@ -362,7 +379,9 @@ class ToolTip: label.pack() def hidetip(self): - """ """ + """ + Destroy the tooltip window + """ if self.tipwindow: self.tipwindow.destroy() self.tipwindow = None @@ -386,16 +405,16 @@ class Element(): def __init__(self, type, size=(None, None), auto_size_text=None, font=None, background_color=None, text_color=None, key=None, pad=None, tooltip=None, visible=True): """ Element base class. Only used internally. User will not create an Element object by itself - :param type: ?????????????????????????? - :param size: ▲ (w,h) w=characters-wide, h=rows-high - :param auto_size_text: True if size should fit the text length - :param font: ▲ specifies the font family, size, etc - :param background_color: color of background - :param text_color: element's text color - :param key: ▲ Used with window.FindElement and with return values - :param pad: ▲ Amount of padding to put around element - :param tooltip: text, that will appear the you hover on - :param visible: set visibility state of the element (Default = True) + :param type: (int - could be enum) The type of element. These constants all start with "ELEM_TYPE_" + :param size: (int,int) (width ,height ) w=characters-wide, h=rows-high + :param auto_size_text: (bool) True if the Widget should be shrunk to exactly fit the number of chars to show + :param font: (str or tuple) specifies the font family, size, bold, .... See docs on format of this field + :param background_color: (str) color of background. Can be in #RRGGBB format or a color name "black" + :param text_color: (str) element's text color. Can be in #RRGGBB format or a color name "black" + :param key: (any type) Identifies an Element. Should be UNIQUE to this window. + :param pad: (int, int) or ((int,int),(int,int)) Amount of padding to put around element in pixels (left/right, top/bottom) + :param tooltip: (str) text, that will appear when mouse hovers over the element + :param visible: (bool) set visibility state of the element (Default = True) """ self.Size = size @@ -640,23 +659,23 @@ class InputText(Element): right_click_menu=None, visible=True): """ - :param default_text: Text initially shown in the input box as a default value(Default value = '') - :param size: ▲ (w,h) w=characters-wide, h=rows-high - :param disabled: set disable state for element (Default = False) - :param password_char: Password character if this is a password field (Default value = '') - :param justification: justification for data display. Valid choices - left, right, center - :param background_color: color of background - :param text_color: color of the text - :param font: ▲ specifies the font family, size, etc - :param tooltip: str. Text shown when cursor hovers over the element - :param change_submits: If True, pressing Enter key submits window- DEPRICATED DO NOT USE! (Default = False) - :param enable_events: Turns on the element specific events. Use this instead of change_submits (Default = False) - :param do_not_clear: Bool. If False then the field will be set to blank after ANY submission (button, any event) (Default = True) - :param key: ▲ Any. Value that uniquely identifies this element from all other elements. Used when Finding an element or in return values - :param focus: Bool. Determines if initial focus should go to this element. - :param pad: ▲ Tuple. Amount of padding to put around element. Normally (horizontal pixels, vertical pixels) but can be split apart further into ((horizontal left, horizontal right), (vertical above, vertical below)) + :param default_text: (str) Text initially shown in the input box as a default value(Default value = '') + :param size: (int, int) (width, height) w=characters-wide, h=rows-high + :param disabled: (bool) set disable state for element (Default = False) + :param password_char: (char) Password character if this is a password field (Default value = '') + :param justification: (str) justification for data display. Valid choices - left, right, center + :param background_color: (str) color of background in one of the color formats + :param text_color: (str) color of the text + :param font: (str / tuple) specifies the font family, size, etc + :param tooltip: (str) Text shown when cursor hovers over the element + :param change_submits: (bool) * DEPRICATED DO NOT USE! Same as enable_events + :param enable_events: (bool) If True then changes to this element are immediately reported as an event. Use this instead of change_submits (Default = False) + :param do_not_clear: (bool) If False then the field will be set to blank after ANY event (button, any event) (Default = True) + :param key: (any) Value that uniquely identifies this element from all other elements. Used when Finding an element or in return values. Must be unique to the window + :param focus: (bool) Determines if initial focus should go to this element. + :param pad: (int, int) or ((int, int), (int, int)) Tuple(s). Amount of padding to put around element. Normally (horizontal pixels, vertical pixels) but can be split apart further into ((horizontal left, horizontal right), (vertical above, vertical below)) :param right_click_menu: [[]]. A list of lists of Menu items to show when this element is right clicked. See docs for format. - :param visible: Bool. set visibility state of the element (Default = True) + :param visible: (bool) set visibility state of the element (Default = True) """ self.DefaultText = default_text self.PasswordCharacter = password_char @@ -674,11 +693,11 @@ class InputText(Element): def Update(self, value=None, disabled=None, select=None, visible=None): """ - - :param value: new text to display - :param disabled: disable or enable state of the element - :param select: ???????????????????????????? - :param visible: change visibility of element + Changes some of the settings for the Input Element + :param value: (str) new text to display as default text in Input field + :param disabled: (bool) disable or enable state of the element (sets Entry Widget to readonly or normal) + :param select: (bool) if True, then the text will be selected + :param visible: (bool) change visibility of element """ #NOTE - Read or Finalize must be called on Window prior to Update call @@ -700,7 +719,10 @@ class InputText(Element): self.TKEntry.pack() def Get(self): - """ """ + """ + Read and return the current value of the input element + :return: (str) current value of Input field or '' if error encountered + """ try: text = self.TKStringVar.get() except: @@ -708,7 +730,10 @@ class InputText(Element): return text def SetFocus(self, force=False): - """ """ + """ + Sets focus to this element using focus_set. Will use focus_force if force flag set + :param force: (bool) if True then focus_force will be called instead of focus_set + """ try: if force: self.TKEntry.focus_force() @@ -740,18 +765,18 @@ class Combo(Element): :param values: values to choice :param default_value: Choices to be displayed. List of strings - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_text: True if size should fit the text length :param background_color: color of background :param text_color: color of the text :param change_submits: If True, pressing Enter key submits window (Default = False) :param enable_events: Turns on the element specific events.(Default = False) :param disabled: set disable state for element (Default = False) - :param key: ▲ Used with window.FindElement and with return values - :param pad: ▲ Amount of padding to put around element + :param key: Used with window.FindElement and with return values + :param pad: Amount of padding to put around element :param tooltip: text, that will appear the you hover on :param readonly: make element readonly (Default = False) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param visible: set visibility state of the element (Default = True) """ @@ -775,7 +800,7 @@ class Combo(Element): :param set_to_index: change selection to a particular choice :param disabled: disable or enable state of the element :param readonly: make element readonly - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param visible: change visibility of element """ @@ -858,13 +883,13 @@ class OptionMenu(Element): :param values: ?????????????????? :param default_value: ?????????????????????????// - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param disabled: set disable state for element (Default = False) :param auto_size_text: True if size should fit the text length :param background_color: color of background :param text_color: color of the text - :param key: ▲ Used with window.FindElement and with return values - :param pad: ▲ Amount of padding to put around element + :param key: Used with window.FindElement and with return values + :param pad: Amount of padding to put around element :param tooltip: text, that will appear the you hover on :param visible: set visibility state of the element (Default = True) @@ -948,14 +973,14 @@ class Listbox(Element): :param change_submits: If True, pressing Enter key submits window (Default = False) :param enable_events: Turns on the element specific events.(Default = False) :param bind_return_key: (Default = False) - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param disabled: set disable state for element (Default = False) :param auto_size_text: True if size should fit the text length - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param background_color: color of background :param text_color: color of the text - :param key: ▲ Used with window.FindElement and with return values - :param pad: ▲ Amount of padding to put around element + :param key: Used with window.FindElement and with return values + :param pad: Amount of padding to put around element :param tooltip: text, that will appear the you hover on :param right_click_menu: see "Right Click Menus" :param visible: set visibility state of the element (Default = True) @@ -1091,13 +1116,13 @@ class Radio(Element): :param group_id: Groups together multiple Radio Buttons. Can be any value :param default: Bool. Initial state (Default = False) :param disabled: set disable state for element (Default = False) - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_text: True if size should fit the text length :param background_color: color of background :param text_color: color of the text - :param font: ▲ specifies the font family, size, etc - :param key: ▲ Used with window.FindElement and with return values - :param pad: ▲ Amount of padding to put around element + :param font: specifies the font family, size, etc + :param key: Used with window.FindElement and with return values + :param pad: Amount of padding to put around element :param tooltip: text, that will appear the you hover on :param change_submits: If True, pressing Enter key submits window (Default = False) :param enable_events: Turns on the element specific events.(Default = False) @@ -1180,16 +1205,16 @@ class Checkbox(Element): :param text: Text to display next to checkbox :param default: Bool + None. Initial state. True = Checked, False = unchecked, None = Not available (grayed out) (Default = False) - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_text: True if size should fit the text length - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param background_color: color of background :param text_color: color of the text :param change_submits: If True, pressing Enter key submits window (Default = False) :param enable_events: Turns on the element specific events.(Default = False) :param disabled: set disable state for element (Default = False) - :param key: ▲ Used with window.FindElement and with return values - :param pad: ▲ Amount of padding to put around element + :param key: Used with window.FindElement and with return values + :param pad: Amount of padding to put around element :param tooltip: text, that will appear the you hover on :param visible: set visibility state of the element (Default = True) @@ -1263,13 +1288,13 @@ class Spin(Element): :param disabled: set disable state for element (Default = False) :param change_submits: If True, pressing Enter key submits window (Default = False) :param enable_events: Turns on the element specific events.(Default = False) - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_text: True if size should fit the text length - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param background_color: color of background :param text_color: color of the text - :param key: ▲ Used with window.FindElement and with return values - :param pad: ▲ Amount of padding to put around element + :param key: Used with window.FindElement and with return values + :param pad: Amount of padding to put around element :param tooltip: text, that will appear the you hover on :param visible: set visibility state of the element (Default = True) @@ -1363,17 +1388,17 @@ class Multiline(Element): :param disabled: set disable state for element (Default = False) :param autoscroll: ?????????? (Default = False) :param border_width: width of border around element - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_text: True if size should fit the text length :param background_color: color of background :param text_color: color of the text :param change_submits: If True, pressing Enter key submits window (Default = False) :param enable_events: Turns on the element specific events.(Default = False) :param do_not_clear: see docx (Default = True) - :param key: ▲ Used with window.FindElement and with return values + :param key: Used with window.FindElement and with return values :param focus: if focus should be set to this - :param font: ▲ specifies the font family, size, etc - :param pad: ▲ Amount of padding to put around element + :param font: specifies the font family, size, etc + :param pad: Amount of padding to put around element :param tooltip: text, that will appear the you hover on :param right_click_menu: see "Right Click Menus" :param visible: set visibility state of the element (Default = True) @@ -1404,7 +1429,7 @@ class Multiline(Element): :param value: new text to display :param disabled: disable or enable state of the element :param append: (Default = False) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param text_color: color of the text :param background_color: color of background :param visible: change visibility of element @@ -1477,17 +1502,17 @@ class Text(Element): """ :param text: The text to display (required) - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_text: True if size should fit the text length :param click_submits: ????????????????????(Default = False) :param enable_events: Turns on the element specific events.(Default = False) :param 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` - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param text_color: color of the text :param background_color: color of background :param justification: justification for data display - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values :param right_click_menu: see "Right Click Menus" :param tooltip: text, that will appear the you hover on :param visible: set visibility state of the element (Default = True) @@ -1516,7 +1541,7 @@ class Text(Element): :param value: new value to show :param background_color: color of background :param text_color: color of the text - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param visible: change visibility of element """ @@ -1558,17 +1583,17 @@ class StatusBar(Element): """ :param text: (required) text that is to be displayed in the widget - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_text: True if size should fit the text length :param click_submits: ???????????????????? :param enable_events: Turns on the element specific events.(Default = False) :param 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 = RELIEF_SUNKEN) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param text_color: color of the text :param background_color: color of background :param justification: justification for data display - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values :param tooltip: text, that will appear the you hover on :param visible: set visibility state of the element (Default = True) @@ -1595,7 +1620,7 @@ class StatusBar(Element): :param value: ?????????????????????????? :param background_color: color of background :param text_color: color of the text - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param visible: change visibility of element """ @@ -1642,7 +1667,7 @@ class TKProgressBar(): :param border_width: (Default value = DEFAULT_PROGRESS_BAR_BORDER_WIDTH) :param orientation: 'horizontal' or 'vertical' ('h' or 'v' work) (Default value = 'vertical')(Default value = 'horizontal') :param BarColor: ???????????????????????? - :param key: ▲ Used with window.FindElement and with return values + :param key: Used with window.FindElement and with return values """ @@ -1725,8 +1750,8 @@ class TKOutput(tk.Frame): :param bd: :param background_color: color of background :param text_color: color of the text - :param font: ▲ specifies the font family, size, etc - :param pad: ▲ Amount of padding to put around element + :param font: specifies the font family, size, etc + :param pad: Amount of padding to put around element """ self.frame = tk.Frame(parent) @@ -1788,13 +1813,13 @@ class Output(Element): key=None, right_click_menu=None, visible=True): """ - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param background_color: color of background :param text_color: color of the text - :param pad: ▲ Amount of padding to put around element - :param font: ▲ specifies the font family, size, etc + :param pad: Amount of padding to put around element + :param font: specifies the font family, size, etc :param tooltip: text, that will appear the you hover on - :param key: ▲ Used with window.FindElement and with return values + :param key: Used with window.FindElement and with return values :param right_click_menu: see "Right Click Menus" :param visible: set visibility state of the element (Default = True) @@ -1868,14 +1893,14 @@ class Button(Element): :param image_size: size of button image in pixels (Default = (None)) :param image_subsample:amount to reduce the size of the image :param border_width: width of border around button in pixels - :param size: ▲ (w,h) w=characters-wide, h=rows-high (Default = (None)) + :param size: (w,h) w=characters-wide, h=rows-high (Default = (None)) :param auto_size_button: True if button size is determined by button text :param button_color: (text color, backound color) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param bind_return_key: If True the return key will cause this button to fire (Default = False) :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values :param visible: set visibility state of the element (Default = True) """ @@ -2192,12 +2217,12 @@ class ButtonMenu(Element): :param image_size: size of button image in pixels (Default = (None)) :param image_subsample:amount to reduce the size of the image :param border_width: width of border around button in pixels - :param size: ▲ (w,h) w=characters-wide, h=rows-high (Default = (None)) + :param size: (w,h) w=characters-wide, h=rows-high (Default = (None)) :param auto_size_button: True if button size is determined by button text :param button_color: (text color, backound color) - :param font: ▲ specifies the font family, size, etc - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param font: specifies the font family, size, etc + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values :param tearoff: ?????????????????? (Default = False) :param visible: set visibility state of the element (Default = True) @@ -2277,14 +2302,14 @@ class ProgressBar(Element): :param max_value: max value of progressbar :param orientation: 'horizontal' or 'vertical' ('h' or 'v' work) (Default value = 'vertical') - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_text: True if size should fit the text length :param bar_color: (Default = (None)) :param style: ???????????????????????????? :param border_width: width of border around button :param relief: ???????????????????????????? - :param key: ▲ Used with window.FindElement and with return values - :param pad: ▲ Amount of padding to put around element + :param key: Used with window.FindElement and with return values + :param pad: Amount of padding to put around element :param visible: set visibility state of the element (Default = True) """ @@ -2356,9 +2381,9 @@ class Image(Element): :param filename: file name if the image is in a file :param data: if image is in RAM (PIL format?) :param background_color: color of background - :param size: ▲ (w,h) w=characters-wide, h=rows-high - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param size: (w,h) w=characters-wide, h=rows-high + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values :param tooltip: text, that will appear the you hover on :param right_click_menu: see "Right Click Menus" :param visible: set visibility state of the element (Default = True) @@ -2389,7 +2414,7 @@ class Image(Element): :param filename: :param data: - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param visible: change visibility of element """ @@ -2479,9 +2504,9 @@ class Canvas(Element): :param canvas: ???????????????????????? :param background_color: color of background - :param size: ▲ (w,h) w=characters-wide, h=rows-high - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param size: (w,h) w=characters-wide, h=rows-high + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values :param tooltip: text, that will appear the you hover on :param right_click_menu: see "Right Click Menus" :param visible: set visibility state of the element (Default = True) @@ -2524,11 +2549,11 @@ class Graph(Element): :param graph_bottom_left: ???????????????????????? :param graph_top_right: ???????????????????????? :param background_color: color of background - :param pad: ▲ Amount of padding to put around element + :param pad: Amount of padding to put around element :param change_submits: If True, pressing Enter key submits window (Default = False) :param drag_submits: ???????????????????????? (Default = False) :param enable_events: Turns on the element specific events.(Default = False) - :param key: ▲ Used with window.FindElement and with return values + :param key: Used with window.FindElement and with return values :param tooltip: text, that will appear the you hover on :param right_click_menu: see "Right Click Menus" :param visible: set visibility state of the element (Default = True) @@ -2614,7 +2639,7 @@ class Graph(Element): """ :param point: - :param size: ▲ (w,h) w=characters-wide, h=rows-high (Default value = 2) + :param size: (w,h) w=characters-wide, h=rows-high (Default value = 2) :param color: (Default value = 'black') """ @@ -2735,7 +2760,7 @@ class Graph(Element): :param text: :param location: :param color: (Default value = 'black') - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param angle: (Default value = 0) """ @@ -2760,7 +2785,7 @@ class Graph(Element): :param data: :param location: :param color: (Default value = 'black') - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param angle: (Default value = 0) """ @@ -2975,11 +3000,11 @@ class Frame(Element): :param background_color: color of background :param title_location: ???????????????????????? :param 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_FRAME_RELIEF) - :param size: ▲ (w,h) w=characters-wide, h=rows-high - :param font: ▲ specifies the font family, size, etc - :param pad: ▲ Amount of padding to put around element + :param size: (w,h) w=characters-wide, h=rows-high + :param font: specifies the font family, size, etc + :param pad: Amount of padding to put around element :param border_width: width of border around element - :param key: ▲ Used with window.FindElement and with return values + :param key: Used with window.FindElement and with return values :param tooltip: text, that will appear the you hover on :param right_click_menu: see "Right Click Menus" :param visible: set visibility state of the element (Default = True) @@ -3078,7 +3103,7 @@ class VerticalSeparator(Element): def __init__(self, pad=None): """ - :param pad: ▲ Amount of padding to put around element + :param pad: Amount of padding to put around element """ @@ -3109,11 +3134,11 @@ class Tab(Element): :param layout: ????????????????????? :param title_color: :param background_color: color of background - :param font: ▲ specifies the font family, size, etc - :param pad: ▲ Amount of padding to put around element + :param font: specifies the font family, size, etc + :param pad: Amount of padding to put around element :param disabled: set disable state for element (Default = False) :param border_width: width of border around element - :param key: ▲ Used with window.FindElement and with return values + :param key: Used with window.FindElement and with return values :param tooltip: text, that will appear the you hover on :param right_click_menu: see "Right Click Menus" :param visible: set visibility state of the element (Default = True) @@ -3226,13 +3251,13 @@ class TabGroup(Element): :param title_color: :param selected_title_color: :param background_color: color of background - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param change_submits: If True, pressing Enter key submits window (Default = False) :param enable_events: Turns on the element specific events.(Default = False) - :param pad: ▲ Amount of padding to put around element + :param pad: Amount of padding to put around element :param border_width: width of border around element :param theme: - :param key: ▲ Used with window.FindElement and with return values + :param key: Used with window.FindElement and with return values :param tooltip: text, that will appear the you hover on :param visible: set visibility state of the element (Default = True) @@ -3354,12 +3379,12 @@ class Slider(Element): :param change_submits: If True, pressing Enter key submits window (Default = False) :param enable_events: Turns on the element specific events.(Default = False) :param disabled: set disable state for element (Default = False) - :param size: ▲ (w,h) w=characters-wide, h=rows-high (Default = (None)) - :param font: ▲ specifies the font family, size, etc + :param size: (w,h) w=characters-wide, h=rows-high (Default = (None)) + :param font: specifies the font family, size, etc :param background_color: color of background :param text_color: color of the text - :param key: ▲ Used with window.FindElement and with return values - :param pad: ▲ Amount of padding to put around element + :param key: Used with window.FindElement and with return values + :param pad: Amount of padding to put around element :param tooltip: text, that will appear the you hover on :param visible: set visibility state of the element (Default = True) @@ -3582,12 +3607,12 @@ class Column(Element): :param layout: ???????????????????????? :param background_color: color of background - :param size: ▲ (w,h) w=characters-wide, h=rows-high - :param pad: ▲ Amount of padding to put around element + :param size: (w,h) w=characters-wide, h=rows-high + :param pad: Amount of padding to put around element :param scrollable: ???????????????????????? (Default = False) :param vertical_scroll_only: ???????????????????????? (Default = False) :param right_click_menu: see "Right Click Menus" - :param key: ▲ Used with window.FindElement and with return values + :param key: Used with window.FindElement and with return values :param visible: set visibility state of the element (Default = True) """ @@ -3694,14 +3719,14 @@ class Pane(Element): :param pane_list: :param background_color: color of background - :param size: ▲ (w,h) w=characters-wide, h=rows-high - :param pad: ▲ Amount of padding to put around element + :param size: (w,h) w=characters-wide, h=rows-high + :param pad: Amount of padding to put around element :param orientation: 'horizontal' or 'vertical' ('h' or 'v' work) (Default value = 'vertical') :param show_handle: (Default = True) :param 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` :param handle_size: :param border_width: width of border around element - :param key: ▲ Used with window.FindElement and with return values + :param key: Used with window.FindElement and with return values :param visible: set visibility state of the element (Default = True) """ @@ -4021,10 +4046,10 @@ class Menu(Element): :param menu_definition: :param background_color: color of background - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param tearoff: (Default = False) - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values :param visible: set visibility state of the element (Default = True) """ @@ -4115,7 +4140,7 @@ class Table(Element): :param display_row_numbers: (Default = False) :param num_rows: :param row_height: - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param justification: (Default value = 'right') :param text_color: color of the text :param background_color: color of background @@ -4123,12 +4148,12 @@ class Table(Element): :param row_colors: :param vertical_scroll_only: (Default = True) :param hide_vertical_scroll: (Default = False) - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param change_submits: If True, pressing Enter key submits window (Default = False) :param enable_events: Turns on the element specific events.(Default = False) :param bind_return_key: (Default = False) - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values :param tooltip: text, that will appear the you hover on :param right_click_menu: see "Right Click Menus" :param visible: set visibility state of the element (Default = True) @@ -4267,14 +4292,14 @@ class Tree(Element): :param show_expanded: (Default = False) :param change_submits: If True, pressing Enter key submits window (Default = False) :param enable_events: Turns on the element specific events.(Default = False) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param justification: (Default value = 'right') :param text_color: color of the text :param background_color: color of background :param num_rows: :param row_height: - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values :param tooltip: text, that will appear the you hover on :param right_click_menu: see "Right Click Menus" :param visible: set visibility state of the element (Default = True) @@ -4355,7 +4380,7 @@ class Tree(Element): """ :param values: - :param key: ▲ Used with window.FindElement and with return values + :param key: Used with window.FindElement and with return values :param value: :param text: :param icon: @@ -4408,7 +4433,7 @@ class TreeData(object): """ :param parent: - :param key: ▲ Used with window.FindElement and with return values + :param key: Used with window.FindElement and with return values :param text: :param values: :param icon: @@ -4438,7 +4463,7 @@ class TreeData(object): def _AddNode(self, key, node): """ - :param key: ▲ Used with window.FindElement and with return values + :param key: Used with window.FindElement and with return values :param node: """ @@ -4448,7 +4473,7 @@ class TreeData(object): """ :param parent: - :param key: ▲ Used with window.FindElement and with return values + :param key: Used with window.FindElement and with return values :param text: :param values: :param icon: @@ -4483,7 +4508,7 @@ class ErrorElement(Element): def __init__(self, key=None): """Error Element - :param key: ▲ Used with window.FindElement and with return values + :param key: Used with window.FindElement and with return values """ self.Key = key @@ -4554,11 +4579,11 @@ class Window: :param auto_size_text: True if size should fit the text length :param auto_size_buttons: :param location: (Default = (None)) - :param size: ▲ (w,h) w=characters-wide, h=rows-high (Default = (None)) + :param size: (w,h) w=characters-wide, h=rows-high (Default = (None)) :param element_padding: :param margins: (Default = (None)) :param button_color: button color (foreground, background) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param progress_bar_color: (Default = (None)) :param background_color: color of background :param border_depth: @@ -5029,7 +5054,7 @@ class Window: Find element object associated with the provided key :returns Found element object, an Error Element, or None - :param key: ▲ Used with window.FindElement and with return values + :param key: Used with window.FindElement and with return values :param silent_on_error: (Default = False) """ @@ -5372,7 +5397,7 @@ class Window: def Size(self, size): """ - :param size: ▲ + :param size: """ try: @@ -5484,15 +5509,15 @@ def FolderBrowse(button_text='Browse', target=(ThisRow, -1), initial_folder=None :param target: key or (row,col) target for the button (Default value = (ThisRow, -1)) :param initial_folder: starting path for folders and files :param tooltip: text, that will appear the you hover on - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) :param disabled: set disable state for element (Default = False) :param change_submits: If True, pressing Enter key submits window (Default = False) :param enable_events: Turns on the element specific events.(Default = False) - :param font: ▲ specifies the font family, size, etc - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param font: specifies the font family, size, etc + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ @@ -5514,15 +5539,15 @@ def FileBrowse(button_text='Browse', target=(ThisRow, -1), file_types=(("ALL Fil :param file_types: (Default value = (("ALL Files", "*.*"))) :param initial_folder: starting path for folders and files :param tooltip: text, that will appear the you hover on - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) :param change_submits: If True, pressing Enter key submits window (Default = False) :param enable_events: Turns on the element specific events.(Default = False) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param disabled: set disable state for element (Default = False) - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_BROWSE_FILE, target=target, file_types=file_types, @@ -5544,14 +5569,14 @@ def FilesBrowse(button_text='Browse', target=(ThisRow, -1), file_types=(("ALL Fi :param disabled: set disable state for element (Default = False) :param initial_folder: starting path for folders and files :param tooltip: text, that will appear the you hover on - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) :param change_submits: If True, pressing Enter key submits window (Default = False) :param enable_events: Turns on the element specific events.(Default = False) - :param font: ▲ specifies the font family, size, etc - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param font: specifies the font family, size, etc + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_BROWSE_FILES, target=target, file_types=file_types, @@ -5573,14 +5598,14 @@ def FileSaveAs(button_text='Save As...', target=(ThisRow, -1), file_types=(("ALL :param initial_folder: starting path for folders and files :param disabled: set disable state for element (Default = False) :param tooltip: text, that will appear the you hover on - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) :param change_submits: If True, pressing Enter key submits window (Default = False) :param enable_events: Turns on the element specific events.(Default = False) - :param font: ▲ specifies the font family, size, etc - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param font: specifies the font family, size, etc + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_SAVEAS_FILE, target=target, file_types=file_types, @@ -5602,14 +5627,14 @@ def SaveAs(button_text='Save As...', target=(ThisRow, -1), file_types=(("ALL Fil :param initial_folder: starting path for folders and files :param disabled: set disable state for element (Default = False) :param tooltip: text, that will appear the you hover on - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) :param change_submits: If True, pressing Enter key submits window (Default = False) :param enable_events: Turns on the element specific events.(Default = False) - :param font: ▲ specifies the font family, size, etc - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param font: specifies the font family, size, etc + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_SAVEAS_FILE, target=target, file_types=file_types, @@ -5624,16 +5649,16 @@ def Save(button_text='Save', size=(None, None), auto_size_button=None, button_co """ :param button_text: text in the button (Default value = 'Save') - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) :param bind_return_key: (Default = True) :param disabled: set disable state for element (Default = False) :param tooltip: text, that will appear the you hover on - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, @@ -5647,16 +5672,16 @@ def Submit(button_text='Submit', size=(None, None), auto_size_button=None, butto """ :param button_text: text in the button (Default value = 'Submit') - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) :param disabled: set disable state for element (Default = False) :param bind_return_key: (Default = True) :param tooltip: text, that will appear the you hover on - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, @@ -5671,16 +5696,16 @@ def Open(button_text='Open', size=(None, None), auto_size_button=None, button_co """ :param button_text: text in the button (Default value = 'Open') - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) :param disabled: set disable state for element (Default = False) :param bind_return_key: (Default = True) :param tooltip: text, that will appear the you hover on - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, @@ -5694,16 +5719,16 @@ def OK(button_text='OK', size=(None, None), auto_size_button=None, button_color= """ :param button_text: text in the button (Default value = 'OK') - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) :param disabled: set disable state for element (Default = False) :param bind_return_key: (Default = True) :param tooltip: text, that will appear the you hover on - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, @@ -5717,16 +5742,16 @@ def Ok(button_text='Ok', size=(None, None), auto_size_button=None, button_color= """ :param button_text: text in the button (Default value = 'Ok') - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) :param disabled: set disable state for element (Default = False) :param bind_return_key: (Default = True) :param tooltip: text, that will appear the you hover on - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, @@ -5740,16 +5765,16 @@ def Cancel(button_text='Cancel', size=(None, None), auto_size_button=None, butto """ :param button_text: text in the button (Default value = 'Cancel') - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) :param disabled: set disable state for element (Default = False) :param tooltip: text, that will appear the you hover on - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param bind_return_key: (Default = False) :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, @@ -5763,16 +5788,16 @@ def Quit(button_text='Quit', size=(None, None), auto_size_button=None, button_co """ :param button_text: text in the button (Default value = 'Quit') - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) :param disabled: set disable state for element (Default = False) :param tooltip: text, that will appear the you hover on - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param bind_return_key: (Default = False) :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, @@ -5786,16 +5811,16 @@ def Exit(button_text='Exit', size=(None, None), auto_size_button=None, button_co """ :param button_text: text in the button (Default value = 'Exit') - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) :param disabled: set disable state for element (Default = False) :param tooltip: text, that will appear the you hover on - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param bind_return_key: (Default = False) :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, @@ -5809,16 +5834,16 @@ def Yes(button_text='Yes', size=(None, None), auto_size_button=None, button_colo """ :param button_text: text in the button (Default value = 'Yes') - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) :param disabled: set disable state for element (Default = False) :param tooltip: text, that will appear the you hover on - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param bind_return_key: (Default = True) :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, @@ -5832,16 +5857,16 @@ def No(button_text='No', size=(None, None), auto_size_button=None, button_color= """ :param button_text: text in the button (Default value = 'No') - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) :param disabled: set disable state for element (Default = False) :param tooltip: text, that will appear the you hover on - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param bind_return_key: (Default = False) :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, @@ -5855,16 +5880,16 @@ def Help(button_text='Help', size=(None, None), auto_size_button=None, button_co """ :param button_text: text in the button (Default value = 'Help') - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) :param disabled: set disable state for element (Default = False) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param tooltip: text, that will appear the you hover on :param bind_return_key: (Default = False) :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, tooltip=tooltip, size=size, @@ -5878,16 +5903,16 @@ def Debug(button_text='', size=(None, None), auto_size_button=None, button_color """ :param button_text: text in the button (Default value = '') - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) :param disabled: set disable state for element (Default = False) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param tooltip: text, that will appear the you hover on :param bind_return_key: (Default = False) :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_SHOW_DEBUGGER, tooltip=tooltip, size=size, @@ -5909,15 +5934,15 @@ def SimpleButton(button_text, image_filename=None, image_data=None, image_size=( :param image_subsample:amount to reduce the size of the image :param border_width: width of border around element :param tooltip: text, that will appear the you hover on - :param size: ▲ (w,h) w=characters-wide, h=rows-high (Default = (None)) + :param size: (w,h) w=characters-wide, h=rows-high (Default = (None)) :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param bind_return_key: (Default = False) :param disabled: set disable state for element (Default = False) :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_CLOSES_WIN, image_filename=image_filename, @@ -5940,15 +5965,15 @@ def CloseButton(button_text, image_filename=None, image_data=None, image_size=(N :param image_subsample:amount to reduce the size of the image :param border_width: width of border around element :param tooltip: text, that will appear the you hover on - :param size: ▲ (w,h) w=characters-wide, h=rows-high (Default = (None)) + :param size: (w,h) w=characters-wide, h=rows-high (Default = (None)) :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param bind_return_key: (Default = False) :param disabled: set disable state for element (Default = False) :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_CLOSES_WIN, image_filename=image_filename, @@ -5974,15 +5999,15 @@ def ReadButton(button_text, image_filename=None, image_data=None, image_size=(No :param image_subsample:amount to reduce the size of the image :param border_width: width of border around element :param tooltip: text, that will appear the you hover on - :param size: ▲ (w,h) w=characters-wide, h=rows-high (Default = (None)) + :param size: (w,h) w=characters-wide, h=rows-high (Default = (None)) :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param bind_return_key: (Default = False) :param disabled: set disable state for element (Default = False) :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_READ_FORM, image_filename=image_filename, @@ -6009,15 +6034,15 @@ def RealtimeButton(button_text, image_filename=None, image_data=None, image_size :param image_subsample:amount to reduce the size of the image :param border_width: width of border around element :param tooltip: text, that will appear the you hover on - :param size: ▲ (w,h) w=characters-wide, h=rows-high (Default = (None)) + :param size: (w,h) w=characters-wide, h=rows-high (Default = (None)) :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param disabled: set disable state for element (Default = False) :param bind_return_key: (Default = False) :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_REALTIME, image_filename=image_filename, @@ -6040,15 +6065,15 @@ def DummyButton(button_text, image_filename=None, image_data=None, image_size=(N :param image_subsample:amount to reduce the size of the image :param border_width: width of border around element :param tooltip: text, that will appear the you hover on - :param size: ▲ (w,h) w=characters-wide, h=rows-high (Default = (None)) + :param size: (w,h) w=characters-wide, h=rows-high (Default = (None)) :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param disabled: set disable state for element (Default = False) :param bind_return_key: (Default = False) :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_CLOSES_WIN_ONLY, image_filename=image_filename, @@ -6077,15 +6102,15 @@ def CalendarButton(button_text, target=(None, None), close_when_date_chosen=True :param image_subsample:amount to reduce the size of the image :param tooltip: text, that will appear the you hover on :param border_width: width of border around element - :param size: ▲ (w,h) w=characters-wide, h=rows-high (Default = (None)) + :param size: (w,h) w=characters-wide, h=rows-high (Default = (None)) :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) :param disabled: set disable state for element (Default = False) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param bind_return_key: (Default = False) :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values :param locale: :param format: @@ -6117,15 +6142,15 @@ def ColorChooserButton(button_text, target=(None, None), image_filename=None, im :param image_subsample:amount to reduce the size of the image :param tooltip: text, that will appear the you hover on :param border_width: width of border around element - :param size: ▲ (w,h) w=characters-wide, h=rows-high (Default = (None)) + :param size: (w,h) w=characters-wide, h=rows-high (Default = (None)) :param auto_size_button: True if button size is determined by button text :param button_color: button color (foreground, background) :param disabled: set disable state for element (Default = False) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param bind_return_key: (Default = False) :param focus: if focus should be set to this - :param pad: ▲ Amount of padding to put around element - :param key: ▲ Used with window.FindElement and with return values + :param pad: Amount of padding to put around element + :param key: Used with window.FindElement and with return values """ return Button(button_text=button_text, button_type=BUTTON_TYPE_COLOR_CHOOSER, target=target, @@ -6506,7 +6531,7 @@ def _FindElementFromKeyInSubForm(form, key): """ :param form: - :param key: ▲ Used with window.FindElement and with return values + :param key: Used with window.FindElement and with return values """ for row_num, row in enumerate(form.Rows): @@ -8193,12 +8218,12 @@ class QuickMeter(object): :param title: text to display in eleemnt :param current_value: current value :param max_value: max value of QuickMeter - :param key: ▲ Used with window.FindElement and with return values + :param key: Used with window.FindElement and with return values :param *args: stuff to output :param orientation: 'horizontal' or 'vertical' ('h' or 'v' work) (Default value = 'vertical')(Default value = 'v') :param bar_color: ??????????????????????????????????? :param button_color: button color (foreground, background) - :param size: ▲ (w,h) w=characters-wide, h=rows-high (Default value = DEFAULT_PROGRESS_BAR_SIZE) + :param size: (w,h) w=characters-wide, h=rows-high (Default value = DEFAULT_PROGRESS_BAR_SIZE) :param border_width: width of border around element :param grab_anywhere: If True can grab anywhere to move the window (Default = False) @@ -8307,12 +8332,12 @@ def OneLineProgressMeter(title, current_value, max_value, key, *args, orientatio :param title: text to display :param current_value: current progressbar value :param max_value: max value of progressbar - :param key: ▲ Used with window.FindElement and with return values + :param key: Used with window.FindElement and with return values :param *args: stuff to output. :param orientation: 'horizontal' or 'vertical' ('h' or 'v' work) (Default value = 'vertical')(Default value = 'v') :param bar_color: :param button_color: button color (foreground, background) - :param size: ▲ (w,h) w=characters-wide, h=rows-high (Default value = DEFAULT_PROGRESS_BAR_SIZE) + :param size: (w,h) w=characters-wide, h=rows-high (Default value = DEFAULT_PROGRESS_BAR_SIZE) :param border_width: width of border around element :param grab_anywhere: If True can grab anywhere to move the window (Default = False) @@ -8332,7 +8357,7 @@ def OneLineProgressMeter(title, current_value, max_value, key, *args, orientatio def OneLineProgressMeterCancel(key): """ - :param key: ▲ Used with window.FindElement and with return values + :param key: Used with window.FindElement and with return values """ try: @@ -8374,9 +8399,9 @@ class DebugWin(): grab_anywhere=False, keep_on_top=False, do_not_reroute_stdout=True): """ - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param location: (Default = (None)) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param no_titlebar: (Default = False) :param no_button: (Default = False) :param grab_anywhere: If True can grab anywhere to move the window (Default = False) @@ -8458,11 +8483,11 @@ def EasyPrint(*args, size=(None, None), end=None, sep=None, location=(None, None """ :param *args: - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param end: :param sep: :param location: (Default = (None)) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param no_titlebar: (Default = False) :param no_button: (Default = False) :param grab_anywhere: If True can grab anywhere to move the window (Default = False) @@ -8499,7 +8524,7 @@ def PopupScrolled(*args, button_color=None, yes_no=False, auto_close=False, auto :param yes_no: (Default = False) :param auto_close: (Default = False) :param auto_close_duration: - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param location: (Default = (None)) :param title: :param non_blocking: (Default = False) @@ -8593,7 +8618,7 @@ def SetOptions(icon=None, button_color=None, element_size=(None, None), button_e :param element_padding: (Default = (None)) :param auto_size_text: True if size should fit the text length :param auto_size_buttons: - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param border_width: width of border around element :param slider_border_width: :param slider_relief: @@ -9149,7 +9174,7 @@ def Popup(*args, title=None, button_color=None, background_color=None, text_colo :param non_blocking: (Default = False) :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) :param line_width: Width of lines in characters - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param no_titlebar: (Default = False) :param grab_anywhere: If True can grab anywhere to move the window (Default = False) :param location: Location on screen to display @@ -9261,7 +9286,7 @@ def PopupNoButtons(*args, title=None, button_color=None, background_color=None, :param non_blocking: (Default = False) :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) :param line_width: Width of lines in characters - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param no_titlebar: (Default = False) :param grab_anywhere: If True can grab anywhere to move the window (Default = False) :param location: Location on screen to display @@ -9295,7 +9320,7 @@ def PopupNonBlocking(*args, title=None, button_type=POPUP_BUTTONS_OK, button_col :param non_blocking: (Default = True) :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) :param line_width: Width of lines in characters - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param no_titlebar: (Default = False) :param grab_anywhere: If True can grab anywhere to move the window (Default = False) :param location: Location on screen to display @@ -9331,7 +9356,7 @@ def PopupQuick(*args, title=None, button_type=POPUP_BUTTONS_OK, button_color=Non :param non_blocking: (Default = True) :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) :param line_width: Width of lines in characters - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param no_titlebar: (Default = False) :param grab_anywhere: If True can grab anywhere to move the window (Default = False) :param location: Location on screen to display @@ -9365,7 +9390,7 @@ def PopupQuickMessage(*args, title=None, button_type=POPUP_BUTTONS_NO_BUTTONS, b :param non_blocking: (Default = True) :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) :param line_width: Width of lines in characters - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param no_titlebar: (Default = True) :param grab_anywhere: If True can grab anywhere to move the window (Default = False) :param location: Location on screen to display @@ -9398,7 +9423,7 @@ def PopupNoTitlebar(*args, title=None, button_type=POPUP_BUTTONS_OK, button_colo :param non_blocking: (Default = False) :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) :param line_width: Width of lines in characters - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param grab_anywhere: (Default = True) :param location: Location on screen to display :param location: @@ -9436,7 +9461,7 @@ def PopupAutoClose(*args, title=None, button_type=POPUP_BUTTONS_OK, button_color :param non_blocking: (Default = False) :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) :param line_width: Width of lines in characters - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param no_titlebar: (Default = False) :param grab_anywhere: If True can grab anywhere to move the window (Default = False) :param location: Location on screen to display @@ -9470,7 +9495,7 @@ def PopupError(*args, title=None, button_color=(None, None), background_color=No :param non_blocking: (Default = False) :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) :param line_width: Width of lines in characters - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param no_titlebar: (Default = False) :param grab_anywhere: If True can grab anywhere to move the window (Default = False) :param location: Location on screen to display @@ -9502,7 +9527,7 @@ def PopupCancel(*args, title=None, button_color=None, background_color=None, tex :param non_blocking: (Default = False) :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) :param line_width: Width of lines in characters - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param no_titlebar: (Default = False) :param grab_anywhere: If True can grab anywhere to move the window (Default = False) :param location: Location on screen to display @@ -9533,7 +9558,7 @@ def PopupOK(*args, title=None, button_color=None, background_color=None, text_co :param non_blocking: (Default = False) :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) :param line_width: Width of lines in characters - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param no_titlebar: (Default = False) :param grab_anywhere: If True can grab anywhere to move the window (Default = False) :param location: Location on screen to display @@ -9563,7 +9588,7 @@ def PopupOKCancel(*args, title=None, button_color=None, background_color=None, t :param non_blocking: (Default = False) :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) :param line_width: Width of lines in characters - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param no_titlebar: (Default = False) :param grab_anywhere: If True can grab anywhere to move the window (Default = False) :param location: Location on screen to display @@ -9594,7 +9619,7 @@ def PopupYesNo(*args, title=None, button_color=None, background_color=None, text :param non_blocking: (Default = False) :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) :param line_width: Width of lines in characters - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param no_titlebar: (Default = False) :param grab_anywhere: If True can grab anywhere to move the window (Default = False) :param location: Location on screen to display @@ -9625,12 +9650,12 @@ def PopupGetFolder(message, title=None, default_path='', no_window=False, size=( :param title: :param default_path: (Default value = '') :param no_window: (Default = False) - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param button_color: button color (foreground, background) :param background_color: color of background :param text_color: color of the text :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param no_titlebar: (Default = False) :param grab_anywhere: If True can grab anywhere to move the window (Default = False) :param location: Location on screen to display @@ -9704,12 +9729,12 @@ def PopupGetFile(message, title=None, default_path='', default_extension='', sav :param multiple_files: (Default = False) :param file_types: (Default value = (("ALL Files", "*.*"))) :param no_window: (Default = False) - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param button_color: button color (foreground, background) :param background_color: color of background :param text_color: color of the text :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param no_titlebar: (Default = False) :param grab_anywhere: If True can grab anywhere to move the window (Default = False) :param location: Location on screen to display @@ -9792,12 +9817,12 @@ def PopupGetText(message, title=None, default_text='', password_char='', size=(N :param title: :param default_text: (Default value = '') :param password_char: Passwork character if this is a password field (Default value = '') - :param size: ▲ (w,h) w=characters-wide, h=rows-high + :param size: (w,h) w=characters-wide, h=rows-high :param button_color: button color (foreground, background) :param background_color: color of background :param text_color: color of the text :param icon: Icon to display (Default value = DEFAULT_WINDOW_ICON) - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param no_titlebar: (Default = False) :param grab_anywhere: If True can grab anywhere to move the window (Default = False) :param location: Location on screen to display @@ -9834,7 +9859,7 @@ def PopupAnimated(image_source, message=None, background_color=None, text_color= :param message: :param background_color: color of background :param text_color: color of the text - :param font: ▲ specifies the font family, size, etc + :param font: specifies the font family, size, etc :param no_titlebar: (Default = True) :param grab_anywhere: (Default = True) :param keep_on_top: (Default = True)