Qt 5.11 | Qt Platform Headers | C++ Classes | QXcbWindowFunctions

Qt 5.11.3 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 | RequestSystemTrayWindowDock
typedef | SetParentRelativeBackPixmap
typedef | SetWmWindowIconText
typedef | SetWmWindowRole
typedef | SetWmWindowType
typedef | SystemTrayWindowGlobalGeometry
typedef | VisualId
enum | WmWindowType { Normal, Desktop, Dock, Toolbar, ..., KdeOverride }
flags | WmWindowTypes

## Static Public Members

bool | requestSystemTrayWindowDock(const QWindow *window)
const QByteArray | requestSystemTrayWindowDockIdentifier()
void | setParentRelativeBackPixmap(const QWindow *window)
const QByteArray | setParentRelativeBackPixmapIdentifier()
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()
QRect | systemTrayWindowGlobalGeometry(const QWindow *window)
const QByteArray | systemTrayWindowGlobalGeometryIdentifier()
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::RequestSystemTrayWindowDock

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

### typedef QXcbWindowFunctions::SetParentRelativeBackPixmap

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

### 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::SystemTrayWindowGlobalGeometry

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

### 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.

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]` bool QXcbWindowFunctions::requestSystemTrayWindowDock(const 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 boolean result of calling the function or false if the function was not found.

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

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

### `[static]` void QXcbWindowFunctions::setParentRelativeBackPixmap(const 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.

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

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

### `[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]` QRect QXcbWindowFunctions::systemTrayWindowGlobalGeometry(const 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 QRect result of calling the function or an empty QRect if the function was not found.

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

This function returns the byte array that can be used to query QGuiApplication::platformFunction to retrieve the SystemTrayWindowGlobalGeometry 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.