#include <workspace_wrapper.h>

Inheritance diagram for KWin::WorkspaceWrapper:

Public Types
enum	ClientAreaOption { PlacementArea , MovementArea , MaximizeArea , MaximizeFullArea , FullScreenArea , WorkArea , FullArea , ScreenArea }

enum	ElectricBorder { ElectricTop , ElectricTopRight , ElectricRight , ElectricBottomRight , ElectricBottom , ElectricBottomLeft , ElectricLeft , ElectricTopLeft , ELECTRIC_COUNT , ElectricNone }

Public Slots
void	slotSwitchDesktopNext ()

void	slotSwitchDesktopPrevious ()

void	slotSwitchDesktopRight ()

void	slotSwitchDesktopLeft ()

void	slotSwitchDesktopUp ()

void	slotSwitchDesktopDown ()

void	slotSwitchToNextScreen ()

void	slotSwitchToPrevScreen ()

void	slotSwitchToRightScreen ()

void	slotSwitchToLeftScreen ()

void	slotSwitchToAboveScreen ()

void	slotSwitchToBelowScreen ()

void	slotWindowToNextScreen ()

void	slotWindowToPrevScreen ()

void	slotWindowToRightScreen ()

void	slotWindowToLeftScreen ()

void	slotWindowToAboveScreen ()

void	slotWindowToBelowScreen ()

void	slotToggleShowDesktop ()

void	slotWindowMaximize ()

void	slotWindowMaximizeVertical ()

void	slotWindowMaximizeHorizontal ()

void	slotWindowMinimize ()

void	slotWindowShade ()

void	slotWindowRaise ()

void	slotWindowLower ()

void	slotWindowRaiseOrLower ()

void	slotActivateAttentionWindow ()

void	slotWindowMoveLeft ()

void	slotWindowMoveRight ()

void	slotWindowMoveUp ()

void	slotWindowMoveDown ()

void	slotWindowExpandHorizontal ()

void	slotWindowExpandVertical ()

void	slotWindowShrinkHorizontal ()

void	slotWindowShrinkVertical ()

void	slotWindowQuickTileLeft ()

void	slotWindowQuickTileRight ()

void	slotWindowQuickTileTop ()

void	slotWindowQuickTileBottom ()

void	slotWindowQuickTileTopLeft ()

void	slotWindowQuickTileTopRight ()

void	slotWindowQuickTileBottomLeft ()

void	slotWindowQuickTileBottomRight ()

void	slotSwitchWindowUp ()

void	slotSwitchWindowDown ()

void	slotSwitchWindowRight ()

void	slotSwitchWindowLeft ()

void	slotIncreaseWindowOpacity ()

void	slotLowerWindowOpacity ()

void	slotWindowOperations ()

void	slotWindowClose ()

void	slotWindowMove ()

void	slotWindowResize ()

void	slotWindowAbove ()

void	slotWindowBelow ()

void	slotWindowOnAllDesktops ()

void	slotWindowFullScreen ()

void	slotWindowNoBorder ()

void	slotWindowToNextDesktop ()

void	slotWindowToPreviousDesktop ()

void	slotWindowToDesktopRight ()

void	slotWindowToDesktopLeft ()

void	slotWindowToDesktopUp ()

void	slotWindowToDesktopDown ()

void	sendClientToScreen (KWin::Window client, KWin::Output output)

void	showOutline (const QRect &geometry)

void	showOutline (int x, int y, int width, int height)

void	hideOutline ()

Signals
void	windowAdded (KWin::Window *window)

void	windowRemoved (KWin::Window *window)

void	windowActivated (KWin::Window *window)

void	desktopsChanged ()

void	desktopLayoutChanged ()

void	screensChanged ()

void	currentActivityChanged (const QString &id)

void	activitiesChanged (const QString &id)

void	activityAdded (const QString &id)

void	activityRemoved (const QString &id)

void	virtualScreenSizeChanged ()

void	virtualScreenGeometryChanged ()

void	currentDesktopChanged (KWin::VirtualDesktop *previous)

void	cursorPosChanged ()

