- Qt 5.5
- Qt Platform Headers
- C++ Classes
- QXcbWindowFunctions
- Qt 5.5.1 Reference Documentation

# QXcbWindowFunctions Class

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

Header: | #include <QXcbWindowFunctions>

- List of all members, including inherited members

## Public Types

typedef | SetWmWindowType
typedef | VisualId
enum | WmWindowType { Normal, Desktop, Dock, Toolbar, ..., KdeOverride }
flags | WmWindowTypes

## Static Public Members

void | setWmWindowType(QWindow * window, WmWindowType type)
const QByteArray | setWmWindowTypeIdentifier()
uint | visualId(QWindow * window)
const QByteArray | visualIdIdentifier()

## Detailed Description

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

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::SetWmWindowType

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

### typedef QXcbWindowFunctions::VisualId

### enum QXcbWindowFunctions::WmWindowType
flags QXcbWindowFunctions::WmWindowTypes

This enum represents the supported WM_WINDOW_TYPE atoms.

Constant | Value
--- | ---
`QXcbWindowFunctions::Normal` | `0x000001`
`QXcbWindowFunctions::Desktop` | `0x000002`
`QXcbWindowFunctions::Dock` | `0x000004`
`QXcbWindowFunctions::Toolbar` | `0x000008`
`QXcbWindowFunctions::Menu` | `0x000010`
`QXcbWindowFunctions::Utility` | `0x000020`
`QXcbWindowFunctions::Splash` | `0x000040`
`QXcbWindowFunctions::Dialog` | `0x000080`
`QXcbWindowFunctions::DropDownMenu` | `0x000100`
`QXcbWindowFunctions::PopupMenu` | `0x000200`
`QXcbWindowFunctions::Tooltip` | `0x000400`
`QXcbWindowFunctions::Notification` | `0x000800`
`QXcbWindowFunctions::Combo` | `0x001000`
`QXcbWindowFunctions::Dnd` | `0x002000`
`QXcbWindowFunctions::KdeOverride` | `0x004000`

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

## Member Function Documentation

### `[static]` void QXcbWindowFunctions::setWmWindowType(QWindow * window, 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)

### `[static]` const QByteArray QXcbWindowFunctions::visualIdIdentifier()