Back to Qt.io
Contact Us Blog Download Qt

QXcbWindowFunctions Class

The QXcbWindowFunctions class is an inline class containing miscellaneous functionality for xcb window specific functionality. More...

Header: #include <QXcbWindowFunctions>

Public Types

typedef SetWmWindowIconText
typedef SetWmWindowRole
typedef SetWmWindowType
typedef VisualId
enum WmWindowType { Normal, Desktop, Dock, Toolbar, Menu, …, KdeOverride }
flags WmWindowTypes

Static Public Members

void setWmWindowIconText(QWindow *window, const QString &text)
const QByteArray setWmWindowIconTextIdentifier()
void setWmWindowRole(QWindow *window, const QByteArray &role)
const QByteArray setWmWindowRoleIdentifier()
void setWmWindowType(QWindow *window, QXcbWindowFunctions::WmWindowType type)
const QByteArray setWmWindowTypeIdentifier()
uint visualId(QWindow *window)
const QByteArray visualIdIdentifier()

Detailed Description

A common usage pattern is as follows:

int main(int argc, char **argv)
{
    QApplication app(argc, argv);

    QPushButton topLevelWidget("Hello World!");
    topLevelWidget.winId(); //have to create the QWindow

    QWindow *tlwWindow = topLevelWidget.windowHandle();

    QXcbWindowFunctions::setWmWindowType(tlwWindow, QXcbWindowFunctions::Dock);

    topLevelWidget.show();

    return app.exec();
}

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.

Member Type Documentation

typedef QXcbWindowFunctions::SetWmWindowIconText

This is the typedef for the function returned by QGuiApplication::platformFunction when passed the value returned by setWmWindowIconTextIdentifier().

typedef QXcbWindowFunctions::SetWmWindowRole

This is the typedef for the function returned by QGuiApplication::platformFunction when passed the value returned by setWmWindowRoleIdentifier().

This typedef was introduced in Qt 5.6.2.

typedef QXcbWindowFunctions::SetWmWindowType

This is the typedef for the function returned by QGuiApplication::platformFunction when passed the value returned by setWmWindowTypeIdentifier().

typedef QXcbWindowFunctions::VisualId

This is the typedef for the function returned by QGuiApplication::platformFunction when passed the value returned by visualIdIdentifier().

enum QXcbWindowFunctions::WmWindowType
flags QXcbWindowFunctions::WmWindowTypes

This enum represents the supported WM_WINDOW_TYPE atoms.

ConstantValue
QXcbWindowFunctions::Normal0x000001
QXcbWindowFunctions::Desktop0x000002
QXcbWindowFunctions::Dock0x000004
QXcbWindowFunctions::Toolbar0x000008
QXcbWindowFunctions::Menu0x000010
QXcbWindowFunctions::Utility0x000020
QXcbWindowFunctions::Splash0x000040
QXcbWindowFunctions::Dialog0x000080
QXcbWindowFunctions::DropDownMenu0x000100
QXcbWindowFunctions::PopupMenu0x000200
QXcbWindowFunctions::Tooltip0x000400
QXcbWindowFunctions::Notification0x000800
QXcbWindowFunctions::Combo0x001000
QXcbWindowFunctions::Dnd0x002000
QXcbWindowFunctions::KdeOverride0x004000

The WmWindowTypes type is a typedef for QFlags<WmWindowType>. It stores an OR combination of WmWindowType values.

Member Function Documentation

[static] void QXcbWindowFunctions::setWmWindowIconText(QWindow *window, const QString &text)

This is a convenience function that can be used directly instead of resolving the function pointer. window and text will be relayed to the function retrieved by QGuiApplication.

[static] const QByteArray QXcbWindowFunctions::setWmWindowIconTextIdentifier()

This function returns the byte array that can be used to query QGuiApplication::platformFunction to retrieve the SetWmWindowIconText function.

[static] void QXcbWindowFunctions::setWmWindowRole(QWindow *window, const QByteArray &role)

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. window and role will be relayed to the function retrieved by QGuiApplication.

This function was introduced in Qt 5.6.2.

[static] const QByteArray QXcbWindowFunctions::setWmWindowRoleIdentifier()

This function returns the byte array that can be used to query QGuiApplication::platformFunction to retrieve the SetWmWindowRole function.

This function was introduced in Qt 5.6.2.

[static] void QXcbWindowFunctions::setWmWindowType(QWindow *window, QXcbWindowFunctions::WmWindowType type)

This is a convenience function that can be used directly instead of resolving the function pointer. window and type will be relayed to the function retrieved by QGuiApplication.

[static] const QByteArray QXcbWindowFunctions::setWmWindowTypeIdentifier()

This function returns the byte array that can be used to query QGuiApplication::platformFunction to retrieve the SetWmWindowType function.

[static] uint QXcbWindowFunctions::visualId(QWindow *window)

This is a convenience function that can be used directly instead of resolving the function pointer. 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.

[static] const QByteArray QXcbWindowFunctions::visualIdIdentifier()

This function returns the byte array that can be used to query QGuiApplication::platformFunction to retrieve the VisualId function.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.