Public Member Functions
Window *	activeWindow () const

void	setActiveWindow (Window *window)

QString	currentActivity () const

void	setCurrentActivity (const QString &activity)

QSize	desktopGridSize () const

int	desktopGridWidth () const

int	desktopGridHeight () const

int	workspaceWidth () const

int	workspaceHeight () const

QSize	workspaceSize () const

KWin::Output *	activeScreen () const

QList< KWin::Output * >	screens () const

QStringList	activityList () const

QSize	virtualScreenSize () const

QRect	virtualScreenGeometry () const

QPoint	cursorPos () const

QList< VirtualDesktop * >	desktops () const

VirtualDesktop *	currentDesktop () const

void	setCurrentDesktop (VirtualDesktop *desktop)

Q_INVOKABLE KWin::Output *	screenAt (const QPointF &pos) const

Q_INVOKABLE KWin::TileManager *	tilingForScreen (const QString &screenName) const

Q_INVOKABLE KWin::TileManager *	tilingForScreen (KWin::Output *output) const

Q_SCRIPTABLE QRectF	clientArea (ClientAreaOption option, KWin::Output output, KWin::VirtualDesktop desktop) const

Q_SCRIPTABLE QRectF	clientArea (ClientAreaOption option, KWin::Window *client) const

Q_SCRIPTABLE QRectF	clientArea (ClientAreaOption option, const KWin::Window *client) const

Q_SCRIPTABLE void	createDesktop (int position, const QString &name) const

Q_SCRIPTABLE void	removeDesktop (KWin::VirtualDesktop *desktop) const

Q_SCRIPTABLE QString	supportInformation () const

QList< KWin::Window * >	stackingOrder () const

Q_INVOKABLE void	raiseWindow (KWin::Window *window)

Q_SCRIPTABLE KWin::Window *	getClient (qulonglong windowId)

Q_INVOKABLE QList< KWin::Window * >	windowAt (const QPointF &pos, int count=1) const

Q_INVOKABLE bool	isEffectActive (const QString &pluginId) const

Protected Member Functions
	WorkspaceWrapper (QObject *parent=nullptr)

Properties
QList< KWin::VirtualDesktop * >	desktops

KWin::VirtualDesktop *	currentDesktop

KWin::Window *	activeWindow

QSize	desktopGridSize

int	desktopGridWidth

int	desktopGridHeight

int	workspaceWidth

int	workspaceHeight

QSize	workspaceSize

KWin::Output *	activeScreen

QList< KWin::Output * >	screens

QString	currentActivity

QStringList	activities

QSize	virtualScreenSize

QRect	virtualScreenGeometry

QList< KWin::Window * >	stackingOrder

QPoint	cursorPos

Detailed Description

Definition at line 28 of file workspace_wrapper.h.

Member Enumeration Documentation

◆ ClientAreaOption

enum KWin::WorkspaceWrapper::ClientAreaOption

Enumerator
PlacementArea	geometry where a window will be initially placed after being mapped window movement snapping area? ignore struts
MovementArea	geometry to which a window will be maximized
MaximizeArea	like MaximizeArea, but ignore struts - used e.g. for topmenu
MaximizeFullArea	area for fullscreen windows
FullScreenArea	whole workarea (all screens together)
WorkArea	whole area (all screens together), ignore struts
FullArea	one whole screen, ignore struts
ScreenArea

Definition at line 135 of file workspace_wrapper.h.

◆ ElectricBorder

enum KWin::WorkspaceWrapper::ElectricBorder

Enumerator
ElectricTop
ElectricTopRight
ElectricRight
ElectricBottomRight
ElectricBottom
ElectricBottomLeft
ElectricLeft
ElectricTopLeft
ELECTRIC_COUNT
ElectricNone

Definition at line 154 of file workspace_wrapper.h.

Constructor & Destructor Documentation

◆ WorkspaceWrapper()

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

explicitprotected

Definition at line 30 of file workspace_wrapper.cpp.

Member Function Documentation

◆ activeScreen()

Output * KWin::WorkspaceWrapper::activeScreen ( ) const

