abstract_client.h 8.75 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/********************************************************************
 KWin - the KDE window manager
 This file is part of the KDE project.

Copyright (C) 2015 Martin Gräßlin <mgraesslin@kde.org>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#ifndef KWIN_ABSTRACT_CLIENT_H
#define KWIN_ABSTRACT_CLIENT_H

#include "toplevel.h"
24
#include "options.h"
25
#include "rules.h"
26 27 28 29

namespace KWin
{

30 31
class TabGroup;

32 33 34 35 36 37 38 39
namespace TabBox
{
class TabBoxClientImpl;
}

class AbstractClient : public Toplevel
{
    Q_OBJECT
40 41 42 43 44
    /**
     * Whether this Client is the currently visible Client in its Client Group (Window Tabs).
     * For change connect to the visibleChanged signal on the Client's Group.
     **/
    Q_PROPERTY(bool isCurrentTab READ isCurrentTab)
45 46 47 48 49
    /**
     * Whether this Client is active or not. Use Workspace::activateClient() to activate a Client.
     * @see Workspace::activateClient
     **/
    Q_PROPERTY(bool active READ isActive NOTIFY activeChanged)
50 51 52 53
    /**
     * Whether the Client should be excluded from window switching effects.
     **/
    Q_PROPERTY(bool skipSwitcher READ skipSwitcher WRITE setSkipSwitcher NOTIFY skipSwitcherChanged)
54 55 56 57 58
    /**
     * Whether the window can be closed by the user. The value is evaluated each time the getter is called.
     * Because of that no changed signal is provided.
     **/
    Q_PROPERTY(bool closeable READ isCloseable)
59
    Q_PROPERTY(QIcon icon READ icon NOTIFY iconChanged)
60 61 62
public:
    virtual ~AbstractClient();

63 64 65
    QWeakPointer<TabBox::TabBoxClientImpl> tabBoxClient() const {
        return m_tabBoxClient.toWeakRef();
    }
66 67 68
    bool isFirstInTabBox() const {
        return m_firstInTabBox;
    }
69 70 71 72
    bool skipSwitcher() const {
        return m_skipSwitcher;
    }
    void setSkipSwitcher(bool set);
73

74 75 76 77
    const QIcon &icon() const {
        return m_icon;
    }

78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
    bool isActive() const {
        return m_active;
    }
    /**
     * Sets the client's active state to \a act.
     *
     * This function does only change the visual appearance of the client,
     * it does not change the focus setting. Use
     * Workspace::activateClient() or Workspace::requestFocus() instead.
     *
     * If a client receives or looses the focus, it calls setActive() on
     * its own.
     **/
    void setActive(bool);

93 94 95 96 97 98 99 100
    virtual void updateMouseGrab();
    virtual QString caption(bool full = true, bool stripped = false) const = 0;
    virtual bool isMinimized() const = 0;
    virtual bool isCloseable() const = 0;
    // TODO: remove boolean trap
    virtual bool isShown(bool shaded_is_shown) const = 0;
    virtual bool wantsTabFocus() const = 0;
    virtual bool isFullScreen() const = 0;
101 102
    // TODO: remove boolean trap
    virtual AbstractClient *findModal(bool allow_itself = false) = 0;
103 104 105 106 107 108 109 110 111
    virtual void cancelAutoRaise() = 0;
    virtual bool isTransient() const;
    /**
     * Returns true for "special" windows and false for windows which are "normal"
     * (normal=window which has a border, can be moved by the user, can be closed, etc.)
     * true for Desktop, Dock, Splash, Override and TopMenu (and Toolbar??? - for now)
     * false for Normal, Dialog, Utility and Menu (and Toolbar??? - not yet) TODO
     */
    virtual bool isSpecialWindow() const = 0;
112
    virtual void sendToScreen(int screen) = 0;
113 114
    virtual const QKeySequence &shortcut() const  = 0;
    virtual void setShortcut(const QString &cut) = 0;
115 116
    virtual bool performMouseCommand(Options::MouseCommand, const QPoint &globalPos) = 0;
    virtual void setOnAllDesktops(bool set) = 0;
117
    virtual void setDesktop(int) = 0;
118
    virtual void minimize(bool avoid_animation = false) = 0;
119
    virtual void unminimize(bool avoid_animation = false)= 0;
120 121 122 123 124 125 126
    virtual void setFullScreen(bool set, bool user = true) = 0;
    virtual bool keepAbove() const = 0;
    virtual void setKeepAbove(bool) = 0;
    virtual bool keepBelow() const = 0;
    virtual void setKeepBelow(bool) = 0;
    virtual TabGroup *tabGroup() const;
    Q_INVOKABLE virtual bool untab(const QRect &toGeometry = QRect(), bool clientRemoved = false);
127
    virtual bool isCurrentTab() const;
