KWin::Outline Class Reference

This class is used to show the outline of a given geometry. More...

#include <outline.h>

Inheritance diagram for KWin::Outline:

Signals
void	activeChanged ()
void	geometryChanged ()
void	unifiedGeometryChanged ()
void	visualParentGeometryChanged ()

Public Member Functions
	Outline ()
	~Outline () override
void	setGeometry (const QRect &outlineGeometry)
void	setVisualParentGeometry (const QRect &visualParentGeometry)
void	show ()
void	show (const QRect &outlineGeometry)
void	show (const QRect &outlineGeometry, const QRect &visualParentGeometry)
void	hide ()
const QRect &	geometry () const
const QRect &	visualParentGeometry () const
QRect	unifiedGeometry () const
bool	isActive () const

Properties
QRect	geometry
QRect	visualParentGeometry
QRect	unifiedGeometry
bool	active

Detailed Description

This class is used to show the outline of a given geometry.

The class renders an outline by using four windows. One for each border of the geometry. It is possible to replace the outline with an effect. If an effect is available the effect will be used, otherwise the outline will be rendered by using the X implementation.

Author

Arthur Arlt

Since

4.7

Definition at line 37 of file outline.h.

Constructor & Destructor Documentation

Outline()

KWin::Outline::Outline ( )

explicit

Definition at line 30 of file outline.cpp.

~Outline()

KWin::Outline::~Outline ( )

overridedefault

Member Function Documentation

activeChanged

void KWin::Outline::activeChanged ( )

signal

geometry()

const QRect & KWin::Outline::geometry

(

)

const

Definition at line 118 of file outline.cpp.

geometryChanged

void KWin::Outline::geometryChanged ( )

signal

hide()

void KWin::Outline::hide

(

)

Hides shown outline.

See also

showOutline

Definition at line 52 of file outline.cpp.

isActive()

bool KWin::Outline::isActive

(

)

const

Definition at line 128 of file outline.cpp.

setGeometry()

void KWin::Outline::setGeometry

(

const QRect &

outlineGeometry

)

Set the outline geometry. To show the outline use showOutline.

Parameters

outlineGeometry

The geometry of the outline to be shown

See also

showOutline

Definition at line 77 of file outline.cpp.

setVisualParentGeometry()

void KWin::Outline::setVisualParentGeometry

(

const QRect &

visualParentGeometry

)

Set the visual parent geometry. This is the geometry from which the will emerge.

Parameters

visualParentGeometry

The visual geometry of the visual parent

See also

showOutline

Definition at line 87 of file outline.cpp.

show() [1/3]

void KWin::Outline::show

(

)

Shows the outline of a window using either an effect or the X implementation. To stop the outline process use hideOutline.

See also

hideOutline

Definition at line 38 of file outline.cpp.

show() [2/3]

void KWin::Outline::show

(

const QRect &

outlineGeometry

)

Shows the outline for the given outlineGeometry. This is the same as setOutlineGeometry followed by showOutline directly. To stop the outline process use hideOutline.

Parameters

outlineGeometry

The geometry of the outline to be shown

See also

hideOutline

Definition at line 65 of file outline.cpp.

show() [3/3]

void KWin::Outline::show	(	const QRect &	outlineGeometry,
		const QRect &	visualParentGeometry )

Shows the outline for the given outlineGeometry animated from visualParentGeometry. This is the same as setOutlineGeometry followed by setVisualParentGeometry and then showOutline. To stop the outline process use hideOutline.

Parameters

outlineGeometry	The geometry of the outline to be shown
visualParentGeometry	The geometry from where the outline should emerge

See also

hideOutline

Since

5.10

Definition at line 70 of file outline.cpp.

unifiedGeometry()

QRect KWin::Outline::unifiedGeometry

(

)

const

Definition at line 97 of file outline.cpp.

unifiedGeometryChanged

void KWin::Outline::unifiedGeometryChanged ( )

signal

visualParentGeometry()

const QRect & KWin::Outline::visualParentGeometry

(

)

const

Definition at line 123 of file outline.cpp.

visualParentGeometryChanged

void KWin::Outline::visualParentGeometryChanged ( )

signal

Property Documentation

active

bool KWin::Outline::active

read

Definition at line 43 of file outline.h.

geometry

QRect KWin::Outline::geometry

read

Definition at line 40 of file outline.h.

unifiedGeometry

QRect KWin::Outline::unifiedGeometry

read

Definition at line 42 of file outline.h.

visualParentGeometry

QRect KWin::Outline::visualParentGeometry

read

Definition at line 41 of file outline.h.

---

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

• src/outline.h
• src/outline.cpp