Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yjg30737/pyqt-frameless-window

PyQt(+PySide) Frameless Window
https://github.com/yjg30737/pyqt-frameless-window

framelesswindow pyqt pyqt5 pyqt5-examples pyqt5-frameless-window pyqt5-tutorial qcursor qt qwidget qwindow

Last synced: about 1 month ago
JSON representation

PyQt(+PySide) Frameless Window

Awesome Lists containing this project

README 

        
# pyqt-frameless-window

PyQt(+PySide) Frameless Window



## Feature

* Frameless

* Using Windows API (for Windows OS effect - shadow, rounded, animation, etc.) 

* Supports PyQt5, PySide2, PySide6

* User can make it enable/disable to move, resize

* Supports QWidget, QDialog, QMainWindow

* Support title bar. You can decide either show or hide it.



## Note

I strongly recommend legacy version if your OS is not Windows and that's saying a lot.



If you want to enhance this project, feel free to contribute macOS and Linux feature, since i don't afford to do test of pyqt-frameless-window in those OS.



## Requirements

* qtpy - To use PyQt5, PySide2(Qt version 5), PySide6(Qt version 6)

* pywin32 - For using Windows API feature



## Setup



### New version (using Windows API)

#### clone

1. git clone ~

2. pip install -r requirements.txt



You can skip below, it's just for testing. 



3. python sample_dialog_pyside6.py (Frameless dialog with PySide6)

4. python sample_mainwindow_pyqt5.py (Frameless main window with PyQt5)

5. python sample_widget_pyside6.py (Frameless widget with PySide6)



#### pip

`python -m pip install pyqt-frameless-window`



### Legacy version



`python -m pip install pyqt-frameless-window==0.0.61`



## Class Overview

### Recommend to use `FramelessWidget`, the others have multiple inheritance, so it can cause unexpected problem (haven't found any so far, though)

* FramelessWidget(hint=None) - frameless QWidget

* FramelessDialog(hint=None) - frameless QDialog

* FramelessMainWindow(hint=None) - frameless QMainWindow



### About `hint`

You can give the list of buttons on the right top of the menu bar with `hint` like ['full_screen', 'min', 'max', 'close']. 



['min', 'max', 'close'] will set by default if you don't give any arguments.



Available arguments (since v0.0.78)

* full_screen (still buggy, for example you can resize the full-screen window if you put the cusror to the very edge of the window)

* min

* max

* close



You can set the list of them with `setTitleBarHint(hint: list)` as well. (since v0.0.82)



## Method Overview

### == FramelessWidget, FramelessDialog, FramelessMainWindow ==

#### For Windows & The Others

* `setResizable(f: bool)` - Set resizable/none-resizable.

* `isResizable() -> bool` - Check if window is resizable or not

* `setPressToMove(f: bool)` - Set movable/non-movable

* `isPressToMove() -> bool` - Check if window is movable or not

* ##### New Version Only

   * `setWindowIcon(filename: str)` - Set the icon to the title bar. This method is overriden.

   * `setWindowTitle(title: str)` - Set the title to the title bar. This method is overriden.

   * `setFixedSize(width, height)` - Set the fixed width and height. This method is overriden to call `setResizable(false)`.

   * `setTitleBarVisible(f: bool)` - Set the title bar's visibility. If window is movable, window moving policy will also be decided by this.

       * If you set this true and window is movable, you should click and drag only the title bar to move the window.

       * If you set this false and window is movable, you can click and drag the part of the window which is not occupied by widget to move the window.

   * `getTitleBar()` - Get the title bar.

   * `setTitleBarHint(hint: list)` - Set the standard buttons(min, max, close...) of corner widget.

#### The Others

* `setMargin(margin: int)` - Set the margin which allows cursor to change its shape to resize form

* `setFrameColor(color)` - Set the background color. color argument type can be both QColor and str.

* `getFrameColor` -> QColor - Get the background color.

* `setVerticalExpandedEnabled(f: bool)` - Make it able to expand vertically when double-clicking the top or bottom edges of the window.

### == TitleBar (New Version Only) ==

* `getIcon() -> QLabel` - Get the icon.

* `getTitle() -> QLabel` - Get the title.

* `setTitleBarFont(font: QFont)` - Set the font of the title bar.

* `setIconSize(w, h)` - Set the size of icon on the title bar.



Note: Do not use any functions other than the above.



### Preview



#### Title bar



![image](https://user-images.githubusercontent.com/55078043/201617865-a613c415-61df-4402-a420-7c15ce3bb868.png)



#### No title bar 



If you make the title bar not visible with `setTitleBarVisible(False)`



![image](https://user-images.githubusercontent.com/55078043/202587513-62a8b31d-df94-47a6-a13c-c3d45d6ce3a2.png)



Try to move and resize it.



Note: Result image was tested in Windows 11, PySide6.



## See Also



Legacy version(0.0.61) README - not using Windows API, qtpy, just good old PyQt5. Enable to resize and move as always. (clunky in Windows though) Only for PyQt5 by the way.



## TODO list

* Make QWebEngineView work in win32 app (Windows 10) (bug report link)