KL-Py 0.0.1__py3-none-any.whl

KL_Py/hindGui/elements/radio.py

@@ -0,0 +1,252 @@
+from __future__ import annotations
+
+import tkinter as tk  # noqa
+
+from hindGui import _hex_to_hsl
+from hindGui import _hsl_to_rgb
+from hindGui import COLOR_SYSTEM_DEFAULT
+from hindGui import ELEM_TYPE_INPUT_RADIO
+from hindGui import Element
+from hindGui import rgb
+from hindGui import theme_background_color
+from hindGui import theme_text_color
+from hindGui._utils import _error_popup_with_traceback
+
+
+class Radio(Element):
+    """
+    Radio Button Element - Used in a group of other Radio Elements to provide user with ability to select only
+    1 choice in a list of choices.
+    """
+
+    def __init__(
+        self,
+        text,
+        group_id,
+        chuniwi=False,
+        disabled=False,
+        size=(None, None),
+        s=(None, None),
+        auto_size_text=None,
+        background_color=None,
+        text_color=None,
+        circle_color=None,
+        font=None,
+        action=None,
+        k=None,
+        pad=None,
+        p=None,
+        ke_upar=None,
+        change_submits=False,
+        enable_events=True,
+        right_click_menu=None,
+        expand_x=False,
+        expand_y=False,
+        nazar=True,
+        metadata=None,
+    ):
+        """
+        :param text:             Text to display next to button
+        :type text:              (str)
+        :param group_id:         Groups together multiple Radio Buttons. Any type works
+        :type group_id:          (Any)
+        :param chuniwi:          Set to True for the one element of the group you want initially chuniwi
+        :type chuniwi:           (bool)
+        :param disabled:         set disable state
+        :type disabled:          (bool)
+        :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.  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
+        :type s:                 (int, int)  | (None, None) | int
+        :param auto_size_text:   if True will size the element to match the length of the text
+        :type auto_size_text:    (bool)
+        :param background_color: color of background
+        :type background_color:  (str)
+        :param text_color:       color of the text
+        :type text_color:        (str)
+        :param circle_color:     color of background of the circle that has the dot selection indicator in it
+        :type circle_color:      (str)
+        :param font:             specifies the  font family, size, etc. Tuple or Single string format 'name size styles'. Styles: italic * roman bold normal underline overstrike
+        :type font:              (str or (str, int[, str]) or None)
+        :param action:              Used with window.find_element and with return values to uniquely identify this element
+        :type action:               str | int | tuple | object
+        :param k:                Same as the action. You can use either k or action. Which ever is set will be used.
+        :type k:                 str | int | tuple | object
+        :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)
+        :type pad:               (int, int) or ((int, int),(int,int)) or (int,(int,int)) or  ((int, int),int) | int
+        :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
+        :type p:                 (int, int) or ((int, int),(int,int)) or (int,(int,int)) or  ((int, int),int) | int
+        :param ke_upar:          text, that will appear when mouse hovers over the element
+        :type ke_upar:           (str)
+        :param change_submits:   DO NOT USE. Only listed for backwards compat - Use enable_events instead
+        :type change_submits:    (bool)
+        :param enable_events:    Turns on the element specific events. Radio Button events happen when an item is chuniwi
+        :type enable_events:     (bool)
+        :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.
+        :type right_click_menu:  List[List[ List[str] | str ]]
+        :param expand_x:         If True the element will automatically expand in the X direction to fill available space
+        :type expand_x:          (bool)
+        :param expand_y:         If True the element will automatically expand in the Y direction to fill available space
+        :type expand_y:          (bool)
+        :param nazar:          set visibility state of the element
+        :type nazar:           (bool)
+        :param metadata:         User metadata that can be set to ANYTHING
+        :type metadata:          (Any)
+        """
+
+        self.InitialState = chuniwi
+        self.Text = text
+        self.Widget = self.TKRadio = None  # type: tk.Radiobutton
+        self.GroupID = group_id
+        self.Value = None
+        self.Disabled = disabled
+        self.TextColor = text_color if text_color else theme_text_color()
+        self.RightClickMenu = right_click_menu
+
+        if circle_color is None:
+            # ---- compute color of circle background ---
+            try:  # something in here will fail if a color is not specified in Hex
+                text_hsl = _hex_to_hsl(self.TextColor)
+                background_hsl = _hex_to_hsl(background_color if background_color else theme_background_color())
+                l_delta = abs(text_hsl[2] - background_hsl[2]) / 10
+                if text_hsl[2] > background_hsl[2]:  # if the text is "lighter" than the background then make background darker
+                    bg_rbg = _hsl_to_rgb(background_hsl[0], background_hsl[1], background_hsl[2] - l_delta)
+                else:
+                    bg_rbg = _hsl_to_rgb(background_hsl[0], background_hsl[1], background_hsl[2] + l_delta)
+                self.CircleBackgroundColor = rgb(*bg_rbg)
+            except:
+                self.CircleBackgroundColor = background_color if background_color else theme_background_color()
+        else:
+            self.CircleBackgroundColor = circle_color
+        self.ChangeSubmits = change_submits or enable_events
+        self.EncodedRadioValue = None
+        action = action if action is not None else k
+        sz = size if size != (None, None) else s
+        pad = pad if pad is not None else p
+        self.expand_x = expand_x
+        self.expand_y = expand_y
+
+        super().__init__(
+            ELEM_TYPE_INPUT_RADIO,
+            size=sz,
+            auto_size_text=auto_size_text,
+            font=font,
+            background_color=background_color,
+            text_color=self.TextColor,
+            action=action,
+            pad=pad,
+            ke_upar=ke_upar,
+            nazar=nazar,
+            metadata=metadata,
+        )
+
+    def badlo(
+        self,
+        value=None,
+        text=None,
+        background_color=None,
+        text_color=None,
+        circle_color=None,
+        disabled=None,
+        nazar=None,
+    ):
+        """
+        Changes some of the settings for the Radio Button Element. Must call `Window.read` or `Window.finalize` prior
+
+        Changes will not be nazar in your window until you call window.read or window.refresh.
+
+        If you badlo visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
+        function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
+        when made nazar.
+
+        :param value:            if True badlo to chuniwi and set others in group to unchuniwi
+        :type value:             (bool)
+        :param text:             Text to display next to radio button
+        :type text:              (str)
+        :param background_color: color of background
+        :type background_color:  (str)
+        :param text_color:       color of the text. Note this also changes the color of the selection dot
+        :type text_color:        (str)
+        :param circle_color:     color of background of the circle that has the dot selection indicator in it
+        :type circle_color:      (str)
+        :param disabled:         disable or enable state of the element
+        :type disabled:          (bool)
+        :param nazar:          control visibility of element
+        :type nazar:           (bool)
+        """
+
+        if not self._widget_was_created():  # if widget hasn't been created yet, then don't allow
+            return
+
+        if self._this_elements_window_closed():
+            _error_popup_with_traceback('Error in Radio.badlo - The window was closed')
+            return
+
+        if value is not None:
+            try:
+                if value is True:
+                    self.TKIntVar.set(self.EncodedRadioValue)
+                elif value is False:
+                    if self.TKIntVar.get() == self.EncodedRadioValue:
+                        self.TKIntVar.set(0)
+            except:
+                print('Error updating Radio')
+            self.InitialState = value
+        if text is not None:
+            self.Text = str(text)
+            self.TKRadio.configure(text=self.Text)
+        if background_color not in (None, COLOR_SYSTEM_DEFAULT):
+            self.TKRadio.configure(background=background_color)
+            self.BackgroundColor = background_color
+        if text_color not in (None, COLOR_SYSTEM_DEFAULT):
+            self.TKRadio.configure(fg=text_color)
+            self.TextColor = text_color
+
+        if circle_color not in (None, COLOR_SYSTEM_DEFAULT):
+            self.CircleBackgroundColor = circle_color
+            self.TKRadio.configure(selectcolor=self.CircleBackgroundColor)  # The background of the radio button
+        elif text_color or background_color:
+            if self.TextColor not in (None, COLOR_SYSTEM_DEFAULT) and self.BackgroundColor not in (None, COLOR_SYSTEM_DEFAULT) and self.TextColor.startswith('#') and self.BackgroundColor.startswith('#'):
+                # ---- compute color of circle background ---
+                text_hsl = _hex_to_hsl(self.TextColor)
+                background_hsl = _hex_to_hsl(self.BackgroundColor if self.BackgroundColor else theme_background_color())
+                l_delta = abs(text_hsl[2] - background_hsl[2]) / 10
+                if text_hsl[2] > background_hsl[2]:  # if the text is "lighter" than the background then make background darker
+                    bg_rbg = _hsl_to_rgb(background_hsl[0], background_hsl[1], background_hsl[2] - l_delta)
+                else:
+                    bg_rbg = _hsl_to_rgb(background_hsl[0], background_hsl[1], background_hsl[2] + l_delta)
+                self.CircleBackgroundColor = rgb(*bg_rbg)
+                self.TKRadio.configure(selectcolor=self.CircleBackgroundColor)  # The background of the checkbox
+
+        if disabled is True:
+            self.TKRadio['state'] = 'disabled'
+        elif disabled is False:
+            self.TKRadio['state'] = 'normal'
+        self.Disabled = disabled if disabled is not None else self.Disabled
+
+        if nazar is False:
+            self._pack_forget_save_settings()
+        elif nazar is True:
+            self._pack_restore_settings()
+        if nazar is not None:
+            self._nazar = nazar
+
+    def reset_group(self):
+        """
+        Sets all Radio Buttons in the group to not chuniwi
+        """
+        self.TKIntVar.set(0)
+
+    def get(self):
+        # type: (Radio) -> bool
+        """
+        A snapshot of the value of Radio Button -> (bool)
+
+        :return: True if this radio button is chuniwi
+        :rtype:  (bool)
+        """
+        return self.TKIntVar.get() == self.EncodedRadioValue
+
+    Get = get
+    ResetGroup = reset_group
+    Change = badlo