Definition at line 364 of file workspace_wrapper.cpp.

◆ activeWindow()

Window * KWin::WorkspaceWrapper::activeWindow ( ) const

Definition at line 72 of file workspace_wrapper.cpp.

◆ activitiesChanged

void KWin::WorkspaceWrapper::activitiesChanged ( const QString & id )

signal

Signal emitted whenever the list of activities changed.

Parameters

id	id of the new activity

◆ activityAdded

void KWin::WorkspaceWrapper::activityAdded ( const QString & id )

signal

This signal is emitted when a new activity is added

Parameters

id	id of the new activity

◆ activityList()

QStringList KWin::WorkspaceWrapper::activityList ( ) const

Definition at line 98 of file workspace_wrapper.cpp.

◆ activityRemoved

void KWin::WorkspaceWrapper::activityRemoved ( const QString & id )

signal

This signal is emitted when the activity is removed

Parameters

id	id of the removed activity

◆ clientArea() [1/3]

QRectF KWin::WorkspaceWrapper::clientArea	(	ClientAreaOption	option,
		const KWin::Window *	client ) const

Definition at line 232 of file workspace_wrapper.cpp.

◆ clientArea() [2/3]

QRectF KWin::WorkspaceWrapper::clientArea	(	ClientAreaOption	option,
		KWin::Output *	output,
		KWin::VirtualDesktop *	desktop ) const

Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas.

Parameters

option	The type of area which should be considered
screen	The screen for which the area should be considered
desktop	The desktop for which the area should be considered, in general there should not be a difference

Returns: The specified screen geometry

Definition at line 248 of file workspace_wrapper.cpp.

◆ clientArea() [3/3]

QRectF KWin::WorkspaceWrapper::clientArea	(	ClientAreaOption	option,
		KWin::Window *	client ) const

Overloaded method for convenience.

Parameters

client The Client for which the area should be retrieved

Returns: The specified screen geometry

Definition at line 240 of file workspace_wrapper.cpp.

◆ createDesktop()

void KWin::WorkspaceWrapper::createDesktop	(	int	position,
		const QString &	name ) const

Create a new virtual desktop at the requested position.

Parameters

position	The position of the desktop. It should be in range [0, count].
name	The name for the new desktop, if empty the default name will be used.

Definition at line 253 of file workspace_wrapper.cpp.

◆ currentActivity()

QString KWin::WorkspaceWrapper::currentActivity ( ) const

Definition at line 77 of file workspace_wrapper.cpp.

◆ currentActivityChanged

void KWin::WorkspaceWrapper::currentActivityChanged ( const QString & id )

signal

Signal emitted whenever the current activity changed.

Parameters

id	id of the new activity

◆ currentDesktop()

VirtualDesktop * KWin::WorkspaceWrapper::currentDesktop ( ) const

Definition at line 57 of file workspace_wrapper.cpp.

◆ currentDesktopChanged

void KWin::WorkspaceWrapper::currentDesktopChanged ( KWin::VirtualDesktop * previous )

signal

This signal is emitted when the current virtual desktop changes.

◆ cursorPos()

QPoint KWin::WorkspaceWrapper::cursorPos ( ) const

Definition at line 110 of file workspace_wrapper.cpp.

◆ cursorPosChanged

void KWin::WorkspaceWrapper::cursorPosChanged ( )

signal

This signal is emitted when the cursor position changes.

See also: cursorPos()

◆ desktopGridHeight()

int KWin::WorkspaceWrapper::desktopGridHeight ( ) const

Definition at line 349 of file workspace_wrapper.cpp.

◆ desktopGridSize()

QSize KWin::WorkspaceWrapper::desktopGridSize ( ) const

Definition at line 339 of file workspace_wrapper.cpp.

◆ desktopGridWidth()

int KWin::WorkspaceWrapper::desktopGridWidth ( ) const

Definition at line 344 of file workspace_wrapper.cpp.

◆ desktopLayoutChanged

void KWin::WorkspaceWrapper::desktopLayoutChanged ( )

signal

