class KWMModuleApplication

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

Definition#include <kwmmapp.h>
InheritsKApplication (kdecore)
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Members

Signals


Detailed Description

The class KWMModuleApplication is the base class for KDE 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).

void connectToKWM (bool dock_module = false)

Connect to KWM. This cannot be done in the constructor, since your application probably is not ready to recieve messages at this state.

bool x11EventFilter ( XEvent * )
[virtual]

if you inherit KWMModuleApplication and overload x11EventFilter, be sure to call its x11EventFilter in your x11EventFilter: if (KWMModuleApplication::x11EventFilter(XEvent *)) return True;

QList <Window> windows

A 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! So your module should perhaps work on a copy of this list and verify a window with hasWindow() before any operations.

QList <Window> windows_sorted

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 hasWindow (Window)

Is <Window> still managed at present?

QList <Window> dock_windows

The dock windows. Only valid if you are succesfully connected as docking module

void init ()
[signal]

Note that an init() may also be emitted if the window manager is restarted. So your module MUST react on it by clearing all internal data structures.

void initialized ()
[signal]

This signal is emitted when a connect is complete, i.e. when all existing windows or soundevents have been transfered to the module

void desktopChange (int)
[signal]

Switch to another virtual desktop

void windowAdd (Window)
[signal]

Add a window

void dialogWindowAdd (Window)
[signal]

Add a dialog window. Note that dialog windows are also included in the set of windows you recieve with windowAdd (see above). The dialogs are reported extra (before the windowAdd) to allow a taskbar to exclude them. The dialogWindowAdd signal is guaranteed to be emitted before the correspondinging windowAdd signal.

void windowRemove (Window)
[signal]

Remove a window

void windowChange (Window)
[signal]

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

void windowRaise (Window)
[signal]

Raise a window

void windowLower (Window)
[signal]

Lower a window

void windowActivate (Window)
[signal]

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

void commandReceived (QString)
[signal]

A command kwm did not understand. Maybe it is for your module.

void windowIconChanged (Window)
[signal]

This is not integrated into windowChange since reading icons is somewhat expensive via the KWM class.

void desktopNameChange (int, QString)
[signal]

The specified desktop got a new name

void desktopNumberChange (int)
[signal]

The number of desktops changed

void dockWindowAdd (Window)
[signal]

Add a dock window

void dockWindowRemove (Window)
[signal]

Remove a dock window

void playSound (QString)
[signal]

Play/register/unregister a sound