class KWinModule

Base class for KDE Window Manager modules. More...

Definition#include <kwinmodule.h>
InheritsQObject
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Signals


Detailed Description

THIS API ISN'T FINISHED YET: IT'S STILL VERY COMPATIBLE WITH THE OLD KWMMODULEAPPLICATION. BE AWARE THAT IT MIGHT CHANGE A BIT BEFORE KDE-2.0 FREEZE

The class KWinModule provides information about the window manager required by windowmanager modules. It mainly informs a module about all currently managed windows and changes to them (via Qt signals). There are no methods to manipulate windows. These are defined in the class KWM (see kwm.h).

KWinModule ( QObject* parent = 0, bool dockModule = FALSE )

Create a KWinModule object and connect to the window manager. If @param dockModule is TRUE, the module will also serve as docking module.

~KWinModule ()

Destructor. Internal cleanup, nothing fancy.

const QValueList<WId>& windows ()
[const]

Retieve list of all toplevel windows currently managed by the windowmanger in the order of creation. Please do not rely on indexes of this list: Whenever you enter Qt's eventloop 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


  QValueList<WId>::ConstIterator it;
  for ( it = module->windows().begin(); 
        it != modules->windows().end(); ++it ) {
     ... do something here,  (*it) is the current WId.
       }

const QValueList<WId>& windowsSorted ()
[const]

Retrieve a list of all toplevel windows currently managed by the windowmanger in the current stacking order (from lower to higher). May be useful for pagers.

bool hasWId (WId)
[const]

Test to see if WId still managed at present.

const QValueList<WId>& dockWindows ()
[const]

Retrieve a list of the dock windows. Only valid if you are succesfully connected as a docking module.

void desktopChange (int)
[signal]

Switch to another virtual desktop

void windowAdd (WId)
[signal]

Add a window

void windowRemove (WId)
[signal]

Remove a window

void windowChange (WId)
[signal]

A window has been changed (size, title, etc.)

void windowActivate (WId)
[signal]

Hint that <Window> is active (= has focus) now.

void desktopNameChange (int, QString)
[signal]

The specified desktop got a new name

void desktopNumberChange (int)
[signal]

The number of desktops changed

void dockWindowAdd (WId)
[signal]

Add a dock window

void dockWindowRemove (WId)
[signal]

Remove a dock window

void workspaceAreaChanged ()
[signal]

The workspace area has changed

void stackingOrderChanged ()
[signal]

The stacking order of the window changed. The new order can be obtained with windowsSorted()