【Qt开源项目推荐】完美的Dock窗口布局解决方案 Qt-Advanced-Docking-System

1 概述

1.1 介绍

这是GitHub上一个基于Qt实现并且非常完美的Dock窗口布局解决方案——Qt-Advanced-Docking-System，支持Windows、Linux和MacOS跨平台。
Qt-Advanced-Docking-System提供高自由度的Dock窗口管理接口，允许用户创建可定制的窗口布局，实现类似于主流的IDE、设计软件和工具软件的窗口布局管理，比如Visual Studio。
相比Qt中QMainWindow原生的Dock布局管理，Qt-Advanced-Docking-System具有更高的自由度、灵活性和可扩展性。

1.2 GitHub地址

https://github.com/githubuser0xFFFF/Qt-Advanced-Docking-System

2 特点

2.1 Dock窗口可以停靠在任何地方

Qt-Advanced-Docking-System中没有中心窗口，你可以将Dock窗口停靠在主窗口的每一个边界上，或者你可以停靠到每个停靠区，所以你几乎可以将Dock窗口自由停靠在任何地方。

2.2 Dock窗口支持停靠在浮动窗内

在Qt-Advanced-Docking-System中，主窗口和浮动窗口之间没有区别，支持将Dock窗口停靠在浮动窗内。

2.3 支持同区域选项卡中的Dock窗口同时拖动

当拖动一个Dock窗口的标题栏时，所有与它同区域的Dock窗口选项卡都将被拖动。因此，你可以将完整的选项卡窗口区域移动到浮动窗口，或者从一个停靠区移动到另一个停靠区。

2.4 支持布局的保存与自由切换

Qt-Advanced-Docking-System提供DockManager支持将当前Dock窗口的布局保存到视图配置中，创建自定义视图。同时，也支持从已有的视图配置列表中选择一个视图配置，快速切换完整的主窗口布局。

2.5 分割器（Splitter）支持两种拖动交互方式

1.拖动分割器时，Dock窗口动态调整窗口尺寸。将全局参数“OpaqueSplitterResize”设置为“true”时该属性生效。

2.拖动分割器时，Dock窗口的尺寸将在拖动分割器并放开鼠标后才改变。将全局参数“OpaqueSplitterResize”设置为“false”时该属性生效。

2.6 支持同区域多选项卡管理菜单

如果同区域中Dock窗口数量过多，可以使用标题栏中提供的选项卡菜单来实现选项卡的切换和管理。

2.7 支持多种交互方法分离Dock窗口

1.通过拖动Dock窗口选项卡或停靠区域的标题栏；
2.通过双击Dock窗口选项卡或标题栏；
3.通过选项卡菜单管理；

2.8 支持创建和删除临时Dock窗口

一般情况下，点击Dock窗口的关闭按钮只会隐藏窗口，同时用户也可以使用Dock窗口的toggleView方法控制Dock窗口的显隐。若对Dock窗口设置了“DockWidgetDeleteOnClose”属性，那么一旦这个Dock窗口被关闭，它就会被删除。

2.9 支持Python PyQt5

Qt-Advanced-Docking-System提供了基于PyQt5的完整Python集成方案。

2.10 Qt版本兼容

该库支持Qt5和Qt6。

2.11 支持跨平台

2.11.1 支持Windows

Qt-Advanced-Docking-System对Windows的支持近乎完美，因为该库最初便是为Windows应用程序开发。

2.11.2 支持Linux

由于Linux环境相对复杂，有各种不同的发行版。所以不可能像Windows那样完美支持。只能支持并测试通过Linux发行版的一小部分。该库可以在以下Linux发行版上编译、开发和运行：

1.Kubuntu 18.04 and 19.10

2.Ubuntu 18.04, 19.10 and 20.04

2.11.3 支持MacOS

该库支持MacOS，可以在MacOS上编译、开发和运行。

3 使用案例

3.1 Qt Creator

从Qt Creator 4.12版本开始，其工具Qt Quick Designer使用了Qt-Advanced-Docking-System，这提高了使用多个屏幕时的可用性。
Qt Creator官方链接

3.2 Qt Design Studio

