kwin/effects/effect_builtins.h
Martin Gräßlin 82731f231e [kwin] Define an enum for all the built in effects
For each effect there is an enum value. The internal mapping of effect to
create, supported and checkDefault is switched to the enum value, though
the methods for the name based variants are still available.
2014-03-28 14:04:54 +01:00

96 lines
2.4 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 <QList>
class QByteArray;
namespace KWin
{
class Effect;
/**
* Defines all the built in effects.
**/
enum class BuiltInEffect
{
Invalid, ///< not a valid Effect
Blur,
Contrast,
CoverSwitch,
Cube,
CubeSlide,
Dashboard,
DesktopGrid,
DimInactive,
DimScreen,
FallApart,
FlipSwitch,
Glide,
HighlightWindow,
Invert,
Kscreen,
Logout,
LookingGlass,
MagicLamp,
Magnifier,
MinimizeAnimation,
MouseClick,
MouseMark,
PresentWindows,
Resize,
ScreenEdge,
ScreenShot,
Sheet,
ShowFps,
ShowPaint,
Slide,
SlideBack,
SlidingPopups,
SnapHelper,
StartupFeedback,
ThumbnailAside,
TrackMouse,
WindowGeometry,
WobblyWindows,
Zoom
};
namespace BuiltInEffects
{
KWINEFFECTS_EXPORT Effect *create(const QByteArray &name);
KWINEFFECTS_EXPORT Effect *create(BuiltInEffect effect);
KWINEFFECTS_EXPORT bool available(const QByteArray &name);
KWINEFFECTS_EXPORT bool supported(const QByteArray &name);
KWINEFFECTS_EXPORT bool supported(BuiltInEffect effect);
KWINEFFECTS_EXPORT bool enabledByDefault(const QByteArray &name);
KWINEFFECTS_EXPORT bool enabledByDefault(BuiltInEffect effect);
KWINEFFECTS_EXPORT QByteArray nameForEffect(BuiltInEffect effect);
KWINEFFECTS_EXPORT BuiltInEffect builtInForName(const QByteArray &name);
KWINEFFECTS_EXPORT QList<QByteArray> availableEffectNames();
KWINEFFECTS_EXPORT QList<BuiltInEffect> availableEffects();
}
}
#endif