QWidget *widget = new QWidget(nullptr);
widget->show(); // ensures native window gets created
connect(KX11Extras::self(), &KX11Extras::KWindowSystem::windowChanged,
       [window](WId id, NET::Properties properties, NET::Properties2 properties2) {
    if (widget->winId() != winId) {
        return; // not our window
    }
    if (properties & NET::WMState) {
        // let's check whether our window is demanding attention
        KWindowInfo info(widget->winId(), NET::WMState);
        qDebug() << "Has demands attention: " << info.hasState(NET::DemandsAttention);
    }
});

Member Function Documentation

KWindowInfo::KWindowInfo(WId window, NET::Properties properties, NET::Properties2 properties2 = NET::Properties2())

Reads all the info about the given window.

Only the information requested through the properties and properties2 parameters are fetched. Refer to the methods you are interested in to see which flags to pass.

properties Bitmask of NET::Property

properties2 Bitmask of NET::Property2

bool KWindowInfo::actionSupported(NET::Action action) const

Returns true if the given action is currently supported for the window.

The supported actions are set by the window manager and can differ depending on the window manager. Requires NET::WM2AllowedActions passed as properties2 parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), 0, NET::WM2AllowedActions);
if (info.valid())
    info.actionSupported(NET::ActionClose);

[since 5.0] QStringList KWindowInfo::activities() const

Returns the list of activity UUIDs this window belongs to.

The Plasma workspace allows the user to separate its work into different activities, by assigning windows, documents etc. to the specific ones. An activity is an abstract concept whose meaning can differ from one user to another. Typical examples of activities are "developing a KDE project", "studying the 19th century art", "composing music", "lazing on a Sunday afternoon" etc.

If the list is empty, or contains a null UUID, the window is on all activities.

Requires NET::WM2Activities passed as properties parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), 0, NET::WM2Activities);
if (info.valid())
    info.desktop();

This function was introduced in 5.0.

[since 5.69] QByteArray KWindowInfo::applicationMenuObjectPath() const

Returns object path of a window's application menu if present.

Requires NET::WMPid passed as properties parameter to the constructor.

This function was introduced in 5.69.

[since 5.69] QByteArray KWindowInfo::applicationMenuServiceName() const

Returns service name of a window's application menu if present.

Requires NET::WMPid passed as properties parameter to the constructor.

This function was introduced in 5.69.

QByteArray KWindowInfo::clientMachine() const

Returns the WM_CLIENT_MACHINE property for the window.

Requires NET::WM2ClientMachine passed as properties2 parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), 0, NET::WM2ClientMachine);
if (info.valid())
    info.clientMachine();

int KWindowInfo::desktop() const

Returns the virtual desktop this window is on.

If the window is on all desktops NET::OnAllDesktops is returned. You should prefer using isOnDesktop(). Requires NET::WMDesktop passed as properties parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), NET::WMDesktop);
if (info.valid())
    info.desktop();

See also isOnDesktop().

[since 5.29] QByteArray KWindowInfo::desktopFileName() const

Returns the desktop file name of the window's application if present.

This is either the base name without full path and without file extension of the desktop file for the window's application (e.g. "org.kde.foo").

If the application's desktop file name is not at a standard location it should be the full path to the desktop file name (e.g. "/opt/kde/share/org.kde.foo.desktop").

Requires NET::WM2DesktopFileName passed as properties2 parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), 0, NET::WM2DesktopFileName);
if (info.valid())
    info.desktopFileName();

This function was introduced in 5.29.

NETExtendedStrut KWindowInfo::extendedStrut() const

Returns the window extended (partial) strut.

Requires NET::WM2ExtendedStrut passed as properties2 parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), 0, NET::WM2ExtendedStrut);
if (info.valid())
    info.extendedStrut();

QRect KWindowInfo::frameGeometry() const

Returns the frame geometry of the window, i.e. including the window decoration.

Requires NET::WMFrameExtents passed as properties parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), NET::WMFrameExtents);
if (info.valid())
    info.frameGeometry();

QRect KWindowInfo::geometry() const

Returns the position and size of the window contents.

Requires NET::WMGeometry passed as properties parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), NET::WMGeometry);
if (info.valid())
    info.geometry();

WId KWindowInfo::groupLeader() const

Returns the leader window for the group the window is in, if any.

Requires NET::WM2GroupLeader passed as properties2 parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), 0, NET::WM2GroupLeader);
if (info.valid())
    info.groupLeader();

[since 5.91] QByteArray KWindowInfo::gtkApplicationId() const

Returns the GTK application id of the window if present.

This is comparable to desktopFileName.

Requires NET::WM2GTKApplicationId passed as properties2 parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), 0, NET::WM2GTKApplicationId);
if (info.valid())
    info.gtkApplicationId();

This function was introduced in 5.91.

bool KWindowInfo::hasState(NET::States s) const

Returns true if the window has the given state flag s set.

Requires NET::WMState passed as properties parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), NET::WMState);
if (info.valid())
    info.hasState(NET::DemandsAttention);

See also NET::State.

QString KWindowInfo::iconName() const

Returns the name of the window that should be shown in taskbar.

Note that this has nothing to do with normal icons but with an "iconic" representation of the window. Requires NET::WMIconName passed as properties parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), NET::WMIconName);
if (info.valid())
    info.iconName();

bool KWindowInfo::isMinimized() const

Returns true if the window is minimized.

