tabbox.h

Go to the documentation of this file.

/*
    KWin - the KDE window manager
    This file is part of the KDE project.
 
    SPDX-FileCopyrightText: 1999, 2000 Matthias Ettrich <ettrich@kde.org>
    SPDX-FileCopyrightText: 2003 Lubos Lunak <l.lunak@kde.org>
    SPDX-FileCopyrightText: 2009 Martin Gräßlin <mgraesslin@kde.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
 
#include "tabbox/tabboxhandler.h"
#include "utils/common.h"
#include <QKeySequence>
#include <QModelIndex>
#include <QTimer>
 
class KConfigGroup;
class KLazyLocalizedString;
class QAction;
class QMouseEvent;
class QKeyEvent;
class QWheelEvent;
 
namespace KWin
{
 
class Workspace;
class Window;
class X11EventFilter;
namespace TabBox
{
class TabBoxConfig;
class TabBox;
class TabBoxHandlerImpl : public TabBoxHandler
{
public:
    explicit TabBoxHandlerImpl(TabBox *tabBox);
    ~TabBoxHandlerImpl() override;
 
    int activeScreen() const override;
    Window *activeClient() const override;
    QString desktopName(Window *client) const override;
    bool isKWinCompositing() const override;
    Window *nextClientFocusChain(Window *client) const override;
    Window *firstClientFocusChain() const override;
    bool isInFocusChain(Window *client) const override;
    QList<Window *> stackingOrder() const override;
    void elevateClient(Window *c, QWindow *tabbox, bool elevate) const override;
    void raiseClient(Window *client) const override;
    void restack(Window *c, Window *under) override;
    void shadeClient(Window *c, bool b) const override;
    Window *clientToAddToList(Window *client) const override;
    Window *desktopClient() const override;
    void activateAndClose() override;
    void highlightWindows(Window *window = nullptr, QWindow *controller = nullptr) override;
    bool noModifierGrab() const override;
 
private:
    bool checkDesktop(Window *client) const;
    bool checkActivity(Window *client) const;
    bool checkApplications(Window *client) const;
    bool checkMinimized(Window *client) const;
    bool checkMultiScreen(Window *client) const;
 
    TabBox *m_tabBox;
};
 
class KWIN_EXPORT TabBox : public QObject
{
    Q_OBJECT
public:
    explicit TabBox();
    ~TabBox();
 
    Window *currentClient();
 
    QList<Window *> currentClientList();
 
    void setCurrentClient(Window *newClient);
 
    void setMode(TabBoxMode mode);
    TabBoxMode mode() const
    {
        return m_tabBoxMode;
    }
 
    void reset(bool partial_reset = false);
 
    void nextPrev(bool next = true);
 
    void delayedShow();
 
    void hide(bool abort = false);
 
    void reference()
    {
        ++m_displayRefcount;
    }
 
    void unreference()
    {
        --m_displayRefcount;
    }
 
    bool isDisplayed() const
    {
        return m_displayRefcount > 0;
    }
 
    bool isShown() const
    {
        return m_isShown;
    }
 
    bool handleMouseEvent(QMouseEvent *event);
    bool handleWheelEvent(QWheelEvent *event);
    void grabbedKeyEvent(QKeyEvent *event);
 
    bool isGrabbed() const
    {
        return m_tabGrab;
    }
 
    void initShortcuts();
 
    Window *nextClientStatic(Window *) const;
    Window *previousClientStatic(Window *) const;
    void keyPress(int key);
    void modifiersReleased();
 
    bool forcedGlobalMouseGrab() const
    {
        return m_forcedGlobalMouseGrab;
    }
 
    bool noModifierGrab() const
    {
        return m_noModifierGrab;
    }
    void setCurrentIndex(QModelIndex index, bool notifyEffects = true);
 
public Q_SLOTS:
    void show();
    void close(bool abort = false);
    void accept(bool closeTabBox = true);
    void slotWalkThroughWindows();
    void slotWalkBackThroughWindows();
    void slotWalkThroughWindowsAlternative();
    void slotWalkBackThroughWindowsAlternative();
    void slotWalkThroughCurrentAppWindows();
    void slotWalkBackThroughCurrentAppWindows();
    void slotWalkThroughCurrentAppWindowsAlternative();
    void slotWalkBackThroughCurrentAppWindowsAlternative();
 
    void handlerReady();
 
    bool toggle(ElectricBorder eb);
 
Q_SIGNALS:
    void tabBoxAdded(int);
    void tabBoxClosed();
    void tabBoxUpdated();
    void tabBoxKeyEvent(QKeyEvent *);
 
private:
    explicit TabBox(QObject *parent);
    void loadConfig(const KConfigGroup &config, TabBoxConfig &tabBoxConfig);
 
    bool startKDEWalkThroughWindows(TabBoxMode mode); // TabBoxWindowsMode | TabBoxWindowsAlternativeMode
    void navigatingThroughWindows(bool forward, const QKeySequence &shortcut, TabBoxMode mode); // TabBoxWindowsMode | TabBoxWindowsAlternativeMode
    void KDEWalkThroughWindows(bool forward);
    void CDEWalkThroughWindows(bool forward);
    void KDEOneStepThroughWindows(bool forward, TabBoxMode mode); // TabBoxWindowsMode | TabBoxWindowsAlternativeMode
    bool establishTabBoxGrab();
    void removeTabBoxGrab();
    template<typename Slot>
    void key(const KLazyLocalizedString &actionName, Slot slot, const QKeySequence &shortcut = QKeySequence());
 
    void shadeActivate(Window *c);
 
    bool toggleMode(TabBoxMode mode);
 
private Q_SLOTS:
    void reconfigure();
    void globalShortcutChanged(QAction *action, const QKeySequence &seq);
 
private:
    TabBoxMode m_tabBoxMode;
    TabBoxHandlerImpl *m_tabBox;
    int m_delayShowTime;
 
    QTimer m_delayedShowTimer;
    int m_displayRefcount;
 
    TabBoxConfig m_defaultConfig;
    TabBoxConfig m_alternativeConfig;
    TabBoxConfig m_defaultCurrentApplicationConfig;
    TabBoxConfig m_alternativeCurrentApplicationConfig;
    // false if an effect has referenced the tabbox
    // true if tabbox is active (independent on showTabbox setting)
    bool m_isShown;
    bool m_tabGrab;
    // true if tabbox is in modal mode which does not require holding a modifier
    bool m_noModifierGrab;
    QKeySequence m_cutWalkThroughWindows, m_cutWalkThroughWindowsReverse;
    QKeySequence m_cutWalkThroughWindowsAlternative, m_cutWalkThroughWindowsAlternativeReverse;
    QKeySequence m_cutWalkThroughCurrentAppWindows, m_cutWalkThroughCurrentAppWindowsReverse;
    QKeySequence m_cutWalkThroughCurrentAppWindowsAlternative, m_cutWalkThroughCurrentAppWindowsAlternativeReverse;
    bool m_forcedGlobalMouseGrab;
    bool m_ready; // indicates whether the config is completely loaded
    QList<ElectricBorder> m_borderActivate, m_borderAlternativeActivate;
    QHash<ElectricBorder, QAction *> m_touchActivate;
    QHash<ElectricBorder, QAction *> m_touchAlternativeActivate;
    std::unique_ptr<X11EventFilter> m_x11EventFilter;
};
 
} // namespace TabBox
} // namespace