#include <screenedge.h>

Inheritance diagram for KWin::Edge:

Public Slots
void	reserve ()

void	unreserve ()

void	unreserve (QObject *object)

void	setBorder (ElectricBorder border)

void	setAction (ElectricBorderAction action)

void	setGeometry (const QRect &geometry)

void	updateApproaching (const QPointF &point)

void	checkBlocking ()

Signals
void	approaching (ElectricBorder border, qreal factor, const QRect &geometry)

void	activatesForTouchGestureChanged ()

Public Member Functions
	Edge (ScreenEdges *parent)

	~Edge () override

bool	isLeft () const

bool	isTop () const

bool	isRight () const

bool	isBottom () const

bool	isCorner () const

bool	isScreenEdge () const

bool	triggersFor (const QPoint &cursorPos) const

bool	check (const QPoint &cursorPos, const QDateTime &triggerTime, bool forceNoPushBack=false)

void	markAsTriggered (const QPoint &cursorPos, const QDateTime &triggerTime)

bool	isReserved () const

const QRect &	approachGeometry () const

ElectricBorder	border () const

void	reserve (QObject object, const char slot)

const QHash< QObject *, QByteArray > &	callBacks () const

void	reserveTouchCallBack (QAction *action, TouchCallback::CallbackFunction callback=nullptr)

void	unreserveTouchCallBack (QAction *action)

void	startApproaching ()

void	stopApproaching ()

bool	isApproaching () const

void	setClient (Window *client)

Window *	client () const

void	setOutput (Output *output)

Output *	output () const

const QRect &	geometry () const

void	setTouchAction (ElectricBorderAction action)

bool	activatesForPointer () const

bool	activatesForTouchGesture () const

virtual quint32	window () const

virtual quint32	approachWindow () const

Protected Member Functions
ScreenEdges *	edges ()

const ScreenEdges *	edges () const

bool	isBlocked () const

virtual void	doGeometryUpdate ()

virtual void	doActivate ()

virtual void	doDeactivate ()

virtual void	doStartApproaching ()

virtual void	doStopApproaching ()

virtual void	doUpdateBlocking ()

Friends
class	ScreenEdges

Detailed Description

Definition at line 61 of file screenedge.h.

Constructor & Destructor Documentation

◆ Edge()

KWin::Edge::Edge ( ScreenEdges * parent )

explicit

Definition at line 92 of file screenedge.cpp.

◆ ~Edge()

KWin::Edge::~Edge ( )

override

Definition at line 149 of file screenedge.cpp.

Member Function Documentation

◆ activatesForPointer()

bool KWin::Edge::activatesForPointer ( ) const

Definition at line 222 of file screenedge.cpp.

◆ activatesForTouchGesture()

bool KWin::Edge::activatesForTouchGesture ( ) const

Definition at line 261 of file screenedge.cpp.

◆ activatesForTouchGestureChanged

void KWin::Edge::activatesForTouchGestureChanged ( )

signal

◆ approachGeometry()

const QRect & KWin::Edge::approachGeometry ( ) const

inline

Definition at line 501 of file screenedge.h.

◆ approaching

void KWin::Edge::approaching	(	ElectricBorder	border,
		qreal	factor,
		const QRect &	geometry )

signal

◆ approachWindow()

quint32 KWin::Edge::approachWindow ( ) const

virtual

The approach window is a special window to notice when get close to the screen border but not yet triggering the border.

The default implementation returns 0, which means no window.

Reimplemented in KWin::WindowBasedEdge.

Definition at line 713 of file screenedge.cpp.

◆ border()

ElectricBorder KWin::Edge::border ( ) const

inline

Definition at line 506 of file screenedge.h.

◆ callBacks()

const QHash< QObject *, QByteArray > & KWin::Edge::callBacks ( ) const

inline

Definition at line 511 of file screenedge.h.

◆ check()