128 129 130 131
    virtual MaximizeMode maximizeMode() const = 0;
    virtual void maximize(MaximizeMode) = 0;
    virtual bool noBorder() const = 0;
    virtual void setNoBorder(bool set) = 0;
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
    virtual void blockActivityUpdates(bool b = true) = 0;
    virtual QPalette palette() const = 0;
    virtual bool isResizable() const = 0;
    virtual bool isMovable() const = 0;
    virtual bool isMovableAcrossScreens() const = 0;
    virtual bool isShade() const = 0; // True only for ShadeNormal
    virtual ShadeMode shadeMode() const = 0; // Prefer isShade()
    virtual void setShade(bool set) = 0;
    virtual void setShade(ShadeMode mode) = 0;
    virtual bool isShadeable() const = 0;
    virtual bool isMaximizable() const = 0;
    virtual bool isMinimizable() const = 0;
    virtual bool userCanSetFullScreen() const = 0;
    virtual bool userCanSetNoBorder() const = 0;
    virtual void setOnAllActivities(bool set) = 0;
147
    virtual const WindowRules* rules() const = 0;
148 149
    virtual void takeFocus() = 0;
    virtual bool wantsInput() const = 0;
150
    virtual void checkWorkspacePosition(QRect oldGeometry = QRect(), int oldDesktop = -2) = 0;
151
    virtual xcb_timestamp_t userTime() const;
152
    virtual void demandAttention(bool set = true) = 0;
153
    virtual void updateWindowRules(Rules::Types selection) = 0;
154

155 156 157 158 159
    virtual void growHorizontal();
    virtual void shrinkHorizontal();
    virtual void growVertical();
    virtual void shrinkVertical();

160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
    /**
     * These values represent positions inside an area
     */
    enum Position {
        // without prefix, they'd conflict with Qt::TopLeftCorner etc. :(
        PositionCenter         = 0x00,
        PositionLeft           = 0x01,
        PositionRight          = 0x02,
        PositionTop            = 0x04,
        PositionBottom         = 0x08,
        PositionTopLeft        = PositionLeft | PositionTop,
        PositionTopRight       = PositionRight | PositionTop,
        PositionBottomLeft     = PositionLeft | PositionBottom,
        PositionBottomRight    = PositionRight | PositionBottom
    };
    virtual Position titlebarPosition() const = 0;

177 178 179
    // a helper for the workspace window packing. tests for screen validity and updates since in maximization case as with normal moving
    virtual void packTo(int left, int top);

180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
    enum QuickTileFlag {
        QuickTileNone = 0,
        QuickTileLeft = 1,
        QuickTileRight = 1<<1,
        QuickTileTop = 1<<2,
        QuickTileBottom = 1<<3,
        QuickTileHorizontal = QuickTileLeft|QuickTileRight,
        QuickTileVertical = QuickTileTop|QuickTileBottom,
        QuickTileMaximize = QuickTileLeft|QuickTileRight|QuickTileTop|QuickTileBottom
    };
    Q_DECLARE_FLAGS(QuickTileMode, QuickTileFlag)
    /** Set the quick tile mode ("snap") of this window.
     * This will also handle preserving and restoring of window geometry as necessary.
     * @param mode The tile mode (left/right) to give this window.
     */
    virtual void setQuickTileMode(QuickTileMode mode, bool keyboard = false) = 0;
196
    virtual void updateLayer();
197

198 199 200 201 202 203
    // TODO: remove boolean trap
    static bool belongToSameApplication(const AbstractClient* c1, const AbstractClient* c2, bool active_hack = false);

public Q_SLOTS:
    virtual void closeWindow() = 0;

204 205
Q_SIGNALS:
    void skipSwitcherChanged();
206
    void iconChanged();
207
    void activeChanged();
208

209 210
protected:
    AbstractClient();
211 212 213
    void setFirstInTabBox(bool enable) {
        m_firstInTabBox = enable;
    }
214
    void setIcon(const QIcon &icon);
215 216 217 218 219 220 221
    /**
     * Called from ::setActive once the active value got updated, but before the changed signal
     * is emitted.
     *
     * Default implementation does nothing.
     **/
    virtual void doSetActive();
222 223
    // TODO: remove boolean trap
    virtual bool belongsToSameApplication(const AbstractClient *other, bool active_hack) const = 0;
224 225 226

private:
    QSharedPointer<TabBox::TabBoxClientImpl> m_tabBoxClient;
227
    bool m_firstInTabBox = false;
228
    bool m_skipSwitcher = false;
229
    QIcon m_icon;
230
    bool m_active = false;
231 232 233 234 235 236
};

}

Q_DECLARE_METATYPE(KWin::AbstractClient*)
Q_DECLARE_METATYPE(QList<KWin::AbstractClient*>)
237
Q_DECLARE_OPERATORS_FOR_FLAGS(KWin::AbstractClient::QuickTileMode)
238 239

#endif