Skip to content

Latest commit

 

History

History
236 lines (170 loc) · 9.76 KB

README.md

File metadata and controls

236 lines (170 loc) · 9.76 KB
Raw

KDDockWidgets

Build Status

KDDockWidgetsLogo

⚠️⚠️: If you're using QtQuick/QML it's recommended to use 2.0 branch. 1.x will continue to receive bug fixes for a long time but only for QtWidgets frontend.

KDDockWidgets is a Qt dock widget library written by KDAB, suitable for replacing QDockWidget and implementing advanced functionalities missing in Qt.

Although KDDockWidgets is ready to be used out of the box, it can also be seen as a framework to allow building very tailored custom docking systems. It tries to expose every internal widget and every knob for the app developer to tune.

You will find more information in these places:

We also have an in browser demo. Note however that this demo isn't fully featured, as it's running on Qt for WebAssembly.

Additionally, KDAB can provide pre-built Windows binaries for the example programs. Contact [email protected] if interested.

Motivation

Throughout the years KDAB contributed and funded bug fixes and features to QDockWidget. Sadly, this was very painful. Each bug fix or feature took many days of implementation, and an equal number of days just to fix dozens of regressions.

QDockWidget mixes GUI code with logic with state, making it very hard to move forward with new features. Furthermore, our customers were getting more creative with their requests, so it was clear we needed a better docking framework.

Features

  • Provide advanced docking that QDockWidget doesn't support
    • Native window resize on Windows (allowing for Aero-snap even with custom title bar decorations)
    • Arrow drop indicators for great drop precision
    • Allow for totally different, user provided, drop indicator types
    • Nesting dock widgets in a floating window and docking that group back to main window
    • Docking to any main window, not only to the parent main window
    • Docking to center of main window, or simply removing the concept of "central widget"
    • Main window supporting detachable tabs in center widget
    • Detaching arbitrary tabs from a tab bar into a dock area
    • Supporting more than 1 main window
    • Support for affinities, making some dock widgets only dockable on certain main windows
    • Allow to hide TitleBar and just show tabs. Allows dragging via the tab bar.
    • Exposing inner helper widgets so the user can customize them or provide his own
      • Customize tab widgets
      • Customize title bars
      • Customize window frames
      • Custom widget separators
  • Cross-platform (macOS, Linux, Windows, WebAssembly, Wayland, X11/XCB, EGLFS are working) See README-Wayland.md and README-WASM.md for platform specific information.
  • Layouting engine honouring min/max size constraints and some size policies
  • PySide2 bindings
  • Clean codebase
    • Not mixing GUI with state with logic with animations
    • Great test coverage, even the GUI and DnD operations are tested. 200 tests currently.
    • Fuzzer for doing random testing and finding bugs
  • Lazy separator resize
  • Reordering tabs with mouse
  • Partial layout save/restore, affecting only a chosen sub-set
  • Double click on title bar to maximize
  • Double click on separator to distribute equally
  • Show close button on tabs
  • Allow to make a dock widget non-closable and/or non-dockable
  • Optional minimize and maximize button on the title bar
  • FloatingWindows can be utility windows or full native

Screen capture

Screen capture

Building and requirements

To build KDDockWidgets you'll need:

  • CMake
  • Qt 5.15.x or Qt6 >= 6.2
  • Ninja (Other generators might work but are untested)
  • C++17 capable compiler
  • Qt Widgets module
  • Qt X11Extras module if on Linux/X11
  • Qt Quick and QuickControls2 modules if using the QtQuick support
  • Qt private development headers, for instance, for Qt5:
    • SUSE: libqt5-qtbase-private-headers-devel
    • Ubuntu, debian-based: qtbase5-private-dev
    • Fedora, redhat-based: qt5-qtbase-private-devel
    • others: consult your distro

Open a terminal capable of building Qt applications. Make sure you have cmake, ninja, compiler, Qt, etc in PATH.

Adapt the instructions to suit your cmake generator and operating system.

    cmake -G Ninja -DCMAKE_INSTALL_PREFIX=/path/where/to/install ../path/to/kddockwidgets
    cmake --build .
    cmake --build . --target install

