PyQt6-Frameless-Window 0.0.6

A cross-platform frameless window based on pyqt6, support Win32, Linux and macOS.

PyQt6-Frameless-Window

A cross-platform frameless window based on PyQt6

Features

• Moving
• Stretching
• Window animation
• Window shadow
• Win11 snap layout
• Win10 acrylic blur
• Win11 mica blur
• Win7 Aero blur
• MacOS blur

Install

To install use pip:

pip install PyQt6-Frameless-Window

Or clone the repo:

git clone -b PyQt6 https://github.com/zhiyiYo/PyQt-Frameless-Window.git
python setup.py install

Requirements

Because the Qt resource system is used, the version of PyQt6 needs to be greater than 6.3.1. In addition, some third-party packages are required.

Platform	Requirement
Win32	pywin32
MacOS	pyobjc

Usage

To use the frameless window, you only need to inherit FramelessWindow or FramelessMainWindow. Here is a minimal example:

import sys

from PyQt6.QtWidgets import QApplication
from qframelesswindow import FramelessWindow


class Window(FramelessWindow):

    def __init__(self, parent=None):
        super().__init__(parent=parent)
        self.setWindowTitle("PyQt-Frameless-Window")
        self.titleBar.raise_()


if __name__ == '__main__':
    app = QApplication(sys.argv)
    demo = Window()
    demo.show()
    sys.exit(app.exec_())

For more complex requirements, see demo.py and main_window.py.

Examples

• Normal frameless window
• Acrylic frameless window

Document

Want to know more about PyQt6-Frameless-Window? Please read the help document 👈

Notes

1. FramelessWindow provides a default custom title bar. If you don't like it, just rewrite it as demo.py does.

2. Moving the acrylic window on Win10 may get stuck. At present, there is no good solution. Maybe you can disable the acrylic effect when moving the window, but I haven't done this in the source code.

3. Snap layout is not enabled by default. See #56 to learn how to enable it.

4. If you encounter this problem on Windows:

   ImportError: DLL load failed while importing win32api

   see my answer on stackoverflow or my blog for the solution.

5. If you are using PySide2, PySide6 or PyQt5, you can download the code in PySide2, PySide6 or PyQt5 branch.

See Also

Here are some projects that use PyQt-Frameless-Window:

• zhiyiYo/Groove: A cross-platform music player based on PyQt5
• zhiyiYo/Alpha-Gobang-Zero: A gobang robot based on reinforcement learning
• tonquer/picacg-qt: PicACG PC Client

Reference

• wangwenx190/framelesshelper: Frameless windows for Qt Widgets and Qt Quick applications. Support Win32, X11, Wayland and macOS
• libxcb: Basic Graphics Programming With The XCB Library

License

MIT License

Copyright (c) 2021 Zhengzhi Huang

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.