scustomtkinter 0.2.1__py3-none-any.whl

scustomtkinter_pygubu/sCTkFileExplorerbo.py

@@ -0,0 +1,189 @@
+#!/usr/bin/python3
+"""
+sCTkFileExplorerbo
+
+Pygubu Builder Object for the compound FileExplorer entry that is used by pathchooser.
+"""
+import pygubu
+from pygubu.api.v1 import (
+    BuilderObject,
+    register_widget,
+    register_custom_property
+)
+
+# Import the native custom class
+from scustomtkinter.sctk_file_explorer import sCTkFileExplorer
+from pygubu.plugins.customtkinter.widgets import CTkFrameBO
+
+# Builder UI placement definitions
+widget_namespace = "scustomtkinter.sctk_file_explorer"
+widget_classname = "sCTkFileExplorer"
+builder_namespace = "scustomtkinter"
+section_name = "sCustomTkinter"
+
+
+class sCTkFileExplorerBO(BuilderObject):
+    class_ = sCTkFileExplorer
+
+    # Define custom plugin properties (Note: 'title' has been completely removed)
+    OPTIONS_CUSTOM = (
+        "width", "height", "type", "initialdir", "initialfile",
+        "filetypes", "state", "command", "double_click_command",
+        "selection_color"
+    )
+
+    # Merge custom extensions cleanly on top of core container frame attributes
+    properties = CTkFrameBO.properties + OPTIONS_CUSTOM
+    command_properties = ("command", "double_click_command")
+
+    def _process_property_value(self, pname, value):
+        """Passes values directly to allow core widget validations to handle exceptions."""
+        return super()._process_property_value(pname, value)
+
+    def _code_define_callback_args(self, cmd_pname, cmd):
+        """
+        Declares what each callback receives, so the generated stub has
+        matching parameters.
+
+        FIX: without this, pygubu generated a stub with no arguments --
+
+            def single_cb(self):
+                pass
+
+        -- and the widget called it with the selected path:
+
+            TypeError: single_cb() takes 1 positional argument but 2 were given
+
+        The two callbacks differ. `command` receives the path alone;
+        `double_click_command` receives the WIDGET and the path, which is how
+        sCTkPathChooser drives it (it reads args[-1] to get the path).
+        """
+        if cmd_pname == "double_click_command":
+            return ("explorer", "selected_path")
+        return ("selected_path",)
+
+    def _code_set_property(self, targetid, pname, value, code_bag):
+        """
+        Emits `filetypes` as a real Python list, not a quoted string.
+
+        FIX: the bracketed form contains double quotes, and the default
+        handler wraps the whole value in double quotes again:
+
+            sctkfileexplorer1.configure(filetypes="[".py"]", ...)
+                                                  ^^^^^^^^^
+            SyntaxError: invalid syntax
+
+        Emitting the literal unquoted gives valid Python and a real list, so
+        the widget receives one directly rather than parsing a string back
+        out of it. Same approach sCTkSelectorbo uses for `items`.
+
+        A bare comma-separated value -- the other accepted form -- has no
+        brackets and no quotes, so it is emitted as a quoted string and parsed
+        by the widget as usual.
+        """
+        if pname == "filetypes" and value:
+            text = str(value).strip()
+            if text.startswith("[") and text.endswith("]"):
+                code_bag[pname] = text
+                return None
+        return super()._code_set_property(targetid, pname, value, code_bag)
+
+    # NOTE: `type` and `filetypes` constrain each other in the WIDGET, but the
+    # inspector does not follow.
+    #
+    # Setting filetypes switches the widget to file mode, and choosing
+    # directory clears the filter -- see sCTkFileExplorer. The widget applies
+    # that to itself, and generated code is correct either way, because the
+    # widget corrects the combination at construction.
+    #
+    # The Designer keeps its own copy of the properties, so the inspector goes
+    # on showing the old value: adding a filter leaves `type` reading blank
+    # while the widget has switched to file mode. A set_property() override
+    # writing the companion value back into wmeta was tried and does not
+    # reach the live tree node, so it has been removed rather than left as
+    # dead code implying a behaviour that does not happen.
+
+
+# Register the widget into Pygubu's layout parsing engine
+builder_id = f"{builder_namespace}.{widget_classname}"
+register_widget(builder_id, sCTkFileExplorerBO, 'sCTkFileExplorer', ("ttk", section_name))
+
+# =========================================================================
+# Custom Property Designer Registration Maps
+# =========================================================================
+
+register_custom_property(
+    builder_id,
+    "command",
+    "commandentry",
+    help="Method callback string triggered on single-click file item highlight"
+)
+
+register_custom_property(
+    builder_id,
+    "double_click_command",
+    "commandentry",
+    help="Method callback string triggered on double-click selection"
+)
+
+register_custom_property(
+    builder_id,
+    "width",
+    "naturalnumber",
+    help="Total horizontal pixel constraint footprint assigned to the layout canvas wrapper"
+)
+
+register_custom_property(
+    builder_id,
+    "height",
+    "naturalnumber",
+    help="Total vertical pixel constraint footprint assigned to the layout canvas wrapper"
+)
+
+register_custom_property(
+    builder_id,
+    "type",
+    "choice",
+    values=("", "file", "directory"),
+    state="readonly",
+    default_value="directory",
+    help="What the explorer selects. The widget's own default is 'directory'; "
+         "setting filetypes switches it to 'file'."
+)
+
+register_custom_property(
+    builder_id,
+    "initialdir",
+    "entry",
+    help="Default starting directory path location string"
+)
+
+register_custom_property(
+    builder_id,
+    "initialfile",
+    "entry",
+    help="Default starting highlight focus target file path string"
+)
+
+register_custom_property(
+    builder_id,
+    "filetypes",
+    "entry",
+    help='Filter by file extension. Preferred: [".py", ".txt"]. Bare comma-separated (.py, .txt) also works, but cannot contain a comma inside a value.'
+)
+
+register_custom_property(
+    builder_id,
+    "state",
+    "choice",
+    values=("", "normal", "disabled"),
+    state="readonly",
+    help="Set widget active visibility or input interaction lockdown state"
+)
+
+register_custom_property(
+    builder_id, "selection_color", "colorentry",
+    help="Colour of the highlighted row. Blank uses the theme's "
+         "selection_color. Separate from btn_fg, which colours the navigation "
+         "buttons -- changing one does not affect the other."
+)

