pyqt_reactive.windows.help_window_manager

PyQt6 help system - reuses Textual TUI help logic and components.

Functions

help_content_label(text, *, color_scheme[, ...])	Create compact wrapped help text labels.
help_target_display_name(target)	Return the display name for a documented function/class target.
help_window_width_for_content(docstring_info)	Choose a readable help-window width from rendered content volume.
help_window_width_for_parameter_content(content)	Choose a readable help-window width from parameter-help content.
optional_text_length(value)	Return text length for an optional docstring section.
total_docstring_text_length(docstring_info)	Return approximate rendered text length for help-window sizing.

Classes

BaseHelpWindow([title, color_scheme, parent])	Base class for all PyQt6 help windows - reuses Textual TUI help logic.
DocstringHelpWindow(target[, title, ...])	Help window for functions and classes - reuses Textual TUI DocstringExtractor.
HelpWindowManager()	PyQt6 help window manager - unified window for all help content.
HelpableWidget()	Mixin class to add help functionality to PyQt6 widgets - mirrors Textual TUI.
ParameterHelpWindow(content[, title, ...])	Help window for one parameter or dataclass field.

pyqt_reactive.windows.help_window_manager.help_target_display_name(target: Callable | type) → str

Return the display name for a documented function/class target.

pyqt_reactive.windows.help_window_manager.optional_text_length(value: str | None) → int

Return text length for an optional docstring section.

pyqt_reactive.windows.help_window_manager.total_docstring_text_length(docstring_info) → int

Return approximate rendered text length for help-window sizing.

pyqt_reactive.windows.help_window_manager.help_window_width_for_content(docstring_info) → int

Choose a readable help-window width from rendered content volume.

pyqt_reactive.windows.help_window_manager.help_window_width_for_parameter_content(content: ParameterHelpContent) → int

Choose a readable help-window width from parameter-help content.

class pyqt_reactive.windows.help_window_manager.BaseHelpWindow(title: str = 'Help', color_scheme: ColorScheme | None = None, parent=None)

Base class for all PyQt6 help windows - reuses Textual TUI help logic.

__init__(title: str = 'Help', color_scheme: ColorScheme | None = None, parent=None)

setup_ui()

Setup the base help window UI.

set_content_widget(content_widget: QWidget, target_width: int) → None

Install content and size the dialog to show available content.

available_help_bounds() → tuple[int, int]

Return max help-window dimensions bounded by the active screen.

resize_to_content(content_widget: QWidget, requested_width: int) → None

Resize to fit content where possible, bounded by available screen size.

pyqt_reactive.windows.help_window_manager.help_content_label(text: str, *, color_scheme: ColorScheme, accent: bool = False, title: bool = False) → QLabel

Create compact wrapped help text labels.

class pyqt_reactive.windows.help_window_manager.DocstringHelpWindow(target: Callable | type, title: str | None = None, color_scheme: ColorScheme | None = None, parent=None)

Help window for functions and classes - reuses Textual TUI DocstringExtractor.

__init__(target: Callable | type, title: str | None = None, color_scheme: ColorScheme | None = None, parent=None)

set_help_target(target: Callable | type, *, title: str) → None

Replace displayed callable/class docs without exposing storage details.

populate_content()

Populate the help content with minimal styling.

class pyqt_reactive.windows.help_window_manager.ParameterHelpWindow(content: ParameterHelpContent, title: str = 'Parameter', color_scheme: ColorScheme | None = None, parent=None)

Help window for one parameter or dataclass field.

__init__(content: ParameterHelpContent, title: str = 'Parameter', color_scheme: ColorScheme | None = None, parent=None)

set_parameter_content(content: ParameterHelpContent, *, title: str) → None

Replace displayed parameter content without changing renderer type.

populate_content() → None

Populate compact parameter help content.

class pyqt_reactive.windows.help_window_manager.HelpWindowManager

PyQt6 help window manager - unified window for all help content.

classmethod show_docstring_help(target: Callable | type, title: str | None = None, parent=None)

Show help for a function or class - reuses Textual TUI extraction logic.

classmethod show_parameter_help(param_name: str, param_description: str, param_type: type = None, *, help_target: Callable | type | None = None, parent=None)

Show help for a parameter using parameter-help content directly.

class pyqt_reactive.windows.help_window_manager.HelpableWidget

Mixin class to add help functionality to PyQt6 widgets - mirrors Textual TUI.

show_function_help(target: Callable | type) → None

Show help window for a function or class.

show_parameter_help(param_name: str, param_description: str, param_type: type = None) → None

Show help window for a parameter.