blob: f0ef5ee2a7e8e6a530aa1af03af6b3a3c592549c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\class QXcbWindowFunctions
\inmodule QtPlatformHeaders
\brief The QXcbWindowFunctions class is an inline class containing
miscellaneous functionality for xcb window specific functionality.
A common usage pattern is as follows:
\snippet qxcbwindowfunctions/main.cpp 0
\note There is no binary compatibility guarantee for this class,
meaning that an application using it is only guaranteed to work with the Qt
version it was developed against.
*/
/*!
\enum QXcbWindowFunctions::WmWindowType
This enum represents the supported WM_WINDOW_TYPE atoms.
\value Normal
\value Desktop
\value Dock
\value Toolbar
\value Menu
\value Utility
\value Splash
\value Dialog
\value DropDownMenu
\value PopupMenu
\value Tooltip
\value Notification
\value Combo
\value Dnd
\value KdeOverride
*/
/*!
\typedef QXcbWindowFunctions::SetWmWindowType
This is the typedef for the function returned by
QGuiApplication::platformFunction when passed the
value returned by setWmWindowTypeIdentifier().
*/
/*!
\fn QByteArray QXcbWindowFunctions::setWmWindowTypeIdentifier()
This function returns the byte array that can be used to query
QGuiApplication::platformFunction to retrieve the SetWmWindowType function.
*/
/*!
\fn void QXcbWindowFunctions::setWmWindowType(QWindow *window, WmWindowType type)
This is a convenience function that can be used directly instead
of resolving the function pointer. \a window and \a type will be
relayed to the function retrieved by QGuiApplication.
*/
/*!
\typedef QXcbWindowFunctions::SetWmWindowRole
\since 5.6.2
This is the typedef for the function returned by
QGuiApplication::platformFunction when passed the
value returned by setWmWindowRoleIdentifier().
*/
/*!
\fn QByteArray QXcbWindowFunctions::setWmWindowRoleIdentifier()
\since 5.6.2
This function returns the byte array that can be used to query
QGuiApplication::platformFunction to retrieve the SetWmWindowRole function.
*/
/*!
\fn void QXcbWindowFunctions::setWmWindowRole(QWindow *window, const QByteArray &role)
\since 5.6.2
Sets the WM_WINDOW_ROLE property from \role on the corresponding
X11 window.
This is a convenience function that can be used directly instead
of resolving the function pointer. \a window and \a role will be
relayed to the function retrieved by QGuiApplication.
*/
/*!
\typedef QXcbWindowFunctions::SetWmWindowIconText
This is the typedef for the function returned by
QGuiApplication::platformFunction when passed the
value returned by setWmWindowIconTextIdentifier().
*/
/*!
\fn const QByteArray QXcbWindowFunctions::setWmWindowIconTextIdentifier()
This function returns the byte array that can be used to query
QGuiApplication::platformFunction to retrieve the SetWmWindowIconText function.
*/
/*!
\fn void QXcbWindowFunctions::setWmWindowIconText(QWindow *window, const QString& text)
This is a convenience function that can be used directly instead
of resolving the function pointer. \a window and \a text will be
relayed to the function retrieved by QGuiApplication.
*/
/*!
\typedef QXcbWindowFunctions::SetParentRelativeBackPixmap
This is the typedef for the function returned by
QGuiApplication::platformFunction when passed the
value returned by setParentRelativeBackPixmapIdentifier().
*/
/*!
\fn const QByteArray QXcbWindowFunctions::setParentRelativeBackPixmapIdentifier()
This function returns the byte array that can be used to query
QGuiApplication::platformFunction to retrieve the SetParentRelativeBackPixmap function.
*/
/*!
\fn void QXcbWindowFunctions::setParentRelativeBackPixmap(const QWindow *window)
This is a convenience function that can be used directly instead
of resolving the function pointer. \a window will be
relayed to the function retrieved by QGuiApplication.
*/
/*!
\typedef QXcbWindowFunctions::RequestSystemTrayWindowDock
This is the typedef for the function returned by
QGuiApplication::platformFunction when passed the
value returned by requestSystemTrayWindowDockIdentifier().
*/
/*!
\fn const QByteArray QXcbWindowFunctions::requestSystemTrayWindowDockIdentifier()
This function returns the byte array that can be used to query
QGuiApplication::platformFunction to retrieve the RequestSystemTrayWindowDock function.
*/
/*!
\fn bool QXcbWindowFunctions::requestSystemTrayWindowDock(const QWindow *window)
This is a convenience function that can be used directly instead
of resolving the function pointer. \a window will be
relayed to the function retrieved by QGuiApplication.
Returns the boolean result of calling the function or false if the
function was not found.
*/
/*!
\typedef QXcbWindowFunctions::SystemTrayWindowGlobalGeometry
This is the typedef for the function returned by
QGuiApplication::platformFunction when passed the
value returned by systemTrayWindowGlobalGeometryIdentifier().
*/
/*!
\fn const QByteArray QXcbWindowFunctions::systemTrayWindowGlobalGeometryIdentifier()
This function returns the byte array that can be used to query
QGuiApplication::platformFunction to retrieve the SystemTrayWindowGlobalGeometry function.
*/
/*!
\fn QRect QXcbWindowFunctions::systemTrayWindowGlobalGeometry(const QWindow *window)
This is a convenience function that can be used directly instead
of resolving the function pointer. \a window will be
relayed to the function retrieved by QGuiApplication.
Returns the QRect result of calling the function or an empty
QRect if the function was not found.
*/
/*!
\typedef QXcbWindowFunctions::VisualId
This is the typedef for the function returned by
QGuiApplication::platformFunction when passed the
value returned by visualIdIdentifier().
*/
/*!
\fn const QByteArray QXcbWindowFunctions::visualIdIdentifier()
This function returns the byte array that can be used to query
QGuiApplication::platformFunction to retrieve the VisualId function.
*/
/*!
\fn uint QXcbWindowFunctions::visualId(QWindow *window)
This is a convenience function that can be used directly instead
of resolving the function pointer. \a window will be
relayed to the function retrieved by QGuiApplication.
Returns the unsigned integer result of calling the function or
UINT_MAX if the function was not found.
*/
|