scustomtkinter_pygubu/sCTkFrameLabeledPrimarybo.py

@@ -0,0 +1,69 @@
+#!/usr/bin/python3
+"""
+sCTkFrameLabeledPrimary
+
+Similer to ttk.labelframe built on ctkscrollableframe with scrollbars hidden
+
+UI source file: sCTkFrameLabeledPrimary.ui
+"""
+import tkinter as tk
+import tkinter.ttk as ttk
+from customtkinter import CTkScrollableFrame
+from pygubu.api.v1 import (
+    BuilderObject,
+    register_widget,
+    register_custom_property)
+
+from pygubu.plugins.customtkinter.scrollableframe import CTkScrollableFrameBO
+
+from scustomtkinter.sctk_frame_labeled_primary import sCTkFrameLabeledPrimary
+
+
+#
+# Builder definition section
+#
+widget_namespace = "scustomtkinter.sctk_frame_labeled_primary"
+widget_classname = "sCTkFrameLabeledPrimary"
+builder_namespace = "scustomtkinter"
+section_name = "sCustomTkinter"
+
+
+container = True
+# CTkScrollableFrame does some weird things
+# with layout so disabled container layout here on purpose.
+container_layout = False
+
+
+class sCTkFrameLabeledPrimaryBO(CTkScrollableFrameBO):
+    class_ = sCTkFrameLabeledPrimary
+
+    # state was never declared here, so the property did not reach the
+    # inspector at all -- even though the widget implements it fully, with its
+    # own state()/get_state() and a disabled_map that dims the border and the
+    # label. sCTkScrollableFramebo declares it the same way.
+    OPTIONS_CUSTOM = ("state",)
+    properties = CTkScrollableFrameBO.properties + OPTIONS_CUSTOM
+
+    OPTIONS_CUSTOM_DEFAULTS = {
+        "state": "normal",
+    }
+
+
+    def code_imports(self):
+            # should return an iterable of (module, classname/function) to import
+            # or None
+            imports = [(widget_namespace, widget_classname)]
+            imports.extend(self.code_extra_imports())
+            return imports
+
+builder_id = f"{builder_namespace}.{widget_classname}"
+register_widget(
+    builder_id, sCTkFrameLabeledPrimaryBO, widget_classname, ("ttk", section_name)
+)
+
+register_custom_property(
+    builder_id, "state", "choice", values=("normal", "disabled"),
+    state="readonly", default_value="normal",
+    help="Disabled dims the border and the label. The contents keep their own "
+         "state -- disabling the frame does not disable what is inside it."
+)