bool KWin::Edge::check	(	const QPoint &	cursorPos,
		const QDateTime &	triggerTime,
		bool	forceNoPushBack = false )

Definition at line 307 of file screenedge.cpp.

◆ checkBlocking

void KWin::Edge::checkBlocking ( )

slot

Definition at line 583 of file screenedge.cpp.

◆ client()

Window * KWin::Edge::client ( ) const

inline

Definition at line 521 of file screenedge.h.

◆ doActivate()

void KWin::Edge::doActivate ( )

protectedvirtual

Reimplemented in KWin::WindowBasedEdge.

Definition at line 617 of file screenedge.cpp.

◆ doDeactivate()

void KWin::Edge::doDeactivate ( )

protectedvirtual

Reimplemented in KWin::WindowBasedEdge.

Definition at line 627 of file screenedge.cpp.

◆ doGeometryUpdate()

void KWin::Edge::doGeometryUpdate ( )

protectedvirtual

Reimplemented in KWin::WindowBasedEdge.

Definition at line 605 of file screenedge.cpp.

◆ doStartApproaching()

void KWin::Edge::doStartApproaching ( )

protectedvirtual

Reimplemented in KWin::WindowBasedEdge.

Definition at line 642 of file screenedge.cpp.

◆ doStopApproaching()

void KWin::Edge::doStopApproaching ( )

protectedvirtual

Reimplemented in KWin::WindowBasedEdge.

Definition at line 657 of file screenedge.cpp.

◆ doUpdateBlocking()

void KWin::Edge::doUpdateBlocking ( )

protectedvirtual

Reimplemented in KWin::WindowBasedEdge.

Definition at line 601 of file screenedge.cpp.

◆ edges() [1/2]

ScreenEdges * KWin::Edge::edges ( )

inlineprotected

Definition at line 486 of file screenedge.h.

◆ edges() [2/2]

const ScreenEdges * KWin::Edge::edges ( ) const

inlineprotected

Definition at line 491 of file screenedge.h.

◆ geometry()

const QRect & KWin::Edge::geometry ( ) const

inline

Definition at line 496 of file screenedge.h.

◆ isApproaching()

bool KWin::Edge::isApproaching ( ) const

inline

Definition at line 526 of file screenedge.h.

◆ isBlocked()

bool KWin::Edge::isBlocked ( ) const

inlineprotected

Definition at line 516 of file screenedge.h.

◆ isBottom()

bool KWin::Edge::isBottom ( ) const

inline

Definition at line 440 of file screenedge.h.

◆ isCorner()

bool KWin::Edge::isCorner ( ) const

inline

Definition at line 460 of file screenedge.h.

◆ isLeft()

bool KWin::Edge::isLeft ( ) const

inline

Definition at line 445 of file screenedge.h.

◆ isReserved()

bool KWin::Edge::isReserved ( ) const

inline

Definition at line 476 of file screenedge.h.

◆ isRight()

bool KWin::Edge::isRight ( ) const

inline

Definition at line 450 of file screenedge.h.

◆ isScreenEdge()

bool KWin::Edge::isScreenEdge ( ) const

inline

Definition at line 468 of file screenedge.h.

◆ isTop()

bool KWin::Edge::isTop ( ) const

inline

Definition at line 455 of file screenedge.h.

◆ markAsTriggered()

void KWin::Edge::markAsTriggered	(	const QPoint &	cursorPos,
		const QDateTime &	triggerTime )

Definition at line 331 of file screenedge.cpp.

◆ output()

Output * KWin::Edge::output ( ) const

Definition at line 762 of file screenedge.cpp.

◆ reserve [1/2]

void KWin::Edge::reserve ( )

slot

Definition at line 154 of file screenedge.cpp.

◆ reserve() [2/2]

void KWin::Edge::reserve	(	QObject *	object,
		const char *	slot )

Definition at line 163 of file screenedge.cpp.

◆ reserveTouchCallBack()

void KWin::Edge::reserveTouchCallBack	(	QAction *	action,
		TouchCallback::CallbackFunction	callback = nullptr )

Definition at line 170 of file screenedge.cpp.

◆ setAction

void KWin::Edge::setAction ( ElectricBorderAction action )

inlineslot

Definition at line 481 of file screenedge.h.

◆ setBorder

void KWin::Edge::setBorder ( ElectricBorder border )

slot

Definition at line 718 of file screenedge.cpp.

◆ setClient()

void KWin::Edge::setClient ( Window * client )

Definition at line 748 of file screenedge.cpp.

◆ setGeometry

void KWin::Edge::setGeometry ( const QRect & geometry )

slot

Definition at line 540 of file screenedge.cpp.

◆ setOutput()

void KWin::Edge::setOutput ( Output * output )

Definition at line 757 of file screenedge.cpp.

◆ setTouchAction()

void KWin::Edge::setTouchAction ( ElectricBorderAction action )

Definition at line 739 of file screenedge.cpp.

◆ startApproaching()

void KWin::Edge::startApproaching ( )

Definition at line 631 of file screenedge.cpp.

◆ stopApproaching()

void KWin::Edge::stopApproaching ( )

Definition at line 646 of file screenedge.cpp.

◆ triggersFor()

bool KWin::Edge::triggersFor ( const QPoint & cursorPos ) const

Definition at line 281 of file screenedge.cpp.

◆ unreserve [1/2]

void KWin::Edge::unreserve ( )

slot

Definition at line 205 of file screenedge.cpp.

◆ unreserve [2/2]

void KWin::Edge::unreserve ( QObject * object )

slot

Definition at line 214 of file screenedge.cpp.

◆ unreserveTouchCallBack()

void KWin::Edge::unreserveTouchCallBack ( QAction * action )

Definition at line 194 of file screenedge.cpp.

◆ updateApproaching

void KWin::Edge::updateApproaching ( const QPointF & point )

slot

Definition at line 661 of file screenedge.cpp.

◆ window()

quint32 KWin::Edge::window ( ) const

virtual

The window id of the native window representing the edge. Default implementation returns 0, which means no window.

Reimplemented in KWin::WindowBasedEdge.

Definition at line 708 of file screenedge.cpp.

Friends And Related Symbol Documentation

◆ ScreenEdges

friend class ScreenEdges

friend

Definition at line 176 of file screenedge.h.

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

src/screenedge.h
src/screenedge.cpp

Public Slots

Signals

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Edge()

◆ ~Edge()

Member Function Documentation

◆ activatesForPointer()

◆ activatesForTouchGesture()

◆ activatesForTouchGestureChanged

◆ approachGeometry()

◆ approaching

◆ approachWindow()

◆ border()

◆ callBacks()

◆ check()

◆ checkBlocking

◆ client()

◆ doActivate()

◆ doDeactivate()

◆ doGeometryUpdate()

◆ doStartApproaching()

◆ doStopApproaching()

◆ doUpdateBlocking()

◆ edges() [1/2]

◆ edges() [2/2]

◆ geometry()

◆ isApproaching()

◆ isBlocked()

◆ isBottom()

◆ isCorner()

◆ isLeft()

◆ isReserved()

◆ isRight()

◆ isScreenEdge()

◆ isTop()

◆ markAsTriggered()

◆ output()

◆ reserve [1/2]

◆ reserve() [2/2]

◆ reserveTouchCallBack()

◆ setAction

◆ setBorder

◆ setClient()

◆ setGeometry

◆ setOutput()

◆ setTouchAction()

◆ startApproaching()

◆ stopApproaching()

◆ triggersFor()

◆ unreserve [1/2]

◆ unreserve [2/2]

◆ unreserveTouchCallBack()

◆ updateApproaching

◆ window()

Friends And Related Symbol Documentation

◆ ScreenEdges