focuschain.h

Go to the documentation of this file.

/*
    KWin - the KDE window manager
    This file is part of the KDE project.
 
    SPDX-FileCopyrightText: 2012 Martin Gräßlin <mgraesslin@kde.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
#pragma once
// KWin
#include "effect/globals.h"
// Qt
#include <QHash>
#include <QObject>
 
namespace KWin
{
// forward declarations
class Window;
class Output;
class VirtualDesktop;
 
class FocusChain : public QObject
{
    Q_OBJECT
public:
    enum Change {
        MakeFirst,
        MakeLast,
        Update,
        MakeFirstMinimized = MakeFirst
    };
    explicit FocusChain() = default;
 
    void update(Window *window, Change change);
    void moveAfterWindow(Window *window, Window *reference);
    Window *getForActivation(VirtualDesktop *desktop) const;
    Window *getForActivation(VirtualDesktop *desktop, Output *output) const;
 
    bool contains(Window *window) const;
    bool contains(Window *window, VirtualDesktop *desktop) const;
    Window *nextMostRecentlyUsed(Window *reference) const;
    Window *nextForDesktop(Window *reference, VirtualDesktop *desktop) const;
    Window *firstMostRecentlyUsed() const;
 
    bool isUsableFocusCandidate(Window *window, Window *prev) const;
 
public Q_SLOTS:
    void remove(KWin::Window *window);
    void setSeparateScreenFocus(bool enabled);
    void setActiveWindow(KWin::Window *window);
    void setCurrentDesktop(VirtualDesktop *desktop);
    void addDesktop(VirtualDesktop *desktop);
    void removeDesktop(VirtualDesktop *desktop);
 
private:
    using Chain = QList<Window *>;
    void makeFirstInChain(Window *window, Chain &chain);
    void makeLastInChain(Window *window, Chain &chain);
    void moveAfterWindowInChain(Window *window, Window *reference, Chain &chain);
    void updateWindowInChain(Window *window, Change change, Chain &chain);
    void insertWindowIntoChain(Window *window, Chain &chain);
    Chain m_mostRecentlyUsed;
    QHash<VirtualDesktop *, Chain> m_desktopFocusChains;
    bool m_separateScreenFocus = false;
    Window *m_activeWindow = nullptr;
    VirtualDesktop *m_currentDesktop = nullptr;
};
 
inline bool FocusChain::contains(Window *window) const
{
    return m_mostRecentlyUsed.contains(window);
}
 
inline void FocusChain::setSeparateScreenFocus(bool enabled)
{
    m_separateScreenFocus = enabled;
}
 
inline void FocusChain::setActiveWindow(Window *window)
{
    m_activeWindow = window;
}
 
inline void FocusChain::setCurrentDesktop(VirtualDesktop *desktop)
{
    m_currentDesktop = desktop;
}
 
} // namespace