scustomtkinter_pygubu/sCTkFrameLabeledSecondarybo.py

@@ -0,0 +1,71 @@
+#!/usr/bin/python3
+"""
+sCTkFrameLabeledSecondary
+
+Similer to ttk.labelframe built on ctkscrollableframe with scrollbars hidden
+
+UI source file: sCTkFrameLabeledSecondary.ui
+"""
+import tkinter as tk
+import tkinter.ttk as ttk
+from customtkinter import CTkScrollableFrame
+from pygubu.api.v1 import (
+    BuilderObject,
+    register_widget,
+    register_custom_property
+)
+
+from pygubu.plugins.customtkinter import nsctk
+from pygubu.plugins.customtkinter.scrollableframe import CTkScrollableFrameBO
+from pygubu.api.v1 import copy_custom_property
+
+from scustomtkinter.sctk_frame_labeled_secondary import sCTkFrameLabeledSecondary
+
+
+#
+# Builder definition section
+#
+widget_namespace = "scustomtkinter.sctk_frame_labeled_secondary"
+widget_classname = "sCTkFrameLabeledSecondary"
+builder_namespace = "scustomtkinter"
+section_name = "sCustomTkinter"
+
+container = True
+# CTkScrollableFrame does some weird things
+# with layout so disabled container layout here on purpose.
+container_layout = False
+
+
+class sCTkFrameLabeledSecondaryBO(CTkScrollableFrameBO):
+    class_ = sCTkFrameLabeledSecondary
+
+    # state was never declared here, so the property did not reach the
+    # inspector at all -- even though the widget implements it fully, with its
+    # own state()/get_state() and a disabled_map that dims the border and the
+    # label. sCTkScrollableFramebo declares it the same way.
+    OPTIONS_CUSTOM = ("state",)
+    properties = CTkScrollableFrameBO.properties + OPTIONS_CUSTOM
+
+    OPTIONS_CUSTOM_DEFAULTS = {
+        "state": "normal",
+    }
+
+    def code_imports(self):
+        # should return an iterable of (module, classname/function) to import
+        # or None
+        imports = [(widget_namespace, widget_classname)]
+        imports.extend(self.code_extra_imports())
+        return imports
+
+
+builder_id = f"{builder_namespace}.{widget_classname}"
+register_widget(
+    builder_id, sCTkFrameLabeledSecondaryBO, widget_classname, ("ttk", section_name)
+)
+
+register_custom_property(
+    builder_id, "state", "choice", values=("normal", "disabled"),
+    state="readonly", default_value="normal",
+    help="Disabled dims the border and the label. The contents keep their own "
+         "state -- disabling the frame does not disable what is inside it."
+)

scustomtkinter_pygubu/sCTkFramebo.py

