KWinModule Class Reference
The class KWinModule provides information about the state of the window manager as required by windowmanager modules. Base class for KDE Window Manager modules. More...
#include <kwinmodule.h>
Inheritance diagram for KWinModule:


Signals | |
void | currentDesktopChanged (int desktop) |
Switched to another virtual desktop. | |
void | windowAdded (WId id) |
A window has been added. | |
void | windowRemoved (WId id) |
A window has been removed. | |
void | activeWindowChanged (WId) |
Hint that is active (= has focus) now. | |
void | desktopNamesChanged () |
Desktops have been renamed. | |
void | numberOfDesktopsChanged (int num) |
The number of desktops changed. | |
void | systemTrayWindowAdded (WId id) |
Emitted when a dock window has been added. | |
void | systemTrayWindowRemoved (WId id) |
Emitted when a dock window has been removed. | |
void | workAreaChanged () |
The workarea has changed. | |
void | strutChanged () |
Something changed with the struts, may or may not have changed the work area. | |
void | stackingOrderChanged () |
Emitted when the stacking order of the window changed. | |
void | windowChanged (WId id, unsigned int properties) |
The window changed. | |
void | windowChanged (WId id) |
The window changed somehow. | |
Public Member Functions | |
KWinModule (QObject *parent=0) | |
Creates a KWinModule object and connects to the window manager. | |
~KWinModule () | |
Destructor. | |
const QValueList< WId > & | windows () const |
Returns the list of all toplevel windows currently managed by the window manager in the order of creation. | |
const QValueList< WId > & | stackingOrder () const |
Returns the list of all toplevel windows currently managed by the window manager in the current stacking order (from lower to higher). | |
bool | hasWId (WId id) const |
Test to see if id still managed at present. | |
const QValueList< WId > & | systemTrayWindows () const |
Returns a list of the system tray windows. | |
int | currentDesktop () const |
Returns the current virtual desktop. | |
int | numberOfDesktops () const |
Returns the number of virtual desktops. | |
WId | activeWindow () const |
Returns the currently active window, or 0 if no window is active. | |
QRect | workArea (int desktop=-1) const |
Returns the workarea for the specified desktop, or the current work area if no desktop has been specified. | |
QRect | workArea (const QValueList< WId > &excludes, int desktop=-1) const |
Returns the workarea for the specified desktop, or the current work area if no desktop has been specified. | |
QString | desktopName (int desktop) const |
Returns the name of the specified desktop. | |
void | setDesktopName (int desktop, const QString &name) |
Sets the name of the specified desktop. | |
void | doNotManage (const QString &title) |
Informs kwin via dcop to not manage a window with the specified title . | |
Friends | |
class | KWinModulePrivate |
Detailed Description
The class KWinModule provides information about the state of the window manager as required by windowmanager modules. Base class for KDE Window Manager modules.It informs a module about all currently managed windows and changes to them (via Qt signals).
KWinModule uses NETRootInfo internally. Modules written with this class will work fine under any window manager that implements the NET_WM protocol.
There are no methods to manipulate windows. Those are defined in the classes KWin, NETWinInfo and NETRootInfo.
- Author:
- Matthias Ettrich (ettrich@kde.org)
- Version:
- Id
- kwinmodule.h,v 1.16 2002/09/27 22:50:16 tjansen Exp
Definition at line 50 of file kwinmodule.h.
Constructor & Destructor Documentation
|
Creates a KWinModule object and connects to the window manager.
|
|
Destructor. Internal cleanup, nothing fancy. |
Member Function Documentation
|
Returns the list of all toplevel windows currently managed by the window manager in the order of creation. Please do not rely on indexes of this list: Whenever you enter Qt's event loop in your application, it may happen that entries are removed or added. Your module should perhaps work on a copy of this list and verify a window with hasWindow() before any operations. Iteration over this list can be done easily with
|
|
Returns the list of all toplevel windows currently managed by the window manager in the current stacking order (from lower to higher). May be useful for pagers.
|
|
Test to see if
|
|
Returns a list of the system tray windows.
|
|
Returns the current virtual desktop.
|
|
Returns the number of virtual desktops.
|
|
Returns the currently active window, or 0 if no window is active.
|
|
Returns the workarea for the specified desktop, or the current work area if no desktop has been specified.
|
|
Returns the workarea for the specified desktop, or the current work area if no desktop has been specified. Excludes struts of clients in the exclude List.
|
|
Returns the name of the specified desktop.
|
|
Sets the name of the specified desktop.
|
|
Informs kwin via dcop to not manage a window with the specified Useful for swallowing legacy applications, for example java applets.
|
|
Switched to another virtual desktop.
|
|
A window has been added.
|
|
A window has been removed.
|
|
Hint that is active (= has focus) now.
|
|
Desktops have been renamed.
|
|
The number of desktops changed.
|
|
Emitted when a dock window has been added.
|
|
Emitted when a dock window has been removed.
|
|
The workarea has changed.
|
|
Something changed with the struts, may or may not have changed the work area.
|
|
Emitted when the stacking order of the window changed. The new order can be obtained with stackingOrder(). |
|
The window changed. The unsigned int parameter contains the NET properties that were modified (see netem_def.h).
|
|
The window changed somehow.
|
The documentation for this class was generated from the following file: