class KWin

Public Types

• struct Info

Public Static Methods

• static void  setActiveWindow ( WId win)
• static void  invokeContextHelp ()
• static void  setSystemTrayWindowFor ( WId trayWin, WId forWin )
• static Info  info ( WId win )
• static QPixmap  icon ( WId win, int width = -1, int height = -1, bool scale = false )
• static void  setIcons ( WId win, const QPixmap& icon, const QPixmap& miniIcon )
• static void  setType ( WId win, NET::WindowType windowType )
• static void  setState ( WId win, unsigned long state )
• static void  clearState ( WId win, unsigned long state )
• static void  setOnAllDesktops ( WId win, bool b )
• static void  setOnDesktop ( WId win, int desktop)
• static void  setStrut ( WId win, int left, int right, int top, int bottom )
• static int  currentDesktop ()
• static int  numberOfDesktops ()
• static void  setCurrentDesktop ( int desktop )
• static void  iconifyWindow ( WId win, bool animation = true )
• static void  deIconifyWindow ( WId win, bool animation = true )
• static void  appStarted ()

Detailed Description

Convenience access to certain properties and features of the window manager.

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

In KDE 2 and KDE 3, communication with the windowmanager is done with the NET-protocol, a common window manager specification designed by various authors of X11 window managers (including those of the KDE project). The full specification can be found in kdebase/kwin/wm-spec/

To access features of the NET-protocol, use the classes NETRootInfo and NETWinInfo.

The purpose of this class is to to provide easy access to the most-commonly used NET-features with a simpler, KDEish interface.

In addition, it encapsulates KDE functionality not yet provided by the NET hints. Currently that is invokeContextHelp() and setSystemTrayWindowFor() only.

See also: NET, NetWinInfo

[static]

Sets window win to be the active window.

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

Parameters:

win	the if of the window to make active

[static]

Invokes interactive context help.

[static]

Makes trayWin a system tray window for forWin.

A system tray window serves as an icon replacement. It's displayed inside the panel's system tray.

Parameters:

trayWin	the id of the system tray window
trayWin	the id of the window represented by the system tray window

Information about a window.

[static]

Returns information about window win.

Parameters:

win	the id of the windoe

Returns: the window information

[static]

Returns an icon for window win.

If width and height are specified, the best icon for the requested size is returned.

If scale is true, the icon is smooth-scaled to have exactly the requested size.

Parameters:

win	the id of the window
the	desired width, or -1
the	desired height, or -1
if	true the icon will be scaled to the desired size. Otherwise the icon will not be modified.

Returns: the icon of the window

[static]

Sets an icon and a miniIcon on window win

Parameters:

win	the id of the window
icon	the new icon
miniIcon	the new mini icon

[static]

Sets the type of window win to windowType.

Possible values are NET::Normal, NET::Desktop, NET::Dock, NET::Tool, NET::Menu, NET::Dialog, NET::Override (== no decoration frame) or NET::TopMenu

Parameters:

win	the id of the window
windowType	the type of the window

[static]

Sets the state of window win to state.

Possible values are or'ed combinations of NET::Modal, NET::Sticky, NET::MaxVert, NET::MaxHoriz, NET::Shaded, NET::SkipTaskbar, NET::StaysOnTop, NET::SkipPager

Parameters:

win	the id of the window
state	the new flags that will be set

[static]

Clears the state of window win from state.

Possible values are or'ed combinations of NET::Modal, NET::Sticky, NET::MaxVert, NET::MaxHoriz, NET::Shaded, NET::SkipTaskbar, NET::StaysOnTop, NET::SkipPager

Parameters:

win	the id of the window
state	the flags that will be cleared

[static]

Sets window win to be present on all virtual desktops if is true. Otherwise the window lives only on one single desktop.

Parameters:

win	the id of the window
b	true to show the window on all desktops, false otherwise

[static]

Moves window win to desktop desktop.

Parameters:

win	the id of the window
desktop	the number of the new desktop

[static]

Sets the strut of window win to left, right, top, bottom.

Parameters:

win	the id of the window
left	the left strut
right	the right strut
top	the top strut
bottom	the bottom strut

[static]

Convenience function to access the current desktop. See NETRootInfo.

Returns: the number of the current desktop

[static]

Convenience function to access the number of desktops. See NETRootInfo.

Returns: the number of desktops

[static]

Convenience function to set the current desktop to desktop. See NETRootInfo.

Parameters:

the	number of the new desktop

[static]

Iconifies a window. Compatible to XIconifyWindow but has an additional parameter animation.

Parameters:

win	the id of the window
animation	true to show an animation

See also: deIconifyWindow()

[static]

DeIconifies a window. Compatible to XMapWindow but has an additional parameter animation.

Parameters:

win	the id of the window
animation	true to show an animation

See also: iconifyWindow()

[static]

Use KStartupInfo::appStarted

• Author: Matthias Ettrich (ettrich@kde.org)
• Generated: caleb on tcdevel on Tue Jan 28 12:54:04 2003, using kdoc $.