@@ -0,0 +1,46 @@
+#!/usr/bin/python3
+"""
+sCTkFrame
+
+subclass of Frame tuned for this ux
+
+UI source file: sCTkFrame.ui
+"""
+import tkinter as tk
+import tkinter.ttk as ttk
+from customtkinter import CTkFrame
+from pygubu.api.v1 import (
+    BuilderObject,
+    register_widget,
+    register_custom_property
+)
+
+from pygubu.plugins.customtkinter import nsctk
+from pygubu.plugins.customtkinter.widgets import CTkFrameBO
+from pygubu.api.v1 import copy_custom_property
+
+from scustomtkinter.sctk_frame import sCTkFrame
+
+
+#
+# Builder definition section
+#
+widget_namespace = "scustomtkinter.sctk_frame"
+widget_classname = "sCTkFrame"
+builder_namespace = "scustomtkinter"
+section_name = "sCustomTkinter"
+
+
+class sCTkFrameBO(CTkFrameBO):
+    class_ = sCTkFrame
+
+    def code_imports(self):
+        # should return an iterable of (module, classname/function) to import
+        # or None
+        return [(widget_namespace, widget_classname)]
+
+
+builder_id = f"{builder_namespace}.{widget_classname}"
+register_widget(
+    builder_id, sCTkFrameBO, widget_classname, ("ttk", section_name)
+)

scustomtkinter_pygubu/sCTkFrequencyDisplaybo.py

