#include <highlightwindow.h>

Inheritance diagram for KWin::HighlightWindowEffect:

Public Slots
void	slotWindowAdded (KWin::EffectWindow *w)

void	slotWindowClosed (KWin::EffectWindow *w)

void	slotWindowDeleted (KWin::EffectWindow *w)

void	slotPropertyNotify (KWin::EffectWindow w, long atom, EffectWindow addedWindow=nullptr)

Public Slots inherited from KWin::Effect
virtual bool	borderActivated (ElectricBorder border)

Public Member Functions
	HighlightWindowEffect ()

	~HighlightWindowEffect () override

int	requestedEffectChainPosition () const override

bool	provides (Feature feature) override

bool	perform (Feature feature, const QVariantList &arguments) override

Q_SCRIPTABLE void	highlightWindows (const QStringList &windows)

Public Member Functions inherited from KWin::AnimationEffect
	AnimationEffect ()

	~AnimationEffect () override

bool	isActive () const override

QString	debug (const QString &parameter) const override

void	prePaintWindow (EffectWindow *w, WindowPrePaintData &data, std::chrono::milliseconds presentTime) override

void	paintWindow (const RenderTarget &renderTarget, const RenderViewport &viewport, EffectWindow *w, int mask, QRegion region, WindowPaintData &data) override

void	postPaintScreen () override

Public Member Functions inherited from KWin::CrossFadeEffect
	CrossFadeEffect (QObject *parent=nullptr)

	~CrossFadeEffect () override

void	drawWindow (const RenderTarget &renderTarget, const RenderViewport &viewport, EffectWindow *window, int mask, const QRegion &region, WindowPaintData &data) override

void	redirect (EffectWindow *window)

void	unredirect (EffectWindow *window)

void	setShader (EffectWindow window, GLShader shader)

Public Member Functions inherited from KWin::Effect
	Effect (QObject *parent=nullptr)

	~Effect () override

virtual void	reconfigure (ReconfigureFlags flags)

virtual void	prePaintScreen (ScreenPrePaintData &data, std::chrono::milliseconds presentTime)

virtual void	paintScreen (const RenderTarget &renderTarget, const RenderViewport &viewport, int mask, const QRegion &region, Output *screen)

virtual void	postPaintWindow (EffectWindow *w)

virtual void	windowInputMouseEvent (QEvent *e)

virtual void	grabbedKeyboardEvent (QKeyEvent *e)

virtual bool	touchDown (qint32 id, const QPointF &pos, std::chrono::microseconds time)

virtual bool	touchMotion (qint32 id, const QPointF &pos, std::chrono::microseconds time)

virtual bool	touchUp (qint32 id, std::chrono::microseconds time)

virtual bool	tabletToolEvent (QTabletEvent *event)

virtual bool	tabletToolButtonEvent (uint button, bool pressed, quint64 tabletToolId)

virtual bool	tabletPadButtonEvent (uint button, bool pressed, void *tabletPadId)

virtual bool	tabletPadStripEvent (int number, int position, bool isFinger, void *tabletPadId)

virtual bool	tabletPadRingEvent (int number, int position, bool isFinger, void *tabletPadId)

template<typename T >
int	animationTime (int defaultDuration)

virtual bool	blocksDirectScanout () const

Additional Inherited Members
Public Types inherited from KWin::AnimationEffect
enum	Anchor { Left = 1 << 0 , Top = 1 << 1 , Right = 1 << 2 , Bottom = 1 << 3 , Horizontal = Left \| Right , Vertical = Top \| Bottom , Mouse = 1 << 4 }

enum	Attribute { Opacity = 0 , Brightness , Saturation , Scale , Rotation , Position , Size , Translation , Clip , Generic , CrossFadePrevious , Shader , ShaderUniform , NonFloatBase = Position }

enum	MetaType { SourceAnchor , TargetAnchor , RelativeSourceX , RelativeSourceY , RelativeTargetX , RelativeTargetY , Axis }

enum	Direction { Forward , Backward }

enum	TerminationFlag { DontTerminate = 0x00 , TerminateAtSource = 0x01 , TerminateAtTarget = 0x02 }

Public Types inherited from KWin::Effect
enum	{ PAINT_WINDOW_OPAQUE = 1 << 0 , PAINT_WINDOW_TRANSLUCENT = 1 << 1 , PAINT_WINDOW_TRANSFORMED = 1 << 2 , PAINT_SCREEN_REGION = 1 << 3 , PAINT_SCREEN_TRANSFORMED = 1 << 4 , PAINT_SCREEN_WITH_TRANSFORMED_WINDOWS = 1 << 5 , PAINT_SCREEN_BACKGROUND_FIRST = 1 << 6 }

enum	Feature { Nothing = 0 , ScreenInversion , Blur , Contrast , HighlightWindows }

enum	ReconfigureFlag { ReconfigureAll = 1 << 0 }

Static Public Member Functions inherited from KWin::AnimationEffect
static int	metaData (MetaType type, uint meta)

static void	setMetaData (MetaType type, uint value, uint &meta)

static qreal	qecGaussian (qreal progress)

static qint64	clock ()