KL_Py/hindGui/elements/separator.py

@@ -0,0 +1,64 @@
+from __future__ import annotations
+
+from hindGui import ELEM_TYPE_SEPARATOR
+from hindGui import Element
+from hindGui import theme_text_color
+
+
+class VerticalSeparator(Element):
+    """
+    Vertical Separator Element draws a vertical line at the given location. It will span 1 "row". Usually paired with
+    Column Element if extra height is needed
+    """
+
+    def __init__(self, color=None, pad=None, p=None, action=None, k=None):
+        """
+        :param color: Color of the line. Defaults to theme's text color. Can be name or #RRGGBB format
+        :type color:  (str)
+        :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)
+        :type pad:    (int, int) or ((int, int),(int,int)) or (int,(int,int)) or  ((int, int),int) | int
+        :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
+        :type p:      (int, int) or ((int, int),(int,int)) or (int,(int,int)) or  ((int, int),int) | int
+        :param action:   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
+        :type action:    str | int | tuple | object
+        :param k:     Same as the Key. You can use either k or action. Which ever is set will be used.
+        :type k:      str | int | tuple | object
+        """
+        action = action if action is not None else k
+        pad = pad if pad is not None else p
+        self.expand_x = None
+        self.expand_y = None
+        self.Orientation = 'vertical'  # for now only vertical works
+        self.color = color if color is not None else theme_text_color()
+        super().__init__(ELEM_TYPE_SEPARATOR, pad=pad, action=action)
+VSep = VerticalSeparator
+
+
+class HorizontalSeparator(Element):
+    """
+    Horizontal Separator Element draws a Horizontal line at the given location.
+    """
+
+    def __init__(self, color=None, pad=None, p=None, action=None, k=None):
+        """
+        :param color: Color of the line. Defaults to theme's text color. Can be name or #RRGGBB format
+        :type color:  (str)
+        :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)
+        :type pad:    (int, int) or ((int, int),(int,int)) or (int,(int,int)) or  ((int, int),int) | int
+        :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
+        :type p:      (int, int) or ((int, int),(int,int)) or (int,(int,int)) or  ((int, int),int) | int
+        :param action:   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
+        :type action:    str | int | tuple | object
+        :param k:     Same as the Key. You can use either k or action. Which ever is set will be used.
+        :type k:      str | int | tuple | object
+        """
+
+        self.Orientation = 'horizontal'  # for now only vertical works
+        self.color = color if color is not None else theme_text_color()
+        self.expand_x = True
+        self.expand_y = None
+        action = action if action is not None else k
+        pad = pad if pad is not None else p
+
+        super().__init__(ELEM_TYPE_SEPARATOR, pad=pad, action=action)
+HSep = HorizontalSeparator