Signal emitted whenever the layout of virtual desktops changed. That is desktopGrid(Size/Width/Height) will have new values.

Since: 4.11

◆ desktops()

QList< VirtualDesktop * > KWin::WorkspaceWrapper::desktops ( ) const

Definition at line 62 of file workspace_wrapper.cpp.

◆ desktopsChanged

void KWin::WorkspaceWrapper::desktopsChanged ( )

signal

This signal is emitted when a virtual desktop is added or removed.

◆ getClient()

Window * KWin::WorkspaceWrapper::getClient ( qulonglong windowId )

Finds the Client with the given windowId.

Parameters

windowId The window Id of the Client

Returns: The found Client or null

Definition at line 295 of file workspace_wrapper.cpp.

◆ hideOutline

void KWin::WorkspaceWrapper::hideOutline ( )

slot

Hides the outline previously shown by showOutline.

Definition at line 278 of file workspace_wrapper.cpp.

◆ isEffectActive()

bool KWin::WorkspaceWrapper::isEffectActive ( const QString & pluginId ) const

Checks if a specific effect is currently active.

Parameters

pluginId The plugin Id of the effect to check.

Returns: true if the effect is loaded and currently active, false otherwise.

Since: 6.0

Definition at line 331 of file workspace_wrapper.cpp.

◆ raiseWindow()

void KWin::WorkspaceWrapper::raiseWindow ( KWin::Window * window )

Raises a Window above all others on the screen.

Parameters

window The Window to raise

Definition at line 288 of file workspace_wrapper.cpp.

◆ removeDesktop()

void KWin::WorkspaceWrapper::removeDesktop ( KWin::VirtualDesktop * desktop ) const

Removes the specified virtual desktop.

Definition at line 258 of file workspace_wrapper.cpp.

◆ screenAt()

Output * KWin::WorkspaceWrapper::screenAt ( const QPointF & pos ) const

Definition at line 374 of file workspace_wrapper.cpp.

◆ screens()

QList< Output * > KWin::WorkspaceWrapper::screens ( ) const

Definition at line 369 of file workspace_wrapper.cpp.

◆ screensChanged

void KWin::WorkspaceWrapper::screensChanged ( )

signal

Emitted when the output list changes, e.g. an output is connected or removed.

◆ sendClientToScreen

void KWin::WorkspaceWrapper::sendClientToScreen	(	KWin::Window *	client,
		KWin::Output *	output )

slot

Sends the Window to the given output.

Definition at line 391 of file workspace_wrapper.cpp.

◆ setActiveWindow()

void KWin::WorkspaceWrapper::setActiveWindow ( KWin::Window * window )

Definition at line 222 of file workspace_wrapper.cpp.

◆ setCurrentActivity()

void KWin::WorkspaceWrapper::setCurrentActivity ( const QString & activity )

Definition at line 89 of file workspace_wrapper.cpp.

◆ setCurrentDesktop()

void KWin::WorkspaceWrapper::setCurrentDesktop ( VirtualDesktop * desktop )

Definition at line 67 of file workspace_wrapper.cpp.

◆ showOutline [1/2]

void KWin::WorkspaceWrapper::showOutline ( const QRect & geometry )

slot

Shows an outline at the specified geometry. If an outline is already shown the outline is moved to the new position. Use hideOutline to remove the outline again.

Definition at line 268 of file workspace_wrapper.cpp.

◆ showOutline [2/2]

void KWin::WorkspaceWrapper::showOutline	(	int	x,
		int	y,
		int	width,
		int	height )

slot

Overloaded method for convenience.

Definition at line 273 of file workspace_wrapper.cpp.

◆ slotActivateAttentionWindow

void KWin::WorkspaceWrapper::slotActivateAttentionWindow ( )

slot

◆ slotIncreaseWindowOpacity

void KWin::WorkspaceWrapper::slotIncreaseWindowOpacity ( )

slot

◆ slotLowerWindowOpacity

void KWin::WorkspaceWrapper::slotLowerWindowOpacity ( )

slot

◆ slotSwitchDesktopDown

