API Reference

Complete API documentation for all ThreePaneWindows classes and functions.

API Modules:

• Fixed Layout API
  • FixedThreePaneLayout
  • FixedThreePaneWindow
  • FixedThreePaneWindow
• Dockable Layout API
  • DockableThreePaneWindow
  • DockableThreePaneWindow
• Enhanced Dockable API
  • DetachedWindow
  • DragHandle
  • EnhancedDockableThreePaneWindow
  • PaneConfig
  • PaneHeader
  • get_recommended_icon_formats()
  • validate_icon_path()
  • EnhancedDockableThreePaneWindow
  • PaneConfig
  • Cross-Platform Icon Support
• Theming System API
  • ColorScheme
  • Spacing
  • Theme
  • ThemeManager
  • ThemeType
  • Typography
  • get_theme_manager()
  • set_global_theme()
  • ThemeManager
  • Theme Classes
  • Functions
• Command Line Interface
  • main()
  • show_info()
• Utilities API
  • FixedThreePaneLayout
  • ThemeType
  • add_file_logging()
  • disable_logging()
  • enable_console_logging()
  • get_recommended_icon_formats()
  • get_theme_manager()
  • set_global_theme()
  • validate_icon_path()
  • Utility Functions

Overview

The ThreePaneWindows API is organized into several modules:

Core Layout Classes

threepanewindows.FixedThreePaneWindow	alias of FixedThreePaneLayout
threepanewindows.DockableThreePaneWindow([...])	A dockable three-pane window with detachable left and right frames.
threepanewindows.EnhancedDockableThreePaneWindow([...])	Enhanced professional dockable three-pane window with theming and advanced UI.

Configuration Classes

threepanewindows.PaneConfig([title, icon, ...])

Configuration for a pane in the three-pane window.

Theming System

threepanewindows.ThemeManager([theme, ...])	Manages theme application and platform-specific theme detection.
threepanewindows.get_theme_manager()	Get the global theme manager instance.
threepanewindows.set_global_theme(theme[, ...])	Set the global theme for all ThreePaneWindows components.
threepanewindows.ThemeType(value)	Enumeration of available theme types.

Icon Utilities

threepanewindows.get_recommended_icon_formats()	Get recommended icon formats for the current platform.
threepanewindows.validate_icon_path(icon_path)	Validate an icon path for cross-platform compatibility.

Quick Reference

Most Common Classes

For most applications, you’ll primarily use these classes:

from threepanewindows import (
    FixedThreePaneWindow,        # Simple fixed layout
    DockableThreePaneWindow,     # Resizable/dockable layout
    EnhancedDockableThreePaneWindow,  # Full-featured layout
)

Basic Usage Pattern

import tkinter as tk
from threepanewindows import FixedThreePaneWindow

root = tk.Tk()
window = FixedThreePaneWindow(root)
window.pack(fill=tk.BOTH, expand=True)

# Access panes
left_pane = window.left_pane
center_pane = window.center_pane
right_pane = window.right_pane

Common Parameters

Most layout classes accept these common parameters:

• parent - The parent Tkinter widget

• left_width - Initial width of left pane (pixels)

• right_width - Initial width of right pane (pixels)

• min_pane_size - Minimum size for any pane (pixels)

• theme - Theme name or ThemeType enum value

Error Handling

All classes raise appropriate exceptions for invalid parameters:

• ValueError - Invalid parameter values

• TypeError - Wrong parameter types

• RuntimeError - Runtime configuration errors

Type Hints

All public APIs include comprehensive type hints for better IDE support and static analysis.