hPyT


NamehPyT JSON
Version 1.4.0 PyPI version JSON
download
home_pagehttps://github.com/zingzy/hPyT
SummaryHack Python Titlebar - A package to manipulate windows and titlebar of GUI applications made using python.
upload_time2025-01-18 23:03:30
maintainerNone
docs_urlNone
authorzingzy
requires_python>=3.6
licenseMIT
keywords tkinter wxpython pyqt pyside gui window controls decorations hide show titlebar border color animation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # hPyT - Hack Python Titlebar

A package to manipulate windows and titlebar of GUI applications made using python
**Supports Windows 7-11**

https://github.com/Zingzy/hPyT/assets/90309290/f86df1c7-b75b-4477-974a-eb34cc117df3

**You can download the above hPyT-preview-app from [github releases](https://github.com/Zingzy/hPyT-preview-app/releases/latest/) to test out the package before using it in your projects**

<br>

<details>

<summary>πŸ“– Table of Contents</summary>

- [hPyT - Hack Python Titlebar](#hpyt---hack-python-titlebar)
	- [πŸ“š Supported Libraries](#-supported-libraries)
	- [πŸ“¦ Installing](#-installing)
	- [πŸ“₯ Importing](#-importing)
	- [NEW Features in `v1.4.0` πŸŽ‰](#new-features-in-v140-)
	- [Hide/Unhide TitleBar](#hideunhide-titlebar)
			- [**Understanding Window Geometry**](#understanding-window-geometry)
		- [**Impact of Hiding the Title Bar**](#impact-of-hiding-the-title-bar)
		- [**Potential Issues**](#potential-issues)
		- [**Solution**](#solution)
		- [Example Usage](#example-usage)
		- [Comparision of the dimensions with and without `no_span=True`:](#comparision-of-the-dimensions-with-and-without-no_spantrue)
		- [Visual Example:](#visual-example)
	- [🌈 Rainbow TitleBar](#-rainbow-titlebar)
	- [🌈 Rainbow Border](#-rainbow-border)
		- [πŸ”„ Synchronizing the Rainbow Effect with other elements](#-synchronizing-the-rainbow-effect-with-other-elements)
	- [Hide/Unhide both Maximize and Minimize Buttons (Completely Hides both buttons)](#hideunhide-both-maximize-and-minimize-buttons-completely-hides-both-buttons)
	- [Hide/Unhide All Buttons or Stuffs](#hideunhide-all-buttons-or-stuffs)
	- [Enable/Disable Maximize Button](#enabledisable-maximize-button)
	- [Enable/Disable Minimize Button](#enabledisable-minimize-button)
	- [🎨 Custom TitleBar Color](#-custom-titlebar-color)
		- [Set TitleBar Color to windows Accent Color](#set-titlebar-color-to-windows-accent-color)
	- [πŸ–ŒοΈ Custom TitleBar Text Color](#️-custom-titlebar-text-color)
	- [πŸ–ŒοΈ Custom Border Color](#️-custom-border-color)
		- [Set Border Color to windows Accent Color](#set-border-color-to-windows-accent-color)
	- [Window Corner Radius](#window-corner-radius)
	- [Window DWM Manipulation](#window-dwm-manipulation)
		- [Enable RTL Layout for the DWM Window](#enable-rtl-layout-for-the-dwm-window)
		- [Disable DWM Transitions for the DWM Window](#disable-dwm-transitions-for-the-dwm-window)
		- [Window Cloaking](#window-cloaking)
			- [Example of window rendering with and without cloacking](#example-of-window-rendering-with-and-without-cloacking)
	- [Opacity](#opacity)
	- [⚑ Flashing Window](#-flashing-window)
	- [πŸ’» Window Management](#-window-management)
		- [Center a window on the screen](#center-a-window-on-the-screen)
		- [Center a secondary window relative to the primary window](#center-a-secondary-window-relative-to-the-primary-window)
		- [Other basic window management functions](#other-basic-window-management-functions)
	- [✨ Window Animations](#-window-animations)
		- [Circle Motion](#circle-motion)
		- [Verical Shake](#verical-shake)
		- [Horizontal Shake](#horizontal-shake)
	- [✏️ Stylize text](#️-stylize-text)
	- [Workaround for other libraries](#workaround-for-other-libraries)
	- [Miscellaneous](#miscellaneous)
		- [Get Windows Accent Color](#get-windows-accent-color)
		- [Stylize text](#stylize-text)
	- [πŸ“œ hPyT Changelog](#-hpyt-changelog)
		- [v1.4.0](#v140)
		- [v1.3.7](#v137)
		- [v1.3.6](#v136)
		- [v1.3.5](#v135)
		- [v1.3.4](#v134)
		- [v1.3.3](#v133)
		- [v1.3.2](#v132)
		- [v1.3.1](#v131)
		- [v1.3.0](#v130)
		- [v1.2.1](#v121)
		- [v1.2.0](#v120)
		- [v1.1.3](#v113)
		- [v1.1.2](#v112)
		- [v1.1.1](#v111)
		- [v1.1.0](#v110)
</details>

---

## πŸ“š Supported Libraries

- Tkinter & CustomTkinter
- PyQt
- PySide
- WxPython
- Kivy
- Almost all other UI libraries
  
> [!IMPORTANT]
> follow this [section](#workaround-for-other-libraries) to see how to use hPyT with other libraries

## πŸ“¦ Installing

```powershell
pip install hPyT==1.4.0
```

## πŸ“₯ Importing

```python
from hPyT import *
from customtkinter import * # you can use any other library from the above mentioned list

window = CTk() # creating a window using CustomTkinter
```

## NEW Features in `v1.4.0` πŸŽ‰

- Function to change `corner radius` of the window with the [`hPyT.corner_radius`](#window-corner-radius) module 
- Functions to manipulate `DWM` window attributes with the [`hPyT.window_dwm`](#window-dwm-manipulation) module
   - Enable **RTL layout**
   - Disable **DWM transitions**
   - Cloak the window

## Hide/Unhide TitleBar

```python
title_bar.hide(window, no_span = False) # hides full titlebar
# optional parameter : no_span, more details in the note below
# title_bar.unhide(window)
```

| Parameter | Type | Default | Description |
| :-------: | :--: | :-----: | :----------: |
| `no_span` | `bool` | `False` | If `True`, the content area height will not be adjusted to accommodate the title bar. |

![Hide Titlebar preview](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/titlebar.png)

<details>
<summary><h3>❗Important Note when hiding the titlebar and using <code>no_span</code> parameter</h3></summary>

When hiding a title bar, the application window's total geometry and its content area geometry behave differently, which may introduce ambiguities. Here's a detailed explanation of the issue:

#### **Understanding Window Geometry**

1. **Full Window Dimensions**:
   - Includes the content area, title bar, and borders.
   - When the user specifies dimensions (e.g., `400x400`), it usually represents the **content area dimensions**. The total window height becomes `content height + title bar height + border width`.
   - The color of the `top border` and `title bar` is usually the same in **windows 11 & 10**, making it appear as a single entity. So when hiding the title bar, we also need to hide the top border.
   - However, in **windows 7 & 8**, the top border is a different color from the title bar, so we don't need to hide the top border when hiding the title bar. Moreover removing the top border will make the window behave abnormally in these versions.

2. **Content Area Dimensions**:
   - Represents only the usable area inside the window, excluding the title bar and borders.

### **Impact of Hiding the Title Bar**

When the title bar is hidden:
- The **content area height** expands to occupy the height previously used by the title bar. For example, a `400x400` content area might expand to `400x438` (assuming the visual title bar height is 38px).

Better illustrated in the following example:

```python
...

def show_window_dimensions():
    hwnd: int = ctypes.windll.user32.GetForegroundWindow()

    x_with_decorations: int = root.winfo_rootx()  # X position of the full window
    y_with_decorations: int = root.winfo_rooty()  # Y position of the full window

    x_without_decorations: int = root.winfo_x()  # X position of the content area
    y_without_decorations: int = root.winfo_y()  # Y position of the content area

    titlebar_height: int = y_with_decorations - y_without_decorations
    border_width: int = x_with_decorations - x_without_decorations

    window_rect: RECT = get_window_rect(hwnd)

    width: int = window_rect.right - window_rect.left
    height: int = window_rect.bottom - window_rect.top

    print(f"Title bar height: {titlebar_height}")
    print(f"Border width: {border_width}")
    print(f"Main window dimensions: {width}x{height}")
    print(
        f"Content window dimensions: {root.winfo_geometry()}"
    )  # This will return the dimensions of the content area only

...

def click(e=None):
    root.update_idletasks()

    print("------ Before hiding title bar ------")
    show_window_dimensions()

	title_bar.hide(root)
	is_hidden = True

    print("------ After hiding title bar ------")
    show_window_dimensions()


button = CTkButton(root, text="Click Me", command=click)
button.place(relx=0.5, rely=0.5, anchor="center")

root.mainloop()
```

Output:

```cmd
------ Before hiding title bar ------
Title bar height: 38
Border width: 9
Main window dimensions: 468x497
Content window dimensions: 450x450
------ After hiding title bar ------
Title bar height: 0
Border width: 9
Main window dimensions: 468x497
Content window dimensions: 450x488
```

By the above example, you can see that the content area height has increased from `450px` to `488px` after hiding the title bar.

### **Potential Issues**
This automatic resizing may cause layout problems or unintended behavior in some applications. For instance:
- UI elements might **overlap** or **stretch**.
- Custom layouts may require recalibration.

### **Solution**
To address this, a `no_span` parameter is introduced in the `hide` method. This parameter allows users to control whether the content area height should be adjusted dynamically to maintain its original size.

- **Default Behavior (`no_span=False`)**:
  The content area height will expand to occupy the title bar's space.
- **With `no_span=True`**:
  The content area will be resized dynamically to maintain its original dimensions.

### Example Usage

```python
title_bar.hide(root, no_span=True)
```

### Comparision of the dimensions with and without `no_span=True`:

```diff
- Content window dimensions: 450x488
+ Content window dimensions: 450x450

- Main window dimensions: 468x497
+ Main window dimensions: 468x459
```

### Visual Example:

<div align="center">

| `no_span = False` | `no_span = True` |
| :---------------: | :--------------: |
| <img src="https://raw.githubusercontent.com/Zingzy/hPyT/main/.github/assets/span.gif" alt="Height of the Content area changes when the no_span paramer is set to False by default" width=300> | <img src="https://raw.githubusercontent.com/Zingzy/hPyT/main/.github/assets/no_span.gif" alt="Height of the Content area does not change when the no_span paramer is set to False by default" width=300> |

</div>

---

</details>

## 🌈 Rainbow TitleBar

This feature is only supported on Windows 11.

```python
rainbow_title_bar.start(window, interval=5) # starts the rainbow titlebar
# rainbow_title_bar.stop(window) # stops the rainbow titlebar
```

| Parameter | Type | Default | Description |
| :-------: | :--: | :-----: | :----------: |
| `interval` | `int` | `5` | The time in milliseconds in which the color would change. |
| `color_stops` | `int` | `5` | The number of color stops between each RGB value. |

![Rainbow TitleBar](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/rainbow_titlebar.gif)

## 🌈 Rainbow Border

This feature is only supported on Windows 11.

```python
rainbow_border.start(window, interval=4) # starts the rainbow border
# rainbow_border.stop(window) # stops the rainbow border
```

| Parameter | Type | Default | Description |
| :-------: | :--: | :-----: | :----------: |
| `interval` | `int` | `5` | The time in milliseconds in which the color would change. |
| `color_stops` | `int` | `5` | The number of color stops between each RGB value. |

![Rainbow Border](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/rainbow_border.gif)

### πŸ”„ Synchronizing the Rainbow Effect with other elements

```python
from hPyT import *

...

rainbow_title_bar.start(window, interval=30) # starts the rainbow titlebar
# rainbow_border.start(window, interval=30) # also works with rainbow border

current_color = rainbow_title_bar.get_current_color() # or rainbow_border.get_current_color()
# you can use this color to synchronize the color of other elements with the titlebar
```

![synchronization example](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/synchronization-example.gif)


**Code for the above illustration available in [`/examples/rainbow-synchronization-example.py`](https://github.com/Zingzy/hPyT/blob/main/examples/rainbow-synchronization-example.py)**


## Hide/Unhide both Maximize and Minimize Buttons (Completely Hides both buttons)

```python
maximize_minimize_button.hide(window) # hides both maximize and minimize button
# maximize_minimize_button.unhide(window)
```

![Hidden Maximize and Minimize Buttons](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/maximize_minimize.png)

## Hide/Unhide All Buttons or Stuffs

```python
all_stuffs.hide(window) # hides close button
# all_stuffs.unhide(window)
```

![Hide Everything](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/all_stuffs.png)

> [!TIP]
> **To hide the text set the window title to `''`**

## Enable/Disable Maximize Button

```python
maximize_button.disable(window) # hides maximize button
# MaximizeButton.enable(window)
```

![Disabled Maximize Button](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/maximize.png)

## Enable/Disable Minimize Button

```python
minimize_button.disable(window) # hides minimize button
# MinimizeButton.enable(window)
```

![Disabled Minimize Button](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/minimize.png)

## 🎨 Custom TitleBar Color

This feature is only supported on Windows 11.

```python
title_bar_color.set(window, color='#ff00ff') # sets the titlebar color to magenta
# title_bar_color.reset(window) # resets the titlebar color to default
```

| Parameter | Type | Default | Description |
| :-------: | :--: | :-----: | :----------: |
| `color` | `Union[str, Tuple[int]]` | ❌ | The color to set the titlebar to in either Hex (string) or RGB (tuple of integers) format |


![Custom TitleBar Color](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/titlebar_color.png)

### Set TitleBar Color to windows Accent Color

```python
title_bar_color.set_accent(window) # sets the titlebar color to the current windows accent color
```

![Accent TitleBar](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/accent_titlebar.png)

> [!NOTE]
> *The titlebar color will automatically change when the windows accent color changes*

## πŸ–ŒοΈ Custom TitleBar Text Color

This feature is only supported on Windows 11.

```python
title_bar_text_color.set(window, color='#ff00ff') # sets the titlebar text color to magenta
# title_bar_text_color.reset(window) # resets the titlebar text color to default
```

| Parameter | Type | Default | Description |
| :-------: | :--: | :-----: | :----------: |
| `color` | `Union[str, Tuple[int]]` | ❌ | The color to set the titlebar text to in either Hex (string) or RGB (tuple of integers) format |

![Custom TitleBar Text Color](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/title_text_color.png)

## πŸ–ŒοΈ Custom Border Color

This feature is only supported on Windows 11.

```python
border_color.set(window, color='#ff00ff') # sets the border color to magenta
# border_color.reset(window) # resets the border color to default
```

| Parameter | Type | Default | Description |
| :-------: | :--: | :-----: | :----------: |
| `color` | `Union[str, Tuple[int]]` | ❌ | The color to set the border to in either Hex (string) or RGB (tuple of integers) format |

![Custom Border Color](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/border_color.png)

### Set Border Color to windows Accent Color

```python
border_color.set_accent(window) # sets the border color to the current windows accent color
```

![Accent Border](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/accent_border.png)

> [!NOTE]
> *The border color will automatically change when the windows accent color changes*

## Window Corner Radius

This feature is only supported on Windows 11.

```python
corner_radius.set(window, style="round-small") # sets the window border radius to round-small
# corner_radius.reset(window) # resets the window border radius to default
```

**List of available styles**:

<div align="center">

| Style | Preview |
| :---: | :---: |
| `round-small` | <img src="https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/corner_small_round.png" alt="Round-small" width=400> |
| `square` | <img src="https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/corner_square.png" alt="Square" width=400> |
| `round` | <img src="https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/corner_round.png" alt="Round" width=400> |

</div>

## Window DWM Manipulation

`DWM` - **Desktop Window Manager** is the component of a window which controls `non-client area of the window`. The features below are generally used to improve the **accessibility** of a window.

### Enable RTL Layout for the DWM Window

```python
window_dwm.toggle_rtl_layout(window, enabled=True) # enables RTL layout for the window
# window_dwm.toggle_rtl_layout(window, enabled=False) # disables RTL layout for the window
```

![RTL Layout](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/dwm_rtl.png)

> [!NOTE]
> *This feature enables the **RTL layout** for the **non-client area** of the window which includes the **titlebar**, **border**, etc.*

### Disable DWM Transitions for the DWM Window

Disabling DWM Transitions will make the animations for minimize, maximize, restore, etc. more snappy and faster.

```python
window_dwm.toggle_dwm_transitions(window, enabled=False) # disables DWM transitions for the window
# window_dwm.toggle_dwm_transitions(window, enabled=True) # enables DWM transitions for the window
```

<div align="center">

| DWM Transitions `Disabled` | DWM Transitions `Enabled` |
| :----------------------: | :---------------------: |
| ![DWM Transitions Disabled](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/dwm_transitions_disabled.gif) | ![DWM Transitions Enabled](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/dwm_transitions_enabled.gif) |

</div>

> [!NOTE]
> *This will only affect the minimize, maximize, restore, etc. animations. It will not affect custom animations.*

> [!IMPORTANT]
> *This feature won't work if the global animations are disabled by the user in the windows settings.*

### Window Cloaking

If window cloaking is enabled, the window will be hidden while still being composed by DWM i.e the window will be rendered but it will not be visible to the user. 

```python
window_dwm.toggle_cloak(window, enabled=True) # hides the window

# Do complex taks like rendering window widgets

window_dwm.toggle_cloak(window, enabled=False) # shows the window
```

> [!TIP]
> *By cloaking a window, `DWM` can optimize the **rendering process** since it doesn't have to display the window's content on the screen. This can help **improve the performance** of applications, especially those with complex UI elements or animations.*

#### Example of window rendering with and without cloacking

<div align="center">

| Cloacking Used | Cloacking Not Used |
| :------------: | :---------------: |
| ![Cloacking Used](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/dwm_cloak_example.gif) | ![Cloacking Not Used](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/dwm_no_cloak_example.gif) |

</div>

## Opacity

```python
opacity.set(window, opacity=0.5) # sets the window opacity to 50%
# opacity.set(window, opacity=1.0) # resets the window opacity to 100%
```

| Parameter | Type | Default | Description |
| :-------: | :--: | :-----: | :----------: |
| `opacity` | `float` | ❌ | The opacity to set the window to. It should be a value between 0 (**transparent**) and 1.0 (**opaque**). |

![Opacity 0.5 preview](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/opacity.png)

## ⚑ Flashing Window

```python
window_flash.flash(window, count=10, interval=100) # flashes the window 10 times with 100ms interval
# window_flash.stop(window) # stops the flashing immediately
```

| Parameter | Type | Default | Description |
| :-------: | :--: | :-----: | :----------: |
| `count` | `int` | `5` | The number of times the window will flash. |
| `interval` | `int` | `1000` | The time in milliseconds in which the window will flash. |

![Flashing Window](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/flashing.gif)

## πŸ’» Window Management

### Center a window on the screen

```python
window_frame.center(window)
```

### Center a secondary window relative to the primary window

```python
window_frame.center_relative(window, child_window)
```

![Center Relative](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/center_relative.png)

**Example Usecase**

```python
window = CTk()
window.title("Primary Window")
window.geometry('600x300')
window_frame.center(window)

child_window = CTkToplevel()

window_frame.center_relative(window, child_window)

window.bind("<Configure>", lambda event: window_frame.center_relative(window, child_window))

def on_close():  # this is required to stop the window from centering the child window after the parent window is closed
	window.unbind("<Configure>")
	child_window.destroy()

child_window.protocol("WM_DELETE_WINDOW", on_close)

window.mainloop()
```

![Center Relative Example](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/center_relative_example.gif)

### Other basic window management functions

```python
window_frame.move(window, 100, 100) # moves the window to (100, 100)
window_frame.resize(window, 500, 500) # resizes the window to 500x500
window_frame.maximize(window) # maximizes the window
window_frame.minimize(window) # minimizes the window
window_frame.restore(window) # restores the window
```

## ✨ Window Animations

### Circle Motion

```python
window_animation.circle_motion(window, count=5, interval=5, radius=30)
# moves the window in a circular motion 5 times with 5ms interval and 30px radius
```

| Parameter | Type | Default | Description |
| :-------: | :--: | :-----: | :----------: |
| `count` | `int` | `5` | The number of times the window will move in a circular motion. |
| `interval` | `int` | `5` | The time in milliseconds in which the window will move in a circular motion. |
| `radius` | `int` | `20` | The radius of the circular motion. |

![Circle Motion](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/circle_motion.gif)

*The animation might appear a bit fasterer and rougher in the above preview gif than it is*

### Verical Shake

```python
window_animation.vertical_shake(window, count=5, interval=5, amplitude=20)
# shakes the window vertically 5 times with 5ms interval and 10px distance
```

| Parameter | Type | Default | Description |
| :-------: | :--: | :-----: | :----------: |
| `count` | `int` | `5` | The number of times the window will shake vertically. |
| `interval` | `int` | `5` | The time in milliseconds in which the window will shake vertically. |
| `amplitude` | `int` | `20` | The distance the window will shake vertically. |

### Horizontal Shake

```python
window_animation.horizontal_shake(window, count=5, interval=5, amplitude=20)
# shakes the window horizontally 5 times with 5ms interval and 10px distance
```

| Parameter | Type | Default | Description |
| :-------: | :--: | :-----: | :----------: |
| `count` | `int` | `5` | The number of times the window will shake horizontally. |
| `interval` | `int` | `5` | The time in milliseconds in which the window will shake horizontally. |
| `amplitude` | `int` | `20` | The distance the window will shake horizontally. |

## ✏️ Stylize text

```python
title_text.stylize(window, style=1)
```

**Choose any style from 1 to 10.**

*Below is a gif demonstrating all of the available styles*

![Stylize Text](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/stylize_text.gif)

> [!NOTE]
> *It is recommended to use the `title_text.set` function to change the title of the window instead of directly setting the title of the window.*
> 
> *This is because the `title_text.set` function also caches the original title and the styled title so that it can be used to verify the consistency of the title before applying the style.*

## Workaround for other libraries

This menthod is applicable for any other UI library like <kbd>pygame</kbd> <kbd>pySimpleGUI</kbd>, etc. which are not mentioned in the [supported libraries list](#-supported-libraries). You just need to pass the `hwnd` of the window instead of the `window object` to the functions as demonstrated below.

```python
import tkinter as tk
from hPyT import *
import ctypes

# make sure that the window has been created and is active

hwnd = ctypes.windll.user32.GetActiveWindow()
rainbow_border.start(hwnd, interval=4) # use the hwnd of the window instead of the window object
```

[Back to top](#-installing)

## Miscellaneous

### Get Windows Accent Color

```python
print(get_accent_color()) # prints the current windows accent color
>>> '#1b595a'
```

### Stylize text

```python
print(stylize_text("Your Custom Text", style=1)) # stylizes your text
# all of the styles shown on the above gif are available
>>> "π”œπ”¬π”²π”― ℭ𝔲𝔰𝔱𝔬π”ͺ 𝔗𝔒𝔡𝔱"
```

<br>

## πŸ“œ hPyT Changelog

### v1.4.0

- Add new feature for customizing the corner radius of the window
- Add new feature for manipulating the non-client area of the window
- Fix the issue with stylize text not looking for changes made by the user
- Fix the issue with title text not being consistent on older versions of windows
- Add support for x86/x32 pythonarchitecture

### v1.3.7

- Fix color conversion issue which returned the wrong color when the windows accent color was set to a custom color
- Add handling for WM_NCACTIVATE and WM_NCPAINT messages to improve title bar rendering
- Add dynamic height adjustment to hide_titlebar method using the no_span parameter

### v1.3.6

- Minor Bug Fixes

### v1.3.5

- Add feature for automatically changing the accent color of the titlebar and border
- Fix an issue which caused ImportError when used with a python version less than 3.9

### v1.3.4

- Add method for applying the current windows accent color to the titlebar and border color
- Add method for getting the current windows accent color
- Add type annotations and docstrings to functions for better clarity and autocompletion

### v1.3.3

- Fixed taskbar unhide/hide bug

### v1.3.2

- Add support for synchronizing the rainbow effect with other ui elements.

### v1.3.1

- Add support for UI libraries like Kivy, PySimpleGUI, PyGame, etc.
- Improve the rainbow titlebar & border effects.
- Improve the center_relative function & examples.

### v1.3.0

- Add support for setting custom border color
- Add support for rainbow border color effect
- Add support for resetting the titleBar color and titleText color
- Fix an issue which caused the titleBar to appear black after the rainbow titleBar effect was stopped

### v1.2.1

- Minor Bug Fixes

### v1.2.0

- Add support for rainbow titlebar
- Add support for styling title text
- Add support for vertical, horizontal shake and circle motion window animations
- Add support for centering a window on the screen
- Add support for centering a window relative to another window
- Add support for moving/resizing/maximizing/minimizing/restoring a window
- Add support for setting custom titlebar color
- Add support for setting custom titlebar text color

### v1.1.3

- Add flashing inverval support

### v1.1.2

- Add window flashing support
- Add window opacity support
- Add support for PyGTK

### v1.1.1

- Add support for WxPython, PyQt and PySide

### v1.1.0

- Initial Release

<br>

![PyPI](https://img.shields.io/pypi/v/hPyT?style=flat-square)
![Python](https://img.shields.io/badge/python-3.6+-blue)
![Downloads](https://img.shields.io/pypi/dm/hPyT?style=flat-square)
![Stars](https://img.shields.io/github/stars/zingzy/hPyT?style=flat-square)
![Contributors](https://img.shields.io/github/contributors/zingzy/hPyT?style=flat-square)
![Last Commit](https://img.shields.io/github/last-commit/zingzy/hPyT?style=flat-square)

---

<h6 align="center">
<img src="https://avatars.githubusercontent.com/u/90309290?v=4" height=30 title="zingzy Copyright">
<br>
Β© zingzy . 2025

All Rights Reserved</h6>

<p align="center">
	<a href="https://github.com/zingzy/hPyT/blob/master/LICENSE"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8"/></a>
</p>

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/zingzy/hPyT",
    "name": "hPyT",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "Tkinter wxpython pyqt pyside GUI window controls decorations hide show titlebar border color animation",
    "author": "zingzy",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/e3/16/a94baddc0137ad692a12d33ef2ac28fb6eeab5f508fa45592183e3742a58/hpyt-1.4.0.tar.gz",
    "platform": null,
    "description": "# hPyT - Hack Python Titlebar\n\nA package to manipulate windows and titlebar of GUI applications made using python\n**Supports Windows 7-11**\n\nhttps://github.com/Zingzy/hPyT/assets/90309290/f86df1c7-b75b-4477-974a-eb34cc117df3\n\n**You can download the above hPyT-preview-app from [github releases](https://github.com/Zingzy/hPyT-preview-app/releases/latest/) to test out the package before using it in your projects**\n\n<br>\n\n<details>\n\n<summary>\ud83d\udcd6 Table of Contents</summary>\n\n- [hPyT - Hack Python Titlebar](#hpyt---hack-python-titlebar)\n\t- [\ud83d\udcda Supported Libraries](#-supported-libraries)\n\t- [\ud83d\udce6 Installing](#-installing)\n\t- [\ud83d\udce5 Importing](#-importing)\n\t- [NEW Features in `v1.4.0` \ud83c\udf89](#new-features-in-v140-)\n\t- [Hide/Unhide TitleBar](#hideunhide-titlebar)\n\t\t\t- [**Understanding Window Geometry**](#understanding-window-geometry)\n\t\t- [**Impact of Hiding the Title Bar**](#impact-of-hiding-the-title-bar)\n\t\t- [**Potential Issues**](#potential-issues)\n\t\t- [**Solution**](#solution)\n\t\t- [Example Usage](#example-usage)\n\t\t- [Comparision of the dimensions with and without `no_span=True`:](#comparision-of-the-dimensions-with-and-without-no_spantrue)\n\t\t- [Visual Example:](#visual-example)\n\t- [\ud83c\udf08 Rainbow TitleBar](#-rainbow-titlebar)\n\t- [\ud83c\udf08 Rainbow Border](#-rainbow-border)\n\t\t- [\ud83d\udd04 Synchronizing the Rainbow Effect with other elements](#-synchronizing-the-rainbow-effect-with-other-elements)\n\t- [Hide/Unhide both Maximize and Minimize Buttons (Completely Hides both buttons)](#hideunhide-both-maximize-and-minimize-buttons-completely-hides-both-buttons)\n\t- [Hide/Unhide All Buttons or Stuffs](#hideunhide-all-buttons-or-stuffs)\n\t- [Enable/Disable Maximize Button](#enabledisable-maximize-button)\n\t- [Enable/Disable Minimize Button](#enabledisable-minimize-button)\n\t- [\ud83c\udfa8 Custom TitleBar Color](#-custom-titlebar-color)\n\t\t- [Set TitleBar Color to windows Accent Color](#set-titlebar-color-to-windows-accent-color)\n\t- [\ud83d\udd8c\ufe0f Custom TitleBar Text Color](#\ufe0f-custom-titlebar-text-color)\n\t- [\ud83d\udd8c\ufe0f Custom Border Color](#\ufe0f-custom-border-color)\n\t\t- [Set Border Color to windows Accent Color](#set-border-color-to-windows-accent-color)\n\t- [Window Corner Radius](#window-corner-radius)\n\t- [Window DWM Manipulation](#window-dwm-manipulation)\n\t\t- [Enable RTL Layout for the DWM Window](#enable-rtl-layout-for-the-dwm-window)\n\t\t- [Disable DWM Transitions for the DWM Window](#disable-dwm-transitions-for-the-dwm-window)\n\t\t- [Window Cloaking](#window-cloaking)\n\t\t\t- [Example of window rendering with and without cloacking](#example-of-window-rendering-with-and-without-cloacking)\n\t- [Opacity](#opacity)\n\t- [\u26a1 Flashing Window](#-flashing-window)\n\t- [\ud83d\udcbb Window Management](#-window-management)\n\t\t- [Center a window on the screen](#center-a-window-on-the-screen)\n\t\t- [Center a secondary window relative to the primary window](#center-a-secondary-window-relative-to-the-primary-window)\n\t\t- [Other basic window management functions](#other-basic-window-management-functions)\n\t- [\u2728 Window Animations](#-window-animations)\n\t\t- [Circle Motion](#circle-motion)\n\t\t- [Verical Shake](#verical-shake)\n\t\t- [Horizontal Shake](#horizontal-shake)\n\t- [\u270f\ufe0f Stylize text](#\ufe0f-stylize-text)\n\t- [Workaround for other libraries](#workaround-for-other-libraries)\n\t- [Miscellaneous](#miscellaneous)\n\t\t- [Get Windows Accent Color](#get-windows-accent-color)\n\t\t- [Stylize text](#stylize-text)\n\t- [\ud83d\udcdc hPyT Changelog](#-hpyt-changelog)\n\t\t- [v1.4.0](#v140)\n\t\t- [v1.3.7](#v137)\n\t\t- [v1.3.6](#v136)\n\t\t- [v1.3.5](#v135)\n\t\t- [v1.3.4](#v134)\n\t\t- [v1.3.3](#v133)\n\t\t- [v1.3.2](#v132)\n\t\t- [v1.3.1](#v131)\n\t\t- [v1.3.0](#v130)\n\t\t- [v1.2.1](#v121)\n\t\t- [v1.2.0](#v120)\n\t\t- [v1.1.3](#v113)\n\t\t- [v1.1.2](#v112)\n\t\t- [v1.1.1](#v111)\n\t\t- [v1.1.0](#v110)\n</details>\n\n---\n\n## \ud83d\udcda Supported Libraries\n\n- Tkinter & CustomTkinter\n- PyQt\n- PySide\n- WxPython\n- Kivy\n- Almost all other UI libraries\n  \n> [!IMPORTANT]\n> follow this [section](#workaround-for-other-libraries) to see how to use hPyT with other libraries\n\n## \ud83d\udce6 Installing\n\n```powershell\npip install hPyT==1.4.0\n```\n\n## \ud83d\udce5 Importing\n\n```python\nfrom hPyT import *\nfrom customtkinter import * # you can use any other library from the above mentioned list\n\nwindow = CTk() # creating a window using CustomTkinter\n```\n\n## NEW Features in `v1.4.0` \ud83c\udf89\n\n- Function to change `corner radius` of the window with the [`hPyT.corner_radius`](#window-corner-radius) module \n- Functions to manipulate `DWM` window attributes with the [`hPyT.window_dwm`](#window-dwm-manipulation) module\n   - Enable **RTL layout**\n   - Disable **DWM transitions**\n   - Cloak the window\n\n## Hide/Unhide TitleBar\n\n```python\ntitle_bar.hide(window, no_span = False) # hides full titlebar\n# optional parameter : no_span, more details in the note below\n# title_bar.unhide(window)\n```\n\n| Parameter | Type | Default | Description |\n| :-------: | :--: | :-----: | :----------: |\n| `no_span` | `bool` | `False` | If `True`, the content area height will not be adjusted to accommodate the title bar. |\n\n![Hide Titlebar preview](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/titlebar.png)\n\n<details>\n<summary><h3>\u2757Important Note when hiding the titlebar and using <code>no_span</code> parameter</h3></summary>\n\nWhen hiding a title bar, the application window's total geometry and its content area geometry behave differently, which may introduce ambiguities. Here's a detailed explanation of the issue:\n\n#### **Understanding Window Geometry**\n\n1. **Full Window Dimensions**:\n   - Includes the content area, title bar, and borders.\n   - When the user specifies dimensions (e.g., `400x400`), it usually represents the **content area dimensions**. The total window height becomes `content height + title bar height + border width`.\n   - The color of the `top border` and `title bar` is usually the same in **windows 11 & 10**, making it appear as a single entity. So when hiding the title bar, we also need to hide the top border.\n   - However, in **windows 7 & 8**, the top border is a different color from the title bar, so we don't need to hide the top border when hiding the title bar. Moreover removing the top border will make the window behave abnormally in these versions.\n\n2. **Content Area Dimensions**:\n   - Represents only the usable area inside the window, excluding the title bar and borders.\n\n### **Impact of Hiding the Title Bar**\n\nWhen the title bar is hidden:\n- The **content area height** expands to occupy the height previously used by the title bar. For example, a `400x400` content area might expand to `400x438` (assuming the visual title bar height is 38px).\n\nBetter illustrated in the following example:\n\n```python\n...\n\ndef show_window_dimensions():\n    hwnd: int = ctypes.windll.user32.GetForegroundWindow()\n\n    x_with_decorations: int = root.winfo_rootx()  # X position of the full window\n    y_with_decorations: int = root.winfo_rooty()  # Y position of the full window\n\n    x_without_decorations: int = root.winfo_x()  # X position of the content area\n    y_without_decorations: int = root.winfo_y()  # Y position of the content area\n\n    titlebar_height: int = y_with_decorations - y_without_decorations\n    border_width: int = x_with_decorations - x_without_decorations\n\n    window_rect: RECT = get_window_rect(hwnd)\n\n    width: int = window_rect.right - window_rect.left\n    height: int = window_rect.bottom - window_rect.top\n\n    print(f\"Title bar height: {titlebar_height}\")\n    print(f\"Border width: {border_width}\")\n    print(f\"Main window dimensions: {width}x{height}\")\n    print(\n        f\"Content window dimensions: {root.winfo_geometry()}\"\n    )  # This will return the dimensions of the content area only\n\n...\n\ndef click(e=None):\n    root.update_idletasks()\n\n    print(\"------ Before hiding title bar ------\")\n    show_window_dimensions()\n\n\ttitle_bar.hide(root)\n\tis_hidden = True\n\n    print(\"------ After hiding title bar ------\")\n    show_window_dimensions()\n\n\nbutton = CTkButton(root, text=\"Click Me\", command=click)\nbutton.place(relx=0.5, rely=0.5, anchor=\"center\")\n\nroot.mainloop()\n```\n\nOutput:\n\n```cmd\n------ Before hiding title bar ------\nTitle bar height: 38\nBorder width: 9\nMain window dimensions: 468x497\nContent window dimensions: 450x450\n------ After hiding title bar ------\nTitle bar height: 0\nBorder width: 9\nMain window dimensions: 468x497\nContent window dimensions: 450x488\n```\n\nBy the above example, you can see that the content area height has increased from `450px` to `488px` after hiding the title bar.\n\n### **Potential Issues**\nThis automatic resizing may cause layout problems or unintended behavior in some applications. For instance:\n- UI elements might **overlap** or **stretch**.\n- Custom layouts may require recalibration.\n\n### **Solution**\nTo address this, a `no_span` parameter is introduced in the `hide` method. This parameter allows users to control whether the content area height should be adjusted dynamically to maintain its original size.\n\n- **Default Behavior (`no_span=False`)**:\n  The content area height will expand to occupy the title bar's space.\n- **With `no_span=True`**:\n  The content area will be resized dynamically to maintain its original dimensions.\n\n### Example Usage\n\n```python\ntitle_bar.hide(root, no_span=True)\n```\n\n### Comparision of the dimensions with and without `no_span=True`:\n\n```diff\n- Content window dimensions: 450x488\n+ Content window dimensions: 450x450\n\n- Main window dimensions: 468x497\n+ Main window dimensions: 468x459\n```\n\n### Visual Example:\n\n<div align=\"center\">\n\n| `no_span = False` | `no_span = True` |\n| :---------------: | :--------------: |\n| <img src=\"https://raw.githubusercontent.com/Zingzy/hPyT/main/.github/assets/span.gif\" alt=\"Height of the Content area changes when the no_span paramer is set to False by default\" width=300> | <img src=\"https://raw.githubusercontent.com/Zingzy/hPyT/main/.github/assets/no_span.gif\" alt=\"Height of the Content area does not change when the no_span paramer is set to False by default\" width=300> |\n\n</div>\n\n---\n\n</details>\n\n## \ud83c\udf08 Rainbow TitleBar\n\nThis feature is only supported on Windows 11.\n\n```python\nrainbow_title_bar.start(window, interval=5) # starts the rainbow titlebar\n# rainbow_title_bar.stop(window) # stops the rainbow titlebar\n```\n\n| Parameter | Type | Default | Description |\n| :-------: | :--: | :-----: | :----------: |\n| `interval` | `int` | `5` | The time in milliseconds in which the color would change. |\n| `color_stops` | `int` | `5` | The number of color stops between each RGB value. |\n\n![Rainbow TitleBar](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/rainbow_titlebar.gif)\n\n## \ud83c\udf08 Rainbow Border\n\nThis feature is only supported on Windows 11.\n\n```python\nrainbow_border.start(window, interval=4) # starts the rainbow border\n# rainbow_border.stop(window) # stops the rainbow border\n```\n\n| Parameter | Type | Default | Description |\n| :-------: | :--: | :-----: | :----------: |\n| `interval` | `int` | `5` | The time in milliseconds in which the color would change. |\n| `color_stops` | `int` | `5` | The number of color stops between each RGB value. |\n\n![Rainbow Border](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/rainbow_border.gif)\n\n### \ud83d\udd04 Synchronizing the Rainbow Effect with other elements\n\n```python\nfrom hPyT import *\n\n...\n\nrainbow_title_bar.start(window, interval=30) # starts the rainbow titlebar\n# rainbow_border.start(window, interval=30) # also works with rainbow border\n\ncurrent_color = rainbow_title_bar.get_current_color() # or rainbow_border.get_current_color()\n# you can use this color to synchronize the color of other elements with the titlebar\n```\n\n![synchronization example](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/synchronization-example.gif)\n\n\n**Code for the above illustration available in [`/examples/rainbow-synchronization-example.py`](https://github.com/Zingzy/hPyT/blob/main/examples/rainbow-synchronization-example.py)**\n\n\n## Hide/Unhide both Maximize and Minimize Buttons (Completely Hides both buttons)\n\n```python\nmaximize_minimize_button.hide(window) # hides both maximize and minimize button\n# maximize_minimize_button.unhide(window)\n```\n\n![Hidden Maximize and Minimize Buttons](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/maximize_minimize.png)\n\n## Hide/Unhide All Buttons or Stuffs\n\n```python\nall_stuffs.hide(window) # hides close button\n# all_stuffs.unhide(window)\n```\n\n![Hide Everything](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/all_stuffs.png)\n\n> [!TIP]\n> **To hide the text set the window title to `''`**\n\n## Enable/Disable Maximize Button\n\n```python\nmaximize_button.disable(window) # hides maximize button\n# MaximizeButton.enable(window)\n```\n\n![Disabled Maximize Button](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/maximize.png)\n\n## Enable/Disable Minimize Button\n\n```python\nminimize_button.disable(window) # hides minimize button\n# MinimizeButton.enable(window)\n```\n\n![Disabled Minimize Button](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/minimize.png)\n\n## \ud83c\udfa8 Custom TitleBar Color\n\nThis feature is only supported on Windows 11.\n\n```python\ntitle_bar_color.set(window, color='#ff00ff') # sets the titlebar color to magenta\n# title_bar_color.reset(window) # resets the titlebar color to default\n```\n\n| Parameter | Type | Default | Description |\n| :-------: | :--: | :-----: | :----------: |\n| `color` | `Union[str, Tuple[int]]` | \u274c | The color to set the titlebar to in either Hex (string) or RGB (tuple of integers) format |\n\n\n![Custom TitleBar Color](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/titlebar_color.png)\n\n### Set TitleBar Color to windows Accent Color\n\n```python\ntitle_bar_color.set_accent(window) # sets the titlebar color to the current windows accent color\n```\n\n![Accent TitleBar](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/accent_titlebar.png)\n\n> [!NOTE]\n> *The titlebar color will automatically change when the windows accent color changes*\n\n## \ud83d\udd8c\ufe0f Custom TitleBar Text Color\n\nThis feature is only supported on Windows 11.\n\n```python\ntitle_bar_text_color.set(window, color='#ff00ff') # sets the titlebar text color to magenta\n# title_bar_text_color.reset(window) # resets the titlebar text color to default\n```\n\n| Parameter | Type | Default | Description |\n| :-------: | :--: | :-----: | :----------: |\n| `color` | `Union[str, Tuple[int]]` | \u274c | The color to set the titlebar text to in either Hex (string) or RGB (tuple of integers) format |\n\n![Custom TitleBar Text Color](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/title_text_color.png)\n\n## \ud83d\udd8c\ufe0f Custom Border Color\n\nThis feature is only supported on Windows 11.\n\n```python\nborder_color.set(window, color='#ff00ff') # sets the border color to magenta\n# border_color.reset(window) # resets the border color to default\n```\n\n| Parameter | Type | Default | Description |\n| :-------: | :--: | :-----: | :----------: |\n| `color` | `Union[str, Tuple[int]]` | \u274c | The color to set the border to in either Hex (string) or RGB (tuple of integers) format |\n\n![Custom Border Color](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/border_color.png)\n\n### Set Border Color to windows Accent Color\n\n```python\nborder_color.set_accent(window) # sets the border color to the current windows accent color\n```\n\n![Accent Border](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/accent_border.png)\n\n> [!NOTE]\n> *The border color will automatically change when the windows accent color changes*\n\n## Window Corner Radius\n\nThis feature is only supported on Windows 11.\n\n```python\ncorner_radius.set(window, style=\"round-small\") # sets the window border radius to round-small\n# corner_radius.reset(window) # resets the window border radius to default\n```\n\n**List of available styles**:\n\n<div align=\"center\">\n\n| Style | Preview |\n| :---: | :---: |\n| `round-small` | <img src=\"https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/corner_small_round.png\" alt=\"Round-small\" width=400> |\n| `square` | <img src=\"https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/corner_square.png\" alt=\"Square\" width=400> |\n| `round` | <img src=\"https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/corner_round.png\" alt=\"Round\" width=400> |\n\n</div>\n\n## Window DWM Manipulation\n\n`DWM` - **Desktop Window Manager** is the component of a window which controls `non-client area of the window`. The features below are generally used to improve the **accessibility** of a window.\n\n### Enable RTL Layout for the DWM Window\n\n```python\nwindow_dwm.toggle_rtl_layout(window, enabled=True) # enables RTL layout for the window\n# window_dwm.toggle_rtl_layout(window, enabled=False) # disables RTL layout for the window\n```\n\n![RTL Layout](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/dwm_rtl.png)\n\n> [!NOTE]\n> *This feature enables the **RTL layout** for the **non-client area** of the window which includes the **titlebar**, **border**, etc.*\n\n### Disable DWM Transitions for the DWM Window\n\nDisabling DWM Transitions will make the animations for minimize, maximize, restore, etc. more snappy and faster.\n\n```python\nwindow_dwm.toggle_dwm_transitions(window, enabled=False) # disables DWM transitions for the window\n# window_dwm.toggle_dwm_transitions(window, enabled=True) # enables DWM transitions for the window\n```\n\n<div align=\"center\">\n\n| DWM Transitions `Disabled` | DWM Transitions `Enabled` |\n| :----------------------: | :---------------------: |\n| ![DWM Transitions Disabled](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/dwm_transitions_disabled.gif) | ![DWM Transitions Enabled](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/dwm_transitions_enabled.gif) |\n\n</div>\n\n> [!NOTE]\n> *This will only affect the minimize, maximize, restore, etc. animations. It will not affect custom animations.*\n\n> [!IMPORTANT]\n> *This feature won't work if the global animations are disabled by the user in the windows settings.*\n\n### Window Cloaking\n\nIf window cloaking is enabled, the window will be hidden while still being composed by DWM i.e the window will be rendered but it will not be visible to the user. \n\n```python\nwindow_dwm.toggle_cloak(window, enabled=True) # hides the window\n\n# Do complex taks like rendering window widgets\n\nwindow_dwm.toggle_cloak(window, enabled=False) # shows the window\n```\n\n> [!TIP]\n> *By cloaking a window, `DWM` can optimize the **rendering process** since it doesn't have to display the window's content on the screen. This can help **improve the performance** of applications, especially those with complex UI elements or animations.*\n\n#### Example of window rendering with and without cloacking\n\n<div align=\"center\">\n\n| Cloacking Used | Cloacking Not Used |\n| :------------: | :---------------: |\n| ![Cloacking Used](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/dwm_cloak_example.gif) | ![Cloacking Not Used](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/dwm_no_cloak_example.gif) |\n\n</div>\n\n## Opacity\n\n```python\nopacity.set(window, opacity=0.5) # sets the window opacity to 50%\n# opacity.set(window, opacity=1.0) # resets the window opacity to 100%\n```\n\n| Parameter | Type | Default | Description |\n| :-------: | :--: | :-----: | :----------: |\n| `opacity` | `float` | \u274c | The opacity to set the window to. It should be a value between 0 (**transparent**) and 1.0 (**opaque**). |\n\n![Opacity 0.5 preview](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/opacity.png)\n\n## \u26a1 Flashing Window\n\n```python\nwindow_flash.flash(window, count=10, interval=100) # flashes the window 10 times with 100ms interval\n# window_flash.stop(window) # stops the flashing immediately\n```\n\n| Parameter | Type | Default | Description |\n| :-------: | :--: | :-----: | :----------: |\n| `count` | `int` | `5` | The number of times the window will flash. |\n| `interval` | `int` | `1000` | The time in milliseconds in which the window will flash. |\n\n![Flashing Window](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/flashing.gif)\n\n## \ud83d\udcbb Window Management\n\n### Center a window on the screen\n\n```python\nwindow_frame.center(window)\n```\n\n### Center a secondary window relative to the primary window\n\n```python\nwindow_frame.center_relative(window, child_window)\n```\n\n![Center Relative](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/center_relative.png)\n\n**Example Usecase**\n\n```python\nwindow = CTk()\nwindow.title(\"Primary Window\")\nwindow.geometry('600x300')\nwindow_frame.center(window)\n\nchild_window = CTkToplevel()\n\nwindow_frame.center_relative(window, child_window)\n\nwindow.bind(\"<Configure>\", lambda event: window_frame.center_relative(window, child_window))\n\ndef on_close():  # this is required to stop the window from centering the child window after the parent window is closed\n\twindow.unbind(\"<Configure>\")\n\tchild_window.destroy()\n\nchild_window.protocol(\"WM_DELETE_WINDOW\", on_close)\n\nwindow.mainloop()\n```\n\n![Center Relative Example](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/center_relative_example.gif)\n\n### Other basic window management functions\n\n```python\nwindow_frame.move(window, 100, 100) # moves the window to (100, 100)\nwindow_frame.resize(window, 500, 500) # resizes the window to 500x500\nwindow_frame.maximize(window) # maximizes the window\nwindow_frame.minimize(window) # minimizes the window\nwindow_frame.restore(window) # restores the window\n```\n\n## \u2728 Window Animations\n\n### Circle Motion\n\n```python\nwindow_animation.circle_motion(window, count=5, interval=5, radius=30)\n# moves the window in a circular motion 5 times with 5ms interval and 30px radius\n```\n\n| Parameter | Type | Default | Description |\n| :-------: | :--: | :-----: | :----------: |\n| `count` | `int` | `5` | The number of times the window will move in a circular motion. |\n| `interval` | `int` | `5` | The time in milliseconds in which the window will move in a circular motion. |\n| `radius` | `int` | `20` | The radius of the circular motion. |\n\n![Circle Motion](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/circle_motion.gif)\n\n*The animation might appear a bit fasterer and rougher in the above preview gif than it is*\n\n### Verical Shake\n\n```python\nwindow_animation.vertical_shake(window, count=5, interval=5, amplitude=20)\n# shakes the window vertically 5 times with 5ms interval and 10px distance\n```\n\n| Parameter | Type | Default | Description |\n| :-------: | :--: | :-----: | :----------: |\n| `count` | `int` | `5` | The number of times the window will shake vertically. |\n| `interval` | `int` | `5` | The time in milliseconds in which the window will shake vertically. |\n| `amplitude` | `int` | `20` | The distance the window will shake vertically. |\n\n### Horizontal Shake\n\n```python\nwindow_animation.horizontal_shake(window, count=5, interval=5, amplitude=20)\n# shakes the window horizontally 5 times with 5ms interval and 10px distance\n```\n\n| Parameter | Type | Default | Description |\n| :-------: | :--: | :-----: | :----------: |\n| `count` | `int` | `5` | The number of times the window will shake horizontally. |\n| `interval` | `int` | `5` | The time in milliseconds in which the window will shake horizontally. |\n| `amplitude` | `int` | `20` | The distance the window will shake horizontally. |\n\n## \u270f\ufe0f Stylize text\n\n```python\ntitle_text.stylize(window, style=1)\n```\n\n**Choose any style from 1 to 10.**\n\n*Below is a gif demonstrating all of the available styles*\n\n![Stylize Text](https://raw.githubusercontent.com/zingzy/hPyT/main/.github/assets/stylize_text.gif)\n\n> [!NOTE]\n> *It is recommended to use the `title_text.set` function to change the title of the window instead of directly setting the title of the window.*\n> \n> *This is because the `title_text.set` function also caches the original title and the styled title so that it can be used to verify the consistency of the title before applying the style.*\n\n## Workaround for other libraries\n\nThis menthod is applicable for any other UI library like <kbd>pygame</kbd> <kbd>pySimpleGUI</kbd>, etc. which are not mentioned in the [supported libraries list](#-supported-libraries). You just need to pass the `hwnd` of the window instead of the `window object` to the functions as demonstrated below.\n\n```python\nimport tkinter as tk\nfrom hPyT import *\nimport ctypes\n\n# make sure that the window has been created and is active\n\nhwnd = ctypes.windll.user32.GetActiveWindow()\nrainbow_border.start(hwnd, interval=4) # use the hwnd of the window instead of the window object\n```\n\n[Back to top](#-installing)\n\n## Miscellaneous\n\n### Get Windows Accent Color\n\n```python\nprint(get_accent_color()) # prints the current windows accent color\n>>> '#1b595a'\n```\n\n### Stylize text\n\n```python\nprint(stylize_text(\"Your Custom Text\", style=1)) # stylizes your text\n# all of the styles shown on the above gif are available\n>>> \"\ud835\udd1c\ud835\udd2c\ud835\udd32\ud835\udd2f \u212d\ud835\udd32\ud835\udd30\ud835\udd31\ud835\udd2c\ud835\udd2a \ud835\udd17\ud835\udd22\ud835\udd35\ud835\udd31\"\n```\n\n<br>\n\n## \ud83d\udcdc hPyT Changelog\n\n### v1.4.0\n\n- Add new feature for customizing the corner radius of the window\n- Add new feature for manipulating the non-client area of the window\n- Fix the issue with stylize text not looking for changes made by the user\n- Fix the issue with title text not being consistent on older versions of windows\n- Add support for x86/x32 pythonarchitecture\n\n### v1.3.7\n\n- Fix color conversion issue which returned the wrong color when the windows accent color was set to a custom color\n- Add handling for WM_NCACTIVATE and WM_NCPAINT messages to improve title bar rendering\n- Add dynamic height adjustment to hide_titlebar method using the no_span parameter\n\n### v1.3.6\n\n- Minor Bug Fixes\n\n### v1.3.5\n\n- Add feature for automatically changing the accent color of the titlebar and border\n- Fix an issue which caused ImportError when used with a python version less than 3.9\n\n### v1.3.4\n\n- Add method for applying the current windows accent color to the titlebar and border color\n- Add method for getting the current windows accent color\n- Add type annotations and docstrings to functions for better clarity and autocompletion\n\n### v1.3.3\n\n- Fixed taskbar unhide/hide bug\n\n### v1.3.2\n\n- Add support for synchronizing the rainbow effect with other ui elements.\n\n### v1.3.1\n\n- Add support for UI libraries like Kivy, PySimpleGUI, PyGame, etc.\n- Improve the rainbow titlebar & border effects.\n- Improve the center_relative function & examples.\n\n### v1.3.0\n\n- Add support for setting custom border color\n- Add support for rainbow border color effect\n- Add support for resetting the titleBar color and titleText color\n- Fix an issue which caused the titleBar to appear black after the rainbow titleBar effect was stopped\n\n### v1.2.1\n\n- Minor Bug Fixes\n\n### v1.2.0\n\n- Add support for rainbow titlebar\n- Add support for styling title text\n- Add support for vertical, horizontal shake and circle motion window animations\n- Add support for centering a window on the screen\n- Add support for centering a window relative to another window\n- Add support for moving/resizing/maximizing/minimizing/restoring a window\n- Add support for setting custom titlebar color\n- Add support for setting custom titlebar text color\n\n### v1.1.3\n\n- Add flashing inverval support\n\n### v1.1.2\n\n- Add window flashing support\n- Add window opacity support\n- Add support for PyGTK\n\n### v1.1.1\n\n- Add support for WxPython, PyQt and PySide\n\n### v1.1.0\n\n- Initial Release\n\n<br>\n\n![PyPI](https://img.shields.io/pypi/v/hPyT?style=flat-square)\n![Python](https://img.shields.io/badge/python-3.6+-blue)\n![Downloads](https://img.shields.io/pypi/dm/hPyT?style=flat-square)\n![Stars](https://img.shields.io/github/stars/zingzy/hPyT?style=flat-square)\n![Contributors](https://img.shields.io/github/contributors/zingzy/hPyT?style=flat-square)\n![Last Commit](https://img.shields.io/github/last-commit/zingzy/hPyT?style=flat-square)\n\n---\n\n<h6 align=\"center\">\n<img src=\"https://avatars.githubusercontent.com/u/90309290?v=4\" height=30 title=\"zingzy Copyright\">\n<br>\n\u00a9 zingzy . 2025\n\nAll Rights Reserved</h6>\n\n<p align=\"center\">\n\t<a href=\"https://github.com/zingzy/hPyT/blob/master/LICENSE\"><img src=\"https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8\"/></a>\n</p>\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Hack Python Titlebar - A package to manipulate windows and titlebar of GUI applications made using python.",
    "version": "1.4.0",
    "project_urls": {
        "Documentation": "https://github.com/zingzy/hPyT#readme",
        "Homepage": "https://github.com/zingzy/hPyT",
        "Source": "https://github.com/zingzy/hPyT",
        "Tracker": "https://github.com/zingzy/hPyT/issues"
    },
    "split_keywords": [
        "tkinter",
        "wxpython",
        "pyqt",
        "pyside",
        "gui",
        "window",
        "controls",
        "decorations",
        "hide",
        "show",
        "titlebar",
        "border",
        "color",
        "animation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a453783ad4d5286ca17d11feadfa7ffbf71db61777d8ea286e05275821990e93",
                "md5": "be7f1a51546ca80e050af799360d6118",
                "sha256": "7d8528a18432c1afa6eeed6e41acb39fa4d076b041b60ebb6df7a9c80cc50270"
            },
            "downloads": -1,
            "filename": "hPyT-1.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "be7f1a51546ca80e050af799360d6118",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 20984,
            "upload_time": "2025-01-18T23:03:28",
            "upload_time_iso_8601": "2025-01-18T23:03:28.783332Z",
            "url": "https://files.pythonhosted.org/packages/a4/53/783ad4d5286ca17d11feadfa7ffbf71db61777d8ea286e05275821990e93/hPyT-1.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e316a94baddc0137ad692a12d33ef2ac28fb6eeab5f508fa45592183e3742a58",
                "md5": "26a7626047999c19312920ce20280ff1",
                "sha256": "27a06f4b86cd679ce44b2afd4b699814e88cf88d5c35cf43c86454c39dc51f6a"
            },
            "downloads": -1,
            "filename": "hpyt-1.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "26a7626047999c19312920ce20280ff1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 28876,
            "upload_time": "2025-01-18T23:03:30",
            "upload_time_iso_8601": "2025-01-18T23:03:30.579434Z",
            "url": "https://files.pythonhosted.org/packages/e3/16/a94baddc0137ad692a12d33ef2ac28fb6eeab5f508fa45592183e3742a58/hpyt-1.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-18 23:03:30",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "zingzy",
    "github_project": "hPyT",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "hpyt"
}
        
Elapsed time: 0.90878s