Note that it is true only if the window is truly minimized, not shaded or on another virtual desktops, which makes it different from mappingState() == NET::Iconic or QWidget::isMinimized(). Requires NET::WMState and NET::XAWMState passed as properties parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), NET::WMState | NET::XAWMState);
if (info.valid())
    info.isMinimized();

bool KWindowInfo::isOnCurrentDesktop() const

Returns true if the window is on the currently active virtual desktop.

Requires NET::WMDesktop passed as properties parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), NET::WMDesktop);
if (info.valid())
    info.isOnCurrentDesktop();

bool KWindowInfo::isOnDesktop(int desktop) const

Returns true if the window is on the given virtual desktop.

Requires NET::WMDesktop passed as properties parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), NET::WMDesktop);
if (info.valid())
    info.isOnDesktop(KWindowSystem::currentDesktop());

NET::MappingState KWindowInfo::mappingState() const

Returns the mapping state of the window.

Note that it's very likely that you don't want to use this function, and use isOnDesktop(), isMinimized() etc. instead. Requires NET::XAWMState passed as properties parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), NET::XAWMState);
if (info.valid())
    info.mappingState();

See also NET::MappingState, isOnDesktop(), and isMinimzed().

QString KWindowInfo::name() const

Returns the name of the window, as specified by the application.

The difference to visibleName() is that this is the name provided by the application without any modifications by the window manager. You should often use visibleName() instead. Requires NET::WMName passed as properties parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), NET::WMName);
if (info.valid())
    info.name();

See also visibleName().

bool KWindowInfo::onAllDesktops() const

Returns true if the window is on all desktops.

A window is on all desktops if desktop() returns NET::OnAllDesktops. Requires NET::WMDesktop passed as properties parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), NET::WMDesktop);
if (info.valid())
    info.onAllDesktops();

See also desktop().

[since 5.29] int KWindowInfo::pid() const

Returns the process ID of the window's application if present.

Requires NET::WMPid passed as properties parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), NET::WMPid);
if (info.valid())
    info.pid();

This function was introduced in 5.29.

NET::States KWindowInfo::state() const

Returns the window's state flags.

Requires NET::WMState passed as properties parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), NET::WMState);
if (info.valid())
    info.state();

See also NET::State.

WId KWindowInfo::transientFor() const

Returns the window identifier of the main window this window belongs to.

This is the value of the WM_TRANSIENT_FOR X11 property.

Requires NET::WM2TransientFor passed as properties2 parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), 0, NET::WM2TransientFor);
if (info.valid())
    info.transientFor();

bool KWindowInfo::valid(bool withdrawn_is_valid = false) const

Returns false if this window info is not valid.

In case the window does not exist false is returned.

withdrawn_is_valid If true, windows in the withdrawn state (i.e. not managed) are also considered. This is usually not the case.

QString KWindowInfo::visibleIconName() const

Returns the visible name of the window that should be shown in a taskbar.

Note that this has nothing to do with normal icons but with an "iconic" representation of the window. Requires NET::WMVisibleIconName passed as properties parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), NET::WMVisibleIconName);
if (info.valid())
    info.visibleIconName();

QString KWindowInfo::visibleIconNameWithState() const

Returns a visible icon name with state.

This is a simple convenience function that returns the visible iconic name but with parentheses around minimized windows. Note that this has nothing to do with normal icons. Requires NET::WMVisibleIconName, NET::WMState and NET::XAWMState passed as properties parameter to the constructor. Returns the window iconic name with state

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), NET::WMVisibleIconName | NET::WMState | NET::XAWMState);
if (info.valid())
    info.visibleIconNameWithState();

See also visibleIconName().

QString KWindowInfo::visibleName() const

Returns the visible name of the window.

The visible name differs from the name by including possible <2> appended when there are two or more windows with the same name. Requires NET::WMVisibleName passed as properties parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), NET::WMVisibleName);
if (info.valid())
    info.visibleName();

See also name().

QString KWindowInfo::visibleNameWithState() const

Returns a visible name with state.

This is a simple convenience function that returns the visible name but with parentheses around minimized windows. Requires NET::WMVisibleName, NET::WMState and NET::XAWMState passed as properties parameter to the constructor. Returns the window name with state

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), NET::WMVisibleName | NET::WMState | NET::XAWMState);
if (info.valid())
    info.visibleNameWithState();

See also visibleName().

WId KWindowInfo::win() const

Returns the window identifier.

QByteArray KWindowInfo::windowClassClass() const

Returns the class component of the WM_CLASS X11 property for the window.

Requires NET::WM2WindowClass passed as properties2 parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), 0, NET::WM2WindowClass);
if (info.valid())
    info.windowClassClass();

QByteArray KWindowInfo::windowClassName() const

Returns the name component of the WM_CLASS X11 property for the window.

Requires NET::WM2WindowClass passed as properties2 parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), 0, NET::WM2WindowClass);
if (info.valid())
    info.windowClassName();

QByteArray KWindowInfo::windowRole() const

Returns the WM_WINDOW_ROLE X11 property for the window.

Requires NET::WM2WindowRole passed as properties2 parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), 0, NET::WM2WindowRole);
if (info.valid())
    info.windowRole();

NET::WindowType KWindowInfo::windowType(NET::WindowTypes supported_types) const

Returns the window type of this window.

The argument should be all window supported_types your application supports. Requires NET::WMWindowType passed as properties parameter to the constructor.

QWidget *window = new QWidget(nullptr);
window->show();
KWindowInfo info(window->winId(), NET::WMWindowType);
if (info.valid())
    info.windowType(NET::NormalMask | NET::DialogMask);

See also NET::WindowType and NET::WindowTypeMask.