| 1 |
// SPDX-FileCopyrightText: 2022 UnionTech Software Technology Co., Ltd. |
| 2 |
// |
| 3 |
// SPDX-License-Identifier: LGPL-3.0-or-later |
| 4 |
|
| 5 |
#include "dwindowgroupleader.h" |
| 6 |
|
| 7 |
#include <QWindow> |
| 8 |
#include <QGuiApplication> |
| 9 |
#include <QPointer> |
| 10 |
|
| 11 |
DGUI_BEGIN_NAMESPACE |
| 12 |
|
| 13 |
#define DEFINE_CONST_CHAR(Name) const char _##Name[] = "_d_" #Name |
| 14 |
|
| 15 |
DEFINE_CONST_CHAR(groupLeader); |
| 16 |
DEFINE_CONST_CHAR(createGroupWindow); |
| 17 |
DEFINE_CONST_CHAR(destoryGroupWindow); |
| 18 |
DEFINE_CONST_CHAR(setWindowGroup); |
| 19 |
DEFINE_CONST_CHAR(clientLeader); |
| 20 |
|
| 21 |
class DWindowGroupLeaderPrivate |
| 22 |
{ |
| 23 |
public: |
| 24 |
explicit DWindowGroupLeaderPrivate(quint32 groupLeader) |
| 25 |
: groupLeader(groupLeader) { |
| 26 |
QFunctionPointer clientLeaderFun = qApp->platformFunction(_clientLeader); |
| 27 |
|
| 28 |
if (clientLeaderFun) { |
| 29 |
clientLeader = reinterpret_cast<quint32(*)()>(clientLeaderFun)(); |
| 30 |
} |
| 31 |
} |
| 32 |
|
| 33 |
quint32 groupLeader; |
| 34 |
quint32 clientLeader = 0; |
| 35 |
bool groupLeaderFromUser = false; |
| 36 |
|
| 37 |
QList<QPointer<QWindow>> windowList; |
| 38 |
|
| 39 |
void ensureGroupLeader(); |
| 40 |
bool setWindowGroupLeader(quint32 window, quint32 groupLeader); |
| 41 |
}; |
| 42 |
|
| 43 |
void DWindowGroupLeaderPrivate::ensureGroupLeader() |
| 44 |
{ |
| 45 |
if (groupLeader != 0) |
| 46 |
return; |
| 47 |
|
| 48 |
QFunctionPointer createGroupWindow = qApp->platformFunction(_createGroupWindow); |
| 49 |
|
| 50 |
if (!createGroupWindow) |
| 51 |
return; |
| 52 |
|
| 53 |
groupLeader = reinterpret_cast<quint32(*)()>(createGroupWindow)(); |
| 54 |
} |
| 55 |
|
| 56 |
bool DWindowGroupLeaderPrivate::setWindowGroupLeader(quint32 window, quint32 groupLeader) |
| 57 |
{ |
| 58 |
QFunctionPointer setWindowGroup = qApp->platformFunction(_setWindowGroup); |
| 59 |
|
| 60 |
if (!setWindowGroup) { |
| 61 |
return false; |
| 62 |
} |
| 63 |
|
| 64 |
reinterpret_cast<void(*)(quint32, quint32)>(setWindowGroup)(window, groupLeader); |
| 65 |
|
| 66 |
return true; |
| 67 |
} |
| 68 |
|
| 69 |
/*! |
| 70 |
\class Dtk::Gui::DWindowGroupLeader |
| 71 |
\inmodule dtkgui |
| 72 |
|
| 73 |
\brief DWindowGroupLeader 用于设置窗口所在的组,可以把多个窗口加到同一个组. |
| 74 |
|
| 75 |
在dxcb平台上,所有未指定组的窗口都会被分配到 DWindowGroupLeader::clientLeaderId |
| 76 |
这个组,且在窗口对应的本地窗口被创建时,会对 Qt::Dialog、Qt::Sheet、Qt::Tool、 |
| 77 |
Qt::SplashScreen、Qt::ToolTip、Qt::Drawer、Qt::Popup 类型的窗口设置 |
| 78 |
WM_TRANSIENT_FOR 属性,对于此类型的窗口,如果没有手动调用 QWindow::setTransientParent , |
| 79 |
则会将其 WM_TRANSIENT_FOR 属性设置为所在组id,得到的效果就是:会保证此窗口显示到这个组所有其它窗口 |
| 80 |
之上。例子: |
| 81 |
\code |
| 82 |
DWindowGroupLeader leader; |
| 83 |
QWindow wa, wb; |
| 84 |
QWindow topWindow; |
| 85 |
|
| 86 |
leader.addWindow(&wa); |
| 87 |
leader.addWindow(&wb); |
| 88 |
leader.addWindow(&topWindow); |
| 89 |
|
| 90 |
wa.setTitle("窗口wa"); |
| 91 |
wa.resize(300, 100); |
| 92 |
wa.show(); |
| 93 |
wb.setTitle("窗口wb"); |
| 94 |
wb.resize(300, 100); |
| 95 |
wb.show(); |
| 96 |
topWindow.setTitle("窗口topWindow"); |
| 97 |
topWindow.setFlag(Qt::Dialog); |
| 98 |
topWindow.resize(300, 300); |
| 99 |
topWindow.show(); |
| 100 |
\endcode |
| 101 |
窗口topWindow一直处于窗口wa和wb上层 |
| 102 |
\image wa_wb_topWindow.gif |
| 103 |
如果一个组内同时存在多个未设置过 QWindow::setTransientParent 的 Qt::Dialog(其它会自动设置 WM_TRANSIENT_FOR |
| 104 |
属性的窗口也成立)类型的窗口,这些窗口之间不会互相影响显示顺序,具体的规则和 X11 ICCCM 标准一致。 |
| 105 |
\ref {https://tronche.com/gui/x/icccm/sec-4.html#WM_TRANSIENT_FOR} |
| 106 |
\sa DWindowGroupLeader::clientLeaderId |
| 107 |
\sa Dtk::Widget::DApplication::loadDXcbPlugin |
| 108 |
*/ |
| 109 |
|
| 110 |
/*! |
| 111 |
\brief DWindowGroupLeader::DWindowGroupLeader |
| 112 |
\a groupId 为0时会在需要时自动创建一个有效的 groupLeaderId |
| 113 |
\sa DWindowGroupLeader::groupLeaderId |
| 114 |
*/ |
| 115 |
DWindowGroupLeader::DWindowGroupLeader(quint32 groupId) |
| 116 |
: d_ptr(new DWindowGroupLeaderPrivate(groupId)) |
| 117 |
{ |
| 118 |
if (groupId != 0) |
| 119 |
d_ptr->groupLeaderFromUser = true; |
| 120 |
} |
| 121 |
|
| 122 |
/*! |
| 123 |
\brief DWindowGroupLeader::~DWindowGroupLeader |
| 124 |
对象销毁时会释放由自己自动创建的 groupLeaderId |
| 125 |
\sa DWindowGroupLeader::groupLeaderId |
| 126 |
*/ |
| 127 |
DWindowGroupLeader::~DWindowGroupLeader() |
| 128 |
{ |
| 129 |
Q_D(DWindowGroupLeader); |
| 130 |
|
| 131 |
for (auto window : d->windowList) |
| 132 |
removeWindow(window); |
| 133 |
|
| 134 |
if (!d->groupLeaderFromUser) { |
| 135 |
QFunctionPointer destoryGroupWindow = qApp->platformFunction(_destoryGroupWindow); |
| 136 |
|
| 137 |
if (!destoryGroupWindow) |
| 138 |
return; |
| 139 |
|
| 140 |
reinterpret_cast<void(*)(quint32)>(destoryGroupWindow)(d->groupLeader); |
| 141 |
} |
| 142 |
} |
| 143 |
|
| 144 |
/*! |
| 145 |
\brief DWindowGroupLeader::groupLeaderId |
| 146 |
\return 返回组的id,类似于 QWindow::winId |
| 147 |
\warning 如果没有一个有效的id,则会先创建一个新的组id |
| 148 |
*/ |
| 149 |
quint32 DWindowGroupLeader::groupLeaderId() const |
| 150 |
{ |
| 151 |
Q_D(const DWindowGroupLeader); |
| 152 |
|
| 153 |
const_cast<DWindowGroupLeaderPrivate*>(d)->ensureGroupLeader(); |
| 154 |
|
| 155 |
return d->groupLeader; |
| 156 |
} |
| 157 |
|
| 158 |
/*! |
| 159 |
\brief DWindowGroupLeader::clientLeaderId |
| 160 |
\return 返回应用程序默认的组id |
| 161 |
*/ |
| 162 |
quint32 DWindowGroupLeader::clientLeaderId() const |
| 163 |
{ |
| 164 |
Q_D(const DWindowGroupLeader); |
| 165 |
|
| 166 |
return d->clientLeader; |
| 167 |
} |
| 168 |
|
| 169 |
/*! |
| 170 |
\brief DWindowGroupLeader::addWindow |
| 171 |
将窗口添加到这个组 |
| 172 |
\a window |
| 173 |
\warning 每个窗口只能有一个组,添加到新的组时,将不再受旧的组所带来的任何影响 |
| 174 |
*/ |
| 175 |
void DWindowGroupLeader::addWindow(QWindow *window) |
| 176 |
{ |
| 177 |
Q_ASSERT(window); |
| 178 |
Q_D(DWindowGroupLeader); |
| 179 |
|
| 180 |
d->ensureGroupLeader(); |
| 181 |
|
| 182 |
window->setProperty(_groupLeader, d->groupLeader); |
| 183 |
|
| 184 |
if (window->handle()) { |
| 185 |
d->setWindowGroupLeader(window->winId(), d->groupLeader); |
| 186 |
} |
| 187 |
|
| 188 |
d->windowList << window; |
| 189 |
} |
| 190 |
|
| 191 |
/*! |
| 192 |
\brief DWindowGroupLeader::removeWindow |
| 193 |
将窗口从这个组中移除 |
| 194 |
\a window |
| 195 |
\warning 窗口被移除后将不再受此组带来的任何影响 |
| 196 |
*/ |
| 197 |
void DWindowGroupLeader::removeWindow(QWindow *window) |
| 198 |
{ |
| 199 |
if (!window) |
| 200 |
return; |
| 201 |
|
| 202 |
window->setProperty(_groupLeader, QVariant()); |
| 203 |
|
| 204 |
Q_D(DWindowGroupLeader); |
| 205 |
|
| 206 |
if (window->handle()) { |
| 207 |
d->setWindowGroupLeader(window->winId(), d->clientLeader); |
| 208 |
} |
| 209 |
} |
| 210 |
|
| 211 |
DGUI_END_NAMESPACE |