<HTML>
<HEAD>
<TITLE>class KWin</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>class KWin</h1>
</TD>
<TD valign="top" align="right" colspan="1">Class for interaction with the windowmanager.
<small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH>Definition</TH><TD><code>#include <<A HREF="kwin_h.html">kwin.h</A>></code></TD></TR>
<TR><TH><A HREF="full-list-KWin.html">List of all Methods</A></TH></TR>
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Types</h4><ul><LI>struct <A HREF="KWin__Info.html">Info</A>
</LI>
</ul><h4>Public Static Methods</h4><ul><LI>static void <b><A HREF="#ref1">setActiveWindow</A></b> ( WId win)
</LI>
<LI>static void <b><A HREF="#ref2">invokeContextHelp</A></b> ()
</LI>
<LI>static void <b><A HREF="#ref3">setSystemTrayWindowFor</A></b> ( WId trayWin, WId forWin )
</LI>
<LI>static Info <b><A HREF="#ref5">info</A></b> ( WId win )
</LI>
<LI>static <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qpixmap.html">QPixmap</A> <b><A HREF="#ref6">icon</A></b> ( WId win, int width = -1, int height = -1, bool scale = false )
</LI>
<LI>static void <b><A HREF="#ref7">setIcons</A></b> ( WId win, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qpixmap.html">QPixmap</A>& icon, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qpixmap.html">QPixmap</A>& miniIcon )
</LI>
<LI>static void <b><A HREF="#ref8">setType</A></b> ( WId win, <A HREF="NET.html#WindowType">NET::WindowType</A> windowType )
</LI>
<LI>static void <b><A HREF="#ref9">setState</A></b> ( WId win, unsigned long state )
</LI>
<LI>static void <b><A HREF="#ref10">clearState</A></b> ( WId win, unsigned long state )
</LI>
<LI>static void <b><A HREF="#ref11">setOnAllDesktops</A></b> ( WId win, bool b )
</LI>
<LI>static void <b><A HREF="#ref12">setOnDesktop</A></b> ( WId win, int desktop)
</LI>
<LI>static void <b><A HREF="#ref13">setStrut</A></b> ( WId win, int left, int right, int top, int bottom )
</LI>
<LI>static int <b><A HREF="#ref14">currentDesktop</A></b> ()
</LI>
<LI>static int <b><A HREF="#ref15">numberOfDesktops</A></b> ()
</LI>
<LI>static void <b><A HREF="#ref16">setCurrentDesktop</A></b> ( int desktop )
</LI>
<LI>static void <b><A HREF="#ref17">iconifyWindow</A></b> ( WId win, bool animation = true )
</LI>
<LI>static void <b><A HREF="#ref18">deIconifyWindow</A></b> ( WId win, bool animation = true )
</LI>
<LI>static void <b><A HREF="#ref19">appStarted</A></b> ()
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
Convenience access to certain properties and features of the
window manager.
</p>
<p> This class is not supposed to be instantiated. It exists mostly as
a namespace for the static member functions.
</p>
<p> In KDE-2.0, communication with the window manger 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/
</p>
<p> To access features of the NET-protocol, use the classes NETRootInfo
and NETWinInfo.
</p>
<p> The purpose of this class is to to provide easy access to the
most-commonly used NET-features with a simpler, KDEish interface.
</p>
<p> In addition, it encapsulates KDE functionality not yet provided by
the NET hints. Currently that is invokeContextHelp() and
setSystemTrayWindowFor() only.
</p>
<p></p>
<A NAME="setActiveWindow"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>setActiveWindow</strong> ( WId win)
<br></td><td align="right"><h3><strong>setActiveWindow</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Set window win to be the active window.
</p>
<p> This is a request to the window manager. It may or may not be
obeyed.
</p>
<A NAME="invokeContextHelp"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>invokeContextHelp</strong> ()
<br></td><td align="right"><h3><strong>invokeContextHelp</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Invoke interactive context help.
</p>
<A NAME="setSystemTrayWindowFor"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>setSystemTrayWindowFor</strong> ( WId trayWin, WId forWin )
<br></td><td align="right"><h3><strong>setSystemTrayWindowFor</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Makes <code>trayWin</code> a system tray window for <code>forWin</code>.
</p>
<p> A system tray window serves as an icon replacement. It's
displayed inside the panel's system tray.
</p>
<A NAME="KWin__Info.html"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td><strong>Info</strong> <small>(struct)</small></td><td align="right"><h3><strong>Info</strong></h3></td></tr></table><p></p><A NAME="info"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td> Info <strong>info</strong> ( WId win )
<br></td><td align="right"><h3><strong>info</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Retrieves information about window <code>win</code>.
</p>
<A NAME="icon"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qpixmap.html">QPixmap</A> <strong>icon</strong> ( WId win, int width = -1, int height = -1, bool scale = false )
<br></td><td align="right"><h3><strong>icon</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Retrieves an icon for window <code>win</code>.
</p>
<p> If <code>width</code> and <code>height</code> are specified, the best icon for the requested
size is returned.
</p>
<p> If <code>scale</code> is true, the icon is smooth-scaled to have exactly
the requested size.
</p>
<p> </p>
<A NAME="setIcons"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>setIcons</strong> ( WId win, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qpixmap.html">QPixmap</A>& icon, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qpixmap.html">QPixmap</A>& miniIcon )
<br></td><td align="right"><h3><strong>setIcons</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Sets an <code>icon</code> and a <code>miniIcon</code> on window <code>win</code>
</p>
<A NAME="setType"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>setType</strong> ( WId win, <A HREF="NET.html#WindowType">NET::WindowType</A> windowType )
<br></td><td align="right"><h3><strong>setType</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Sets the type of window <code>win</code> to <code>windowType</code>.
</p>
<p> Possible values are NET::Normal, NET::Desktop, NET::Dock,
NET::Tool, NET::Menu, NET::Dialog or NET::Override (== no
decoration frame)
</p>
<A NAME="setState"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>setState</strong> ( WId win, unsigned long state )
<br></td><td align="right"><h3><strong>setState</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Sets the state of window <code>win</code> to <code>state</code>.
</p>
<p> Possible values are or'ed combinations of NET::Modal,
NET::Sticky, NET::MaxVert, NET::MaxHoriz, NET::Shaded,
NET::SkipTaskbar, NET::StaysOnTop, NET::SkipPager
</p>
<A NAME="clearState"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>clearState</strong> ( WId win, unsigned long state )
<br></td><td align="right"><h3><strong>clearState</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Clears the state of window <code>win</code> from <code>state</code>.
</p>
<p> Possible values are or'ed combinations of NET::Modal,
NET::Sticky, NET::MaxVert, NET::MaxHoriz, NET::Shaded,
NET::SkipTaskbar, NET::StaysOnTop, NET::SkipPager
</p>
<A NAME="setOnAllDesktops"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>setOnAllDesktops</strong> ( WId win, bool b )
<br></td><td align="right"><h3><strong>setOnAllDesktops</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Sets window <code>win</code> to be present on all virtual desktops if <code>is</code> true. Otherwise the window lives only on one single desktop.
</p>
<A NAME="setOnDesktop"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>setOnDesktop</strong> ( WId win, int desktop)
<br></td><td align="right"><h3><strong>setOnDesktop</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Move window <code>win</code> to desktop <code>desktop</code>.
</p>
<A NAME="setStrut"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>setStrut</strong> ( WId win, int left, int right, int top, int bottom )
<br></td><td align="right"><h3><strong>setStrut</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Sets the strut of window <code>win</code> to <code>left</code>, @right, @top, @bottom.
</p>
<p> </p>
<A NAME="currentDesktop"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td> int <strong>currentDesktop</strong> ()
<br></td><td align="right"><h3><strong>currentDesktop</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Convienence function to access the current desktop. See NETRootInfo.
</p>
<A NAME="numberOfDesktops"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td> int <strong>numberOfDesktops</strong> ()
<br></td><td align="right"><h3><strong>numberOfDesktops</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Convienence function to access the number of desktops. See
NETRootInfo.
</p>
<A NAME="setCurrentDesktop"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>setCurrentDesktop</strong> ( int desktop )
<br></td><td align="right"><h3><strong>setCurrentDesktop</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Convienence function to set the current desktop to <code>desktop</code>.
See NETRootInfo.
</p>
<A NAME="iconifyWindow"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>iconifyWindow</strong> ( WId win, bool animation = true )
<br></td><td align="right"><h3><strong>iconifyWindow</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Iconifies a window. Compatible to XIconifyWindow but has an
additional parameter <code>animation</code>.
</p>
<p> <A HREF="KWin.html#deIconifyWindow">deIconifyWindow</A>()
</p>
<A NAME="deIconifyWindow"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>deIconifyWindow</strong> ( WId win, bool animation = true )
<br></td><td align="right"><h3><strong>deIconifyWindow</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
DeIconifies a window. Compatible to XMapWindow but has an
additional parameter <code>animation</code>.
</p>
<p> <A HREF="KWin.html#iconifyWindow">iconifyWindow</A>()
</p>
<A NAME="appStarted"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>appStarted</strong> ()
<br></td><td align="right"><h3><strong>appStarted</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Use <A HREF="KStartupInfo.html#appStarted">KStartupInfo::appStarted</A>
</p>
<HR><UL><LI><i>Author</i>: s Matthias Ettrich (ettrich@kde.org)
</LI><LI><i>Generated</i>: qateam on updates.mandrakesoft.com on Mon Dec 30 16:08:56 2002, using kdoc 2.0a53.</LI></UL></BODY></HTML>