void KWin::WorkspaceWrapper::slotSwitchDesktopDown ( )

slot

◆ slotSwitchDesktopLeft

void KWin::WorkspaceWrapper::slotSwitchDesktopLeft ( )

slot

◆ slotSwitchDesktopNext

void KWin::WorkspaceWrapper::slotSwitchDesktopNext ( )

slot

◆ slotSwitchDesktopPrevious

void KWin::WorkspaceWrapper::slotSwitchDesktopPrevious ( )

slot

◆ slotSwitchDesktopRight

void KWin::WorkspaceWrapper::slotSwitchDesktopRight ( )

slot

◆ slotSwitchDesktopUp

void KWin::WorkspaceWrapper::slotSwitchDesktopUp ( )

slot

◆ slotSwitchToAboveScreen

void KWin::WorkspaceWrapper::slotSwitchToAboveScreen ( )

slot

◆ slotSwitchToBelowScreen

void KWin::WorkspaceWrapper::slotSwitchToBelowScreen ( )

slot

◆ slotSwitchToLeftScreen

void KWin::WorkspaceWrapper::slotSwitchToLeftScreen ( )

slot

◆ slotSwitchToNextScreen

void KWin::WorkspaceWrapper::slotSwitchToNextScreen ( )

slot

◆ slotSwitchToPrevScreen

void KWin::WorkspaceWrapper::slotSwitchToPrevScreen ( )

slot

◆ slotSwitchToRightScreen

void KWin::WorkspaceWrapper::slotSwitchToRightScreen ( )

slot

◆ slotSwitchWindowDown

void KWin::WorkspaceWrapper::slotSwitchWindowDown ( )

slot

◆ slotSwitchWindowLeft

void KWin::WorkspaceWrapper::slotSwitchWindowLeft ( )

slot

◆ slotSwitchWindowRight

void KWin::WorkspaceWrapper::slotSwitchWindowRight ( )

slot

◆ slotSwitchWindowUp

void KWin::WorkspaceWrapper::slotSwitchWindowUp ( )

slot

◆ slotToggleShowDesktop

void KWin::WorkspaceWrapper::slotToggleShowDesktop ( )

slot

◆ slotWindowAbove

void KWin::WorkspaceWrapper::slotWindowAbove ( )

slot

◆ slotWindowBelow

void KWin::WorkspaceWrapper::slotWindowBelow ( )

slot

◆ slotWindowClose

void KWin::WorkspaceWrapper::slotWindowClose ( )

slot

◆ slotWindowExpandHorizontal

void KWin::WorkspaceWrapper::slotWindowExpandHorizontal ( )

slot

◆ slotWindowExpandVertical

void KWin::WorkspaceWrapper::slotWindowExpandVertical ( )

slot

◆ slotWindowFullScreen

void KWin::WorkspaceWrapper::slotWindowFullScreen ( )

slot

◆ slotWindowLower

void KWin::WorkspaceWrapper::slotWindowLower ( )

slot

◆ slotWindowMaximize

void KWin::WorkspaceWrapper::slotWindowMaximize ( )

slot

◆ slotWindowMaximizeHorizontal

void KWin::WorkspaceWrapper::slotWindowMaximizeHorizontal ( )

slot

◆ slotWindowMaximizeVertical

void KWin::WorkspaceWrapper::slotWindowMaximizeVertical ( )

slot

◆ slotWindowMinimize

void KWin::WorkspaceWrapper::slotWindowMinimize ( )

slot

◆ slotWindowMove

void KWin::WorkspaceWrapper::slotWindowMove ( )

slot

◆ slotWindowMoveDown

void KWin::WorkspaceWrapper::slotWindowMoveDown ( )

slot

◆ slotWindowMoveLeft

void KWin::WorkspaceWrapper::slotWindowMoveLeft ( )

slot

◆ slotWindowMoveRight

void KWin::WorkspaceWrapper::slotWindowMoveRight ( )

slot

◆ slotWindowMoveUp

void KWin::WorkspaceWrapper::slotWindowMoveUp ( )

slot

◆ slotWindowNoBorder

