class KWin

Class for interaction with the windowmanager. More...

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

Public Types

Public Static Methods


Detailed Description

Get or modify window properties and to interact with the windowmanager.

This class is not supposed to be instantiated. It exists mostly as a namespace for the static member functions.

It implements the new NET-protocol, a common window manager specification designed by various authors of X11 window managers. TODO: Add more information here, links etc. once the spec is done and fully implemented.

int  numberOfDesktops ()

[static]

Rerieve the number of virtual desktops.

void  setNumberOfDesktops (int num)

[static]

Set the number of virtual desktops.

This is a request to the window manager. It may or may not be obeyed.

int  currentDesktop ()

[static]

The current virtual desktop.

Returns: On success a number > 0 indicating the desktop. 0 if the desktop is unknown.

void  setCurrentDesktop ( int desktop )

[static]

Set the current virtual desktop

This is a request to the window manager. It may or may not be obeyed.

WId  activeWindow ()

[static]

Retrieve the window which has the focus, or 0 if no window has the focus.

void  setActiveWindow ( WId win)

[static]

Set the active window.

This is a request to the window manager. It may or may not be obeyed.

void  setDockWindow (WId dockWin, WId forWin = 0 )

[static]

Register the window dockWin as docking window for window forWin.

This is a low-level API. See KDockWindow in libkdeui for easier usage.

bool  isDockWindow ( WId dockWin, WId *forWin = 0 )

[static]

Test whether the window dockWin is a docking window.

If forWin is specified, forWin returns the window dockWin is docking for.

WindowState  windowState ( WId win )

[static]

Retrieve the state of the window win.

Possible states are NormalState, IconicState and WithdrawnState

void  invokeContextHelp ()

[static]

Invoke interactive context help.

void  avoid (WId win, AnchorEdge edge)

[static]

Add the window win to the list of those that should be avoided when maximising, mapping new windows etc.

Use edge to specify which edge your window is stuck to.

You can call this function as many times as you like. kwin will just forget about the old edge you were anchored to, so you can move to another one if you want.

void  stopAvoiding (WId win)

[static]

Remove the window win from the list of those that should be avoided.

This is useful if your window can be hidden in some way, e.g. kicker can be scrolled off-screen.

void  updateClientArea ()

[static]

Force a re-check of the area available to clients.

QRect  clientArea ()

[static]

Returns: area available to clients. This is adjusted from the desktop size to allow for edge-anchored windows.

QRect  edgeClientArea ()

[static]

Returns: area available to edge-anchored windows. This is adjusted from the desktop size to allow for other edge-anchored windows which have priority.