{"id":14982543,"url":"https://github.com/githubuser0xffff/qt-advanced-docking-system","last_synced_at":"2025-10-03T02:31:24.757Z","repository":{"id":18418235,"uuid":"72958759","full_name":"githubuser0xFFFF/Qt-Advanced-Docking-System","owner":"githubuser0xFFFF","description":"Advanced Docking System for Qt","archived":false,"fork":true,"pushed_at":"2025-01-15T08:00:48.000Z","size":27982,"stargazers_count":1938,"open_issues_count":1,"forks_count":576,"subscribers_count":69,"default_branch":"master","last_synced_at":"2025-01-15T09:58:45.008Z","etag":null,"topics":["cpp","docking","docking-framework","docking-library","qt5"],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"mfreiholz/Qt-Advanced-Docking-System","license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/githubuser0xFFFF.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-11-05T23:18:30.000Z","updated_at":"2025-01-15T09:24:43.000Z","dependencies_parsed_at":"2023-02-13T22:45:25.109Z","dependency_job_id":"0f745123-0322-467a-99b0-4cf451e611c6","html_url":"https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System","commit_stats":{"total_commits":1175,"total_committers":68,"mean_commits":"17.279411764705884","dds":0.5182978723404255,"last_synced_commit":"a940fc29c6d1fbcb5ee1e2fecf86f20bb86a7fb6"},"previous_names":[],"tags_count":39,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/githubuser0xFFFF%2FQt-Advanced-Docking-System","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/githubuser0xFFFF%2FQt-Advanced-Docking-System/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/githubuser0xFFFF%2FQt-Advanced-Docking-System/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/githubuser0xFFFF%2FQt-Advanced-Docking-System/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/githubuser0xFFFF","download_url":"https://codeload.github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235064305,"owners_count":18930088,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cpp","docking","docking-framework","docking-library","qt5"],"created_at":"2024-09-24T14:05:37.025Z","updated_at":"2025-10-03T02:31:24.749Z","avatar_url":"https://github.com/githubuser0xFFFF.png","language":"C++","funding_links":["https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=85R64TMMSY9T6"],"categories":[],"sub_categories":[],"readme":"![ukraine](doc/ukraine.jpg)\n\n![logo](doc/ads_logo.svg)\n\n------------------\n\n[![GitHub release (latest by date)](https://img.shields.io/github/v/release/githubuser0xFFFF/Qt-Advanced-Docking-System)](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/releases/latest)\n[![License: LGPL v2.1](https://img.shields.io/badge/License-LGPL%20v2.1-blue.svg)](gnu-lgpl-v2.1.md)\n[![Build status](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/workflows/linux-builds/badge.svg)](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/actions?query=workflow%3Alinux-builds)\n[![Build status](https://ci.appveyor.com/api/projects/status/qcfb3cy932jw9mpy/branch/master?svg=true)](https://ci.appveyor.com/project/githubuser0xFFFF/qt-advanced-docking-system/branch/master)\n[![windows-builds](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/actions/workflows/windows-cmake.yml/badge.svg?branch=master)](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/actions/workflows/windows-cmake.yml)\n[![GitHub contributors](https://img.shields.io/github/contributors/githubuser0xFFFF/Qt-Advanced-Docking-System?color=ffdf00)](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/graphs/contributors)\n\nQt Advanced Docking System lets you create customizable layouts using a full\nfeatured window docking system similar to what is found in many popular\nintegrated development environments (IDEs) such as Visual Studio.\n\n- [What's new...](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/releases/latest)\n- [Documentation](https://githubuser0xffff.github.io/Qt-Advanced-Docking-System/doc/user-guide.html)\n- Original Repository: [https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System)\n\n[![Video Advanced Docking](doc/advanced-docking_video.png)](https://www.youtube.com/watch?v=7pdNfafg3Qc)\n\n## New and Noteworthy\n\nRelease [4.1](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/releases/latest) significantly improves the Auto-Hide functionality and also brings improvements\nfor Drag and Drop of dock widgets into dock area tabs. These are the highlights of the new version:\n\n#### Drag \u0026 Drop to Auto-Hide\n\nNow you can easily drag any dock widget or any floating widget to the\nborders of a window to pin it as a auto-hide tab in one of the 4 sidebars.\nIf you drag a dock widget close the one of the four window borders, special\ndrop overlays will be shown to indicate the drop area for auto-hide widgets:\n\n![Auo-Hide drag to Sidebar](doc/AutoHide_Drag_to_Sidebar.gif)\n\nOf course, this also works with dock areas:\n\n![Auo-Hide drag Dock Area](doc/AutoHide_Drag_DockArea.gif)\n\nIf you drag a dock widget or dock area into a sidebar, then you even have\ncontrol over where tabs are inserted. Simply drag your mouse over a specific\nauto-hide tab, and your dragged dock widget will be inserted before this tab.\nDrag to the sidebar area behind the last tab, and the dragged widget will be\nappended as last tab. In the following screen capture, the **Image Viewer 1** will\nbe inserted before the **Table 0** Auto-Hide tab and the **Image Viewer 2**\nis appende behind the last tab:\n\n![Auo-Hide tab insert order](doc/AutoHide_Tab_Insert_Order.gif)\n\n#### Auto-Hide Tab Insertion Order\n\nIt is also possible to drag Auto-Hide tabs to a new auto-hide position.\nThat means, you can drag them to a different border or sidebar:\n\n![Auto-Hide change sidebar](doc/AutoHide_Change_Sidebar.gif)\n\n#### Auto-Hide Tab Sorting\n\nYou can drag Auto-Hide tabs to a new position in the current sidebar\nto sort them:\n\n![Auo-Hide sort tabs](doc/AutoHide_Sort_Tabs.gif)\n\n#### Auto-Hide Drag to Float / Dock\n\nBut that is not all. You can also simply move Auto-Hide tabs to another\nfloating widget or dock them via drag and drop:\n\n![Auo-Hide drag to float or dock](doc/AutoHide_Drag_to_Float_or_Dock.gif)\n\n#### Auto-Hide Context Menu\n\nAll Auto-Hide tabs now have a context menu, that provides all the functionality\nthat you know from Dock widget tabs. With the **Pin To...** item from the\ncontext menu it is very easy to move an Auto-Hide tab to a different Auto-Hide\nsidebar:\n\n![Auo-Hide context menu](doc/AutoHide_Context_Menu.png)\n\n#### Dock Area Tab Insert Order\n\nAnd last but not least the new version also improves the docking of widgets\ninto the tabs of a Dock area. Just as with Auto-Hide tabs, you can now determine the position at which a tab is inserted by moving the mouse over an already existing tab (insertion before the tab) or behind the last tab\n(appending):\n\n![Dock area tab insert order](doc/DockArea_Tab_Insertion_Order.gif)\n\nThe [release 4.0](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/releases/latest)\nadds the following features:\n\n- Auto-Hide functionality ([read more...](#auto-hide-functionality))\n\n![Auto Hide Functionality](doc/AutoHide_Animation.gif)\n\n- improved demo application with new image viewer dock widgets\n  \n![Auto Hide Functionality](doc/Feature_ImageViewer.png)\n\n- Visual Studio like CSS theme in demo application\n\nThe [release 3.8](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/releases/3.8.3)\nadds the following features:\n\n- option to close tabs with the middle mouse button\n- `DeleteContentOnClose` flag for dynamic deletion and creation of dock widget\n  content\n- improved focus highlighting functionality\n\nThe [release 3.7](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/releases/tag/3.7.2)\nadds the following features:\n\n- support for **Qt6.**\n- support for [empty dock area](doc/user-guide.md#empty-dock-area)\n\nThe [release 3.6](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/releases/tag/3.6.3)\nadds some nice new features:\n\n- support for [central widget](doc/user-guide.md#central-widget) concept\n\n![Central Widget](doc/central_widget.gif)\n\n- support for [native floating widgets](doc/user-guide.md#floatingcontainerforcenativetitlebar-linux-only) on Linux\n\n![FloatingContainerForceNativeTitleBar true](doc/cfg_flag_FloatingContainerForceNativeTitleBar_true.png)\n\nBoth features are contributions from ADS users. Read the [documentation](doc/user-guide.md)\nto learn more about both new features.\n\nThe [release 3.5](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/releases/tag/3.5.0)\nadds the new [focus highlighting](doc/user-guide.md#focushighlighting) feature.\nThis optional feature enables highlighting of the focused dock widget like you\nknow it from Visual Studio.\n\n![FocusHighlighting](doc/cfg_flag_FocusHighlighting.gif)\n\n [learn more...](doc/user-guide.md#focushighlighting)\n\n## Features\n\n### Overview\n\n- [New and Noteworthy](#new-and-noteworthy)\n    - [Drag \\\u0026 Drop to Auto-Hide](#drag--drop-to-auto-hide)\n    - [Auto-Hide Tab Insertion Order](#auto-hide-tab-insertion-order)\n    - [Auto-Hide Tab Sorting](#auto-hide-tab-sorting)\n    - [Auto-Hide Drag to Float / Dock](#auto-hide-drag-to-float--dock)\n    - [Auto-Hide Context Menu](#auto-hide-context-menu)\n    - [Dock Area Tab Insert Order](#dock-area-tab-insert-order)\n- [Features](#features)\n  - [Overview](#overview)\n  - [Docking everywhere - no central widget](#docking-everywhere---no-central-widget)\n  - [Docking inside floating windows](#docking-inside-floating-windows)\n  - [Grouped dragging](#grouped-dragging)\n  - [Perspectives for fast switching of the complete main window layout](#perspectives-for-fast-switching-of-the-complete-main-window-layout)\n  - [Opaque and non-opaque splitter resizing](#opaque-and-non-opaque-splitter-resizing)\n  - [Cancelable docking process](#cancelable-docking-process)\n  - [Tab-menu for easy handling of many tabbed dock widgets](#tab-menu-for-easy-handling-of-many-tabbed-dock-widgets)\n  - [Many different ways to detach dock widgets](#many-different-ways-to-detach-dock-widgets)\n  - [Supports deletion of dynamically created dock widgets](#supports-deletion-of-dynamically-created-dock-widgets)\n  - [Auto-Hide Functionality](#auto-hide-functionality)\n- [Python Bindings](#python-bindings)\n  - [PySide6](#pyside6)\n  - [PyQt6](#pyqt6)\n  - [PyQt5](#pyqt5)\n- [Tested Compatible Environments](#tested-compatible-environments)\n  - [Supported Qt Versions](#supported-qt-versions)\n  - [Windows](#windows)\n  - [macOS](#macos)\n  - [Linux](#linux)\n- [Build](#build)\n  - [Qt5 on Ubuntu 18.04 or 20.04](#qt5-on-ubuntu-1804-or-2004)\n  - [Qt5 on Ubuntu 22.04](#qt5-on-ubuntu-2204)\n  - [Qt6 on Ubuntu 22.04](#qt6-on-ubuntu-2204)\n- [Getting started / Example](#getting-started--example)\n- [License information](#license-information)\n- [Donation](#donation)\n- [Showcase](#showcase)\n  - [Qt Creator IDE](#qt-creator-ide)\n  - [Qt Design Studio](#qt-design-studio)\n  - [CETONI Elements](#cetoni-elements)\n  - [ezEditor](#ezeditor)\n  - [D-Tect X](#d-tect-x)\n  - [HiveWE](#hivewe)\n  - [Ramses Composer](#ramses-composer)\n  - [Plot Juggler](#plot-juggler)\n  - [Notepad Next](#notepad-next)\n  - [MetGem](#metgem)\n  - [PRE Workbench](#pre-workbench)\n  - [RDE – Robox Development Environment](#rde--robox-development-environment)\n  - [ResInsight](#resinsight)\n  - [ADTF 3](#adtf-3)\n  - [DREAM3D-NX](#dream3d-nx)\n  - [LabPlot](#labplot)\n  - [Scrutiny Debugger](#scrutiny-debugger)\n  - [PySoWorks](#pysoworks)\n- [Alternative Docking System Implementations](#alternative-docking-system-implementations)\n  - [KDDockWidgets](#kddockwidgets)\n  - [QtitanDocking](#qtitandocking)\n  - [DockingPanes](#dockingpanes)\n\n### Docking everywhere - no central widget\n\nThere is no central widget like in the Qt docking system. You can dock on every\nborder of the main window or you can dock into each dock area - so you are\nfree to dock almost everywhere.\n\n![Dropping widgets](doc/preview-dragndrop.png)\n\n![Dropping widgets](doc/preview-dragndrop_dark.png)\n\n### Docking inside floating windows\n\nThere is no difference between the main window and a floating window. Docking\ninto floating windows is supported.\n\n![Docking inside floating windows](doc/floating-widget-dragndrop.png)\n\n![Docking inside floating windows](doc/floating-widget-dragndrop_dark.png)\n\n### Grouped dragging\n\nWhen dragging the titlebar of a dock, all the tabs that are tabbed with it are\ngoing to be dragged. So you can move complete groups of tabbed widgets into\na floating widget or from one dock area to another one.\n\n![Grouped dragging](doc/grouped-dragging.gif)\n\n![Grouped dragging](doc/grouped-dragging_dark.png)\n\n### Perspectives for fast switching of the complete main window layout\n\nA perspective defines the set and layout of dock windows in the main\nwindow. You can save the current layout of the dockmanager into a named\nperspective to make your own custom perspective. Later you can simply\nselect a perspective from the perspective list to quickly switch the complete\nmain window layout.\n\n![Perspective](doc/perspectives.gif)\n\n![Perspective](doc/perspectives_dark.png)\n\n### Opaque and non-opaque splitter resizing\n\nThe advanced docking system uses standard QSplitters as resize separators and thus supports opaque and non-opaque resizing functionality of QSplitter. In some rare cases, for very complex widgets or on slow machines resizing via separator on the fly may cause flicking and glaring of rendered content inside a widget. The global dock manager flag `OpaqueSplitterResize` configures the resizing behaviour of the splitters. If this flag is set, then widgets are resized dynamically (opaquely) while interactively moving the splitters.\n\n![Opaque resizing](doc/opaque_resizing.gif)\n\nIf this flag is cleared, the widget resizing is deferred until the mouse button is released - this is some kind of lazy resizing separator.\n\n![Non-opaque resizing](doc/non_opaque_resizing.gif)\n\n### Cancelable docking process\n\nIn contrast to the standard Qt docking system, docking with the ADS works more like a drag \u0026 drop operation. That means, the dragged dock widget or dock area is not undocked immediately. Instead, a drag preview widget is created and dragged around to indicate the future position of the dock widget or dock area. The actual dock operation is only executed when the mouse button is released. That makes it possible, to cancel an active drag operation with the escape key.\n\nThe drag preview widget can be configured by a number of global dock manager flags:\n\n- `DragPreviewIsDynamic`: if this flag is enabled, the preview will be adjusted dynamically to the drop area\n- `DragPreviewShowsContentPixmap`: the created drag preview window shows a static copy of the content of the dock widget / dock are that is dragged\n- `DragPreviewHasWindowFrame`: this flag configures if the drag preview is frameless like a QRubberBand or looks like a real window\n\n### Tab-menu for easy handling of many tabbed dock widgets\n\nTabs are a good way to quickly switch between dockwidgets in a dockarea. However, if the number of dockwidgets in a dockarea is too large, this may affect the usability of the tab bar. To keep track in this situation, you can use the tab menu. The menu allows you to quickly select the dockwidget you want to activate from a drop down menu.\n\n![Tab menu](doc/tab_menu.gif)\n\n### Many different ways to detach dock widgets\n\nYou can detach dock widgets and also dock areas in the following ways:\n\n- by dragging the dock widget tab or the dock area title bar\n- by double clicking the tab or title bar\n- by using the detach menu entry from the tab and title bar drop down menu\n\n### Supports deletion of dynamically created dock widgets\n\nNormally 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.\n\n### Auto-Hide Functionality\n\nThe 4.0 release of ADS added the new **Auto-Hide** feature. Thanks to the\n[initial contribution](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/pull/452) by [Ahmad Syarifuddin](https://github.com/SyarifFakhri) it was\npossible to close this long standing [feature request](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/issues/147). The \"Auto Hide\" feature\nallows to display more information using less screen space by hiding or showing\nwindows pinned to one of the four dock container borders.\n\n![Auto-Hide Movie](doc/AutoHide_Movie.gif)\n\nThe Advanced Docking\nSystem supports \"Auto-Hide\" functionality for **all** dock containers - that means,\nfor the main window and for each floating widget. Here is short list of all\nauto hide features:\n\n- supported for the main window and all floating dock containers\n- supports showing and hiding via mouse click or mouse hover\n- respects opaque / non opaque splitter resizing flag\n- context menu for pinning a dock widget or a complete dock area to a certain border\n- configuration option to configure if the pin button should pin the current\n  dock widget tab or a complete dock area\n- click the pin button holding the Ctrl key to pin a complete dock area\n- fully CSS styleable\n- backward compatible state file format - is is possible to load older dock manager\n  state files without auto hide support and older versions can load the new state\n  files with Auto-Hide state information\n\nMore about the auto hide configuration options in the [online documentation...](doc/user-guide.md#auto-hide-configuration-flags)\n\n## Python Bindings\n\n![Python Logo](doc/python_logo.png)\n\nThanks to the contribution of several users, the Advanced Docking System comes\nwith a complete Python integration. Python bindings are available for **PyQt5**, **PyQt6**, and\n**PySide6**.\n\n### PySide6\n\nA PySide6 ADS package is available via PyPi and can be installed on Windows,\nmacOS, and Linux with:\n\n```bash\npip install PySide6-QtAds\n```\n\nSample 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\nfrom source (pip install \u003chttps://github.com/spyder-ide/qtpy/archive/refs/heads/master.zip\u003e).\nThe PySide6 bindings were contributed by:\n\n- [mborgerson](https://github.com/mborgerson)\n\nPlease file PySide6-QtAds-specific issues on its [pyside6_qtads](https://github.com/mborgerson/pyside6_qtads) fork for tracking. For more information about the PySide6 bindings read [this](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/issues/298) issue.\n\n### PyQt6\n\nA PyQt6 ADS package is available via PyPi and can be installed on Windows,\nmacOS, and Linux with:\n\n```bash\npip install PyQt6Ads\n```\n\nSample code is available [here](https://github.com/pyapp-kit/PyQt6Ads/tree/main/examples).\n\nThe PyQt6 bindings were contributed by:\n\n- [tlambert03](https://github.com/tlambert03)\n\nPlease file PyQt6Ads-specific issues at [pyapp-kit/PyQt6Ads](https://github.com/pyapp-kit/PyQt6Ads).\n\n### PyQt5\n\nA package is available via [conda-forge](https://github.com/conda-forge/pyqtads-feedstock).\nThe python integration has been contributed to this project by the following people:\n\n- [n-elie](https://github.com/n-elie)\n- [Hugo Slepicka](https://github.com/hhslepicka)\n- [K Lauer](https://github.com/klauer)\n\nA Python integration is also available via PyPi. You can install the\n[PyQtAds](https://pypi.org/project/PyQtAds/) package via pip. This feature has been\ncontributed to this project by:\n\n- [Mira Weller](https://github.com/luelista)\n\n## Tested Compatible Environments\n\n### Supported Qt Versions\n\nThe library supports **Qt5** and **Qt6**.\n\n### Windows\n\nWindows 10 / 11 [![Build status](https://ci.appveyor.com/api/projects/status/qcfb3cy932jw9mpy/branch/master?svg=true)](https://ci.appveyor.com/project/githubuser0xFFFF/qt-advanced-docking-system/branch/master)\n[![windows-builds](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/actions/workflows/windows-cmake.yml/badge.svg?branch=master)](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/actions/workflows/windows-cmake.yml)\n\nThe library was developed on and for Windows. It is used in a commercial Windows application and is therefore constantly tested.\n\n### macOS\n\nThe application can be compiled for macOS. A user reported, that the library works on macOS. If have not tested it.\n\n![Advanced Docking on macOS](doc/macos.png)\n\n### Linux\n\n[![Build status](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/workflows/linux-builds/badge.svg)](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/actions?query=workflow%3Alinux-builds)\n\nUnfortunately, there is no such thing as a Linux operating system. Linux is a heterogeneous environment with a variety of different distributions. So it is not possible to support \"Linux\" like it is possible for Windows. It is only possible to support and test a small subset of Linux distributions. The library can be compiled for and has been developed and tested with some Linux distributions. Depending on the used window manager or compositor, dock widgets\nwith native title bars are supported or not. If native title bars are not supported,\nthe library switches to `QWidget` based title bars.\n\n- **Kubuntu 18.04 and 19.10** - uses KWin - no native title bars\n- **Ubuntu 18.04, 19.10 and 20.04** - native title bars are supported\n- **Ubuntu 22.04** - uses Wayland -\u003e no native title bars\n\nThere are some requirements for the Linux distribution that have to be met:\n\n- an X server that supports ARGB visuals and a compositing window manager. This is required to display the translucent dock overlays ([https://doc.qt.io/qt-5/qwidget.html#creating-translucent-windows](https://doc.qt.io/qt-5/qwidget.html#creating-translucent-windows)). If your Linux distribution does not support this, or if you disable this feature, you will very likely see issue [#95](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/issues/95).\n- Wayland is not properly supported by Qt yet. If you use Wayland, then you should set the session type to x11: `XDG_SESSION_TYPE=x11 ./AdvancedDockingSystemDemo`. You will find more details about this in issue [#288](https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System/issues/288).\n\nScreenshot Kubuntu:\n![Advanced Docking on Kubuntu Linux](doc/linux_kubuntu_1804.png)\n\nScreenshot Ubuntu:\n![Advanced Docking on Ubuntu Linux](doc/linux_ubuntu_1910.png)\n\n## Build\n\nThe Linux build requires private header files. Make sure that they are installed.\nThe library uses SVG icons, so ensure that Qt SVG support is installed. The demo\napplication creates a `QQuickWidget` for testing, so ensure that the required\nlibraries are installed.\n\n### Qt5 on Ubuntu 18.04 or 20.04\n\n```bash\nsudo apt install qt5-default qtbase5-private-dev\n```\n\n### Qt5 on Ubuntu 22.04\n\n```bash\nsudo apt install qtbase5-dev qtbase5-private-dev qtbase5-dev-tools libqt5svg5 libqt5qml5 qtdeclarative5-dev\n```\n\n### Qt6 on Ubuntu 22.04\n\n```bash\nsudo apt install qt6-default qt6-base-dev qt6-base-private-dev qt6-tools-dev libqt6svg6 qt6-qtdeclarative\n```\n\nOpen the `ads.pro` file with QtCreator and start the build, that's it.\nYou can run the demo project and test it yourself.\n\n## Getting started / Example\n\nThe following example shows the minimum code required to use the advanced Qt docking system.\n\n*MainWindow.h*\n\n```cpp\n#include \u003cQMainWindow\u003e\n#include \"DockManager.h\"\n\nnamespace Ui {\nclass MainWindow;\n}\n\nclass MainWindow : public QMainWindow\n{\n    Q_OBJECT\n\npublic:\n    explicit MainWindow(QWidget *parent = 0);\n    ~MainWindow();\n\nprivate:\n    Ui::MainWindow *ui;\n    \n    // The main container for docking\n    ads::CDockManager* m_DockManager;\n};\n```\n\n*MainWindow.cpp*\n\n```cpp\n#include \"MainWindow.h\"\n#include \"ui_MainWindow.h\"\n\n#include \u003cQLabel\u003e\n\nMainWindow::MainWindow(QWidget *parent) :\n    QMainWindow(parent),\n    ui(new Ui::MainWindow)\n{\n    ui-\u003esetupUi(this);\n\n    // Create the dock manager after the ui is setup. Because the\n    // parent parameter is a QMainWindow the dock manager registers\n    // itself as the central widget as such the ui must be set up first.\n    DockManager = new ads::CDockManager(this);\n\n    // Create example content label - this can be any application specific\n    // widget\n    QLabel* l = new QLabel();\n    l-\u003esetWordWrap(true);\n    l-\u003esetAlignment(Qt::AlignTop | Qt::AlignLeft);\n    l-\u003esetText(\"Lorem ipsum dolor sit amet, consectetuer adipiscing elit. \");\n\n    // Create a dock widget with the title Label 1 and set the created label\n    // as the dock widget content\n    ads::CDockWidget* DockWidget = DockManager-\u003ecreateDockWidget(\"Label 1\");\n    DockWidget-\u003esetWidget(l);\n\n    // Add the toggleViewAction of the dock widget to the menu to give\n    // the user the possibility to show the dock widget if it has been closed\n    ui-\u003emenuView-\u003eaddAction(DockWidget-\u003etoggleViewAction());\n\n    // Add the dock widget to the top dock widget area\n    DockManager-\u003eaddDockWidget(ads::TopDockWidgetArea, DockWidget);\n}\n\nMainWindow::~MainWindow()\n{\n    delete ui;\n}\n```\n\n## License information\n\n[![License: LGPL v2.1](https://img.shields.io/badge/License-LGPL%20v2.1-blue.svg)](gnu-lgpl-v2.1.md)\nThis project uses the [LGPLv2.1 license](gnu-lgpl-v2.1.md)\n\n## Donation\n\nIf this project help you reduce time to develop or if you just like it, you can give me a cup of coffee :coffee::wink:.\n\n\u003ca href=\"https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=85R64TMMSY9T6\"\u003e\n  \u003cimg src=\"doc/donate.png\" alt=\"Donate with PayPal\" width=\"160\"/\u003e\n\u003c/a\u003e\n\n## Showcase\n\n### [Qt Creator IDE](https://www.qt.io/development-tools)\n\nFrom version 4.12 on, Qt Creator uses the Advanced Docking Framework for its\nQt Quick Designer. This improves the usability when using multiple screens.\n\n![Qt Creator](doc/showcase_qtcreator.png)\n\n### [Qt Design Studio](https://www.qt.io/ui-design-tools)\n\nTaken from the [Qt Blog](https://www.qt.io/blog/qt-design-studio-1.5-beta-released):\n\n\u003e The most obvious change in [Qt Design Studio 1.5](https://www.qt.io/blog/qt-design-studio-1.5-beta-released) is the integration of dock widgets using the Qt Advanced Docking System. This allows the user to fully customize the workspace and also to undock any view into its own top level window. This especially improves the usability when using multiple screens.\n\n[![Qt Design Studio](doc/showcase_qt_design_studio_video.png)](https://youtu.be/za9KBWcFXEw?t=84)\n\n### [CETONI Elements](https://cetoni.com/cetoni-elements/)\n\nThe CETONI Elements software from [CETONI](https://www.cetoni.com) is a comprehensive,\nplugin-based and modular laboratory automation software for controlling CETONI devices using a joint graphical user interface. The software features a powerful script system to automate processes. The software uses the advanced docking system to give the user the freedom to arrange all the views and windows that are provided by the various plugins.\n\n[learn more...](https://cetoni.com/cetoni-elements/)\n\n[![CETONI_Elements](doc/showcase_qmix_elements.png)](https://www.youtube.com/watch?v=7pdNfafg3Qc)\n\n### [ezEditor](https://github.com/ezEngine/ezEngine)\n\nThe ezEditor is a full blown graphical editor used for editing scenes and\nimporting and authoring assets for the [ezEngine](https://github.com/ezEngine/ezEngine) -\nan open source C++ game engine in active development.\n\n![ezEditor](doc/showcase_ezEngine_editor.png)\n\n### [D-Tect X](https://www.duerr-ndt.com/products/ndt-software/d-tect-xray-inspection-software.html)\n\nD-Tect X is a X-ray inspection software for industrial radiography. It is a state-of-the-art 64-bit application which supports GPU (Graphics Processing Unit) acceleration and takes full advantage of computers with multiple CPU cores. A large set of tools assist the user in image analysis and evaluation. Thanks to the Qt Advanced Docking System the flexible and intuitive user interface can be completely customized to  each user’s preference.\n\n[learn more...](https://www.duerr-ndt.com/products/ndt-software/d-tect-xray-inspection-software.html)\n\n[![D-TectX](doc/showcase_d-tect-x.png)](https://youtu.be/mOor7GmmIJo?t=13)\n\n### [HiveWE](https://github.com/stijnherfst/HiveWE)\n\nHiveWE is a Warcraft III world editor. It focusses on speed and ease of use,\nespecially for large maps where the regular World Editor is often too slow and clunky.\nIt has a JASS editor with syntax highlighting, tabs, code completion and more.\nThe JASS editor uses the Qt Advanced Docking System for the management and layout\nof the open editor windows.\n\n[learn more...](https://github.com/stijnherfst/HiveWE)\n\n![HiveWE](doc/showcase_hivewe.png)\n\n### [Ramses Composer](https://github.com/GENIVI/ramses-composer)\n\nRamses Composer is the authoring tool for the open source [RAMSES](https://github.com/GENIVI/ramses)\nrendering ecosystem.\n\nRamses is a low-level rendering engine which is optimized for embedded hardware\nmobile devices, automotive ECUs, IoT electronics. Ramses was initially developed\nat the BMW Group and open-sourced in 2018 as part of a collaboration initiative\nwith the Genivi Alliance. It is an important part of the BMW infotainment cluster\nand digital portfolio.\n\n[learn more...](https://github.com/GENIVI/ramses-composer)\n\n![RamsesComposer](doc/showcase_ramses_composer.png)\n\n### [Plot Juggler](https://github.com/facontidavide/PlotJuggler)\n\nPlotJuggler is a fast, powerful and intuitive tool to visualize time series.\nIt makes it easy to visualize data but also to analyze it. You can manipulate\nyour time series using a simple and extendable Transform Editor. Some of the\nhighlights are:\n\n- Simple Drag \u0026 Drop user interface.\n- Load data from file.\n- Connect to live streaming of data.\n- Save the visualization layout and configurations to reuse them later.\n- Fast OpenGL visualization.\n- Can handle thousands of timeseries and millions of data points.\n- Transform your data using a simple editor: derivative, moving average, integral, etc…\n- PlotJuggler can be easily extended using plugins.\n\n[read more...](https://github.com/facontidavide/PlotJuggler)\n\n[![Plot Juggler](doc/showcase_plot_juggler.png)](https://vimeo.com/480588113#t=46s)\n\n### [Notepad Next](https://github.com/dail8859/NotepadNext)\n\nNotepad Next is a cross-platform reimplementation of Notepad++ that uses the\nAdvanced Docking System to arrange the open source files on the screen.\n\n[read more...](https://github.com/dail8859/NotepadNext)\n\n![NotepadNext](doc/showcase_notepad_next.png)\n\n### [MetGem](https://metgem.github.io/)\n\nMetGem is an open-source software for tandem mass-spectrometry data visualization.\nIt's key features are standalone molecular networking and t-SNE based projections.\nMetGem uses the Qt-Advanced-Docking-System to manage docks and to create independent\nmolecular network views.\n\n[read more...](https://metgem.github.io/)\n\n![MetGem](doc/showcase_metgem.png)\n\n### [PRE Workbench](https://luelista.github.io/pre_workbench/)\n\nProtocol Reverse Engineering Workbench is a software to support researchers in reverse engineering protocols and documenting the results. It supports various sources to import protocol traffic from, helps the discovery process by displaying different views and heuristic-based highlighting on data, and aids in documenting and sharing findings.\n\nPRE Workbench is a Python software and uses the ADS PyQt integration.\n\n[read more...](https://luelista.github.io/pre_workbench/)\n\n[![PRE Workbench](doc/showcase_pre_workbench.png)](https://youtu.be/U3op5UreV1Q)\n\n### [RDE – Robox Development Environment](https://www.robox.it/en/product/rde-robox-development-environment/)\n\nThis software is a development environment for PAC (Programmable Automation Controllers)\nfrom ROBOX. It offers a lot of tools to write, compile and debug machine control\nand application software. The Advanced Docking System helps to organize all the tools and\nwindows (Project window, Shell window, Monitor windows, Oscilloscope window...)\non the screen to provide a easy to use, highly configurable and visual pleasing\ndevelopment experience.\n\n[read more...](https://www.robox.it/en/product/rde-robox-development-environment/)\n\n![RDE](doc/showcase_robox_ide.png)\n\n### [ResInsight](https://www.ceetronsolutions.com/projects/resinsight)\n\nResInsight as a software from Ceetron Solutions for visualization of oil and\ngas reservoir simulation data. It allows reservoir models, simulation results,\nand measurements to be visualized with very high performance. Optimized use of\ngraphics technology and simultaneous processing on multiple CPU cores have been\nvital to enhance the performance and capacity of ResInsight for large data sets.\nThe Advanced Docking System has empowered Ceetron to build a much more intuitive\nuser interface for its ResInsight users.\n\n[read more...](https://resinsight.org/)\n\n[![ResInsight](doc/showcase_resinsight.png)](https://www.youtube.com/watch?v=HzLaQ1p6AUc)\n\n### [ADTF 3](https://www.digitalwerk.net/adtf/)\n\nThe Automotive Data and Time-Triggered Framework was designed as a Rapid Prototyping Toolset, Simulation Framework and Test- and Measurement Tool. It is meant for:\n\n- Developing and testing ADAS and HAD components\n- Recording of vehicle data for visualisation\n- Simulation of complex scenarios in SIL/HIL test environments\n\nThe software features time-based processing of multiple data streams and graphical editing of dynamic filter graphs. It also includes an SDK for custom plug-ins and reusable components, as well as components for data visualization in both 2D and 3D. This is was the\n[manual](https://support.digitalwerk.net/adtf/v3/adtf_html/page_adtf_xsystem_plugin.html)\nsays about the switch to Qt Advanced Docking:\n\n\u003e After several minor improvements the Qt5 ADTF XSystem uses the Advanced Docking System for Qt since ADTF 3.10.0 for more convenience and usability regarding layouting, docking and embedding several widgets.\n\n[read more...](https://support.digitalwerk.net/adtf/v3/adtf_html/index.html)\n\n![ADTF](doc/showcase_adtf.png)\n\n### [DREAM3D-NX](https://www.dream3d.io)\n\nDREAM3D-NX *(Digital Representation Environment for Analysis of Materials in 3D)* is a cross-platform and modular, software suite that allows users to prepare, reconstruct, quantify, instantiate, and mesh, multidimensional, multimodal microstructural data, as well as many other applications.\n\n[BlueQuartz Software](http://www.bluequartz.net/) has completely rewritten the old DREAM.3D version 6.5 application\ntaking advantage of the Advanced Docking System to present a highly customizable user interface\nfor DREAM3D-NX Version 7.\n\n![DREAM.3D NX](doc/showcase_dream3d_nx.png)\n\n[read more...](http://www.dream3d.io/)\n\n### [LabPlot](https://labplot.kde.org/)\n\nKDE LabPlot is the ultimate free, open source and cross-platform tool for scientists, engineers, and students who need to analyze and visualize data. With its intuitive interface and powerful features, you can create stunning plots and diagrams with ease. Whether you're working with CSV, FITS, or HDF5 data, KDE LabPlot makes it simple to import and analyze your data.\n\nThe LabPlot project recently switched to the Qt Advanced Docking System for their user interface. This switch represents a significant improvement to the LabPlot software, allowing users to create and manage complex data visualization layouts with ease.\n\n![LabPlot](doc/showcase_labplot.png)\n\n[read more...](https://labplot.kde.org/)\n\n### [Scrutiny Debugger](https://scrutinydebugger.com/)\n\nScrutiny is an [open source](https://github.com/scrutinydebugger/) non-intrusive, real-time debugger for embedded systems, built for fast introspection, memory access, and signal visualization—without stopping your application. It uses the Qt Advanced Docking System (ADS) to provide fully customizable dashboards for monitoring and control.\n\nSome of the highlights are:\n\n- **Debug without interfering** — Inspect C++ memory live without disrupting execution flow.\n- **HIL testing made easy** — Write to variables through the GUI or SDK to simulate conditions.\n- **Configure during production** — Access and tweak variables anytime via GUI or Python.\n- **Catch fast events** — Embedded graphs sample at task-level frequency, even with multithreading.\n- **Build your dashboard** — Use ADS to create and save custom layouts for your debug sessions.\n- **No JTAG needed** — Communicates over serial, CAN, or network interfaces.\n- **Compact C++11 library** — Lightweight and easy to integrate into your firmware.\n- **Live graphs and runtime values** — Visualize variables, RPVs, and aliases in real time.\n\nADS powers Scrutiny’s flexible interface, letting users organize views and data panels to suit their workflow — ideal for real-time monitoring, testing, and debugging.\n\n[read more...](https://scrutinydebugger.com/)\n\n[![Scrutiny Debugger UI](doc/showcase_scrutiny-dark.png)](https://www.youtube.com/watch?v=Dd3osxW-Clo)\n\n\n### [PySoWorks](https://pypi.org/project/pysoworks/)\n\nPySoWorks is an application for controlling the piezo amplifiers, such as the [NV200/D](https://www.piezosystem.com/product/nv-200-d-compact-amplifier/), from [piezosystem jena](https://www.piezosystem.com/) GmbH.\n\n![LabPlot](doc/showcase_pysoworks.png)\n\n[read more...](https://piezosystemjena.github.io/PySoWorks/)\n\n## Alternative Docking System Implementations\n\nIf this Qt Advanced Docking System does not fit to your needs you may consider some of the alternative docking system solutions for Qt.\n\n### KDDockWidgets\n\nThis 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.\n\n- [Blog post about KDDockWidgets](https://www.kdab.com/kddockwidgets/)\n- [GitHub project](https://github.com/KDAB/KDDockWidgets)\n\n**License:** dual-licensed, available under both commercial and GPL license.\n\n### QtitanDocking\n\nThis 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\n\n- [Product page](https://www.devmachines.com/qtitandocking-overview.html)\n\n**License:** Commercial license\n\n### DockingPanes\n\nDockingPanes 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.\n\n- [GitHub project](https://github.com/KestrelRadarSensors/dockingpanes)\n\n**License:** GPL\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithubuser0xffff%2Fqt-advanced-docking-system","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgithubuser0xffff%2Fqt-advanced-docking-system","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithubuser0xffff%2Fqt-advanced-docking-system/lists"}