PySide2-Frameless-Window


NamePySide2-Frameless-Window JSON
Version 0.3.10 PyPI version JSON
download
home_pagehttps://github.com/zhiyiYo/PyQt-Frameless-Window/tree/Pyside2
SummaryA cross-platform frameless window based on pyside2, support Win32, Linux and macOS.
upload_time2024-03-18 14:37:22
maintainer
docs_urlNone
authorzhiyiYo
requires_python
licenseLGPLv3
keywords pyside2 frameless
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <p align="center">
  <img width="15%" align="center" src="https://raw.githubusercontent.com/zhiyiYo/PyQt-Frameless-Window/master/screenshot/logo.png" alt="logo">
</p>
  <h1 align="center">
  PySide2-Frameless-Window
</h1>
<p align="center">
  A cross-platform frameless window based on PySide2
</p>

<p align="center">
  <a style="text-decoration:none">
    <img src="https://img.shields.io/badge/Platform-Win32%20|%20Linux%20|%20macOS-blue?color=#4ec820" alt="Platform Win32 | Linux | macOS"/>
  </a>

  <a style="text-decoration:none">
    <img src="https://static.pepy.tech/personalized-badge/pyside2_frameless_window?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads" alt="Download"/>
  </a>

  <a style="text-decoration:none">
    <img src="https://img.shields.io/badge/License-LGPLv3-blue?color=#4ec820" alt="LGPLv3"/>
  </a>
</p>