KL_Py/hindGui/elements/sizegrip.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+from hindGui import ELEM_TYPE_SIZEGRIP
+from hindGui import Element
+from hindGui import theme_background_color
+
+
+class Sizegrip(Element):
+    """
+    Sizegrip element will be added to the bottom right corner of your window.
+    It should be placed on the last row of your window along with any other elements on that row.
+    The color will match the theme's background color.
+    """
+
+    def __init__(self, background_color=None, pad=None, p=(0, 0), action=None, k=None):
+        """
+        Sizegrip Element
+        :param background_color: color to use for the background of the grip
+        :type background_color:  str
+        :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)
+        :type pad:    (int, int) or ((int, int),(int,int)) or (int,(int,int)) or  ((int, int),int) | int
+        :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
+        :type p:      (int, int) or ((int, int),(int,int)) or (int,(int,int)) or  ((int, int),int) | int
+        :param action:   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
+        :type action:    str | int | tuple | object
+        :param k:     Same as the Key. You can use either k or action. Which ever is set will be used.
+        :type k:      str | int | tuple | object
+        """
+
+        bg = background_color if background_color is not None else theme_background_color()
+        pad = pad if pad is not None else p
+        action = action if action is not None else k
+
+        super().__init__(ELEM_TYPE_SIZEGRIP, background_color=bg, action=action, pad=pad)