void KWin::WorkspaceWrapper::slotWindowNoBorder ( )

slot

◆ slotWindowOnAllDesktops

void KWin::WorkspaceWrapper::slotWindowOnAllDesktops ( )

slot

◆ slotWindowOperations

void KWin::WorkspaceWrapper::slotWindowOperations ( )

slot

◆ slotWindowQuickTileBottom

void KWin::WorkspaceWrapper::slotWindowQuickTileBottom ( )

slot

◆ slotWindowQuickTileBottomLeft

void KWin::WorkspaceWrapper::slotWindowQuickTileBottomLeft ( )

slot

◆ slotWindowQuickTileBottomRight

void KWin::WorkspaceWrapper::slotWindowQuickTileBottomRight ( )

slot

◆ slotWindowQuickTileLeft

void KWin::WorkspaceWrapper::slotWindowQuickTileLeft ( )

slot

◆ slotWindowQuickTileRight

void KWin::WorkspaceWrapper::slotWindowQuickTileRight ( )

slot

◆ slotWindowQuickTileTop

void KWin::WorkspaceWrapper::slotWindowQuickTileTop ( )

slot

◆ slotWindowQuickTileTopLeft

void KWin::WorkspaceWrapper::slotWindowQuickTileTopLeft ( )

slot

◆ slotWindowQuickTileTopRight

void KWin::WorkspaceWrapper::slotWindowQuickTileTopRight ( )

slot

◆ slotWindowRaise

void KWin::WorkspaceWrapper::slotWindowRaise ( )

slot

◆ slotWindowRaiseOrLower

void KWin::WorkspaceWrapper::slotWindowRaiseOrLower ( )

slot

◆ slotWindowResize

void KWin::WorkspaceWrapper::slotWindowResize ( )

slot

◆ slotWindowShade

void KWin::WorkspaceWrapper::slotWindowShade ( )

slot

◆ slotWindowShrinkHorizontal

void KWin::WorkspaceWrapper::slotWindowShrinkHorizontal ( )

slot

◆ slotWindowShrinkVertical

void KWin::WorkspaceWrapper::slotWindowShrinkVertical ( )

slot

◆ slotWindowToAboveScreen

void KWin::WorkspaceWrapper::slotWindowToAboveScreen ( )

slot

◆ slotWindowToBelowScreen

void KWin::WorkspaceWrapper::slotWindowToBelowScreen ( )

slot

◆ slotWindowToDesktopDown

void KWin::WorkspaceWrapper::slotWindowToDesktopDown ( )

slot

◆ slotWindowToDesktopLeft

void KWin::WorkspaceWrapper::slotWindowToDesktopLeft ( )

slot

◆ slotWindowToDesktopRight

void KWin::WorkspaceWrapper::slotWindowToDesktopRight ( )

slot

◆ slotWindowToDesktopUp

void KWin::WorkspaceWrapper::slotWindowToDesktopUp ( )

slot

◆ slotWindowToLeftScreen

void KWin::WorkspaceWrapper::slotWindowToLeftScreen ( )

slot

◆ slotWindowToNextDesktop

void KWin::WorkspaceWrapper::slotWindowToNextDesktop ( )

slot

◆ slotWindowToNextScreen

void KWin::WorkspaceWrapper::slotWindowToNextScreen ( )

slot

◆ slotWindowToPreviousDesktop

void KWin::WorkspaceWrapper::slotWindowToPreviousDesktop ( )

slot

◆ slotWindowToPrevScreen

void KWin::WorkspaceWrapper::slotWindowToPrevScreen ( )

slot

◆ slotWindowToRightScreen

void KWin::WorkspaceWrapper::slotWindowToRightScreen ( )

slot

◆ stackingOrder()

QList< KWin::Window * > KWin::WorkspaceWrapper::stackingOrder ( ) const

List of Clients currently managed by KWin, orderd by their visibility (later ones cover earlier ones).

Definition at line 283 of file workspace_wrapper.cpp.

◆ supportInformation()

QString KWin::WorkspaceWrapper::supportInformation ( ) const