![Cover](https://raw.githubusercontent.com/zhiyiYo/PyQt-Frameless-Window/master/screenshot/cover.jpg)


## Features
* Move
* Stretching
* Window shadow
* Window animation
* Win11 snap layout
* Win10 acrylic blur
* Win11 mica blur
* Win7 Aero blur
* MacOS blur

## Install
To install use pip:
```shell
pip install PySide2-Frameless-Window
```
Or clone the repo:
```shell
git clone -b Pyside2 https://github.com/zhiyiYo/PyQt-Frameless-Window.git
python setup.py install
```

## Requirements

| Platform | Requirement |
| :------: | :---------: |
|  Win32   |   pywin32   |
|  MacOS   |   pyobjc    |


## Usage
To use the frameless window, you only need to inherit `FramelessWindow`. Here is a minimal example:
```python
import sys

from PySide2.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](https://github.com/zhiyiYo/PyQt-Frameless-Window/blob/Pyside2/examples/demo.py) and [main_window.py](https://github.com/zhiyiYo/PyQt-Frameless-Window/blob/Pyside2/examples/main_window.py).

## Examples
* Normal frameless window
![Normal Frameless Window](https://raw.githubusercontent.com/zhiyiYo/PyQt-Frameless-Window/master/screenshot/normal_frameless_window.gif)
* Acrylic frameless window
![Acrylic Frameless Window](https://raw.githubusercontent.com/zhiyiYo/PyQt-Frameless-Window/master/screenshot/acrylic_window.jpg)


## Document
Want to know more about PySide2-Frameless-Window? Please read the [help document](https://pyqt-frameless-window.readthedocs.io/) 👈

## Notes
1. `FramelessWindow` provides a default custom title bar. If you don't like it, just rewrite it as [demo.py](https://github.com/zhiyiYo/PyQt-Frameless-Window/blob/Pyside2/examples/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](https://github.com/zhiyiYo/PyQt-Frameless-Window/issues/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](https://stackoverflow.com/questions/58612306/how-to-fix-importerror-dll-load-failed-while-importing-win32api/72488468#72488468) or my [blog](https://www.cnblogs.com/zhiyiYo/p/16340429.html) for the solution.

5. If you are using PyQt5, PyQt6 or PySide6, you can download the code in [PyQt5](https://github.com/zhiyiYo/PyQt-Frameless-Window) or [PyQt6](https://github.com/zhiyiYo/PyQt-Frameless-Window/tree/PyQt6) or [PySide6](https://github.com/zhiyiYo/PyQt-Frameless-Window/tree/PySide6) branch.

## See Also
Here are some projects that use PyQt-Frameless-Window:
* [**zhiyiYo/Groove**: A cross-platform music player based on PyQt5](https://github.com/zhiyiYo/Groove)
* [**zhiyiYo/Alpha-Gobang-Zero**: A gobang robot based on reinforcement learning](https://github.com/zhiyiYo/Alpha-Gobang-Zero)
* [**zhiyiYo/PyQt-Fluent-Widgets**: A fluent design widgets library based on Qt](https://github.com/zhiyiYo/PyQt-Fluent-Widgets)
* [**zhiyiYo/QMaterialWidgets**: A material design widgets library based on Qt](https://qmaterialwidgets.vercel.app)

## Reference
* [**wangwenx190/framelesshelper**: Frameless windows for Qt Widgets and Qt Quick applications. Support Win32, X11, Wayland and macOS](https://github.com/wangwenx190/framelesshelper)
* [**libxcb**: Basic Graphics Programming With The XCB Library](https://www.x.org/releases/X11R7.5/doc/libxcb/tutorial)

## License
PySide2-Frameless-Window is licensed under [LGPLv3](./LICENSE).

Copyright © 2021 by zhiyiYo.

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/zhiyiYo/PyQt-Frameless-Window/tree/Pyside2",
    "name": "PySide2-Frameless-Window",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "pyside2 frameless",
    "author": "zhiyiYo",
    "author_email": "shokokawaii@outlook.com",
    "download_url": "https://files.pythonhosted.org/packages/36/08/52cbe54da7f20310584315691c95d69ec2113f3937493d25d492cc71a53c/PySide2-Frameless-Window-0.3.10.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <img width=\"15%\" align=\"center\" src=\"https://raw.githubusercontent.com/zhiyiYo/PyQt-Frameless-Window/master/screenshot/logo.png\" alt=\"logo\">\n</p>\n  <h1 align=\"center\">\n  PySide2-Frameless-Window\n</h1>\n<p align=\"center\">\n  A cross-platform frameless window based on PySide2\n</p>\n\n<p align=\"center\">\n  <a style=\"text-decoration:none\">\n    <img src=\"https://img.shields.io/badge/Platform-Win32%20|%20Linux%20|%20macOS-blue?color=#4ec820\" alt=\"Platform Win32 | Linux | macOS\"/>\n  </a>\n\n  <a style=\"text-decoration:none\">\n    <img src=\"https://static.pepy.tech/personalized-badge/pyside2_frameless_window?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads\" alt=\"Download\"/>\n  </a>\n\n  <a style=\"text-decoration:none\">\n    <img src=\"https://img.shields.io/badge/License-LGPLv3-blue?color=#4ec820\" alt=\"LGPLv3\"/>\n  </a>\n</p>\n\n![Cover](https://raw.githubusercontent.com/zhiyiYo/PyQt-Frameless-Window/master/screenshot/cover.jpg)\n\n\n## Features\n* Move\n* Stretching\n* Window shadow\n* Window animation\n* Win11 snap layout\n* Win10 acrylic blur\n* Win11 mica blur\n* Win7 Aero blur\n* MacOS blur\n\n## Install\nTo install use pip:\n```shell\npip install PySide2-Frameless-Window\n```\nOr clone the repo:\n```shell\ngit clone -b Pyside2 https://github.com/zhiyiYo/PyQt-Frameless-Window.git\npython setup.py install\n```\n\n## Requirements\n\n| Platform | Requirement |\n| :------: | :---------: |\n|  Win32   |   pywin32   |\n|  MacOS   |   pyobjc    |\n\n\n## Usage\nTo use the frameless window, you only need to inherit `FramelessWindow`. Here is a minimal example:\n```python\nimport sys\n\nfrom PySide2.QtWidgets import QApplication\nfrom qframelesswindow import FramelessWindow\n\n\nclass Window(FramelessWindow):\n\n    def __init__(self, parent=None):\n        super().__init__(parent=parent)\n        self.setWindowTitle(\"PyQt-Frameless-Window\")\n        self.titleBar.raise_()\n\n\nif __name__ == '__main__':\n    app = QApplication(sys.argv)\n    demo = Window()\n    demo.show()\n    sys.exit(app.exec_())\n```\nFor more complex requirements, see [demo.py](https://github.com/zhiyiYo/PyQt-Frameless-Window/blob/Pyside2/examples/demo.py) and [main_window.py](https://github.com/zhiyiYo/PyQt-Frameless-Window/blob/Pyside2/examples/main_window.py).\n\n## Examples\n* Normal frameless window\n![Normal Frameless Window](https://raw.githubusercontent.com/zhiyiYo/PyQt-Frameless-Window/master/screenshot/normal_frameless_window.gif)\n* Acrylic frameless window\n![Acrylic Frameless Window](https://raw.githubusercontent.com/zhiyiYo/PyQt-Frameless-Window/master/screenshot/acrylic_window.jpg)\n\n\n## Document\nWant to know more about PySide2-Frameless-Window? Please read the [help document](https://pyqt-frameless-window.readthedocs.io/) \ud83d\udc48\n\n## Notes\n1. `FramelessWindow` provides a default custom title bar. If you don't like it, just rewrite it as [demo.py](https://github.com/zhiyiYo/PyQt-Frameless-Window/blob/Pyside2/examples/demo.py) does.\n\n2. 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.\n3. Snap layout is not enabled by default. See [#56](https://github.com/zhiyiYo/PyQt-Frameless-Window/issues/56) to learn how to enable it.\n\n4. If you encounter this problem on Windows:\n   > ImportError: DLL load failed while importing win32api\n\n   see my answer on [stackoverflow](https://stackoverflow.com/questions/58612306/how-to-fix-importerror-dll-load-failed-while-importing-win32api/72488468#72488468) or my [blog](https://www.cnblogs.com/zhiyiYo/p/16340429.html) for the solution.\n\n5. If you are using PyQt5, PyQt6 or PySide6, you can download the code in [PyQt5](https://github.com/zhiyiYo/PyQt-Frameless-Window) or [PyQt6](https://github.com/zhiyiYo/PyQt-Frameless-Window/tree/PyQt6) or [PySide6](https://github.com/zhiyiYo/PyQt-Frameless-Window/tree/PySide6) branch.\n\n## See Also\nHere are some projects that use PyQt-Frameless-Window:\n* [**zhiyiYo/Groove**: A cross-platform music player based on PyQt5](https://github.com/zhiyiYo/Groove)\n* [**zhiyiYo/Alpha-Gobang-Zero**: A gobang robot based on reinforcement learning](https://github.com/zhiyiYo/Alpha-Gobang-Zero)\n* [**zhiyiYo/PyQt-Fluent-Widgets**: A fluent design widgets library based on Qt](https://github.com/zhiyiYo/PyQt-Fluent-Widgets)\n* [**zhiyiYo/QMaterialWidgets**: A material design widgets library based on Qt](https://qmaterialwidgets.vercel.app)\n\n## Reference\n* [**wangwenx190/framelesshelper**: Frameless windows for Qt Widgets and Qt Quick applications. Support Win32, X11, Wayland and macOS](https://github.com/wangwenx190/framelesshelper)\n* [**libxcb**: Basic Graphics Programming With The XCB Library](https://www.x.org/releases/X11R7.5/doc/libxcb/tutorial)\n\n## License\nPySide2-Frameless-Window is licensed under [LGPLv3](./LICENSE).\n\nCopyright \u00a9 2021 by zhiyiYo.\n\n\n",
    "bugtrack_url": null,
    "license": "LGPLv3",
    "summary": "A cross-platform frameless window based on pyside2, support Win32, Linux and macOS.",
    "version": "0.3.10",
    "project_urls": {
        "Homepage": "https://github.com/zhiyiYo/PyQt-Frameless-Window/tree/Pyside2"
    },
    "split_keywords": [
        "pyside2",
        "frameless"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "77d968604b67ce42b7dc83d1eda69d77f0283d14972f04be10817614b56a6084",
                "md5": "8facafe9d77c9d045e70c7286f3f9b0d",
                "sha256": "6b4f2b408a741ff3abf45075cd6616ba3fae14f84d48e2aff7ef3f77be23a1b3"
            },
            "downloads": -1,
            "filename": "PySide2_Frameless_Window-0.3.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8facafe9d77c9d045e70c7286f3f9b0d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 27014,
            "upload_time": "2024-03-18T14:37:21",
            "upload_time_iso_8601": "2024-03-18T14:37:21.299256Z",
            "url": "https://files.pythonhosted.org/packages/77/d9/68604b67ce42b7dc83d1eda69d77f0283d14972f04be10817614b56a6084/PySide2_Frameless_Window-0.3.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "360852cbe54da7f20310584315691c95d69ec2113f3937493d25d492cc71a53c",
                "md5": "a266bdbb0e3d0de076077887e788bb10",
                "sha256": "b0e335a79908d94fb844c1d0c782d95a134a6c26fdf2a46a9e489511ba043f6d"
            },
            "downloads": -1,
            "filename": "PySide2-Frameless-Window-0.3.10.tar.gz",
            "has_sig": false,
            "md5_digest": "a266bdbb0e3d0de076077887e788bb10",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 20352,
            "upload_time": "2024-03-18T14:37:22",
            "upload_time_iso_8601": "2024-03-18T14:37:22.801840Z",
            "url": "https://files.pythonhosted.org/packages/36/08/52cbe54da7f20310584315691c95d69ec2113f3937493d25d492cc71a53c/PySide2-Frameless-Window-0.3.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-18 14:37:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "zhiyiYo",
    "github_project": "PyQt-Frameless-Window",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "pyside2-frameless-window"
}
zhiyiYo
Elapsed time: 0.20264s