Skip to content

scripts/gui/base

scripts.gui.base.__init__

🧠 Docstring Summary

Section Content
Description No module description available.
Args
Returns

scripts.gui.base.base_panel

🧠 Docstring Summary

Section Content
Description base_panel.py
This module defines the BasePanel class, which provides common functionality for all UI panels.
Core features include:
- Providing a base class for panels with consistent styling.
- Allowing subclasses to implement specific UI components and refresh logic.
Args
Returns

📦 Classes

BasePanel

BasePanel provides common functionality for all UI panels. Inherits from ttk.Frame to leverage consistent styling. Attributes: controller (Optional[object]): The controller for handling panel actions. Parameters: ['self: Any', 'parent: tk.Widget', 'controller: Optional[object]', 'kwargs'] Returns:** None

🛠️ Functions

__init__

Initializes the BasePanel with the specified parent and controller. Parameters: ['self: Any', 'parent: tk.Widget', 'controller: Optional[object]', 'kwargs'] Returns:** None

initialize_ui

Set up UI components for the panel. Override this method in subclasses to build specific panel content. Parameters: ['self: Any'] Returns: None

refresh

Refresh the panel content. Override this method in subclasses if needed. Parameters: ['self: Any'] Returns: None

scripts.gui.base.base_tab

🧠 Docstring Summary

Section Content
Description base_tab.py
This module defines the BaseTab class, which provides a common structure for major tabs in the application.
Core features include:
- Providing a base class for tabs with consistent styling.
- Allowing subclasses to implement specific tab components and behavior.
Args
Returns

📦 Classes

BaseTab

BaseTab provides a common structure for major tabs in the application. Inherits from ttk.Frame for consistent styling. Attributes: controller (Optional[object]): The controller for handling tab actions. Parameters: ['self: Any', 'parent: tk.Widget', 'controller: Optional[object]', 'kwargs'] Returns:** None

🛠️ Functions

__init__

Initializes the BaseTab with the specified parent and controller. Parameters: ['self: Any', 'parent: tk.Widget', 'controller: Optional[object]', 'kwargs'] Returns:** None

setup_tab

Set up the tab contents. Override this method in subclasses to build tab-specific components. Parameters: ['self: Any'] Returns: None

on_show

Called when the tab becomes active. Override to update or refresh content when the tab is shown. Parameters: ['self: Any'] Returns: None