Plasma::WindowEffects Namespace Reference

Enumerations
enum	Effect {   Slide = 1, WindowPreview = 2, PresentWindows = 3, PresentWindowsGroup = 4,   HighlightWindows = 5, OverrideShadow = 6, BlurBehind = 7, Dashboard = 8 }

Functions
void	enableBlurBehind (WId window, bool enable=true, const QRegion &region=QRegion())
void	highlightWindows (WId controller, const QList< WId > &ids)
bool	isEffectAvailable (Effect effect)
void	markAsDashboard (WId window)
void	overrideShadow (WId window, bool override)
void	presentWindows (WId controller, const QList< WId > &ids)
void	presentWindows (WId controller, int desktop=-1)
void	showWindowThumbnails (WId parent, const QList< WId > &windows=QList< WId >(), const QList< QRect > &rects=QList< QRect >())
void	slideWindow (WId id, Plasma::Location location, int offset)
void	slideWindow (QWidget *widget, Plasma::Location location)
QList< QSize >	windowSizes (const QList< WId > &ids)

Detailed Description

Namespace for all window effects for Plasma/KWin interaction.

Since

4.4

Enumeration Type Documentation

enum Plasma::WindowEffects::Effect

Enumerator
Slide
WindowPreview
PresentWindows
PresentWindowsGroup
HighlightWindows
OverrideShadow
BlurBehind
Dashboard

Definition at line 38 of file windoweffects.h.

Function Documentation

void Plasma::WindowEffects::enableBlurBehind	(	WId	window,
		bool	enable = true,
		const QRegion &	region = QRegion()
	)

Instructs the window manager to blur the background in the specified region behind the given window.

Passing a null region will enable the blur effect for the whole window. The region is relative to the top-left corner of the client area.

Note that you will usually want to set the region to the shape of the window, excluding any shadow or halo.

Parameters

window	The window for which to enable the blur effect
enable	Enable the effect if true, disable it if
region	The region within the window where the background will be blurred

Since

4.5

Definition at line 310 of file windoweffects.cpp.

void Plasma::WindowEffects::highlightWindows	(	WId	controller,
		const QList< WId > &	ids
	)

Highlight the selected windows, making all the others translucent.

Parameters

controller	The window which is the controller of this effect. The property will be set on this window. It will be removed by the effect
ids	all the windows which should be highlighted.

Since

4.4

Definition at line 262 of file windoweffects.cpp.

bool Plasma::WindowEffects::isEffectAvailable

(

Effect

effect

)

Returns

if an atom property is available

Parameters

effect

the effect we want to check

Since

4.4

Definition at line 44 of file windoweffects.cpp.

void Plasma::WindowEffects::markAsDashboard

(

WId

window

)

Instructs the window manager to handle the given window as dashboard window as Dashboard windows should be handled diffrently and may have special effects applied to them.

Parameters

window

The window for which to enable the blur effect

Since

4.6

Definition at line 331 of file windoweffects.cpp.

void Plasma::WindowEffects::overrideShadow	(	WId	window,
		bool	override
	)

Forbid te windowmanager to automatically generate a shadow for this window.

Parameters

window	the window that won't have shadow
override	true if it won't have shadow, false enables it again

Since

4.4

Definition at line 294 of file windoweffects.cpp.

void Plasma::WindowEffects::presentWindows	(	WId	controller,
		const QList< WId > &	ids
	)

Activate the Present Windows effect for the given groups of windows.

Parameters

controller	The window which is the controller of this effect. The property will be set on this window. It will be removed by the effect
ids	all the windows which should be presented.

Since

4.4

Definition at line 224 of file windoweffects.cpp.

void Plasma::WindowEffects::presentWindows	(	WId	controller,
		int	desktop = -1
	)

Activate the Present Windows effect for the windows of the given desktop.

Parameters

controller	The window which is the controller of this effect. The property will be set on this window. It will be removed by the effect
desktop	The desktop whose windows should be presented. -1 for all desktops

Since

4.4

Definition at line 250 of file windoweffects.cpp.

void Plasma::WindowEffects::showWindowThumbnails	(	WId	parent,
		const QList< WId > &	windows = QList< WId >(),
		const QList< QRect > &	rects = QList< QRect >()
	)

Paint inside the window parent the thumbnails of the windows list in the respective rectangles of the rects list.

Parameters

parent	window where we should paint
windows	windows we want a thumbnail of. If it is empty any thumbnail will be deleted
rects	rectangles in parent coordinates where to paint the window thumbnails. If it is empty any thumbnail will be deleted

Since

4.4

Definition at line 182 of file windoweffects.cpp.

void Plasma::WindowEffects::slideWindow	(	WId	id,
		Plasma::Location	location,
		int	offset
	)

Mark a window as sliding from screen edge.

Parameters

id	of the window on which we want to apply the effect
location	edge of the screen from which we want the sliding effect. Desktop and Floating won't have effect.
offset	distance in pixels from the screen edge defined by location

Since

4.4

Definition at line 97 of file windoweffects.cpp.

void Plasma::WindowEffects::slideWindow	(	QWidget *	widget,
		Plasma::Location	location
	)

Mark a window as sliding from screen edge This is an overloaded member function provided for convenience.

Parameters

widget	QWidget corresponding to the top level window we want to animate
location	edge of the screen from which we want the sliding effect. Desktop and Floating won't have effect.

Since

4.4

Definition at line 131 of file windoweffects.cpp.

QList< QSize > Plasma::WindowEffects::windowSizes

(

const QList< WId > &

ids

)

Returns

dimension of all the windows passed as parameter

Parameters

ids	all the windows we want the size

Since

4.4

Definition at line 164 of file windoweffects.cpp.