KWin::Item Class Reference

#include <item.h>

Inheritance diagram for KWin::Item:

Signals
void	childAdded (Item *item)
void	positionChanged ()
void	sizeChanged ()
void	boundingRectChanged ()

Public Member Functions
	Item (Scene *scene, Item *parent=nullptr)
	~Item () override
Scene *	scene () const
qreal	opacity () const
void	setOpacity (qreal opacity)
QPointF	position () const
void	setPosition (const QPointF &point)
QSizeF	size () const
void	setSize (const QSizeF &size)
int	z () const
void	setZ (int z)
QRectF	rect () const
QRectF	boundingRect () const
virtual QList< QRectF >	shape () const
virtual QRegion	opaque () const
Item *	parentItem () const
void	setParentItem (Item *parent)
QList< Item * >	childItems () const
QList< Item * >	sortedChildItems () const
QPointF	rootPosition () const
QMatrix4x4	transform () const
void	setTransform (const QMatrix4x4 &transform)
QRegion	mapToGlobal (const QRegion &region) const
QRectF	mapToGlobal (const QRectF &rect) const
QRectF	mapFromGlobal (const QRectF &rect) const
void	stackBefore (Item *sibling)
void	stackAfter (Item *sibling)
bool	explicitVisible () const
bool	isVisible () const
void	setVisible (bool visible)
void	scheduleRepaint (const QRectF &region)
void	scheduleRepaint (const QRegion &region)
void	scheduleRepaint (SceneDelegate *delegate, const QRegion &region)
void	scheduleFrame ()
QRegion	repaints (SceneDelegate *delegate) const
void	resetRepaints (SceneDelegate *delegate)
WindowQuadList	quads () const
virtual void	preprocess ()
const ColorDescription &	colorDescription () const
PresentationModeHint	presentationHint () const

Protected Member Functions
virtual WindowQuadList	buildQuads () const
void	discardQuads ()
void	setColorDescription (const ColorDescription &description)
void	setPresentationHint (PresentationModeHint hint)

Detailed Description

The Item class is the base class for items in the scene.

Definition at line 29 of file item.h.

Constructor & Destructor Documentation

Item()

KWin::Item::Item ( Scene * scene, Item * parent = nullptr )

explicit

Definition at line 15 of file item.cpp.

~Item()

KWin::Item::~Item ( )

override

Definition at line 22 of file item.cpp.

Member Function Documentation

boundingRect()

QRectF KWin::Item::boundingRect

(

)

const

Returns the enclosing rectangle of the item and all of its descendants.

Definition at line 157 of file item.cpp.

boundingRectChanged

void KWin::Item::boundingRectChanged ( )

signal

This signal is emitted when the rectangle that encloses this item and all of its children has changed.

buildQuads()

WindowQuadList KWin::Item::buildQuads ( ) const

protectedvirtual

Reimplemented in KWin::DecorationItem, KWin::ImageItemOpenGL, KWin::ShadowItem, and KWin::SurfaceItem.

Definition at line 345 of file item.cpp.

childAdded

void KWin::Item::childAdded ( Item * item )

signal

childItems()

QList< Item * > KWin::Item::childItems

(

)

const

Definition at line 112 of file item.cpp.

colorDescription()

const ColorDescription & KWin::Item::colorDescription

(

)

const

Definition at line 445 of file item.cpp.

discardQuads()

void KWin::Item::discardQuads ( )

protected

Definition at line 350 of file item.cpp.

explicitVisible()

bool KWin::Item::explicitVisible

(

)

const

Definition at line 378 of file item.cpp.

isVisible()

bool KWin::Item::isVisible

(

)

const

Definition at line 383 of file item.cpp.

mapFromGlobal()

QRectF KWin::Item::mapFromGlobal

(

const QRectF &

rect

)

const

Maps the given rect from the scene's coordinate system to the item's coordinate system.

Definition at line 226 of file item.cpp.

mapToGlobal() [1/2]

QRectF KWin::Item::mapToGlobal

(

const QRectF &

rect

)

const

Maps the given rect from the item's coordinate system to the scene's coordinate system.

Definition at line 218 of file item.cpp.

mapToGlobal() [2/2]

QRegion KWin::Item::mapToGlobal

(

const QRegion &

region

)

const

Maps the given region from the item's coordinate system to the scene's coordinate system.

Definition at line 210 of file item.cpp.

opacity()

qreal KWin::Item::opacity

(

)

const

Definition at line 37 of file item.cpp.

opaque()

QRegion KWin::Item::opaque ( ) const

virtual

Reimplemented in KWin::SurfaceItemWayland, KWin::SurfaceItemXwayland, KWin::SurfaceItemX11, and KWin::DecorationItem.