@@ -0,0 +1,175 @@
+#!/usr/bin/python3
+"""
+sCTkFrequencyDisplay
+
+Pygubu builder object for the grouped numeric readout.
+"""
+from pygubu.api.v1 import (
+    register_widget,
+    register_custom_property,
+)
+from pygubu.plugins.customtkinter.widgets import CTkFrameBO
+
+from scustomtkinter.sctk_frequency_display import sCTkFrequencyDisplay
+
+widget_namespace = "scustomtkinter.sctk_frequency_display"
+widget_classname = "sCTkFrequencyDisplay"
+builder_namespace = "scustomtkinter"
+section_name = "sCustomTkinter"
+
+
+class sCTkFrequencyDisplayBO(CTkFrameBO):
+    class_ = sCTkFrequencyDisplay
+
+    OPTIONS_CUSTOM = (
+        "digits", "signed", "value", "delimiter", "font_size",
+        "selectable", "min_digit", "state",
+    )
+    properties = CTkFrameBO.properties + OPTIONS_CUSTOM
+    command_properties = ("command",)
+
+    OPTIONS_CUSTOM_DEFAULTS = {
+        "digits": "10",
+        "signed": "False",
+        "value": "0",
+        "delimiter": ".",
+        "font_size": "34",
+        "selectable": "True",
+        "min_digit": "1",
+        "state": "normal",
+    }
+
+    container = False
+
+    def realize(self, parent, extra_init_args: dict = None):
+        """
+        Builds the readout with its properties as constructor arguments.
+
+        digits and signed change the LAYOUT, so they have to arrive as real
+        values rather than being set afterwards -- a readout that builds at
+        ten digits and shrinks to four flickers through the wrong size on
+        every Designer repaint.
+        """
+        if extra_init_args is None:
+            extra_init_args = {}
+
+        props = self.wmeta.properties
+        init_args = {
+            "digits": int(props.get("digits", 10) or 10),
+            "signed": self._as_bool(props.get("signed", "False")),
+            "value": int(props.get("value", 0) or 0),
+            "delimiter": props.get("delimiter", "."),
+            "font_size": int(props.get("font_size", 34) or 34),
+            "selectable": self._as_bool(props.get("selectable", "True")),
+            "min_digit": int(props.get("min_digit", 1) or 0),
+            "state": props.get("state", "normal"),
+        }
+
+        for prop in self.OPTIONS_CUSTOM:
+            extra_init_args.pop(prop, None)
+        init_args.update(extra_init_args)
+
+        real_master = parent.widget if hasattr(parent, "widget") else parent
+        self.widget = self.class_(real_master, **init_args)
+        return self.widget
+
+    @staticmethod
+    def _as_bool(value):
+        """bool("False") is True, and the Designer sends strings."""
+        if isinstance(value, str):
+            return value.strip().lower() in ("true", "1", "yes", "on")
+        return bool(value)
+
+    def _process_property_value(self, pname, value):
+        if pname in ("digits", "value", "font_size", "min_digit"):
+            return int(value)
+        if pname in ("signed", "selectable"):
+            return self._as_bool(value)
+        return super()._process_property_value(pname, value)
+
+    def _code_set_property(self, targetid, pname, value, code_bag):
+        """Numbers and booleans emit as tokens; the rest keep their quotes."""
+        if pname in ("digits", "value", "font_size", "min_digit",
+                     "signed", "selectable"):
+            code_bag[pname] = str(value).strip("'\"")
+        elif pname in ("delimiter", "state"):
+            code_bag[pname] = f"'{str(value).strip(chr(39) + chr(34))}'"
+        else:
+            super()._code_set_property(targetid, pname, value, code_bag)
+
+    def _code_define_callback_args(self, cmd_pname, cmd):
+        """
+        Declares that `command` receives the step, so the generated stub has
+        a matching parameter.
+
+        Without this a user writing a handler has no indication that the
+        selected digit's place value is being handed to them -- which is the
+        entire point of the callback.
+        """
+        return ("step",)
+
+    def code_imports(self):
+        imports = [(widget_namespace, widget_classname)]
+        imports.extend(self.code_extra_imports())
+        return imports
+
+
+builder_id = f"{builder_namespace}.{widget_classname}"
+register_widget(builder_id, sCTkFrequencyDisplayBO, widget_classname,
+                ("ttk", section_name))
+
+
+# ---------------------------------------------------------------------------
+# Inspector properties
+# ---------------------------------------------------------------------------
+register_custom_property(
+    builder_id, "digits", "naturalnumber", default_value="10",
+    help="How many digit positions. Ten reaches into the GHz as "
+         "x.xxx.xxx.xxx; four suits a signed offset. Leading groups are "
+         "hidden until they hold something, and the layout does not move "
+         "when one appears.")
+
+register_custom_property(
+    builder_id, "signed", "choice", values=("True", "False"),
+    state="readonly", default_value="False",
+    help="Shows a leading + or -, for an offset rather than a frequency. "
+         "The sign is always drawn, even when the leading digits are not.")
+
+register_custom_property(
+    builder_id, "value", "entry", default_value="0",
+    help="The value shown, as an integer -- Hz for a frequency.")
+
+register_custom_property(
+    builder_id, "delimiter", "entry", default_value=".",
+    help="What separates the groups of three. Changeable at any time, "
+         "because it is a display preference the whole interface shares.")
+
+register_custom_property(
+    builder_id, "font_size", "naturalnumber", default_value="34",
+    help="Point size of the digits. The FAMILY comes from the theme and "
+         "should stay fixed-width -- a proportional font makes 1 and 8 "
+         "different widths, so the digits shift as the numbers change.")
+
+register_custom_property(
+    builder_id, "selectable", "choice", values=("True", "False"),
+    state="readonly", default_value="True",
+    help="Whether clicking a digit selects it. The selection IS the tuning "
+         "step, so a readout that is only a readout should set this False.")
+
+register_custom_property(
+    builder_id, "min_digit", "naturalnumber", default_value="1",
+    help="The smallest selectable digit, as a power of ten. 1 means the "
+         "units digit is shown but cannot be tuned -- right for a rig that "
+         "steps in whole 10 Hz.")
+
+register_custom_property(
+    builder_id, "state", "choice", values=("normal", "disabled"),
+    state="readonly", default_value="normal",
+    help="Disabled dims the digits and stops selection. The value keeps "
+         "updating: a display that froze while greyed would look like one "
+         "showing a current reading.")
+
+register_custom_property(
+    builder_id, "command", "commandentry",
+    help="Called with the new step, in units, when the selected digit "
+         "changes. 100 means the hundreds digit -- 100 Hz per detent.")

scustomtkinter_pygubu/sCTkLabelPrimarybo.py

