kwin/effects/slidingpopups/slidingpopups.h

/********************************************************************
 KWin - the KDE window manager
 This file is part of the KDE project.

Copyright (C) 2009 Marco Martin notmart@gmail.com

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_SLIDINGPOPUPS_H
#define KWIN_SLIDINGPOPUPS_H

// Include with base class for effects.
#include <kwineffects.h>

namespace KWin
{

class SlidingPopupsEffect
    : public Effect
{
    Q_OBJECT
    Q_PROPERTY(int fadeInTime READ fadeInTime)
    Q_PROPERTY(int fadeOutTime READ fadeOutTime)
public:
    SlidingPopupsEffect();
    ~SlidingPopupsEffect();
    virtual void prePaintScreen(ScreenPrePaintData& data, int time);
    virtual void prePaintWindow(EffectWindow* w, WindowPrePaintData& data, int time);
    virtual void paintWindow(EffectWindow* w, int mask, QRegion region, WindowPaintData& data);
    virtual void postPaintWindow(EffectWindow* w);
    virtual void reconfigure(ReconfigureFlags flags);
    virtual bool isActive() const;

    int requestedEffectChainPosition() const override {
        return 40;
    }

    static bool supported();

    // TODO react also on virtual desktop changes

    // for properties
    int fadeInTime() const {
        return mFadeInTime.count();
    }
    int fadeOutTime() const {
        return mFadeOutTime.count();
    }
public Q_SLOTS:
    void slotWindowAdded(KWin::EffectWindow *c);
    void slotWindowClosed(KWin::EffectWindow *c);
    void slotWindowDeleted(KWin::EffectWindow *w);
    void slotPropertyNotify(KWin::EffectWindow *w, long a);
    void slotWaylandSlideOnShowChanged(EffectWindow* w);
private:
    void setupAnimData(EffectWindow *w);
    void startForShow(EffectWindow *w);

    enum Position {
        West = 0,
        North = 1,
        East = 2,
        South = 3
    };
    struct Data {
        int start; //point in screen coordinates where the window starts
        //to animate, from decides if this point is an x or an y
        Position from;
        std::chrono::milliseconds fadeInDuration;
        std::chrono::milliseconds fadeOutDuration;
        int slideLength;
    };
    long mAtom;

    // This list is only for appearing windows: we remember that we've enabled the
    // WindowBackgroundContrastForcedRole flag, so we can remove it later.
    // It doesn't matter for disappearing windows, they'll be deleted anyway.
    QList< const EffectWindow* > m_backgroundContrastForced;
    QHash< const EffectWindow*, TimeLine > mAppearingWindows;
    QHash< const EffectWindow*, TimeLine > mDisappearingWindows;
    QHash< const EffectWindow*, Data > mWindowsData;
    int mSlideLength;
    std::chrono::milliseconds mFadeInTime;
    std::chrono::milliseconds mFadeOutTime;
};

} // namespace

#endif