Guidelines and HOWTOs/Wayland Porting Notes

This documents contains porting notes for Wayland. Even if you don't use the Plasma Wayland session as your daily driver, you can still test the behavior of your application on Wayland and fix the bugs. Check the KWin/Wayland wiki page and also this blog post by Martin, which contains general info about Wayland porting.

Popup Menus

Chances are that some popup menus of your application will be misplaced on Wayland. This is because the compositor needs to know how to relate the QMenu's window with the main window of the application. This is done by setting a transient parent window on the QMenu. The easiest way to do so is ensuring that the menu is created with a parent widget:

// Don't
auto menu = new QMenu;
menu->popup(somePos);
// Do
auto menu = new QMenu(someParentWidget);
menu->popup(somePos);

// Don't
QMenu::exec(someActions, somePos);
// Do
QMenu::exec(someActions, somePos, nullptr, someParentWidget);

Drop Menus

"Drop menus" are popup menus that are created because of a drag-and-drop event. On Wayland there is no global cursor position and QCursor::pos() only works by tracking the mouse move events. That's not 100% reliable, and in fact it won't work inside dropEvent() functions:

void SomeWidget::dropEvent(QDropEvent *event)
{
    auto menu = new QMenu(this);
    // Wrong. It will position the popup where the drag started, not where the drop happened.
    menu->popup(QCursor::pos());
    // Good.
    menu->popup(mapToGlobal(event->pos());
}

Embedding KParts

KXMLGui widgets can have "stand-alone" popup menus defined in the XML .rc file (i.e. <Menu> elements that are not children of other elements).

KXMLGui >= 5.35 has been fixed to use the QMainWindow of the application as parent of stand-alone menus. If your application is embedding a KPart widget, make sure you are not doing it wrong:

• Wrong: embed a part widget in a QDialog.
• Good: embed a part widget in a KParts::MainWindow and call createGUI() on the part.

Tooltips

Tooltips have the same problem of popup menus, as they also need a transient parent window. Text-only tooltips created by Qt are fine, but if your application is using custom tooltips that contain other widgets, you should port to KToolTipWidget.

Application Icon

On Wayland setWindowIcon() no longer works. This also means that currently is not possible to set a per-window icon (because the xdg-shell standard doesn't allow it). It is still possible to set the main application icon that will be shown in task managers and window decorations:

• The name of the application icon will be fetched from the .desktop file of the application.
• The name of the .desktop file must adhere to the reverse domain standard (e.g. org.kde.app.desktop).

Most of the KDE applications are already working fine because KAboutData takes care of all the necessary steps. If for some reason your application is not using KAboutData, you need to manually call QGuiApplication::setDesktopFileName().

Exec key of .desktop files

The Exec key of your .desktop file should not contain the %i "field code". Your application won't start on Wayland otherwise, because the specification expands that code in the --icon argument, which is accepted by QGuiApplication only on XCB platforms. This code review contains a discussion about the upstream decision. You can use the -qwindowicon argument as replacement. It still won't work on Wayland (it will on most other platforms) but now your app will start everywhere.

// Don't
Exec=someapp %i %U
// Do
Exec=someapp -qwindowicon someicon %U

QClipboard::mimeData()

QClipboard::mimeData() can return nullptr on Wayland, leading to crashes in code assuming that the mimeData pointer is always valid. Always check the validity of the pointer returned by QClipboard::mimeData().