tabboxconfig.h

Go to the documentation of this file.

/*
    KWin - the KDE window manager
    This file is part of the KDE project.
 
    SPDX-FileCopyrightText: 2009 Martin Gräßlin <mgraesslin@kde.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
 
#include <QString>
 
namespace KWin
{
namespace TabBox
{
class TabBoxConfigPrivate;
 
class TabBoxConfig
{
public:
    enum ClientDesktopMode {
        AllDesktopsClients, 
        OnlyCurrentDesktopClients, 
        ExcludeCurrentDesktopClients 
    };
    enum ClientActivitiesMode {
        AllActivitiesClients, 
        OnlyCurrentActivityClients, 
        ExcludeCurrentActivityClients 
    };
    enum ClientApplicationsMode {
        AllWindowsAllApplications, 
        OneWindowPerApplication, 
        AllWindowsCurrentApplication 
    };
    enum ClientMinimizedMode {
        IgnoreMinimizedStatus, 
        ExcludeMinimizedClients, 
        OnlyMinimizedClients 
    };
    enum ShowDesktopMode {
        DoNotShowDesktopClient, 
        ShowDesktopClient 
    };
    enum OrderMinimizedMode {
        NoGroupByMinimized, 
        GroupByMinimized 
    };
    enum ClientMultiScreenMode {
        IgnoreMultiScreen, 
        OnlyCurrentScreenClients, 
        ExcludeCurrentScreenClients 
    };
    enum ClientSwitchingMode {
        FocusChainSwitching, 
        StackingOrderSwitching 
    };
    TabBoxConfig();
    ~TabBoxConfig();
    TabBoxConfig &operator=(const TabBoxConfig &object);
 
    // getters
    bool isShowTabBox() const;
    bool isHighlightWindows() const;
    ClientDesktopMode clientDesktopMode() const;
    ClientActivitiesMode clientActivitiesMode() const;
    ClientApplicationsMode clientApplicationsMode() const;
    OrderMinimizedMode orderMinimizedMode() const;
    ClientMinimizedMode clientMinimizedMode() const;
    ShowDesktopMode showDesktopMode() const;
    ClientMultiScreenMode clientMultiScreenMode() const;
    ClientSwitchingMode clientSwitchingMode() const;
    QString &layoutName() const;
 
    // setters
    void setShowTabBox(bool show);
    void setHighlightWindows(bool highlight);
    void setClientDesktopMode(ClientDesktopMode desktopMode);
    void setClientActivitiesMode(ClientActivitiesMode activitiesMode);
    void setClientApplicationsMode(ClientApplicationsMode applicationsMode);
    void setOrderMinimizedMode(OrderMinimizedMode orderMinimizedMode);
    void setClientMinimizedMode(ClientMinimizedMode minimizedMode);
    void setShowDesktopMode(ShowDesktopMode showDesktopMode);
    void setClientMultiScreenMode(ClientMultiScreenMode multiScreenMode);
    void setClientSwitchingMode(ClientSwitchingMode switchingMode);
    void setLayoutName(const QString &name);
 
    // some static methods to access default values
    static ClientDesktopMode defaultDesktopMode()
    {
        return OnlyCurrentDesktopClients;
    }
    static ClientActivitiesMode defaultActivitiesMode()
    {
        return OnlyCurrentActivityClients;
    }
    static ClientApplicationsMode defaultApplicationsMode()
    {
        return AllWindowsAllApplications;
    }
    static OrderMinimizedMode defaultOrderMinimizedMode()
    {
        return NoGroupByMinimized;
    }
    static ClientMinimizedMode defaultMinimizedMode()
    {
        return IgnoreMinimizedStatus;
    }
    static ShowDesktopMode defaultShowDesktopMode()
    {
        return DoNotShowDesktopClient;
    }
    static ClientMultiScreenMode defaultMultiScreenMode()
    {
        return IgnoreMultiScreen;
    }
    static ClientSwitchingMode defaultSwitchingMode()
    {
        return FocusChainSwitching;
    }
    static bool defaultShowTabBox()
    {
        return true;
    }
    static bool defaultHighlightWindow()
    {
        return true;
    }
    static QString defaultLayoutName()
    {
        return QStringLiteral("thumbnail_grid");
    }
 
private:
    TabBoxConfigPrivate *d;
};
 
} // namespace TabBox
} // namespace KWin