Skip to content

Commit 38dfd51

Browse files
Merge branch 'master' into auto_hide_feature
2 parents c646d13 + 4600af7 commit 38dfd51

File tree

1 file changed

+63
-42
lines changed

1 file changed

+63
-42
lines changed

README.md

Lines changed: 63 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -73,19 +73,17 @@ know it from Visual Studio.
7373
- [Tab-menu for easy handling of many tabbed dock widgets](#tab-menu-for-easy-handling-of-many-tabbed-dock-widgets)
7474
- [Many different ways to detach dock widgets](#many-different-ways-to-detach-dock-widgets)
7575
- [Supports deletion of dynamically created dock widgets](#supports-deletion-of-dynamically-created-dock-widgets)
76-
- [Python PyQt5 Bindings](#python-pyqt5-bindings)
76+
- [Python Bindings](#python-bindings)
77+
- [PySide6](#pyside6)
78+
- [PyQt5](#pyqt5)
7779
- [Tested Compatible Environments](#tested-compatible-environments)
7880
- [Supported Qt Versions](#supported-qt-versions)
7981
- [Windows](#windows)
8082
- [macOS](#macos)
8183
- [Linux](#linux)
8284
- [Build](#build)
8385
- [Getting started / Example](#getting-started--example)
84-
- [Developers](#developers)
8586
- [License information](#license-information)
86-
- [Alternative Docking System Implementations](#alternative-docking-system-implementations)
87-
- [KDDockWidgets](#kddockwidgets)
88-
- [QtitanDocking](#qtitandocking)
8987
- [Donation](#donation)
9088
- [Showcase](#showcase)
9189
- [Qt Creator IDE](#qt-creator-ide)
@@ -99,6 +97,10 @@ know it from Visual Studio.
9997
- [Notepad Next](#notepad-next)
10098
- [MetGem](#metgem)
10199
- [PRE Workbench](#pre-workbench)
100+
- [Alternative Docking System Implementations](#alternative-docking-system-implementations)
101+
- [KDDockWidgets](#kddockwidgets)
102+
- [QtitanDocking](#qtitandocking)
103+
- [DockingPanes](#dockingpanes)
102104

103105
### Docking everywhere - no central widget
104106

@@ -180,21 +182,41 @@ You can detach dock widgets and also dock areas in the following ways:
180182

181183
Normally clicking the close button of a dock widget will just hide the widget and the user can show it again using the toggleView() action of the dock widget. This is meant for user interfaces with a static amount of widgets. But the advanced docking system also supports dynamic dock widgets that will get deleted on close. If you set the dock widget flag `DockWidgetDeleteOnClose` for a certain dock widget, then it will be deleted as soon as you close this dock widget. This enables the implementation of user interfaces with dynamically created editors, like in word processing applications or source code development tools.
182184

183-
### Python PyQt5 Bindings
185+
## Python Bindings
184186

185187
![Python Logo](doc/python_logo.png)
186188

187-
The Advanced Docking System comes with a complete Python integration based on
188-
PyQt5 bindings. The package is available via [conda-forge](https://github.com/conda-forge/pyqtads-feedstock). The python integration has been contributed to this project
189-
by the following people:
189+
Thanks to the contribution of several users, the Advanced Docking System comes
190+
with a complete Python integration. Python bindings are available for **PyQt5** and
191+
**PySide6**.
192+
193+
### PySide6
194+
195+
A PySide6 ADS package is available via PyPi and can be installed on Windows,
196+
macOS, and Linux with:
197+
198+
```bash
199+
pip install PySide6-QtAds
200+
```
201+
202+
Sample code is available [here](https://github.com/mborgerson/Qt-Advanced-Docking-System/tree/pyside6/examples). To run the samples, you'll also need to install latest qtpy
203+
from source (pip install https://github.com/spyder-ide/qtpy/archive/refs/heads/master.zip).
204+
The PySide6 bindings were contributed by:
205+
206+
- [mborgerson](https://github.com/mborgerson)
207+
208+
For more information about the PySide6 bindings read [this](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/issues/298) issue.
209+
210+
### PyQt5
211+
212+
A package is available via [conda-forge](https://github.com/conda-forge/pyqtads-feedstock).
213+
The python integration has been contributed to this project by the following people:
190214

191215
- [n-elie](https://github.com/n-elie)
192216
- [Hugo Slepicka](https://github.com/hhslepicka)
193217
- [K Lauer](https://github.com/klauer)
194218

195-
Latest working version: [3.5.2](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/releases/tag/3.5.2)
196-
197-
A Python integration is also availables via PyPi. You can install the
219+
A Python integration is also available via PyPi. You can install the
198220
[PyQtAds](https://pypi.org/project/PyQtAds/) package via pip. This feature has been
199221
contributed to this project by:
200222

@@ -327,41 +349,11 @@ MainWindow::~MainWindow()
327349
}
328350
```
329351
330-
## Developers
331-
332-
- Uwe Kindler, Project Maintainer
333-
- Manuel Freiholz
334-
335-
This work is based on and inspired by the
336-
[Advanced Docking System for Qt](https://github.com/mfreiholz/Qt-Advanced-Docking-System)
337-
from Manuel Freiholz. I did an almost complete rewrite of his code to improve
338-
code quality, readibility and to fix all issues from the issue tracker
339-
of his docking system project.
340-
341352
## License information
342353
343354
[![License: LGPL v2.1](https://img.shields.io/badge/License-LGPL%20v2.1-blue.svg)](gnu-lgpl-v2.1.md)
344355
This project uses the [LGPLv2.1 license](gnu-lgpl-v2.1.md)
345356
346-
347-
## Alternative Docking System Implementations
348-
349-
If this Qt Advanced Docking System does not fit to your needs you may consider some of the alternative docking system solutions for Qt.
350-
351-
### KDDockWidgets
352-
353-
This is an advanced docking framework for Qt from [KDAB](https://www.kdab.com/). The interesting thing is, that they separated GUI code from logic, so they can easily provide a QtQuick backend in the future.
354-
355-
- [Blog post about KDDockWidgets](https://www.kdab.com/kddockwidgets/)
356-
- [GitHub project](https://github.com/KDAB/KDDockWidgets)
357-
358-
359-
### QtitanDocking
360-
361-
This is a commercial component from [Developer Machines](https://www.devmachines.com/) for Qt Framework that allows to create a Microsoft like dockable user interface. They also offer a lot of other interesting and useful components for Qt.
362-
363-
- [Product page](https://www.devmachines.com/qtitandocking-overview.html)
364-
365357
## Donation
366358
367359
If this project help you reduce time to develop or if you just like it, you can give me a cup of coffee :coffee::wink:.
@@ -488,3 +480,32 @@ PRE Workbench is a Python software and uses the ADS PyQt integration.
488480
[read more...](https://luelista.github.io/pre_workbench/)
489481
490482
[![PRE Workbench](doc/showcase_pre_workbench.png)](https://youtu.be/U3op5UreV1Q)
483+
484+
## Alternative Docking System Implementations
485+
486+
If this Qt Advanced Docking System does not fit to your needs you may consider some of the alternative docking system solutions for Qt.
487+
488+
### KDDockWidgets
489+
490+
This is an advanced docking framework for Qt from [KDAB](https://www.kdab.com/). The interesting thing is, that they separated GUI code from logic, so they can easily provide a QtQuick backend in the future.
491+
492+
- [Blog post about KDDockWidgets](https://www.kdab.com/kddockwidgets/)
493+
- [GitHub project](https://github.com/KDAB/KDDockWidgets)
494+
495+
**License:** dual-licensed, available under both commercial and GPL license.
496+
497+
### QtitanDocking
498+
499+
This is a commercial component from [Developer Machines](https://www.devmachines.com/) for Qt Framework that allows to create a Microsoft like dockable user interface. They also offer a lot of other interesting and useful components for Qt. The library is available
500+
501+
- [Product page](https://www.devmachines.com/qtitandocking-overview.html)
502+
503+
**License:** Commercial license
504+
505+
### DockingPanes
506+
507+
DockingPanes is a library for Qt Widgets that implements docking windows that have the look and feel of Visual Studio. It provides a simple API which allows an application to make use of docking windows with a few calls.
508+
509+
- [GitHub project](https://github.com/KestrelRadarSensors/dockingpanes)
510+
511+
**License:** GPL

0 commit comments

Comments
 (0)