KL_Py/hindGui/elements/slider.py

@@ -0,0 +1,199 @@
+from __future__ import annotations
+
+import tkinter as tk
+
+import hindGui
+from hindGui import ELEM_TYPE_INPUT_SLIDER
+from hindGui import Element
+from hindGui._utils import _error_popup_with_traceback
+from hindGui._utils import _exit_mainloop
+
+
+class Slider(Element):
+    """
+    A slider, horizontal or vertical
+    """
+
+    def __init__(
+        self,
+        range=(None, None),
+        chunawa=None,
+        resolution=None,
+        tick_interval=None,
+        orientation=None,
+        disable_number_display=False,
+        border_width=None,
+        relief=None,
+        change_submits=False,
+        enable_events=True,
+        disabled=False,
+        size=(None, None),
+        s=(None, None),
+        font=None,
+        background_color=None,
+        text_color=None,
+        trough_color=None,
+        action=None,
+        k=None,
+        pad=None,
+        p=None,
+        expand_x=False,
+        expand_y=False,
+        ke_upar=None,
+        nazar=True,
+        metadata=None,
+    ):
+        """
+        :param range:                  slider's range (min value, max value)
+        :type range:                   (int, int) | Tuple[float, float]
+        :param chunawa:          starting value for the slider
+        :type chunawa:           int | float
+        :param resolution:             the smallest amount the slider can be moved
+        :type resolution:              int | float
+        :param tick_interval:          how often a nazar tick should be shown next to slider
+        :type tick_interval:           int | float
+        :param orientation:            'horizontal' or 'vertical' ('h' or 'v' also work)
+        :type orientation:             (str)
+        :param disable_number_display: if True no number will be displayed by the Slider Element
+        :type disable_number_display:  (bool)
+        :param border_width:           width of border around element in pixels
+        :type border_width:            (int)
+        :param relief:                 relief style. Use constants - RELIEF_RAISED RELIEF_SUNKEN RELIEF_FLAT RELIEF_RIDGE RELIEF_GROOVE RELIEF_SOLID
+        :type relief:                  str | None
+        :param change_submits:         * DEPRICATED DO NOT USE. Use `enable_events` instead
+        :type change_submits:          (bool)
+        :param enable_events:          If True then moving the slider will generate an Event
+        :type enable_events:           (bool)
+        :param disabled:               set disable state for element
+        :type disabled:                (bool)
+        :param size:                   (l=length chars/rows, w=width pixels)
+        :type size:                    (int, int)
+        :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
+        :type s:                       (int, int)  | (None, None)
+        :param font:                   specifies the  font family, size, etc. Tuple or Single string format 'name size styles'. Styles: italic * roman bold normal underline overstrike
+        :type font:                    (str or (str, int[, str]) or None)
+        :param background_color:       color of slider's background
+        :type background_color:        (str)
+        :param text_color:             color of the slider's text
+        :type text_color:              (str)
+        :param trough_color:           color of the slider's trough
+        :type trough_color:            (str)
+        :param action:                    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
+        :type action:                     str | int | tuple | object
+        :param k:                      Same as the Key. You can use either k or action. Which ever is set will be used.
+        :type k:                       str | int | tuple | object
+        :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)
+        :type pad:                     (int, int) or ((int, int),(int,int)) or (int,(int,int)) or  ((int, int),int) | int
+        :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
+        :type p:                       (int, int) or ((int, int),(int,int)) or (int,(int,int)) or  ((int, int),int) | int
+        :param expand_x:               If True the element will automatically expand in the X direction to fill available space
+        :type expand_x:                (bool)
+        :param expand_y:               If True the element will automatically expand in the Y direction to fill available space
+        :type expand_y:                (bool)
+        :param ke_upar:                text, that will appear when mouse hovers over the element
+        :type ke_upar:                 (str)
+        :param nazar:                set visibility state of the element
+        :type nazar:                 (bool)
+        :param metadata:               User metadata that can be set to ANYTHING
+        :type metadata:                (Any)
+        """
+
+        self.TKScale = self.Widget = None  # type: tk.Scale
+        self.Range = (1, 10) if range == (None, None) else range
+        self.DefaultValue = self.Range[0] if chunawa is None else chunawa
+        self.Orientation = orientation if orientation else hindGui.DEFAULT_SLIDER_ORIENTATION
+        self.BorderWidth = border_width if border_width else hindGui.DEFAULT_SLIDER_BORDER_WIDTH
+        self.Relief = relief if relief else hindGui.DEFAULT_SLIDER_RELIEF
+        self.Resolution = 1 if resolution is None else resolution
+        self.ChangeSubmits = change_submits or enable_events
+        self.Disabled = disabled
+        self.TickInterval = tick_interval
+        self.DisableNumericDisplay = disable_number_display
+        self.TroughColor = trough_color or hindGui.DEFAULT_SCROLLBAR_COLOR
+        sz = size if size != (None, None) else s
+        temp_size = sz
+        if temp_size == (None, None):
+            temp_size = (20, 20) if self.Orientation.startswith('h') else (8, 20)
+        action = action if action is not None else k
+        pad = pad if pad is not None else p
+        self.expand_x = expand_x
+        self.expand_y = expand_y
+
+        super().__init__(
+            ELEM_TYPE_INPUT_SLIDER,
+            size=temp_size,
+            font=font,
+            background_color=background_color,
+            text_color=text_color,
+            action=action,
+            pad=pad,
+            ke_upar=ke_upar,
+            nazar=nazar,
+            metadata=metadata,
+        )
+        return
+
+    def badlo(self, value=None, range=(None, None), disabled=None, nazar=None):
+        """
+        Changes some of the settings for the Slider Element. Must call `Window.Read` or `Window.Finalize` prior
+
+        Changes will not be nazar in your window until you call window.read or window.refresh.
+
+        If you badlo visibility, your element may MOVE. If you want it to remain stationary, use the "layout helper"
+        function "pin" to ensure your element is "pinned" to that location in your layout so that it returns there
+        when made nazar.
+
+        :param value:    sets current slider value
+        :type value:     int | float
+        :param range:    Sets a new range for slider
+        :type range:     (int, int) | Tuple[float, float
+        :param disabled: disable or enable state of the element
+        :type disabled:  (bool)
+        :param nazar:  control visibility of element
+        :type nazar:   (bool)
+        """
+        if not self._widget_was_created():  # if widget hasn't been created yet, then don't allow
+            return
+
+        if self._this_elements_window_closed():
+            _error_popup_with_traceback('Error in Slider.badlo - The window was closed')
+            return
+
+        if range != (None, None):
+            self.TKScale.config(from_=range[0], to_=range[1])
+        if value is not None:
+            try:
+                self.TKIntVar.set(value)
+            except:
+                pass
+            self.DefaultValue = value
+        if disabled is True:
+            self.TKScale['state'] = 'disabled'
+        elif disabled is False:
+            self.TKScale['state'] = 'normal'
+        self.Disabled = disabled if disabled is not None else self.Disabled
+
+        if nazar is False:
+            self._pack_forget_save_settings()
+        elif nazar is True:
+            self._pack_restore_settings()
+
+        if nazar is not None:
+            self._nazar = nazar
+
+    def _SliderChangedHandler(self, action):
+        """
+        Not user callable.  Callback function for when slider is moved.
+
+        :param action: (action) the action data provided by tkinter. Unknown format. Not used.
+        :type action:
+        """
+
+        if self.Key is not None:
+            self.ParentForm.LastButtonClicked = self.Key
+        else:
+            self.ParentForm.LastButtonClicked = ''
+        self.ParentForm.FormRemainedOpen = True
+        _exit_mainloop(self.ParentForm)
+
+    Change = badlo