SwiftGUI 0.2.2__tar.gz → 0.2.3__tar.gz

{swiftgui-0.2.2 → swiftgui-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: SwiftGUI
-Version: 0.2.2
+Version: 0.2.3
 Summary: An easy-to-use package for creating and using simple GUIs
 License: Apache-2.0
 Author: Eric aka LeButch

{swiftgui-0.2.2 → swiftgui-0.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "SwiftGUI"
-version = "0.2.2"
+version = "0.2.3"
 packages = [
     { include = "SwiftGUI", from = "src" }
 ]

{swiftgui-0.2.2 → swiftgui-0.2.3}/src/SwiftGUI/Base.py

@@ -2,7 +2,7 @@ from collections.abc import Iterable, Callable
 from typing import Literal, Self, Union
 import tkinter as tk
 
-from SwiftGUI import Event,GlobalOptions
+from SwiftGUI import Event, GlobalOptions, Color
 from SwiftGUI.ElementFlags import ElementFlag
 
 
@@ -227,7 +227,7 @@ class BaseWidget(BaseElement):
     _insert_kwargs_rows:dict    # kwargs for the grid-rows
 
     #_is_container:bool = False   # True, if this widget contains other widgets
-    _contains:Iterable[Iterable[Self]] = []
+    _contains:Iterable[Iterable["BaseElement"]] = []
 
     _transfer_keys: dict[str:str] = dict()   # Rename a key from the update-function. from -> to; from_user -> to_widget
 
@@ -376,6 +376,8 @@ class BaseWidget(BaseElement):
         if self.has_flag(ElementFlag.IS_CONTAINER):
             self._init_containing()
 
+    _containing_row_frame_widgets: list[tk.Frame]
+    _background_color: str | Color
     def _init_containing(self):
         """
         Initialize all containing widgets
@@ -387,8 +389,9 @@ class BaseWidget(BaseElement):
             # line = tk.Frame(self._tk_widget,background="orange",relief="raised",borderwidth="3",border=3)
             # actual_line = tk.Frame(line,background="lightBlue")
 
-            line = tk.Frame(self._tk_widget,relief="flat",background="")  # This is the row
-            actual_line = tk.Frame(line,background="")    # This is where the actual elements are put in
+            line = tk.Frame(self._tk_widget,relief="flat",background=self._background_color)  # This is the row
+            actual_line = tk.Frame(line,background=self._background_color)    # This is where the actual elements are put in
+            self._containing_row_frame_widgets.extend((line,actual_line))
 
             line_elem = BaseElement()
             line_elem._fake_tk_element = actual_line
@@ -457,6 +460,11 @@ class BaseWidgetContainer(BaseWidget):
     """
     Base for Widgets that contain other widgets
     """
+    def __init__(self,key:any=None,tk_kwargs:dict[str:any]=None,expand:bool = False,**kwargs):
+        super().__init__(key,tk_kwargs,expand,**kwargs)
+
+        self._containing_row_frame_widgets = list()
+        self._background_color: str | Color = self.defaults.single("background_color",None)
 
     def _flag_init(self):
         super()._flag_init()

{swiftgui-0.2.2 → swiftgui-0.2.3}/src/SwiftGUI/ElementFlags.py

@@ -7,6 +7,7 @@ class ElementFlag(Enum):
     UPDATE_FONT = 3     # Font has to be updated
     IS_CREATED = 4  # Element was created by _init
     EXPAND_ROW = 5  # The row this element is in should be expanded
+    APPLY_PARENT_BACKGROUND_COLOR = 6   # Set, if the element should apply whatever background-color the parent has
 
     # Flags 100-200 will never be used, so they are available for you to create custom flags
     # It's important to set an actual value for each flag so it can be saved/loaded correctly

{swiftgui-0.2.2 → swiftgui-0.2.3}/src/SwiftGUI/GlobalOptions.py

@@ -1,6 +1,7 @@
 #import tkinter as tk    # Not needed, but helpful to figure out default vals
 #from tkinter import ttk
 from collections.abc import Iterable
+from os import PathLike
 from typing import Literal, Union
 
 from SwiftGUI import Literals, Color, font_windows, Font
@@ -166,6 +167,7 @@ class Text(Common,Common_Textual):
     underline:int = None
     justify:Literal["left","right","center"] = "left"
     #borderwidth:int = "5c" # Does not work
+    apply_parent_background_color:bool = True
 
     padding:Literals.padding = 0
     width:int = None
@@ -227,15 +229,17 @@ class Button(Common,Common_Textual):
 
 class Frame(Common):
     takefocus = False
-    padding:Literals.padding = 3
-    relief:Literals.relief = "flat"
+    padding: Literals.padding = 3
+    relief: Literals.relief = "flat"
     #background = "blue"
-    alignment:Literals.alignment = None
+    alignment: Literals.alignment = None
+    apply_parent_background_color: bool = True
 
 class Checkbox(Common,Common_Textual):
     key: any = None
     default_value: bool = False
     readonly: bool = None
+    apply_parent_background_color: bool = True
     # borderwidth:int = None
     #
     text_color_disabled: str | Color = None
@@ -295,6 +299,13 @@ class FileBrowseButton(Button):
     file_browse_type: Literals.file_browse_types = "open_single"
     file_browse_filetypes: Literals.file_browse_filetypes = (("All files","*"),)
     dont_change_on_abort: bool = False
+    file_browse_initial_dir: PathLike | str = None,  # initialdir
+    file_browse_initial_file: str = None,  # initialfile
+    file_browse_title: str = None,  # title
+    file_browse_save_defaultextension: str = None,  # defaultextension
+
+class ColorChooserButton(Button):
+    color_chooser_title: str = None
 
 def reset_all_options():
     """

{swiftgui-0.2.2 → swiftgui-0.2.3}/src/SwiftGUI/KeyFunctions.py

@@ -1,4 +1,6 @@
 from collections.abc import Callable
+from typing import Any
+
 
 ### HOW TO CREATE KEY-FUNCTION ###
 #
@@ -59,3 +61,27 @@ def set_value_to(new_value:any = "", elem_key:str = None) -> Callable:
 
     return temp
 
+def cycle_values(key:Any, *values:Any) -> Callable:
+    """
+    Every time this gets called, the next value is written to key
+    IT WILL START AT THE SECOND VALUE, so it's a good idea to set the initial element-value as the first value.
+
+    :param key: Element to change
+    :param values: values you want to cycle
+    :return:
+    """
+    n = 0
+    val_len = len(values)
+
+    assert val_len > 1, "You did not provide enough values for your cycle_values key-function"
+
+    def temp(w):
+        nonlocal n
+        n += 1
+
+        if n == val_len:
+            n = 0
+
+        w[key].value = values[n]
+
+    return temp

{swiftgui-0.2.2 → swiftgui-0.2.3}/src/SwiftGUI/Widgets/Checkbox.py

@@ -64,6 +64,7 @@ class Checkbox(BaseWidget):
             anchor: Literals.anchor = None,
             justify: Literal["left", "right", "center"] = None,
             background_color: str | Color = None,
+            apply_parent_background_color: bool = None,
             overrelief: Literals.relief = None,
             offrelief: Literals.relief = None,
             text_color: str | Color = None,
@@ -80,6 +81,9 @@ class Checkbox(BaseWidget):
         if tk_kwargs is None:
             tk_kwargs = dict()
 
+        if background_color and not apply_parent_background_color:
+            apply_parent_background_color = False
+
         _tk_kwargs = {
             **tk_kwargs,
             "default_value": default_value,
@@ -99,6 +103,7 @@ class Checkbox(BaseWidget):
             "underline": underline,
             "justify": justify,
             "background_color": background_color,
+            "apply_parent_background_color": apply_parent_background_color,
             "highlightthickness": 5,
             "highlightcolor": "purple",
             "relief": relief,
@@ -174,6 +179,11 @@ class Checkbox(BaseWidget):
                 self._tk_kwargs["state"] = "disabled" if new_val else "normal"
             case "check_type":
                 self._tk_kwargs["indicatoron"] = int(new_val == "check")
+            case "apply_parent_background_color":
+                if new_val:
+                    self.add_flags(ElementFlag.APPLY_PARENT_BACKGROUND_COLOR)
+                else:
+                    self.remove_flags(ElementFlag.APPLY_PARENT_BACKGROUND_COLOR)
             case _:  # Not a match
                 return False
 

swiftgui-0.2.3/src/SwiftGUI/Widgets/Frame.py

@@ -0,0 +1,88 @@
+import tkinter as tk
+import tkinter.ttk as ttk
+from collections.abc import Iterable
+
+from SwiftGUI import BaseElement, ElementFlag, BaseWidgetContainer, GlobalOptions, Literals, Color
+
+class Frame(BaseWidgetContainer):
+    """
+    Copy this class ot create your own Widget
+    """
+    _tk_widget_class:type[ttk.Frame] = tk.Frame # Class of the connected widget
+    defaults = GlobalOptions.Frame
+
+    _transfer_keys = {
+        "background_color":"background"
+    }
+
+    def __init__(
+            self,
+            layout: Iterable[Iterable[BaseElement]],
+            /,
+            alignment: Literals.alignment = None,
+            expand: bool = False,
+            background_color: str | Color = None,
+            apply_parent_background_color: bool = None,
+            # Add here
+            tk_kwargs: dict[str:any]=None,
+    ):
+        super().__init__(tk_kwargs=tk_kwargs)
+
+        self._contains = layout
+
+        if background_color and not apply_parent_background_color:
+            apply_parent_background_color = False
+
+        if tk_kwargs is None:
+            tk_kwargs = dict()
+
+        _tk_kwargs = {
+            **tk_kwargs,
+            # Insert named arguments for the widget here
+            "background_color":background_color,
+            "apply_parent_background_color": apply_parent_background_color,
+        }
+        self.update(**_tk_kwargs)
+
+        self._insert_kwargs["expand"] = self.defaults.single("expand",expand)
+
+        self._insert_kwargs_rows.update({
+            "side":self.defaults.single("alignment",alignment),
+        })
+
+    def window_entry_point(self,root:tk.Tk|tk.Widget,window:BaseElement):
+        """
+        Starting point for the whole window, or part of the layout.
+        Don't use this unless you overwrite the sg.Window class
+        :param window: Window Element
+        :param root: Window to put every element
+        :return:
+        """
+        self.window = window
+        self.window.add_flags(ElementFlag.IS_CREATED)
+        self.add_flags(ElementFlag.IS_CONTAINER)
+        self._init_widget(root)
+
+    def _update_special_key(self,key:str,new_val:any) -> bool|None:
+
+        match key:
+            case "apply_parent_background_color":
+                if new_val:
+                    self.add_flags(ElementFlag.APPLY_PARENT_BACKGROUND_COLOR)
+                else:
+                    self.remove_flags(ElementFlag.APPLY_PARENT_BACKGROUND_COLOR)
+
+            case "background_color":
+                for row in self._containing_row_frame_widgets:
+                    row.configure(background=new_val)
+
+                for i in self._contains:
+                    for elem in i:
+                        if elem.has_flag(ElementFlag.APPLY_PARENT_BACKGROUND_COLOR):
+                            elem.update(background_color = new_val)
+
+                return True
+            case _:
+                return False
+
+        return True

{swiftgui-0.2.2 → swiftgui-0.2.3}/src/SwiftGUI/Widgets/Spacer.py

@@ -1,5 +1,6 @@
 import tkinter as tk
-from SwiftGUI import BaseWidget
+from SwiftGUI import BaseWidget, ElementFlag
+
 
 class Spacer(BaseWidget):
     """
@@ -7,6 +8,10 @@ class Spacer(BaseWidget):
     """
     _tk_widget_class = tk.Frame
 
+    _transfer_keys = {
+        "background_color":"bg"
+    }
+
     def __init__(
             self,
             width:int = None,
@@ -14,6 +19,8 @@ class Spacer(BaseWidget):
     ):
         super().__init__()
 
+        self.add_flags(ElementFlag.APPLY_PARENT_BACKGROUND_COLOR)
+
         self._tk_kwargs = {
             "width":width,
             "height":height,

{swiftgui-0.2.2 → swiftgui-0.2.3}/src/SwiftGUI/Widgets/Text.py

@@ -30,6 +30,7 @@ class Text(BaseWidget):
             anchor:Literals.anchor = None,
             justify:Literal["left","right","center"] = None,
             background_color:str|Color = None,
+            apply_parent_background_color:bool = None,
             text_color:str|Color = None,
             relief:Literals.relief = None,
             padding:Literals.padding = None,
@@ -62,6 +63,9 @@ class Text(BaseWidget):
         if tk_kwargs is None:
             tk_kwargs = dict()
 
+        if background_color and not apply_parent_background_color:
+            apply_parent_background_color = False
+
         _tk_kwargs = {
             **tk_kwargs,
             "cursor":cursor,
@@ -82,6 +86,7 @@ class Text(BaseWidget):
             "font_underline":font_underline,
             "font_overstrike":font_overstrike,
             "anchor":anchor,
+            "apply_parent_background_color": apply_parent_background_color,
         }
         self.update(**_tk_kwargs)
 
@@ -124,6 +129,11 @@ class Text(BaseWidget):
                 self._tk_kwargs["background"] = self.defaults.single(key,new_val)
             case "text_color":
                 self._tk_kwargs["foreground"] = self.defaults.single(key,new_val)
+            case "apply_parent_background_color":
+                if new_val:
+                    self.add_flags(ElementFlag.APPLY_PARENT_BACKGROUND_COLOR)
+                else:
+                    self.remove_flags(ElementFlag.APPLY_PARENT_BACKGROUND_COLOR)
             case _: # Not a match
                 return False
 

swiftgui-0.2.3/src/SwiftGUI/WidgetsAdvanced/ColorChooserButton.py

@@ -0,0 +1,192 @@
+import tkinter as tk
+from tkinter import colorchooser
+from collections.abc import Iterable, Callable
+from typing import Literal
+
+from SwiftGUI import GlobalOptions, Literals, Color
+from SwiftGUI.Widgets.Button import Button
+
+
+class ColorChooserButton(Button):
+    """
+    Small Element to create a button that lets you chose a color
+    """
+    tk_widget:tk.Button
+    _tk_widget_class:type = tk.Button # Class of the connected widget
+    defaults = GlobalOptions.ColorChooserButton
+
+    def __init__(
+            # https://anzeljg.github.io/rin2/book2/2405/docs/tkinter/button.html
+
+            self,
+            # Add here
+            text:str = "",
+            /,
+            key:any = None,
+            key_function:Callable|Iterable[Callable] = None,
+
+            initial_color: str | Color = None,
+            color_chooser_title: str = None,
+
+            borderwidth:int = None,
+
+            bitmap:Literals.bitmap = None,
+            disabled:bool = None,
+            text_color_disabled: str | Color = None,
+            background_color_active: str | Color = None,
+            text_color_active: str | Color = None,
+
+            width: int = None,
+            height: int = None,
+            padx:int = None,
+            pady:int = None,
+
+            cursor: Literals.cursor = None,
+            takefocus: bool = None,
+
+            underline: int = None,
+            anchor: Literals.anchor = None,
+            justify: Literal["left", "right", "center"] = None,
+            #background_color: str | Color = None,
+            overrelief: Literals.relief = None,
+            text_color: str | Color = None,
+            relief: Literals.relief = None,
+
+            repeatdelay:int = None,
+            repeatinterval:int = None,
+
+            # # Mixed options
+            fonttype: str = None,
+            fontsize: int = None,
+            font_bold: bool = None,
+            font_italic: bool = None,
+            font_underline: bool = None,
+            font_overstrike: bool = None,
+
+            expand: bool = None,
+            tk_kwargs: dict[str:any] = None
+    ):
+        """
+        A button that throws an event every time it is pushed
+
+        :param text: Text the button displays
+        :param key: (See docs for more details)
+        :param key_function: (See docs for more details)
+
+        :param initial_color: Color that should be displayed in the beginning
+
+
+        :param borderwidth: Border-Thickness in pixels. Default is 2
+        :param bitmap: The are a couple of icons builtin. If you are using PyCharm, they should be suggested when pressing "ctrl+space"
+        :param disabled: True, if this button should not be pressable
+        :param text_color_disabled: Text color, if disabled = True
+        :param background_color_active: Background color shown only when the button is held down
+        :param text_color_active: Text color only shown when the button is held down
+        :param width: Button-size in x-direction in text-characters
+        :param height: Button-height in text-rows
+        :param padx: Adds space to both sides not filled with text. Should not be combined with "width". The value is given in characters
+        :param pady: Adds space to the top and bottom not filled with text. Should not be combined with "height". The value is given in rows
+        :param cursor: How the cursor should look when hovering over this element.
+        :param takefocus: True, if this element should be able to get focus (e.g. by pressing tab)
+        :param underline: Underlines the single character at this index
+        :param anchor: Specifies, where the text in this element should be placed (See docs for more details)
+        :param justify: When the text is multiple rows long, this will specify where the new rows begin.
+        :param overrelief: Relief when the mouse hovers over the element
+        :param text_color: Text-color in non-pressed state
+        :param relief: Relief in non-pressed state
+        :param repeatdelay: How long to hold the button until repeation starts (doesn't work without "repeatinterval")
+        :param repeatinterval: How long to wait between repetitions (doesn't work without "repeatdelay")
+        :param fonttype: Use sg.font_windows. ... to select some fancy font. Personally, I like sg.font_windows.Small_Fonts
+        :param fontsize: Size (height) of the font in pixels
+        :param font_bold: True, if thicc text
+        :param font_italic: True, if italic text
+        :param font_underline: True, if the text should be underlined
+        :param font_overstrike: True, if the text should be overstruck
+        :param tk_kwargs: (Only if you know tkinter) Pass more kwargs directly to the tk-widget
+        """
+        if callable(key_function):
+            key_function = (self._button_callback,key_function)
+        elif key_function:
+            key_function = (self._button_callback,*tuple(key_function))
+        else:
+            key_function = self._button_callback
+
+        super().__init__(
+            text,
+            key=key,
+            key_function=key_function,
+            borderwidth=borderwidth,
+            bitmap=bitmap,
+            disabled=disabled,
+            text_color_disabled=text_color_disabled,
+            background_color_active=background_color_active,
+            text_color_active=text_color_active,
+            width=width,
+            height=height,
+            padx=padx,
+            pady=pady,
+            cursor=cursor,
+            takefocus=takefocus,
+            underline=underline,
+            anchor=anchor,
+            justify=justify,
+            #background_color=background_color,
+            overrelief=overrelief,
+            text_color=text_color,
+            relief=relief,
+            repeatdelay=repeatdelay,
+            repeatinterval=repeatinterval,
+            fonttype=fonttype,
+            fontsize=fontsize,
+            font_bold=font_bold,
+            font_italic=font_italic,
+            font_underline=font_underline,
+            font_overstrike=font_overstrike,
+            expand=expand,
+            tk_kwargs=tk_kwargs,
+        )
+
+        self._file_function_kwargs = dict()
+
+        self.update(
+            initial_color = initial_color,
+            color_chooser_title = color_chooser_title,
+        )
+
+    _prev_val:str = None
+    def _button_callback(self):
+        # Call the file-dialogue
+        _,temp = colorchooser.askcolor(initialcolor=self._prev_val,title=self._title)
+
+        if temp is None:
+            return
+
+        self.value = str(temp)
+
+        return True # Refresh values for coming key_functions
+
+    def _get_value(self) -> any:
+        return self._prev_val
+
+    def set_value(self,val:any):
+        self._prev_val = val
+        self.update(background_color = val)
+
+    _title:str = None
+    def _update_special_key(self,key:str,new_val:any) -> bool|None:
+        if super()._update_special_key(key,new_val):
+            return True
+
+        match key:
+            case "initial_color":
+                self.value = new_val
+            case "color_chooser_title":
+                self._title = new_val
+            case _:
+                return False
+
+        return True
+
+    def _personal_init_inherit(self):
+        pass    # Avoid creating a target variable for this button, so the text can be changed with .update(text="...")
+

{swiftgui-0.2.2 → swiftgui-0.2.3}/src/SwiftGUI/WidgetsAdvanced/FileBrowseButton.py

@@ -1,12 +1,10 @@
-import inspect
 import tkinter as tk
 from os import PathLike
 from tkinter import filedialog as fd
-import tkinter.font as font
 from collections.abc import Iterable, Callable
 from typing import Literal
 
-from SwiftGUI import BaseElement, ElementFlag, BaseWidget, BaseWidgetContainer, GlobalOptions, Literals, Color
+from SwiftGUI import GlobalOptions, Literals, Color
 from SwiftGUI.Widgets.Button import Button
 
 

{swiftgui-0.2.2 → swiftgui-0.2.3}/src/SwiftGUI/Windows.py

@@ -127,6 +127,8 @@ class Window(BaseElement):
             background_color = GlobalOptions.Window.single("background_color",background_color)
 
         if background_color is not None:
+            if _first_update:
+                print("Warning! It is not possible to change background_color on an already created window (yet)...")
             self._sg_widget.update(background_color=background_color)
 
         if title is not None:

{swiftgui-0.2.2 → swiftgui-0.2.3}/src/SwiftGUI/__init__.py

@@ -19,6 +19,7 @@ from .Widgets.Listbox import Listbox
 
 from .WidgetsAdvanced.Form import Form
 from .WidgetsAdvanced.FileBrowseButton import FileBrowseButton
+from .WidgetsAdvanced.ColorChooserButton import ColorChooserButton
 
 T = Text
 
@@ -32,7 +33,7 @@ Check = Checkbox
 
 Column = Frame
 
-AnyElement = BaseElement | BaseWidget | Text | Button | Checkbox | Frame | Input | VerticalSeparator | HorizontalSeparator | Spacer | Form | Listbox | FileBrowseButton
+AnyElement = BaseElement | BaseWidget | Text | Button | Checkbox | Frame | Input | VerticalSeparator | HorizontalSeparator | Spacer | Form | Listbox | FileBrowseButton | ColorChooserButton
 
 from .Windows import Window
 

swiftgui-0.2.2/src/SwiftGUI/Widgets/Frame.py

@@ -1,61 +0,0 @@
-import tkinter as tk
-import tkinter.font as font
-import tkinter.ttk as ttk
-from collections.abc import Iterable, Callable
-from typing import Literal
-
-from SwiftGUI import BaseElement, ElementFlag, BaseWidget, BaseWidgetContainer, GlobalOptions, Literals, Color
-
-class Frame(BaseWidgetContainer):
-    """
-    Copy this class ot create your own Widget
-    """
-    _tk_widget_class:type[ttk.Frame] = tk.Frame # Class of the connected widget
-    defaults = GlobalOptions.Frame
-
-    _transfer_keys = {
-        "background_color":"background"
-    }
-
-    def __init__(
-            self,
-            layout:Iterable[Iterable[BaseElement]],
-            /,
-            alignment:Literals.alignment = None,
-            expand:bool = False,
-            background_color:Color = None,
-            # Add here
-            tk_kwargs:dict[str:any]=None,
-    ):
-        super().__init__(tk_kwargs=tk_kwargs)
-
-        self._contains = layout
-
-        if tk_kwargs is None:
-            tk_kwargs = dict()
-
-        _tk_kwargs = {
-            **tk_kwargs,
-            # Insert named arguments for the widget here
-            "background_color":background_color,
-        }
-        self.update(**_tk_kwargs)
-
-        self._insert_kwargs["expand"] = self.defaults.single("expand",expand)
-
-        self._insert_kwargs_rows.update({
-            "side":self.defaults.single("alignment",alignment),
-        })
-
-    def window_entry_point(self,root:tk.Tk|tk.Widget,window:BaseElement):
-        """
-        Starting point for the whole window, or part of the layout.
-        Don't use this unless you overwrite the sg.Window class
-        :param window: Window Element
-        :param root: Window to put every element
-        :return:
-        """
-        self.window = window
-        self.window.add_flags(ElementFlag.IS_CREATED)
-        self.add_flags(ElementFlag.IS_CONTAINER)
-        self._init_widget(root)