Provides support information about the currently running KWin instance.

Definition at line 263 of file workspace_wrapper.cpp.

◆ tilingForScreen() [1/2]

KWin::TileManager * KWin::WorkspaceWrapper::tilingForScreen ( const QString & screenName ) const

Definition at line 396 of file workspace_wrapper.cpp.

◆ tilingForScreen() [2/2]

KWin::TileManager * KWin::WorkspaceWrapper::tilingForScreen ( KWin::Output * output ) const

Definition at line 407 of file workspace_wrapper.cpp.

◆ virtualScreenGeometry()

QRect KWin::WorkspaceWrapper::virtualScreenGeometry ( ) const

Definition at line 381 of file workspace_wrapper.cpp.

◆ virtualScreenGeometryChanged

void KWin::WorkspaceWrapper::virtualScreenGeometryChanged ( )

signal

Emitted whenever the virtualScreenGeometry changes.

See also: virtualScreenGeometry()

Since: 5.0

◆ virtualScreenSize()

QSize KWin::WorkspaceWrapper::virtualScreenSize ( ) const

Definition at line 386 of file workspace_wrapper.cpp.

◆ virtualScreenSizeChanged

void KWin::WorkspaceWrapper::virtualScreenSizeChanged ( )

signal

Emitted whenever the virtualScreenSize changes.

See also: virtualScreenSize()

Since: 5.0

◆ windowActivated

void KWin::WorkspaceWrapper::windowActivated ( KWin::Window * window )

signal

◆ windowAdded

void KWin::WorkspaceWrapper::windowAdded ( KWin::Window * window )

signal

◆ windowAt()

QList< KWin::Window * > KWin::WorkspaceWrapper::windowAt	(	const QPointF &	pos,
		int	count = 1 ) const

Finds up to count windows at a particular location, prioritizing the topmost one first. A negative count returns all matching clients.

Parameters

pos	The location to look for
count	The number of clients to return

Returns: A list of Client objects

Definition at line 302 of file workspace_wrapper.cpp.

◆ windowRemoved

void KWin::WorkspaceWrapper::windowRemoved ( KWin::Window * window )

signal

◆ workspaceHeight()

int KWin::WorkspaceWrapper::workspaceHeight ( ) const

Definition at line 354 of file workspace_wrapper.cpp.

◆ workspaceSize()

QSize KWin::WorkspaceWrapper::workspaceSize ( ) const

Definition at line 227 of file workspace_wrapper.cpp.

◆ workspaceWidth()

int KWin::WorkspaceWrapper::workspaceWidth ( ) const

Definition at line 359 of file workspace_wrapper.cpp.

Property Documentation

◆ activeScreen

KWin::Output * KWin::WorkspaceWrapper::activeScreen

read

Definition at line 41 of file workspace_wrapper.h.

◆ activeWindow

KWin::Window * KWin::WorkspaceWrapper::activeWindow

readwrite

Definition at line 33 of file workspace_wrapper.h.

◆ activities

QStringList KWin::WorkspaceWrapper::activities

read

Definition at line 44 of file workspace_wrapper.h.

◆ currentActivity

QString KWin::WorkspaceWrapper::currentActivity

readwrite

Definition at line 43 of file workspace_wrapper.h.

◆ currentDesktop

KWin::VirtualDesktop * KWin::WorkspaceWrapper::currentDesktop

readwrite

Definition at line 32 of file workspace_wrapper.h.

◆ cursorPos

QPoint KWin::WorkspaceWrapper::cursorPos

read

The current position of the cursor.

Definition at line 65 of file workspace_wrapper.h.

◆ desktopGridHeight

int KWin::WorkspaceWrapper::desktopGridHeight

read

Definition at line 37 of file workspace_wrapper.h.

◆ desktopGridSize

QSize KWin::WorkspaceWrapper::desktopGridSize

read

Definition at line 35 of file workspace_wrapper.h.

◆ desktopGridWidth

int KWin::WorkspaceWrapper::desktopGridWidth

read

Definition at line 36 of file workspace_wrapper.h.

