KWindowSystemProxy Class Reference

#include <kwindowsystemproxy.h>

Inheritance diagram for KWindowSystemProxy:

Properties
bool	compositingActive
int	currentDesktop
QString	currentDesktopName
int	numberOfDesktops
bool	showingDesktop
Properties inherited from QObject
	objectName

Signals
void	compositingActiveChanged (bool compositingActive)
void	currentDesktopChanged (int desktop)
void	currentDesktopNameChanged ()
void	desktopNamesChanged ()
void	numberOfDesktopsChanged (int numberOfDesktops)
void	showingDesktopChanged (bool showingDesktop)

Public Member Functions
	KWindowSystemProxy (QObject *parent=nullptr)
bool	compositingActive () const
int	currentDesktop () const
QString	currentDesktopName () const
Q_INVOKABLE QString	desktopName (int desktop) const
Q_INVOKABLE void	forceActivateWindow (QWindow *window, long time=0)
Q_INVOKABLE bool	hasWindow (QWindow *window) const
int	numberOfDesktops () const
void	setCurrentDesktop (int desktop)
Q_INVOKABLE void	setDesktopName (int desktop, const QString &name)
Q_INVOKABLE void	setOnActivities (QWindow *window, const QStringList &activities)
Q_INVOKABLE void	setOnAllDesktops (QWindow *window, bool onAllDesktops)
Q_INVOKABLE void	setOnDesktop (QWindow *window, int desktop)
void	setShowingDesktop (bool showingDesktop)
bool	showingDesktop () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const
bool	disconnect (const QObject *receiver, const char *method) const
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const
bool	inherits (const char *className) const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const
bool	isWindowType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
QString	objectName () const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const
QVariant	property (const char *name) const
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval, Qt::TimerType timerType)
QThread *	thread () const

Protected Member Functions
void	connectNotify (const QMetaMethod &signal) override
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)

Detailed Description

This item exposes various properties of KWindowSystem for use inside a QML environment.

Example usage:

import org.kde.kwindowsystem 1.0

KWindowSystem {
    id: kwindowsystem
}

Rectangle {
    width: 50
    height: 50
    color: "blue"
    opacity: kwindowsystem.compositingActive ? 0.5 : 1
}

Label {
    text: i18n("You are currently on Desktop '%1'", kwindowsystem.currentDesktopName)
}

Note

The features provided by this item are specific to the windowing system and might not be supported on any platform other than X11

Definition at line 54 of file kwindowsystemproxy.h.

Property Documentation

bool KWindowSystemProxy::compositingActive

read

Whether desktop compositing is active.

Note

This property is updated delayed

Definition at line 79 of file kwindowsystemproxy.h.

int KWindowSystemProxy::currentDesktop

readwrite

The number of the current desktop.

Definition at line 61 of file kwindowsystemproxy.h.

QString KWindowSystemProxy::currentDesktopName

read

The name of the current desktop.

Definition at line 65 of file kwindowsystemproxy.h.

int KWindowSystemProxy::numberOfDesktops

read

The number of desktops.

Definition at line 69 of file kwindowsystemproxy.h.

bool KWindowSystemProxy::showingDesktop

readwrite

Whether "show desktop" is currently active.

Definition at line 73 of file kwindowsystemproxy.h.

Member Function Documentation

QString KWindowSystemProxy::desktopName

(

int

desktop

)

const

Returns the name of the specified desktop.

See also

currentDesktopName

Parameters

desktop

the number of the desktop

Returns

the name of the desktop

Definition at line 143 of file kwindowsystemproxy.cpp.

void KWindowSystemProxy::forceActivateWindow	(	QWindow *	window,
		long	time = 0
	)

Sets window window to be the active window.

Note

This should be called only in special cases, applications shouldn't force themselves or other windows to be the active window. Generally, this call should used only by pagers and similar tools.

Parameters

window	the window to make active
time	X server timestamp of the user activity that caused this request

Definition at line 115 of file kwindowsystemproxy.cpp.

bool KWindowSystemProxy::hasWindow

(

QWindow *

window

)

const

Test to see if window still managed at present.

Parameters

window

the window to test

Definition at line 106 of file kwindowsystemproxy.cpp.

void KWindowSystemProxy::setDesktopName	(	int	desktop,
		const QString &	name
	)

Sets the name of the specified desktop.

Parameters

desktop	the number of the desktop
name	the new name for the desktop

Definition at line 148 of file kwindowsystemproxy.cpp.

void KWindowSystemProxy::setOnActivities	(	QWindow *	window,
		const QStringList &	activities
	)

Moves window window to activities activities.

Parameters

window	the window
activities	the list of activity UUIDs

Definition at line 136 of file kwindowsystemproxy.cpp.

void KWindowSystemProxy::setOnAllDesktops	(	QWindow *	window,
		bool	onAllDesktops
	)

Sets window window to be present on all virtual desktops if onAllDesktops true.

Otherwise the window lives only on one single desktop.

Parameters

window	the window
onAllDesktops	true to show the window on all desktops, false otherwise

Definition at line 122 of file kwindowsystemproxy.cpp.

void KWindowSystemProxy::setOnDesktop	(	QWindow *	window,
		int	desktop
	)

Moves window window to desktop desktop.

Parameters

window	the window
desktop	the number of the new desktop

Definition at line 129 of file kwindowsystemproxy.cpp.

---

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

• kwindowsystemproxy.h
• kwindowsystemproxy.cpp