KWin::ScreenEdgeHandler Class Reference

Qml export for reserving a Screen Edge. More...

#include <screenedgehandler.h>

Inheritance diagram for KWin::ScreenEdgeHandler:

Public Types
enum	Edge {   TopEdge , TopRightEdge , RightEdge , BottomRightEdge ,   BottomEdge , BottomLeftEdge , LeftEdge , TopLeftEdge ,   EDGE_COUNT , NoEdge }
enum class	Mode { Pointer , Touch }

Public Slots
void	setEnabled (bool enabled)
void	setEdge (Edge edge)
void	setMode (Mode mode)

Signals
void	enabledChanged ()
void	edgeChanged ()
void	modeChanged ()
void	activated ()

Public Member Functions
	ScreenEdgeHandler (QObject *parent=nullptr)
	~ScreenEdgeHandler () override
bool	isEnabled () const
Edge	edge () const
Mode	mode () const

Properties
bool	enabled
	Whether the edge is currently enabled, that is reserved. Default value is true.
Edge	edge
	Which of the screen edges is to be reserved. Default value is NoEdge.
Mode	mode
	The operation mode for this edge. Default value is Mode::Pointer.

Detailed Description

Qml export for reserving a Screen Edge.

The edge is controlled by the enabled property and the edge property. If the edge is enabled and gets triggered the activated() signal gets emitted.

Example usage:

ScreenEdgeHandler {
    edge: ScreenEdgeHandler.LeftEdge
    onActivated: doSomething()
}

Definition at line 34 of file screenedgehandler.h.

Member Enumeration Documentation

Edge

enum KWin::ScreenEdgeHandler::Edge

Enumerator
TopEdge
TopRightEdge
RightEdge
BottomRightEdge
BottomEdge
BottomLeftEdge
LeftEdge
TopLeftEdge
EDGE_COUNT
NoEdge

Definition at line 50 of file screenedgehandler.h.

Mode

enum class KWin::ScreenEdgeHandler::Mode

strong

Enum describing the operation modes of the edge.

Enumerator
Pointer
Touch

Definition at line 66 of file screenedgehandler.h.

Constructor & Destructor Documentation

ScreenEdgeHandler()

KWin::ScreenEdgeHandler::ScreenEdgeHandler ( QObject * parent = nullptr )

explicit

Definition at line 21 of file screenedgehandler.cpp.

~ScreenEdgeHandler()

KWin::ScreenEdgeHandler::~ScreenEdgeHandler ( )

override

Definition at line 30 of file screenedgehandler.cpp.

Member Function Documentation

activated

void KWin::ScreenEdgeHandler::activated ( )

signal

edge()

ScreenEdgeHandler::Edge KWin::ScreenEdgeHandler::edge ( ) const

inline

Definition at line 109 of file screenedgehandler.h.

edgeChanged

void KWin::ScreenEdgeHandler::edgeChanged ( )

signal

enabledChanged

void KWin::ScreenEdgeHandler::enabledChanged ( )

signal

isEnabled()

bool KWin::ScreenEdgeHandler::isEnabled ( ) const

inline

Definition at line 104 of file screenedgehandler.h.

mode()

Mode KWin::ScreenEdgeHandler::mode ( ) const

inline

Definition at line 75 of file screenedgehandler.h.

modeChanged

void KWin::ScreenEdgeHandler::modeChanged ( )

signal

setEdge

void KWin::ScreenEdgeHandler::setEdge ( Edge edge )

slot

Definition at line 45 of file screenedgehandler.cpp.

setEnabled

void KWin::ScreenEdgeHandler::setEnabled ( bool enabled )

slot

Definition at line 34 of file screenedgehandler.cpp.

setMode

void KWin::ScreenEdgeHandler::setMode ( Mode mode )

slot

Definition at line 99 of file screenedgehandler.cpp.

Property Documentation

edge

Edge KWin::ScreenEdgeHandler::edge

readwrite

Which of the screen edges is to be reserved. Default value is NoEdge.

Definition at line 44 of file screenedgehandler.h.

enabled

bool KWin::ScreenEdgeHandler::enabled

readwrite

Whether the edge is currently enabled, that is reserved. Default value is true.

Definition at line 40 of file screenedgehandler.h.

mode

Mode KWin::ScreenEdgeHandler::mode

readwrite

The operation mode for this edge. Default value is Mode::Pointer.

Definition at line 48 of file screenedgehandler.h.

---

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

• src/scripting/screenedgehandler.h
• src/scripting/screenedgehandler.cpp