@@ -0,0 +1,45 @@
+#!/usr/bin/python3
+"""
+sCTkLabelPrimary
+
+The primary label used for headers etc.
+
+UI source file: sCTkLabelPrimary.ui
+"""
+import tkinter as tk
+import tkinter.ttk as ttk
+from customtkinter import CTkLabel
+from pygubu.api.v1 import (
+    BuilderObject,
+    register_widget,
+)
+
+from scustomtkinter.sctk_label_primary import sCTkLabelPrimary
+from pygubu.plugins.customtkinter.widgets import CTkLabelBO
+
+
+#
+# Builder definition section
+#
+widget_namespace = "scustomtkinter.sctk_label_primary"
+widget_classname = "sCTkLabelPrimary"
+builder_namespace = "scustomtkinter"
+section_name = "sCustomTkinter"
+
+
+class sCTkLabelPrimaryBO(CTkLabelBO):
+    class_ = sCTkLabelPrimary
+
+    def code_imports(self):
+        # should return an iterable of (module, classname/function) to import
+        # or None
+        imports = [(widget_namespace, widget_classname)]
+        imports.extend(self.code_extra_imports())
+        return imports
+
+
+builder_id = f"{builder_namespace}.{widget_classname}"
+register_widget(
+    builder_id, sCTkLabelPrimaryBO, widget_classname, ("ttk", section_name)
+)
+

scustomtkinter_pygubu/sCTkLabelSecondarybo.py

@@ -0,0 +1,44 @@
+#!/usr/bin/python3
+"""
+sCTkLabelSecondary
+
+The secondary label used for general use.
+
+UI source file: sCTkLabelSecondary.ui
+"""
+import tkinter as tk
+import tkinter.ttk as ttk
+from customtkinter import CTkLabel
+from pygubu.api.v1 import (
+    BuilderObject,
+    register_widget,
+)
+
+from pygubu.plugins.customtkinter.widgets import CTkLabelBO
+from scustomtkinter.sctk_label_secondary import sCTkLabelSecondary
+
+
+#
+# Builder definition section
+#
+widget_namespace = "scustomtkinter.sctk_label_secondary"
+widget_classname = "sCTkLabelSecondary"
+builder_namespace = "scustomtkinter"
+section_name = "sCustomTkinter"
+
+
+class sCTkLabelSecondaryBO(CTkLabelBO):
+    class_ = sCTkLabelSecondary
+
+    def code_imports(self):
+        # should return an iterable of (module, classname/function) to import
+        # or None
+        imports = [(widget_namespace, widget_classname)]
+        imports.extend(self.code_extra_imports())
+        return imports
+
+
+builder_id = f"{builder_namespace}.{widget_classname}"
+register_widget(
+    builder_id, sCTkLabelSecondaryBO, widget_classname, ("ttk", section_name)
+)

scustomtkinter_pygubu/sCTkLabelTertiarybo.py

@@ -0,0 +1,45 @@
+#!/usr/bin/python3
+"""
+sCTkLabelTertiary
+
+3rd level Label used for notes
+
+UI source file: sCTkLabelTertiary.ui
+"""
+import tkinter as tk
+import tkinter.ttk as ttk
+from customtkinter import CTkLabel
+from pygubu.api.v1 import (
+    BuilderObject,
+    register_widget,
+)
+
+from pygubu.plugins.customtkinter.widgets import CTkLabelBO
+from scustomtkinter.sctk_label_tertiary import sCTkLabelTertiary
+
+
+#
+# Builder definition section
+#
+widget_namespace = "scustomtkinter.sctk_label_tertiary"
+widget_classname = "sCTkLabelTertiary"
+builder_namespace = "scustomtkinter"
+section_name = "sCustomTkinter"
+
+
+class sCTkLabelTertiaryBO(CTkLabelBO):
+    class_ = sCTkLabelTertiary
+
+    def code_imports(self):
+        # should return an iterable of (module, classname/function) to import
+        # or None
+        imports = [(widget_namespace, widget_classname)]
+        imports.extend(self.code_extra_imports())
+        return imports
+
+
+builder_id = f"{builder_namespace}.{widget_classname}"
+register_widget(
+    builder_id, sCTkLabelTertiaryBO, widget_classname, ("ttk", section_name)
+)
+