Source code for tkextras.widgets_render

"""
Contains the implementation of the class WidgetsRender

"""
import tkinter as tk




class WidgetsRender:
    """
    Perform element creation and rendering in one command. Without creating a variable unnecessarily.
    Combines general parameters for the arrangement of elements and parameters for a specific element.

    """
    def __init__(self, render_params: dict | None = None, *args, **options):
        """
        Initialization of the Frame, description of the main elements

        :param render_params: General parameters for the arrangement of elements can be set externally
        :param args: standard arguments of the tkinter widget
        :param options: standard options of the tkinter widget
        """
        super().__init__(*args, **options)
        if render_params is None:
            render_params = dict(sticky="ew", padx=5, pady=2)
        self.__render_params = render_params



    def param_prepare(self, pack_params: dict | None = None, func: str = "grid") -> dict:
        """
        Combines the packing parameters pack_params of the object with the parameters of the main object
        of class WidgetsRender. Brings it in line with the rendering function.

        :param pack_params: parameters pack_params of the current object.
        :param func: the rendering function.
        :return: combined packing parameters.
        """
        pack_params = pack_params if pack_params else {}
        united_pack_params = self.__render_params.copy()
        if func == "pack":
            if "sticky" in united_pack_params:
                united_pack_params.pop("sticky")
        elif func == "place":
            if "sticky" in united_pack_params:
                united_pack_params = {}
        united_pack_params.update(pack_params)
        return united_pack_params




    def rgrid(self, obj: tk.Widget, render_params=None):
        """
        Implementation of the tk.Widget.grid() method as a wrapper function

        :param obj: Element to rendering
        :param render_params: Dictionary with element parameters
        :return: Rendered element
        """
        if obj:
            obj.grid(self.param_prepare(render_params, "grid"))
        return obj




    def rpack(self, obj: tk.Widget, render_params=None):
        """
        Implementation of the tk.Widget.pack() method as a wrapper function

        :param obj: Element to rendering
        :param render_params: Dictionary with element parameters
        :return: Rendered element
        """
        if obj:
            obj.pack(self.param_prepare(render_params, "pack"))
        return obj




    def rplace(self, obj: tk.Widget, render_params=None):
        """
        Implementation of the tk.Widget.place() method as a wrapper function.

        :param obj: Element to rendering
        :param render_params: Dictionary with element parameters
        :return: Rendered element
        """
        if obj:
            obj.place(self.param_prepare(render_params, "place"))
        return obj