Qt Design Studio 1.5中最明显的变化是使用Qt-Advanced-Docking-System集成了Dock窗口。
Qt Design Studio官方链接

3.3 CETONI Elements

CETONI Elements软件是一个全面的、基于插件和模块化的实验室自动化软件。
CETONI Elements官方链接

3.4 ezEditor

ezEditor是一个完整的图形编辑器，ezEngine是一个正在开发中的开源c++游戏引擎。
ezEditor官方链接

3.5 D-Tect X

D-Tect X是一款用于工业射线照相的X射线检查软件。
D-Tect X官方链接

3.6 HiveWE

HiveWE是用于游戏“魔兽争霸3（Warcraft III）”的世界编辑器。
HiveWE官方链接

3.7 Ramses Composer

Ramses Composer是开源引擎“Ramses”的创作工具。
Ramses是一个底层渲染引擎，为嵌入式硬件移动设备、汽车ecu、物联网电子产品进行了优化。Ramses最初由宝马集团开发，并于2018年开放源码。它是宝马信息娱乐集群和数字产品组合的重要组成部分。
Ramses Composer官方链接

3.8 Plot Juggler

Plot Juggler是一款快速、强大且直观的时序可视化工具。它使可视化数据变得容易，也使分析数据变得容易。
Plot Juggler官方链接

3.9 Notepad Next

Notepad Next是Notepad++的跨平台重新实现，它使用Qt-Advanced-Docking-System进行视图的布局。
Notepad Next官方链接

3.10 MetGem

MetGem是一款用于串联质谱数据可视化的开源软件。
MetGem官方链接

3.11 PRE Workbench

PRE Workbench是一种用于反向工程协议研究人员记录结果的软件。
PRE Workbench是一个使用Python开发的软件，使用Qt-Advanced-Docking-System PyQt集成。
PRE Workbench官方链接

4 编译与运行

Linux系统构建需要Qt私有头文件，确保它们已经安装，若未安装，请执行以下命令安装：
sudo apt install qtbase5-private-dev

使用QtCreator打开ads.pro文件并开始构建。

5 示例程序

下面的示例展示了使用Qt-Advanced-Docking-System所需的最少代码。

MainWindow.h

#include 
#include "DockManager.h"

namespace Ui {
class MainWindow;
}

class MainWindow : public QMainWindow
{
    Q_OBJECT

public:
    explicit MainWindow(QWidget *parent = 0);
    ~MainWindow();

private:
    Ui::MainWindow *ui;
    
    // Dock窗口主管理器
    ads::CDockManager* m_DockManager;
};

MainWindow.cpp

#include "MainWindow.h"
#include "ui_MainWindow.h"

#include 

MainWindow::MainWindow(QWidget *parent) :
    QMainWindow(parent),
    ui(new Ui::MainWindow)
{
    ui->setupUi(this);

    // 带ui的MainWindow，必须在setupUi调用完成后构造CDockManager，
    // 因为CDockManager的构造将传入父窗口MainWindow，
    // 并且CDockManager会将自身注册为MainWindow的中心窗体
    m_DockManager = new ads::CDockManager(this);

    // 构造一个界面小部件QLabel对象l，l将作为示例Dock窗口中的内容显示
    QLabel* l = new QLabel();
    l->setWordWrap(true);
    l->setAlignment(Qt::AlignTop | Qt::AlignLeft);
    l->setText("Lorem ipsum dolor sit amet, consectetuer adipiscing elit. ");

    // 构造一个标题为“Label 1”的Dock窗口
    // 并将QLabel对象l设置为该Dock窗口的内容显示
    ads::CDockWidget* DockWidget = new ads::CDockWidget("Label 1");
    DockWidget->setWidget(l);

    // 将Dock窗口的toggleViewAction添加到MainWindow的菜单中
    // 用于在MainWindow菜单中控制Dock窗口的显隐
    ui->menuView->addAction(DockWidget->toggleViewAction());

    // 将Dock窗口添加到顶部停靠区域
    m_DockManager->addDockWidget(ads::TopDockWidgetArea, DockWidget);
}

MainWindow::~MainWindow()
{
    delete ui;
}