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
107 lines
2.7 KiB
C++
107 lines
2.7 KiB
C++
/********************************************************************
|
|
KWin - the KDE window manager
|
|
This file is part of the KDE project.
|
|
|
|
Copyright (C) 2014 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_EFFECT_BUILTINS_H
|
|
#define KWIN_EFFECT_BUILTINS_H
|
|
#include <kwineffects_export.h>
|
|
#include <QStringList>
|
|
#include <QUrl>
|
|
#include <functional>
|
|
|
|
namespace KWin
|
|
{
|
|
class Effect;
|
|
|
|
/**
|
|
* Defines all the built in effects.
|
|
*/
|
|
enum class BuiltInEffect
|
|
{
|
|
Invalid, ///< not a valid Effect
|
|
Blur,
|
|
ColorPicker,
|
|
Contrast,
|
|
CoverSwitch,
|
|
Cube,
|
|
CubeSlide,
|
|
DesktopGrid,
|
|
DimInactive,
|
|
FallApart,
|
|
FlipSwitch,
|
|
Glide,
|
|
HighlightWindow,
|
|
Invert,
|
|
Kscreen,
|
|
LookingGlass,
|
|
MagicLamp,
|
|
Magnifier,
|
|
MouseClick,
|
|
MouseMark,
|
|
PresentWindows,
|
|
Resize,
|
|
ScreenEdge,
|
|
ScreenShot,
|
|
Sheet,
|
|
ShowFps,
|
|
ShowPaint,
|
|
Slide,
|
|
SlideBack,
|
|
SlidingPopups,
|
|
SnapHelper,
|
|
StartupFeedback,
|
|
ThumbnailAside,
|
|
TouchPoints,
|
|
TrackMouse,
|
|
WindowGeometry,
|
|
WobblyWindows,
|
|
Zoom
|
|
};
|
|
|
|
namespace BuiltInEffects
|
|
{
|
|
|
|
struct EffectData {
|
|
QString name;
|
|
QString displayName;
|
|
QString comment;
|
|
QString category;
|
|
QString exclusiveCategory;
|
|
QUrl video;
|
|
bool enabled;
|
|
bool internal;
|
|
std::function<Effect*()> createFunction;
|
|
std::function<bool()> supportedFunction;
|
|
std::function<bool()> enabledFunction;
|
|
};
|
|
|
|
KWINEFFECTS_EXPORT Effect *create(BuiltInEffect effect);
|
|
KWINEFFECTS_EXPORT bool available(const QString &name);
|
|
KWINEFFECTS_EXPORT bool supported(BuiltInEffect effect);
|
|
KWINEFFECTS_EXPORT bool checkEnabledByDefault(BuiltInEffect effect);
|
|
KWINEFFECTS_EXPORT bool enabledByDefault(BuiltInEffect effect);
|
|
KWINEFFECTS_EXPORT QString nameForEffect(BuiltInEffect effect);
|
|
KWINEFFECTS_EXPORT BuiltInEffect builtInForName(const QString &name);
|
|
KWINEFFECTS_EXPORT QStringList availableEffectNames();
|
|
KWINEFFECTS_EXPORT QList<BuiltInEffect> availableEffects();
|
|
KWINEFFECTS_EXPORT const EffectData &effectData(BuiltInEffect effect);
|
|
}
|
|
|
|
}
|
|
|
|
#endif
|