KL-Py 0.0.1__py3-none-any.whl

KL_Py/hindGui/elements/spin.py

@@ -0,0 +1,252 @@
+from __future__ import annotations
+
+import tkinter as tk
+
+import hindGui
+from hindGui import ELEM_TYPE_INPUT_SPIN
+from hindGui import Element
+from hindGui._utils import _error_popup_with_traceback
+from hindGui._utils import _exit_mainloop
+
+
+class Spin(Element):
+    """
+    A spinner with up/down buttons and a single line of text. Choose 1 values from list
+    """
+
+    def __init__(
+        self,
+        values,
+        initial_value=None,
+        disabled=False,
+        change_submits=False,
+        enable_events=False,
+        na_badla_jae=False,
+        size=(None, None),
+        s=(None, None),
+        auto_size_text=None,
+        bind_return_key=None,
+        font=None,
+        background_color=None,
+        text_color=None,
+        action=None,
+        k=None,
+        pad=None,
+        p=None,
+        wrap=None,
+        ke_upar=None,
+        right_click_menu=None,
+        expand_x=False,
+        expand_y=False,
+        nazar=True,
+        metadata=None,
+    ):
+        """
+        :param values:           List of valid values
+        :type values:            Tuple[Any] or List[Any]
+        :param initial_value:    Initial item to show in window. Choose from list of values supplied
+        :type initial_value:     (Any)
+        :param disabled:         set disable state
+        :type disabled:          (bool)
+        :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. Spin events happen when an item changes
+        :type enable_events:     (bool)
+        :param na_badla_jae:         If True, then users cannot type in values. Only values from the values list are allowed.
+        :type na_badla_jae:          (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 bind_return_key:  If True, then the return action will cause a the element to generate an action when return action is pressed
+        :type bind_return_key:   (bool)
+        :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 background
+        :type background_color:  (str)
+        :param text_color:       color of the text
+        :type text_color:        (str)
+        :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 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 wrap:             Determines if the values should "Wrap". Default is False. If True, when reaching last value, will continue back to the first value.
+        :type wrap:              (bool)
+        :param ke_upar:          text, that will appear when mouse hovers over the element
+        :type ke_upar:           (str)
+        :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.Values = values
+        self.DefaultValue = initial_value
+        self.ChangeSubmits = change_submits or enable_events
+        self.TKSpinBox = self.Widget = None  # type: tk.Spinbox
+        self.Disabled = disabled
+        self.Readonly = na_badla_jae
+        self.RightClickMenu = right_click_menu
+        self.BindReturnKey = bind_return_key
+        self.wrap = wrap
+
+        bg = background_color if background_color else hindGui.DEFAULT_INPUT_ELEMENTS_COLOR
+        fg = text_color if text_color is not None else hindGui.DEFAULT_INPUT_TEXT_COLOR
+        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_SPIN,
+            size=sz,
+            auto_size_text=auto_size_text,
+            font=font,
+            background_color=bg,
+            text_color=fg,
+            action=action,
+            pad=pad,
+            ke_upar=ke_upar,
+            nazar=nazar,
+            metadata=metadata,
+        )
+        return
+
+    def badlo(self, value=None, values=None, disabled=None, na_badla_jae=None, nazar=None):
+        """
+        Changes some of the settings for the Spin Element. Must call `Window.Read` or `Window.Finalize` prior
+        Note that the state can be in 3 states only.... enabled, disabled, na_badla_jae even
+        though more combinations are available. The easy way to remember is that if you
+        badlo the na_badla_jae parameter then you are enabling the element.
+
+        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:    set the current value from list of choices
+        :type value:     (Any)
+        :param values:   set available choices
+        :type values:    List[Any]
+        :param disabled: disable. Note disabled and na_badla_jae cannot be mixed. It must be one OR the other
+        :type disabled:  (bool)
+        :param na_badla_jae: make element na_badla_jae.  Note disabled and na_badla_jae cannot be mixed. It must be one OR the other
+        :type na_badla_jae:  (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 Spin.badlo - The window was closed')
+            return
+
+        if values is not None:
+            old_value = self.TKStringVar.get()
+            self.Values = values
+            self.TKSpinBox.configure(values=values)
+            self.TKStringVar.set(old_value)
+        if value is not None:
+            try:
+                self.TKStringVar.set(value)
+                self.DefaultValue = value
+            except:
+                pass
+
+        if na_badla_jae is True:
+            self.Readonly = True
+            self.TKSpinBox['state'] = 'readonly'
+        elif na_badla_jae is False:
+            self.Readonly = False
+            self.TKSpinBox['state'] = 'normal'
+        if disabled is True:
+            self.TKSpinBox['state'] = 'disable'
+        elif disabled is False:
+            if self.Readonly:
+                self.TKSpinBox['state'] = 'readonly'
+            else:
+                self.TKSpinBox['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 _SpinChangedHandler(self, action):
+        """
+        Callback function. Used internally only. Called by tkinter when Spinbox Widget changes.  Results in Window.parh() call returning
+
+        :param action: passed in from tkinter
+        :type action:
+        """
+        # first, get the results table built
+        if self.Key is not None:
+            self.ParentForm.LastButtonClicked = self.Key
+        else:
+            self.ParentForm.LastButtonClicked = ''
+        self.ParentForm.FormRemainedOpen = True
+        _exit_mainloop(self.ParentForm)
+        # if self.ParentForm.CurrentlyRunningMainloop:
+        #     Window._window_that_exited = self.ParentForm
+        #     self.ParentForm.TKroot.quit()  # kick the users out of the mainloop
+
+    def set_ibeam_color(self, ibeam_color=None):
+        """
+        Sets the color of the I-Beam that is used to "insert" characters. This is oftens called a "Cursor" by
+        many users.  To keep from being confused with tkinter's definition of cursor (the mouse pointer), the term
+        ibeam is used in this case.
+        :param ibeam_color: color to set the "I-Beam" used to indicate where characters will be inserted
+        :type ibeam_color:  (str)
+        """
+
+        if not self._widget_was_created():
+            return
+        if ibeam_color is not None:
+            try:
+                self.Widget.config(insertbackground=ibeam_color)
+            except Exception:
+                _error_popup_with_traceback(
+                    'Error setting I-Beam color in set_ibeam_color',
+                    'The element has a action:',
+                    self.Key,
+                    'The color passed in was:',
+                    ibeam_color,
+                )
+
+    def get(self):
+        """
+        Return the current chosen value showing in spinbox.
+        This value will be the same as what was provided as list of choices.  If list items are ints, then the
+        item returned will be an int (not a string)
+
+        :return: The currently nazar entry
+        :rtype:  (Any)
+        """
+        value = self.TKStringVar.get()
+        for v in self.Values:
+            if str(v) == value:
+                value = v
+                break
+        return value
+
+    Get = get
+    Change = badlo

KL_Py/hindGui/elements/status_bar.py

@@ -0,0 +1,165 @@
+from __future__ import annotations
+
+import tkinter as tk
+
+import hindGui
+from hindGui import COLOR_SYSTEM_DEFAULT
+from hindGui import ELEM_TYPE_STATUSBAR
+from hindGui import Element
+from hindGui import RELIEF_SUNKEN
+from hindGui._utils import _error_popup_with_traceback
+
+
+class StatusBar(Element):
+    """
+    A StatusBar Element creates the sunken text-filled strip at the bottom. Many Windows programs have this line
+    """
+
+    def __init__(
+        self,
+        text,
+        size=(None, None),
+        s=(None, None),
+        auto_size_text=None,
+        click_submits=None,
+        enable_events=True,
+        relief=RELIEF_SUNKEN,
+        font=None,
+        text_color=None,
+        background_color=None,
+        justification=None,
+        pad=None,
+        p=None,
+        action=None,
+        k=None,
+        right_click_menu=None,
+        expand_x=False,
+        expand_y=False,
+        ke_upar=None,
+        nazar=True,
+        metadata=None,
+    ):
+        """
+        :param text:             Text that is to be displayed in the widget
+        :type text:              (str)
+        :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) |  (int, 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:   True if size should fit the text length
+        :type auto_size_text:    (bool)
+        :param click_submits:    DO NOT USE. Only listed for backwards compat - Use enable_events instead
+        :type click_submits:     (bool)
+        :param enable_events:    Turns on the element specific events. StatusBar events occur when the bar is clicked
+        :type enable_events:     (bool)
+        :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`
+        :type relief:            (enum)
+        :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 text_color:       color of the text
+        :type text_color:        (str)
+        :param background_color: color of background
+        :type background_color:  (str)
+        :param justification:    how string should be aligned within space provided by size. Valid choices = `left`, `right`, `center`
+        :type justification:     (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:              Used with window.find_element and with return values to uniquely identify this element to uniquely identify this element
+        :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 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 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.DisplayText = text
+        self.TextColor = text_color if text_color else hindGui.DEFAULT_TEXT_COLOR
+        self.Justification = justification
+        self.Relief = relief
+        self.ClickSubmits = click_submits or enable_events
+        if background_color is None:
+            bg = hindGui.DEFAULT_TEXT_ELEMENT_BACKGROUND_COLOR
+        else:
+            bg = background_color
+        self.TKText = self.Widget = None  # type: tk.Label
+        action = action if action is not None else k
+        self.RightClickMenu = right_click_menu
+        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_STATUSBAR,
+            size=sz,
+            auto_size_text=auto_size_text,
+            background_color=bg,
+            font=font or hindGui.DEFAULT_FONT,
+            text_color=self.TextColor,
+            pad=pad,
+            action=action,
+            ke_upar=ke_upar,
+            nazar=nazar,
+            metadata=metadata,
+        )
+        return
+
+    def badlo(self, value=None, background_color=None, text_color=None, font=None, nazar=None):
+        """
+        Changes some of the settings for the Status Bar 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:            new text to show
+        :type value:             (str)
+        :param background_color: color of background
+        :type background_color:  (str)
+        :param text_color:       color of the text
+        :type text_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 nazar:          set visibility state of the 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 StatusBar.badlo - The window was closed')
+            return
+
+        if value is not None:
+            self.DisplayText = value
+            stringvar = self.TKStringVar
+            stringvar.set(value)
+        if background_color not in (None, COLOR_SYSTEM_DEFAULT):
+            self.TKText.configure(background=background_color)
+        if text_color not in (None, COLOR_SYSTEM_DEFAULT):
+            self.TKText.configure(fg=text_color)
+        if font is not None:
+            self.TKText.configure(font=font)
+        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
+
+    Change = badlo

KL_Py/hindGui/elements/stretch.py

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+from hindGui.elements.text import Text
+
+
+def Push(background_color=None):
+    """
+    Acts like a Stretch element found in the Qt port.
+    Used in a Horizontal fashion.  Placing one on each side of an element will enter the element.
+    Place one to the left and the element to the right will be right justified.  See VStretch for vertical type
+    :param background_color: color of background may be needed because of how this is implemented
+    :type background_color:  (str)
+    :return:                 (Text)
+    """
+    return Text(font='_ 1', background_color=background_color, pad=(0, 0), expand_x=True)
+
+
+def VPush(background_color=None):
+    """
+    Acts like a Stretch element found in the Qt port.
+    Used in a Vertical fashion.
+    :param background_color: color of background may be needed because of how this is implemented
+    :type background_color:  (str)
+    :return:                 (Text)
+    """
+    return Text(font='_ 1', background_color=background_color, pad=(0, 0), expand_y=True)