Plasma::WindowEffects Namespace Reference

Namespace for all window effects for Plasma/KWin interaction. More...

Enumerations
enum	Effect {   Slide = 1, WindowPreview = 2, PresentWindows = 3, PresentWindowsGroup = 4,   HighlightWindows = 5 }
Functions
void	highlightWindows (WId controller, const QList< WId > &ids)
bool	isEffectAvailable (Effect effect)
void	presentWindows (WId controller, int desktop=-1)
void	presentWindows (WId controller, const QList< WId > &ids)
void	showWindowThumbnails (WId parent, const QList< WId > &windows=QList< WId >(), const QList< QRect > &rects=QList< QRect >())
void	slideWindow (QWidget *widget, Plasma::Location location)
void	slideWindow (WId id, Plasma::Location location, int offset)
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

Definition at line 38 of file windoweffects.h.

---

Function Documentation

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

Highlight the selected windos, 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

bool Plasma::WindowEffects::isEffectAvailable

(

Effect

effect

)

Returns:

if an atom property is available

Parameters:

effect

the effect we want to check

Since:

4.4

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

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

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

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.

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

  Since:

  4.4

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

Mark a window as sliding from screen edge.

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

  Since:

  4.4

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