Static Public Member Functions inherited from KWin::CrossFadeEffect
static bool	supported ()

Static Public Member Functions inherited from KWin::Effect
static QPointF	cursorPos ()

static double	animationTime (const KConfigGroup &cfg, const QString &key, int defaultTime)

static double	animationTime (int defaultTime)

static double	interpolate (double x, double y, double a)

static void	setPositionTransformations (WindowPaintData &data, QRect &region, EffectWindow *w, const QRect &r, Qt::AspectRatioMode aspect)

Protected Types inherited from KWin::AnimationEffect
typedef QMap< EffectWindow *, QPair< QList< AniData >, QRect > >	AniMap

Protected Member Functions inherited from KWin::AnimationEffect
quint64	animate (EffectWindow w, Attribute a, uint meta, int ms, const FPx2 &to, const QEasingCurve &curve=QEasingCurve(), int delay=0, const FPx2 &from=FPx2(), bool fullScreen=false, bool keepAlive=true, GLShader shader=nullptr)

quint64	set (EffectWindow w, Attribute a, uint meta, int ms, const FPx2 &to, const QEasingCurve &curve=QEasingCurve(), int delay=0, const FPx2 &from=FPx2(), bool fullScreen=false, bool keepAlive=true, GLShader shader=nullptr)

bool	retarget (quint64 animationId, FPx2 newTarget, int newRemainingTime=-1)

bool	freezeInTime (quint64 animationId, qint64 frozenTime)

bool	redirect (quint64 animationId, Direction direction, TerminationFlags terminationFlags=TerminateAtSource)

bool	complete (quint64 animationId)

virtual void	animationEnded (EffectWindow *w, Attribute a, uint meta)

bool	cancel (quint64 animationId)

virtual void	genericAnimation (EffectWindow *w, WindowPaintData &data, float progress, uint meta)

AniMap	state () const

Detailed Description

Definition at line 17 of file highlightwindow.h.

Constructor & Destructor Documentation

◆ HighlightWindowEffect()

KWin::HighlightWindowEffect::HighlightWindowEffect ( )

Definition at line 21 of file highlightwindow.cpp.

◆ ~HighlightWindowEffect()

KWin::HighlightWindowEffect::~HighlightWindowEffect ( )

override

Definition at line 45 of file highlightwindow.cpp.

Member Function Documentation

◆ highlightWindows()

void KWin::HighlightWindowEffect::highlightWindows ( const QStringList & windows )

Definition at line 61 of file highlightwindow.cpp.

◆ perform()

bool KWin::HighlightWindowEffect::perform	(	Feature	feature,
		const QVariantList &	arguments )

overridevirtual

Performs the feature with the arguments.

This allows to have specific protocols between KWin core and an Effect.

The method is supposed to return true if it performed the features, false otherwise.

The default implementation returns false.

Since: 5.8

Reimplemented from KWin::Effect.

Definition at line 265 of file highlightwindow.cpp.

◆ provides()

bool KWin::HighlightWindowEffect::provides ( Feature )

overridevirtual

Called on Transparent resizes. return true if your effect substitutes questioned feature

Reimplemented from KWin::Effect.

Definition at line 255 of file highlightwindow.cpp.

◆ requestedEffectChainPosition()

int KWin::HighlightWindowEffect::requestedEffectChainPosition ( ) const

inlineoverridevirtual

Reimplement this method to indicate where in the Effect chain the Effect should be placed.

A low number indicates early chain position, thus before other Effects got called, a high number indicates a late position. The returned number should be in the interval [0, 100]. The default value is 0.

In KWin4 this information was provided in the Effect's desktop file as property X-KDE-Ordering. In the case of Scripted Effects this property is still used.

Since: 5.0

Reimplemented from KWin::Effect.

Definition at line 25 of file highlightwindow.h.

◆ slotPropertyNotify

void KWin::HighlightWindowEffect::slotPropertyNotify	(	KWin::EffectWindow *	w,
		long	atom,
		EffectWindow *	addedWindow = nullptr )

slot

Definition at line 111 of file highlightwindow.cpp.

◆ slotWindowAdded

void KWin::HighlightWindowEffect::slotWindowAdded ( KWin::EffectWindow * w )

slot

Definition at line 75 of file highlightwindow.cpp.

◆ slotWindowClosed

void KWin::HighlightWindowEffect::slotWindowClosed ( KWin::EffectWindow * w )

slot

Definition at line 99 of file highlightwindow.cpp.

◆ slotWindowDeleted

void KWin::HighlightWindowEffect::slotWindowDeleted ( KWin::EffectWindow * w )

slot

Definition at line 106 of file highlightwindow.cpp.

The documentation for this class was generated from the following files:

src/plugins/highlightwindow/highlightwindow.h
src/plugins/highlightwindow/highlightwindow.cpp

Public Slots

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HighlightWindowEffect()

◆ ~HighlightWindowEffect()

Member Function Documentation

◆ highlightWindows()

◆ perform()

◆ provides()

◆ requestedEffectChainPosition()

◆ slotPropertyNotify

◆ slotWindowAdded

◆ slotWindowClosed

◆ slotWindowDeleted