KWindowSystemProxy

#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 QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const 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 const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const 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)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

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
}
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
desktopthe 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
windowthe window to make active
timeX 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
windowthe 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
desktopthe number of the desktop
namethe 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
windowthe window
activitiesthe 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
windowthe window
onAllDesktopstrue 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
windowthe window
desktopthe number of the new desktop

Definition at line 129 of file kwindowsystemproxy.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat Jul 4 2020 22:38:59 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.