The installation directory defaults to c:\KDAB\KDDockWidgets-<version> on Windows and /usr/local/KDAB/KDDockWidgets-<version> on non-Windows.

Change the installation location by passing the option -DCMAKE_INSTALL_PREFIX=/install/path to CMake.

Trying out the examples

A full demo that showcases most of the features lives in examples/dockwidgets.

A simpler example can be found in examples/minimal, which might be more indicated to learn the API, as it's less overwhelming than the full demo.

To build and run the example:

    cd path/to/kddockwidgets/examples/dockwidgets/
    cmake -G Ninja -DCMAKE_PREFIX_PATH=/path/where/kddw/is/installed
    cmake --build .
    ./kddockwidgets_example

Using

From your CMake Qt5 project, add

    find_package(KDDockWidgets CONFIG)

or for Qt6

    find_package(KDDockWidgets-qt6 CONFIG)

and link to the imported target KDAB::kddockwidgets. That's all you need to do (the imported target also brings in the include directories)

You may also need to modify the CMAKE_PREFIX_PATH environment variable depending on where you installed KDDockWidgets.

Python Bindings

Please refer to README-bindings.md.

Versioning

There's currently two lines of development: v1 which is very mature and stable and v2 which is an ongoing effort to make KDDW support multiple "frontends" (QtWidgets, QtQuick and even non-Qt technologies, like flutter).

1.x will be supported for many years to come, at least for bug fixes and small features. Use v1.6.0 tag for the latest stable.

Use 2.0 if you need non-QtWidgets support, for example QtQuick/QML. While 1.6 has support for QtQuick/QML it won't be receiving bug fixes. 2.0 is under active development, you might encounter minor source/ABI incompatibilities. Despite that, it is pretty stable, and all 200 unit-tests pass.

We'll try to remain source-compatible across versions (except for the v1 -> v2 jump). API will get a deprecation notice before being removed in the next version. Note that this compatibility effort is only for the public API. Private API (headers ending in _p.h) might change so you shouldn't depend on them. Private API is only exposed so more advanced users can override, for example paintEvent(), and not so they can change internal business logic.

We don't promise or test binary compatibility. It's advised that you recompile your application whenever updating KDDW.

Styling

Almost all private widgets used by KDDW can be derived by the user to give them a custom look. That's done by providing your own FrameworkWidgetFactory. Run "kddockwidgets_example -p" to see that in action.

Qt StyleSheets are not, and will not, be supported. See the comments in examples/dockwidgets/MyTitleBar_CSS.h for why. You can however use some minimal CSS, as shown in that example, just don't report bugs about it.

Warning: When using private headers, be sure to rebuild your application whenever you update to a new KDDW version. Binary compatibility is only kept when using public headers.

Licensing

KDDockWidgets is (C) 2019-2023, Klarälvdalens Datakonsult AB, and is licensed according to the terms of the GPL 2.0 or GPL 3.0.

Contact KDAB at [email protected] to inquire about commercial licensing.

Get Involved

Please submit your issue reports to our GitHub space at https://github.com/KDAB/KDDockWidgets.

When reporting bugs please make it easy for the maintainer to reproduce it. Use examples/minimal/ or examples/dockwidgets/ for reproducing the problem. If you did modifications to the example in order to reproduce then please attach the patch and not a picture of your changes. You can get a patch by doing git diff > repro.diff at the repo root.

Also state which KDDW sha1, branch or version you're using, and which operating system.

KDAB will happily accept external contributions; however, all contributions require a signed Copyright Assignment Agreement.

This is needed so we can continue to dual-license it.

Contact [email protected] for more information.

Thanks to our contributors.

About KDAB

KDDockWidgets is supported and maintained by Klarälvdalens Datakonsult AB (KDAB).

The KDAB Group is the global No.1 software consultancy for Qt, C++ and OpenGL applications across desktop, embedded and mobile platforms.

The KDAB Group provides consulting and mentoring for developing Qt applications from scratch and in porting from all popular and legacy frameworks to Qt. We continue to help develop parts of Qt and are one of the major contributors to the Qt Project. We can give advanced or standard trainings anywhere around the globe on Qt as well as C++, OpenGL, 3D and more.

Please visit https://www.kdab.com to meet the people who write code like this.

Stay up-to-date with KDAB product announcements: