tkintertools.style.manager¶

Support for theme

All third packages which relative to style introduced by tkintertools are there:

• darkdetect: albertosottile/darkdetect
• pywinstyles: Akascape/py-window-styles
• win32material: littlewhitecloud/win32material
• hPyT: Zingzy/hPyT

🔵_callback¶

function protected

1
2
3

def _callback(
    theme: str,
) -> None: ...

callback function that is triggered when a system theme is switched. Valid only if the theme mode is set to Follow System

• theme: theme name

🔵_process_event¶

function protected

1
2
3

def _process_event(
    dark: bool,
) -> None: ...

Handle registered callback functions

• dark: Wether it is dark mode

🔵customize_window¶

function public

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

def customize_window(
    window: Tk,
    *,
    style: typing.Optional[typing.Literal['mica', 'acrylic', 'aero', 'transparent', 'optimised', 'win7', 'inverse', 'native', 'popup', 'dark', 'normal']] = None,
    border_color: str | None = None,
    header_color: str | None = None,
    title_color: str | None = None,
    enable_file_dnd: typing.Optional[typing.Callable[[str], typing.Any]] = None,
    hide_title_bar: bool | None = None,
    hide_button: typing.Optional[typing.Literal['all', 'maxmin', 'none']] = None,
    disable_minimize_button: bool | None = None,
    disable_maximize_button: bool | None = None,
    boarder_type: typing.Optional[typing.Literal['rectangular', 'smallround', 'round']] = None,
) -> None: ...

Customize the relevant properties of the window

• window: the window which being customized
• style: different styles for windows
• border_color: border color of the window
• header_color: header color of the window
• title_color: title color of the window
• enable_file_dnd: apply file drag and drop in window
• hide_title_bar: Wether hide the whole title bar
• hide_button: Wether hide part of buttons on title bar
• disable_minimize_button: Wether disable minimize button
• disable_maximize_button: Wether disable maximize button
• boarder_type: boarder type of the window

WARNING:

This function is only works on Windows OS! And some parameters are useless on Windows 7/10!

🔵get_color_mode¶

function public

1
2

def get_color_mode(
) -> typing.Literal['dark', 'light']: ...

🔵get_theme_map¶

function public

1
2

def get_theme_map(
) -> dict[typing.Literal['dark', 'light'], str | pathlib._local.Path | module]: ...

🔵register_event¶

function public

1
2
3
4

def register_event(
    func: typing.Callable[[bool, typing.Any], typing.Any],
    *args: typing.Any,
) -> None: ...

When the system accent color changes, the registered function will be called, and the parameter is a boolean value indicating whether it is currently a dark theme

• func: callback function
• args: extra arguments

🔵remove_event¶

function public

1
2
3

def remove_event(
    func: typing.Callable[[bool, typing.Any], typing.Any],
) -> None: ...

Remove a registered function

• func: callback function

🔵reset_theme_map¶

function public

1
2

def reset_theme_map(
) -> None: ...

🔵set_color_mode¶

function public

1
2
3

def set_color_mode(
    mode: typing.Literal['system', 'dark', 'light'] = 'system',
) -> None: ...

Set the color mode of the program

• mode: it can be "light", "dark", and "system"

TIPS:

"system" is the following system

🔵set_theme_map¶

function public

1
2
3
4
5

def set_theme_map(
    *,
    light: str | module | None = None,
    dark: str | module | None = None,
) -> None: ...

Set the path to the theme file used by the current program

• light: the name of the theme of the light theme
• dark: the name of the theme of the dark theme

🟣SYSTEM_DARK_MODE¶

constant public

SYSTEM_DARK_MODE: bool = True

🟣_callback_events¶

variable protected

_callback_events: dict = {}

🟣_color_mode¶

variable protected

_color_mode: str = 'system'

🟣_theme_map¶

variable protected

_theme_map: dict = {
    'dark': <module 'tkintertools.theme.dark' from 'C:\\Software\\Python313\\Lib\\site-packages\\tkintertools\\theme\\dark.py'>,
    'light': <module 'tkintertools.theme.light' from 'C:\\Software\\Python313\\Lib\\site-packages\\tkintertools\\theme\\light.py'>,
}