◆ desktops

QList<KWin::VirtualDesktop *> KWin::WorkspaceWrapper::desktops

read

Definition at line 31 of file workspace_wrapper.h.

◆ screens

QList<KWin::Output *> KWin::WorkspaceWrapper::screens

read

Definition at line 42 of file workspace_wrapper.h.

◆ stackingOrder

QList<KWin::Window *> KWin::WorkspaceWrapper::stackingOrder

read

List of Clients currently managed by KWin, orderd by their visibility (later ones cover earlier ones).

Definition at line 61 of file workspace_wrapper.h.

◆ virtualScreenGeometry

QRect KWin::WorkspaceWrapper::virtualScreenGeometry

read

The bounding geometry of all screens combined. Always starts at (0,0) and has virtualScreenSize as it's size.

See also: virtualScreenSize

Definition at line 56 of file workspace_wrapper.h.

◆ virtualScreenSize

QSize KWin::WorkspaceWrapper::virtualScreenSize

read

The bounding size of all screens combined. Overlapping areas are not counted multiple times.

See also: virtualScreenGeometry

Definition at line 50 of file workspace_wrapper.h.

◆ workspaceHeight

int KWin::WorkspaceWrapper::workspaceHeight

read

Definition at line 39 of file workspace_wrapper.h.

◆ workspaceSize

QSize KWin::WorkspaceWrapper::workspaceSize

read

Definition at line 40 of file workspace_wrapper.h.

◆ workspaceWidth

int KWin::WorkspaceWrapper::workspaceWidth

read

Definition at line 38 of file workspace_wrapper.h.

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

src/scripting/workspace_wrapper.h
src/scripting/workspace_wrapper.cpp

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ ClientAreaOption

◆ ElectricBorder

Constructor & Destructor Documentation

◆ WorkspaceWrapper()

Member Function Documentation

◆ activeScreen()

◆ activeWindow()

◆ activitiesChanged

◆ activityAdded

◆ activityList()

◆ activityRemoved

◆ clientArea() [1/3]

◆ clientArea() [2/3]

◆ clientArea() [3/3]

◆ createDesktop()

◆ currentActivity()

◆ currentActivityChanged

◆ currentDesktop()

◆ currentDesktopChanged

◆ cursorPos()

◆ cursorPosChanged

◆ desktopGridHeight()

◆ desktopGridSize()

◆ desktopGridWidth()

◆ desktopLayoutChanged

◆ desktops()

◆ desktopsChanged

◆ getClient()

◆ hideOutline

◆ isEffectActive()

◆ raiseWindow()

◆ removeDesktop()

◆ screenAt()

◆ screens()

◆ screensChanged

◆ sendClientToScreen

◆ setActiveWindow()

◆ setCurrentActivity()

◆ setCurrentDesktop()

◆ showOutline [1/2]

◆ showOutline [2/2]

◆ slotActivateAttentionWindow

◆ slotIncreaseWindowOpacity

◆ slotLowerWindowOpacity

◆ slotSwitchDesktopDown

◆ slotSwitchDesktopLeft

◆ slotSwitchDesktopNext

◆ slotSwitchDesktopPrevious

◆ slotSwitchDesktopRight

◆ slotSwitchDesktopUp

◆ slotSwitchToAboveScreen

◆ slotSwitchToBelowScreen

◆ slotSwitchToLeftScreen

◆ slotSwitchToNextScreen

◆ slotSwitchToPrevScreen

◆ slotSwitchToRightScreen

◆ slotSwitchWindowDown

◆ slotSwitchWindowLeft

◆ slotSwitchWindowRight

◆ slotSwitchWindowUp

◆ slotToggleShowDesktop

◆ slotWindowAbove

◆ slotWindowBelow

◆ slotWindowClose

◆ slotWindowExpandHorizontal

◆ slotWindowExpandVertical

◆ slotWindowFullScreen

◆ slotWindowLower

◆ slotWindowMaximize

◆ slotWindowMaximizeHorizontal

◆ slotWindowMaximizeVertical

◆ slotWindowMinimize