684b4b635e
Summary:
So far we were following a bit unique and rare doxygen comment style:
/**
* Contents of the comment.
**/
Doxygen comments with this style look balanced and neat, but many people
that contribute to KWin don't follow this style. Instead, they prefer
more traditional doxygen comment style, i.e.
/**
* Contents of the comment.
*/
Reviewing such changes has been a bit frustrating for me (so selfish!)
and for other contributors.
This change switches doxygen comment style in KWin to a more traditional
style. The main reason for doing this is to make code review process easier
for new contributors as well us.
Reviewers: #kwin, davidedmundson
Reviewed By: #kwin, davidedmundson
Subscribers: kwin
Tags: #kwin
Differential Revision: https://phabricator.kde.org/D22812
108 lines
3 KiB
C++
108 lines
3 KiB
C++
/********************************************************************
|
|
KWin - the KDE window manager
|
|
This file is part of the KDE project.
|
|
|
|
Copyright (C) 2011 Thomas Lübking <thomas.luebking@web.de>
|
|
Copyright (C) 2018 Vlad Zagorodniy <vladzzag@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 ANIDATA_H
|
|
#define ANIDATA_H
|
|
|
|
#include "kwinanimationeffect.h"
|
|
|
|
#include <QEasingCurve>
|
|
|
|
namespace KWin {
|
|
|
|
/**
|
|
* Wraps effects->setActiveFullScreenEffect for the duration of it's lifespan
|
|
*/
|
|
class FullScreenEffectLock
|
|
{
|
|
public:
|
|
FullScreenEffectLock(Effect *effect);
|
|
~FullScreenEffectLock();
|
|
private:
|
|
Q_DISABLE_COPY(FullScreenEffectLock)
|
|
};
|
|
typedef QSharedPointer<FullScreenEffectLock> FullScreenEffectLockPtr;
|
|
|
|
/**
|
|
* Keeps windows alive during animation after they got closed
|
|
*/
|
|
class KeepAliveLock
|
|
{
|
|
public:
|
|
KeepAliveLock(EffectWindow *w);
|
|
~KeepAliveLock();
|
|
|
|
private:
|
|
EffectWindow *m_window;
|
|
Q_DISABLE_COPY(KeepAliveLock)
|
|
};
|
|
typedef QSharedPointer<KeepAliveLock> KeepAliveLockPtr;
|
|
|
|
/**
|
|
* References the previous window pixmap to prevent discarding.
|
|
*/
|
|
class PreviousWindowPixmapLock
|
|
{
|
|
public:
|
|
PreviousWindowPixmapLock(EffectWindow *w);
|
|
~PreviousWindowPixmapLock();
|
|
|
|
private:
|
|
EffectWindow *m_window;
|
|
Q_DISABLE_COPY(PreviousWindowPixmapLock)
|
|
};
|
|
typedef QSharedPointer<PreviousWindowPixmapLock> PreviousWindowPixmapLockPtr;
|
|
|
|
class KWINEFFECTS_EXPORT AniData {
|
|
public:
|
|
AniData();
|
|
AniData(AnimationEffect::Attribute a, int meta, const FPx2 &to,
|
|
int delay, const FPx2 &from, bool waitAtSource,
|
|
FullScreenEffectLockPtr=FullScreenEffectLockPtr(),
|
|
bool keepAlive = true, PreviousWindowPixmapLockPtr previousWindowPixmapLock = {});
|
|
|
|
bool isActive() const;
|
|
|
|
inline bool isOneDimensional() const {
|
|
return from[0] == from[1] && to[0] == to[1];
|
|
}
|
|
|
|
quint64 id{0};
|
|
QString debugInfo() const;
|
|
AnimationEffect::Attribute attribute;
|
|
int customCurve;
|
|
FPx2 from, to;
|
|
TimeLine timeLine;
|
|
uint meta;
|
|
qint64 startTime;
|
|
QSharedPointer<FullScreenEffectLock> fullScreenEffectLock;
|
|
bool waitAtSource;
|
|
bool keepAlive;
|
|
KeepAliveLockPtr keepAliveLock;
|
|
PreviousWindowPixmapLockPtr previousWindowPixmapLock;
|
|
AnimationEffect::TerminationFlags terminationFlags;
|
|
};
|
|
|
|
} // namespace
|
|
|
|
QDebug operator<<(QDebug dbg, const KWin::AniData &a);
|
|
|
|
#endif // ANIDATA_H
|