Definition at line 182 of file item.cpp.

parentItem()

Item * KWin::Item::parentItem

(

)

const

Returns the visual parent of the item. Note that the visual parent differs from the QObject parent.

Definition at line 67 of file item.cpp.

position()

QPointF KWin::Item::position

(

)

const

Definition at line 117 of file item.cpp.

positionChanged

void KWin::Item::positionChanged ( )

signal

This signal is emitted when the position of this item has changed.

preprocess()

void KWin::Item::preprocess ( )

virtual

Reimplemented in KWin::DecorationItem, KWin::ImageItemOpenGL, KWin::ShadowItem, KWin::SurfaceItem, and KWin::SurfaceItemX11.

Definition at line 341 of file item.cpp.

presentationHint()

PresentationModeHint KWin::Item::presentationHint

(

)

const

Definition at line 455 of file item.cpp.

quads()

WindowQuadList KWin::Item::quads

(

)

const

Definition at line 355 of file item.cpp.

rect()

QRectF KWin::Item::rect

(

)

const

Returns the enclosing rectangle of the item. The rect equals QRect(0, 0, width(), height()).

Definition at line 152 of file item.cpp.

repaints()

QRegion KWin::Item::repaints

(

SceneDelegate *

delegate

)

const

Definition at line 363 of file item.cpp.

resetRepaints()

void KWin::Item::resetRepaints

(

SceneDelegate *

delegate

)

Definition at line 368 of file item.cpp.

rootPosition()

QPointF KWin::Item::rootPosition

(

)

const

Definition at line 187 of file item.cpp.

scene()

Scene * KWin::Item::scene

(

)

const

Definition at line 32 of file item.cpp.

scheduleFrame()

void KWin::Item::scheduleFrame

(

)

Definition at line 327 of file item.cpp.

scheduleRepaint() [1/3]

void KWin::Item::scheduleRepaint

(

const QRectF &

region

)

Definition at line 396 of file item.cpp.

scheduleRepaint() [2/3]

void KWin::Item::scheduleRepaint

(

const QRegion &

region

)

Definition at line 290 of file item.cpp.

scheduleRepaint() [3/3]

void KWin::Item::scheduleRepaint	(	SceneDelegate *	delegate,
		const QRegion &	region )

Definition at line 297 of file item.cpp.

setColorDescription()

void KWin::Item::setColorDescription ( const ColorDescription & description )

protected

Definition at line 450 of file item.cpp.

setOpacity()

void KWin::Item::setOpacity

(

qreal

opacity

)

Definition at line 42 of file item.cpp.

setParentItem()

void KWin::Item::setParentItem

(

Item *

parent

)

Definition at line 72 of file item.cpp.

setPosition()

void KWin::Item::setPosition

(

const QPointF &

point

)

Definition at line 122 of file item.cpp.

setPresentationHint()

void KWin::Item::setPresentationHint ( PresentationModeHint hint )

protected

Definition at line 460 of file item.cpp.

setSize()

void KWin::Item::setSize

(

const QSizeF &

size

)

Definition at line 140 of file item.cpp.

setTransform()

void KWin::Item::setTransform

(

const QMatrix4x4 &

transform

)

Definition at line 205 of file item.cpp.

setVisible()

void KWin::Item::setVisible

(

bool

visible

)

Definition at line 388 of file item.cpp.

setZ()

void KWin::Item::setZ

(

int

z

)

Definition at line 55 of file item.cpp.

shape()

QList< QRectF > KWin::Item::shape ( ) const

virtual

Reimplemented in KWin::SurfaceItemInternal, KWin::SurfaceItemWayland, KWin::SurfaceItemXwayland, KWin::SurfaceItemX11, and KWin::DecorationItem.

Definition at line 177 of file item.cpp.

size()

QSizeF KWin::Item::size

(

)

const

Definition at line 135 of file item.cpp.

sizeChanged

void KWin::Item::sizeChanged ( )

signal

This signal is emitted when the size of this item has changed.

sortedChildItems()

QList< Item * > KWin::Item::sortedChildItems

(

)

const

Definition at line 430 of file item.cpp.

stackAfter()

void KWin::Item::stackAfter

(

Item *

sibling

)

Moves this item right after the specified sibling in the parent's children list.

Definition at line 262 of file item.cpp.

stackBefore()

void KWin::Item::stackBefore

(

Item *

sibling

)

Moves this item right before the specified sibling in the parent's children list.

Definition at line 234 of file item.cpp.

transform()

QMatrix4x4 KWin::Item::transform

(

)

const

Definition at line 200 of file item.cpp.

z()

int KWin::Item::z

(

)

const

Definition at line 50 of file item.cpp.

---

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

• src/scene/item.h
• src/scene/item.cpp