.TH "NETRootInfo" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
NETRootInfo \- Common API for root window properties/protocols.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <netwm.h>\fP
.PP
Inherits \fBNET\fP.
.PP
Inherited by KWinModulePrivate, and \fBNETRootInfo2\fP.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum { \fBPROTOCOLS\fP, \fBWINDOW_TYPES\fP, \fBSTATES\fP, \fBPROTOCOLS2\fP, \fBACTIONS\fP, \fBPROPERTIES_SIZE\fP }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBNETRootInfo\fP (Display *display, Window supportWindow, const char *wmName, const unsigned long properties[], int properties_size, int screen=-1, bool doActivate=true)"
.br
.ti -1c
.RI "\fBNETRootInfo\fP (Display *display, Window supportWindow, const char *wmName, unsigned long properties, int screen=-1, bool doActivate=true) KDE_DEPRECATED"
.br
.ti -1c
.RI "\fBNETRootInfo\fP (Display *display, const unsigned long properties[], int properties_size, int screen=-1, bool doActivate=true)"
.br
.ti -1c
.RI "\fBNETRootInfo\fP (Display *display, unsigned long properties, int screen=-1, bool doActivate=true)"
.br
.ti -1c
.RI "\fBNETRootInfo\fP (const \fBNETRootInfo\fP &rootinfo)"
.br
.ti -1c
.RI "virtual \fB~NETRootInfo\fP ()"
.br
.ti -1c
.RI "Display * \fBx11Display\fP () const "
.br
.ti -1c
.RI "Window \fBrootWindow\fP () const "
.br
.ti -1c
.RI "Window \fBsupportWindow\fP () const "
.br
.ti -1c
.RI "const char * \fBwmName\fP () const "
.br
.ti -1c
.RI "int \fBscreenNumber\fP () const "
.br
.ti -1c
.RI "bool \fBisSupported\fP (\fBNET::Property\fP property) const "
.br
.ti -1c
.RI "bool \fBisSupported\fP (\fBNET::Property2\fP property) const "
.br
.ti -1c
.RI "bool \fBisSupported\fP (\fBNET::WindowType\fP type) const "
.br
.ti -1c
.RI "bool \fBisSupported\fP (\fBNET::State\fP state) const "
.br
.ti -1c
.RI "bool \fBisSupported\fP (\fBNET::Action\fP action) const "
.br
.ti -1c
.RI "const unsigned long * \fBsupportedProperties\fP () const "
.br
.ti -1c
.RI "const unsigned long * \fBpassedProperties\fP () const "
.br
.ti -1c
.RI "unsigned long \fBsupported\fP () const KDE_DEPRECATED"
.br
.ti -1c
.RI "const Window * \fBclientList\fP () const "
.br
.ti -1c
.RI "int \fBclientListCount\fP () const "
.br
.ti -1c
.RI "const Window * \fBclientListStacking\fP () const "
.br
.ti -1c
.RI "int \fBclientListStackingCount\fP () const "
.br
.ti -1c
.RI "const Window * \fBkdeSystemTrayWindows\fP () const "
.br
.ti -1c
.RI "int \fBkdeSystemTrayWindowsCount\fP () const "
.br
.ti -1c
.RI "\fBNETSize\fP \fBdesktopGeometry\fP (int desktop) const "
.br
.ti -1c
.RI "\fBNETPoint\fP \fBdesktopViewport\fP (int desktop) const "
.br
.ti -1c
.RI "\fBNETRect\fP \fBworkArea\fP (int desktop) const "
.br
.ti -1c
.RI "const char * \fBdesktopName\fP (int desktop) const "
.br
.ti -1c
.RI "const Window * \fBvirtualRoots\fP () const "
.br
.ti -1c
.RI "int \fBvirtualRootsCount\fP () const "
.br
.ti -1c
.RI "int \fBnumberOfDesktops\fP () const "
.br
.ti -1c
.RI "int \fBcurrentDesktop\fP () const "
.br
.ti -1c
.RI "Window \fBactiveWindow\fP () const "
.br
.ti -1c
.RI "void \fBactivate\fP ()"
.br
.ti -1c
.RI "void \fBsetClientList\fP (Window *windows, unsigned int count)"
.br
.ti -1c
.RI "void \fBsetClientListStacking\fP (Window *windows, unsigned int count)"
.br
.ti -1c
.RI "void \fBsetKDESystemTrayWindows\fP (Window *windows, unsigned int count)"
.br
.ti -1c
.RI "void \fBsetCurrentDesktop\fP (int desktop)"
.br
.ti -1c
.RI "void \fBsetDesktopGeometry\fP (int desktop, const \fBNETSize\fP &geometry)"
.br
.ti -1c
.RI "void \fBsetDesktopViewport\fP (int desktop, const \fBNETPoint\fP &viewport)"
.br
.ti -1c
.RI "void \fBsetNumberOfDesktops\fP (int numberOfDesktops)"
.br
.ti -1c
.RI "void \fBsetDesktopName\fP (int desktop, const char *desktopName)"
.br
.ti -1c
.RI "void \fBsetActiveWindow\fP (Window window, \fBNET::RequestSource\fP src, Time timestamp, Window active_window)"
.br
.ti -1c
.RI "void \fBsetActiveWindow\fP (Window window)"
.br
.ti -1c
.RI "void \fBsetWorkArea\fP (int desktop, const \fBNETRect\fP &workArea)"
.br
.ti -1c
.RI "void \fBsetVirtualRoots\fP (Window *windows, unsigned int count)"
.br
.ti -1c
.RI "const \fBNETRootInfo\fP & \fBoperator=\fP (const \fBNETRootInfo\fP &rootinfo)"
.br
.ti -1c
.RI "void \fBcloseWindowRequest\fP (Window window)"
.br
.ti -1c
.RI "void \fBmoveResizeRequest\fP (Window window, int x_root, int y_root, \fBDirection\fP direction)"
.br
.ti -1c
.RI "void \fBmoveResizeWindowRequest\fP (Window window, int flags, int x, int y, int width, int height)"
.br
.ti -1c
.RI "void \fBrestackRequest\fP (Window window, \fBRequestSource\fP source, Window above, int detail, Time timestamp)"
.br
.ti -1c
.RI "void \fBrestackRequest\fP (Window window, Window above, int detail)"
.br
.ti -1c
.RI "void \fBevent\fP (XEvent *event, unsigned long *properties, int properties_size)"
.br
.ti -1c
.RI "unsigned long \fBevent\fP (XEvent *event)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBaddClient\fP (Window window)"
.br
.ti -1c
.RI "virtual void \fBremoveClient\fP (Window window)"
.br
.ti -1c
.RI "virtual void \fBaddSystemTrayWin\fP (Window window)"
.br
.ti -1c
.RI "virtual void \fBremoveSystemTrayWin\fP (Window window)"
.br
.ti -1c
.RI "virtual void \fBchangeNumberOfDesktops\fP (int numberOfDesktops)"
.br
.ti -1c
.RI "virtual void \fBchangeDesktopGeometry\fP (int desktop, const \fBNETSize\fP &geom)"
.br
.ti -1c
.RI "virtual void \fBchangeDesktopViewport\fP (int desktop, const \fBNETPoint\fP &viewport)"
.br
.ti -1c
.RI "virtual void \fBchangeCurrentDesktop\fP (int desktop)"
.br
.ti -1c
.RI "virtual KDE_DEPRECATED void \fBchangeActiveWindow\fP (Window window)"
.br
.ti -1c
.RI "virtual void \fBcloseWindow\fP (Window window)"
.br
.ti -1c
.RI "virtual void \fBmoveResize\fP (Window window, int x_root, int y_root, unsigned long direction)"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBNETRootInfo2\fP"
.br
.ti -1c
.RI "class \fBNETRootInfo3\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Common API for root window properties/protocols. 

The NETRootInfo class provides a common API for clients and window managers to set/read/change properties on the root window as defined by the \fBNET\fP Window Manager Specification..
.PP
\fBAuthor:\fP
.RS 4
Bradley T. Hughes <bhughes@trolltech.com> 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBNET\fP 
.PP
\fBNETWinInfo\fP 
.PP
KWin 
.RE
.PP

.PP
Definition at line 57 of file netwm.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "anonymous enum"
.PP
Indexes for the properties array. 
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 64 of file netwm.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "NETRootInfo::NETRootInfo (Display * display, Window supportWindow, const char * wmName, const unsigned long properties[], int properties_size, int screen = \fC-1\fP, bool doActivate = \fCtrue\fP)"
.PP
Window Managers should use this constructor to create a NETRootInfo object, which will be used to set/update information stored on the rootWindow. 
.PP
The application role is automatically set to WindowManager when using this constructor.
.PP
\fBParameters:\fP
.RS 4
\fIdisplay\fP An X11 Display struct.
.br
\fIsupportWindow\fP The Window id of the supportWindow. The supportWindow must be created by the window manager as a child of the rootWindow. The supportWindow must not be destroyed until the Window Manager exits.
.br
\fIwmName\fP A string which should be the window manager's name (ie. 'KWin' or 'Blackbox').
.br
\fIproperties\fP An array of elements listing all properties and protocols the window manager supports. The elements contain OR'ed values of constants from the \fBNET\fP base class, in the following order: [0]= \fBNET::Property\fP, [1]= \fBNET::WindowTypeMask\fP (not \fBNET::WindowType\fP!), [2]= \fBNET::State\fP, [3]= \fBNET::Property2\fP, [4]= \fBNET::Action\fP. In future versions, the list may be extended. In case you pass less elements, the missing ones will be replaced with default values.
.br
\fIproperties_size\fP The number of elements in the properties array.
.br
\fIscreen\fP For Window Managers that support multiple screen (ie. 'multiheaded') displays, the screen number may be explicitly defined. If this argument is omitted, the default screen will be used.
.br
\fIdoActivate\fP true to activate the window
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 562 of file netwm.cpp.
.SS "NETRootInfo::NETRootInfo (Display * display, Window supportWindow, const char * wmName, unsigned long properties, int screen = \fC-1\fP, bool doActivate = \fCtrue\fP)"
.PP
\fBDeprecated\fP
.RS 4
This constructor differs from the above one only in the way it accepts the list of supported properties. The properties argument is equivalent to the first element of the properties array in the above constructor. 
.RE
.PP

.PP
Definition at line 611 of file netwm.cpp.
.PP
References activate(), and wmName().
.SS "NETRootInfo::NETRootInfo (Display * display, const unsigned long properties[], int properties_size, int screen = \fC-1\fP, bool doActivate = \fCtrue\fP)"
.PP
Clients should use this constructor to create a NETRootInfo object, which will be used to query information set on the root window. 
.PP
The application role is automatically set to Client when using this constructor.
.PP
\fBParameters:\fP
.RS 4
\fIdisplay\fP An X11 Display struct.
.br
\fIproperties\fP An array of elements listing all protocols the client is interested in. The elements contain OR'ed values of constants from the \fBNET\fP base class, in the following order: [0]= \fBNET::Property\fP, [1]= \fBNET::Property2\fP.
.br
\fIproperties_size\fP The number of elements in the properties array.
.br
\fIscreen\fP For Clients that support multiple screen (ie. 'multiheaded') displays, the screen number may be explicitly defined. If this argument is omitted, the default screen will be used.
.br
\fIdoActivate\fP true to activate the window
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 655 of file netwm.cpp.
.PP
References activate().
.SS "NETRootInfo::NETRootInfo (Display * display, unsigned long properties, int screen = \fC-1\fP, bool doActivate = \fCtrue\fP)"
.PP
This constructor differs from the above one only in the way it accepts the list of supported properties. 
.PP
The properties argument is equivalent to the first element of the properties array in the above constructor, and therefore you cannot read all root window properties using it. 
.PP
Definition at line 712 of file netwm.cpp.
.PP
References activate().
.SS "NETRootInfo::NETRootInfo (const \fBNETRootInfo\fP & rootinfo)"
.PP
Creates a shared copy of the specified NETRootInfo object. 
.PP
\fBParameters:\fP
.RS 4
\fIrootinfo\fP the NETRootInfo object to copy 
.RE
.PP

.PP
Definition at line 775 of file netwm.cpp.
.SS "NETRootInfo::~\fBNETRootInfo\fP ()\fC [virtual]\fP"
.PP
Destroys the NETRootInfo object. 
.PP
Definition at line 790 of file netwm.cpp.
.SH "Member Function Documentation"
.PP 
.SS "Display * NETRootInfo::x11Display () const"
.PP
Returns the X11 Display struct used. 
.PP
\fBReturns:\fP
.RS 4
the X11 Display 
.RE
.PP

.PP
Definition at line 2428 of file netwm.cpp.
.SS "Window NETRootInfo::rootWindow () const"
.PP
Returns the Window id of the rootWindow. 
.PP
\fBReturns:\fP
.RS 4
the id of the root window 
.RE
.PP

.PP
Definition at line 2433 of file netwm.cpp.
.SS "Window NETRootInfo::supportWindow () const"
.PP
Returns the Window id of the supportWindow. 
.PP
\fBReturns:\fP
.RS 4
the id of the support window 
.RE
.PP

.PP
Definition at line 2438 of file netwm.cpp.
.SS "const char * NETRootInfo::wmName () const"
.PP
Returns the name of the Window Manager. 
.PP
\fBReturns:\fP
.RS 4
the name of the window manager 
.RE
.PP

.PP
Definition at line 2443 of file netwm.cpp.
.PP
Referenced by NETRootInfo().
.SS "int NETRootInfo::screenNumber () const"
.PP
Returns the screenNumber. 
.PP
\fBReturns:\fP
.RS 4
the screen number 
.RE
.PP

.PP
Definition at line 2447 of file netwm.cpp.
.SS "bool NETRootInfo::isSupported (\fBNET::Property\fP property) const"
.PP
Returns true if the given property is supported by the window manager. 
.PP
Note that for Client mode, NET::Supported needs to be passed in the properties argument for this to work. 
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 2468 of file netwm.cpp.
.PP
Referenced by KStartupInfo::setNewStartupId().
.SS "bool NETRootInfo::isSupported (\fBNET::Property2\fP property) const"
.PP
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 2472 of file netwm.cpp.
.SS "bool NETRootInfo::isSupported (\fBNET::WindowType\fP type) const"
.PP
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 2476 of file netwm.cpp.
.SS "bool NETRootInfo::isSupported (\fBNET::State\fP state) const"
.PP
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 2480 of file netwm.cpp.
.SS "bool NETRootInfo::isSupported (\fBNET::Action\fP action) const"
.PP
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 2484 of file netwm.cpp.
.SS "const unsigned long * NETRootInfo::supportedProperties () const"
.PP
In the Window Manager mode, this is equivalent to the properties argument passed to the constructor. 
.PP
In the Client mode, if NET::Supported was passed in the properties argument, the returned value is array of all protocols and properties supported by the Window Manager. The elements of the array are the same as they would be passed to the Window Manager mode constructor, the size is the maximum array size the constructor accepts.
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 2458 of file netwm.cpp.
.SS "const unsigned long * NETRootInfo::passedProperties () const"
.PP
Returns the properties argument passed to the constructor. 
.PP
The size is the maximum array size the constructor accepts.
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 2462 of file netwm.cpp.
.SS "unsigned long NETRootInfo::supported () const"
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP
Returns an OR'ed list of protocols passed to the constructor. For the constructor used by Window Managers, this is equivalent to the first element of the properties argument, for the constructor for Clients, it's the properties argument.
.PP
Clients willing to find out all properties and protocols supported by the WindowManager should use \fBsupportedProperties()\fP.
.PP
\fBReturns:\fP
.RS 4
an OR'ed list of protocols
.RE
.PP
\fBSee also:\fP
.RS 4
\fBNET::Property\fP 
.RE
.PP

.PP
Definition at line 2452 of file netwm.cpp.
.SS "const Window * NETRootInfo::clientList () const"
.PP
Returns an array of Window id's, which contain all managed windows. 
.PP
\fBReturns:\fP
.RS 4
the array of Window id's
.RE
.PP
\fBSee also:\fP
.RS 4
\fBclientListCount()\fP 
.RE
.PP

.PP
Definition at line 2488 of file netwm.cpp.
.SS "int NETRootInfo::clientListCount () const"
.PP
Returns the number of managed windows in clientList array. 
.PP
\fBReturns:\fP
.RS 4
the number of managed windows in the clientList array
.RE
.PP
\fBSee also:\fP
.RS 4
\fBclientList()\fP 
.RE
.PP

.PP
Definition at line 2493 of file netwm.cpp.
.SS "const Window * NETRootInfo::clientListStacking () const"
.PP
Returns an array of Window id's, which contain all managed windows in stacking order. 
.PP
\fBReturns:\fP
.RS 4
the array of Window id's in stacking order
.RE
.PP
\fBSee also:\fP
.RS 4
\fBclientListStackingCount()\fP 
.RE
.PP

.PP
Definition at line 2498 of file netwm.cpp.
.SS "int NETRootInfo::clientListStackingCount () const"
.PP
Returns the number of managed windows in the clientListStacking array. 
.PP
\fBReturns:\fP
.RS 4
the number of Window id's in the client list
.RE
.PP
\fBSee also:\fP
.RS 4
\fBclientListStacking()\fP 
.RE
.PP

.PP
Definition at line 2503 of file netwm.cpp.
.SS "const Window * NETRootInfo::kdeSystemTrayWindows () const"
.PP
Returns an array of Window id's, which contain all \fBKDE\fP system tray windows. 
.PP
\fBReturns:\fP
.RS 4
the array of Window id's of system tray windows
.RE
.PP
\fBSee also:\fP
.RS 4
\fBkdeSystemTrayWindowsCount()\fP 
.RE
.PP

.PP
Definition at line 2508 of file netwm.cpp.
.SS "int NETRootInfo::kdeSystemTrayWindowsCount () const"
.PP
Returns the number of windows in the kdeSystemTrayWindows array. 
.PP
\fBReturns:\fP
.RS 4
the number of Window id's in the system tray list
.RE
.PP
\fBSee also:\fP
.RS 4
\fBkdeSystemTrayWindows()\fP 
.RE
.PP

.PP
Definition at line 2513 of file netwm.cpp.
.SS "\fBNETSize\fP NETRootInfo::desktopGeometry (int desktop) const"
.PP
Returns the desktop geometry size. 
.PP
The desktop argument is ignored. Early drafts of the \fBNET\fP WM Specification were unclear about the semantics of this property.
.PP
\fBParameters:\fP
.RS 4
\fIdesktop\fP the number of the desktop
.RE
.PP
\fBReturns:\fP
.RS 4
the size of the desktop 
.RE
.PP

.PP
Definition at line 2518 of file netwm.cpp.
.PP
References NETSize::width.
.SS "\fBNETPoint\fP NETRootInfo::desktopViewport (int desktop) const"
.PP
Returns the viewport of the specified desktop. 
.PP
\fBParameters:\fP
.RS 4
\fIdesktop\fP the number of the desktop
.RE
.PP
\fBReturns:\fP
.RS 4
the position of the desktop's viewport 
.RE
.PP

.PP
Definition at line 2523 of file netwm.cpp.
.SS "\fBNETRect\fP NETRootInfo::workArea (int desktop) const"
.PP
Returns the workArea for the specified desktop. 
.PP
\fBParameters:\fP
.RS 4
\fIdesktop\fP the number of the desktop
.RE
.PP
\fBReturns:\fP
.RS 4
the size of the work area 
.RE
.PP

.PP
Definition at line 2533 of file netwm.cpp.
.SS "const char * NETRootInfo::desktopName (int desktop) const"
.PP
Returns the name for the specified desktop. 
.PP
\fBParameters:\fP
.RS 4
\fIdesktop\fP the number of the desktop
.RE
.PP
\fBReturns:\fP
.RS 4
the name of the desktop 
.RE
.PP

.PP
Definition at line 2543 of file netwm.cpp.
.PP
Referenced by setDesktopName().
.SS "const Window * NETRootInfo::virtualRoots () const"
.PP
Returns an array of Window id's, which contain the virtual root windows. 
.PP
\fBReturns:\fP
.RS 4
the array of Window id's
.RE
.PP
\fBSee also:\fP
.RS 4
\fBvirtualRootsCount()\fP 
.RE
.PP

.PP
Definition at line 2552 of file netwm.cpp.
.SS "int NETRootInfo::virtualRootsCount () const"
.PP
Returns the number of window in the virtualRoots array. 
.PP
\fBReturns:\fP
.RS 4
the number of Window id's in the virtual root array
.RE
.PP
\fBSee also:\fP
.RS 4
\fBvirtualRoots()\fP 
.RE
.PP

.PP
Definition at line 2557 of file netwm.cpp.
.SS "int NETRootInfo::numberOfDesktops () const"
.PP
Returns the number of desktops. 
.PP
\fBReturns:\fP
.RS 4
the number of desktops 
.RE
.PP

.PP
Definition at line 2562 of file netwm.cpp.
.SS "int NETRootInfo::currentDesktop () const"
.PP
Returns the current desktop. 
.PP
\fBReturns:\fP
.RS 4
the number of the current desktop 
.RE
.PP

.PP
Definition at line 2567 of file netwm.cpp.
.SS "Window NETRootInfo::activeWindow () const"
.PP
Returns the active (focused) window. 
.PP
\fBReturns:\fP
.RS 4
the id of the active window 
.RE
.PP

.PP
Definition at line 2572 of file netwm.cpp.
.SS "void NETRootInfo::activate ()"
.PP
Window Managers must call this after creating the NETRootInfo object, and before using any other method in the class. 
.PP
This method sets initial data on the root window and does other post-construction duties.
.PP
Clients must also call this after creating the object to do an initial data read/update. 
.PP
Definition at line 813 of file netwm.cpp.
.PP
Referenced by NETRootInfo().
.SS "void NETRootInfo::setClientList (Window * windows, unsigned int count)"
.PP
Sets the list of managed windows on the Root/Desktop window. 
.PP
\fBParameters:\fP
.RS 4
\fIwindows\fP The array of Window id's
.br
\fIcount\fP The number of windows in the array 
.RE
.PP

.PP
Definition at line 833 of file netwm.cpp.
.SS "void NETRootInfo::setClientListStacking (Window * windows, unsigned int count)"
.PP
Sets the list of managed windows in stacking order on the Root/Desktop window. 
.PP
\fBParameters:\fP
.RS 4
\fIwindows\fP The array of Window id's
.br
\fIcount\fP The number of windows in the array. 
.RE
.PP

.PP
Definition at line 852 of file netwm.cpp.
.SS "void NETRootInfo::setKDESystemTrayWindows (Window * windows, unsigned int count)"
.PP
Sets the list of \fBKDE\fP system tray windows on the root window. 
.PP
\fBParameters:\fP
.RS 4
\fIwindows\fP The array of window id's
.br
\fIcount\fP The number of windows in the array. 
.RE
.PP

.PP
Definition at line 871 of file netwm.cpp.
.SS "void NETRootInfo::setCurrentDesktop (int desktop)"
.PP
Sets the current desktop to the specified desktop. 
.PP
\fBParameters:\fP
.RS 4
\fIdesktop\fP the number of the desktop 
.RE
.PP

.PP
Definition at line 923 of file netwm.cpp.
.SS "void NETRootInfo::setDesktopGeometry (int desktop, const \fBNETSize\fP & geometry)"
.PP
Sets the desktop geometry to the specified geometry. 
.PP
The desktop argument is ignored. Early drafts of the \fBNET\fP WM Specification were unclear about the semantics of this property.
.PP
\fBParameters:\fP
.RS 4
\fIdesktop\fP the number of the desktop
.br
\fIgeometry\fP the new size of the desktop 
.RE
.PP

.PP
Definition at line 991 of file netwm.cpp.
.SS "void NETRootInfo::setDesktopViewport (int desktop, const \fBNETPoint\fP & viewport)"
.PP
Sets the viewport for the current desktop to the specified point. 
.PP
\fBParameters:\fP
.RS 4
\fIdesktop\fP the number of the desktop
.br
\fIviewport\fP the new position of the desktop's viewport 
.RE
.PP

.PP
Definition at line 1026 of file netwm.cpp.
.SS "void NETRootInfo::setNumberOfDesktops (int numberOfDesktops)"
.PP
Sets the number of desktops the the specified number. 
.PP
\fBParameters:\fP
.RS 4
\fInumberOfDesktops\fP the number of desktops 
.RE
.PP

.PP
Definition at line 891 of file netwm.cpp.
.SS "void NETRootInfo::setDesktopName (int desktop, const char * desktopName)"
.PP
Sets the name of the specified desktop. 
.PP
\fBParameters:\fP
.RS 4
\fIdesktop\fP the number of the desktop
.br
\fIdesktopName\fP the new name of the desktop 
.RE
.PP

.PP
Definition at line 955 of file netwm.cpp.
.PP
References desktopName().
.SS "void NETRootInfo::setActiveWindow (Window window, \fBNET::RequestSource\fP src, Time timestamp, Window active_window)"
.PP
Requests that the specified window becomes the active (focused) one. 
.PP
\fBParameters:\fP
.RS 4
\fIwindow\fP the id of the new active window 
.br
\fIsrc\fP whether the request comes from normal application or from a pager or similar tool 
.br
\fItimestamp\fP X server timestamp of the user action that caused the request 
.br
\fIactive_window\fP active window of the requesting application, if any
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 1491 of file netwm.cpp.
.PP
Referenced by setActiveWindow().
.SS "void NETRootInfo::setActiveWindow (Window window)"
.PP
Sets the active (focused) window the specified window. 
.PP
This should be used only in the window manager mode.
.PP
\fBParameters:\fP
.RS 4
\fIwindow\fP the if of the new active window 
.RE
.PP

.PP
Definition at line 1487 of file netwm.cpp.
.PP
References setActiveWindow().
.SS "void NETRootInfo::setWorkArea (int desktop, const \fBNETRect\fP & workArea)"
.PP
Sets the workarea for the specified desktop. 
.PP
\fBParameters:\fP
.RS 4
\fIdesktop\fP the number of the desktop
.br
\fIworkArea\fP the new work area of the desktop 
.RE
.PP

.PP
Definition at line 1522 of file netwm.cpp.
.SS "void NETRootInfo::setVirtualRoots (Window * windows, unsigned int count)"
.PP
Sets the list of virtual root windows on the root window. 
.PP
\fBParameters:\fP
.RS 4
\fIwindows\fP The array of Window id's
.br
\fIcount\fP The number of windows in the array. 
.RE
.PP

.PP
Definition at line 1551 of file netwm.cpp.
.SS "const \fBNETRootInfo\fP & NETRootInfo::operator= (const \fBNETRootInfo\fP & rootinfo)"
.PP
Assignment operator. 
.PP
Ensures that the shared data reference counts are correct. 
.PP
Definition at line 1720 of file netwm.cpp.
.PP
References p, and role.
.SS "void NETRootInfo::closeWindowRequest (Window window)"
.PP
Clients (such as pagers/taskbars) that wish to close a window should call this function. 
.PP
This will send a request to the Window Manager, which usually can usually decide how to react to such requests.
.PP
\fBParameters:\fP
.RS 4
\fIwindow\fP the id of the window to close 
.RE
.PP

.PP
Definition at line 1568 of file netwm.cpp.
.SS "void NETRootInfo::moveResizeRequest (Window window, int x_root, int y_root, \fBDirection\fP direction)"
.PP
Clients (such as pagers/taskbars) that wish to start a WMMoveResize (where the window manager controls the resize/movement, i.e. 
.PP
_NET_WM_MOVERESIZE) should call this function. This will send a request to the Window Manager.
.PP
\fBParameters:\fP
.RS 4
\fIwindow\fP The client window that would be resized/moved.
.br
\fIx_root\fP X position of the cursor relative to the root window.
.br
\fIy_root\fP Y position of the cursor relative to the root window.
.br
\fIdirection\fP One of \fBNET::Direction\fP (see base class documentation for a description of the different directions). 
.RE
.PP

.PP
Definition at line 1592 of file netwm.cpp.
.SS "void NETRootInfo::moveResizeWindowRequest (Window window, int flags, int x, int y, int width, int height)"
.PP
Clients (such as pagers/taskbars) that wish to move/resize a window using WM2MoveResizeWindow (_NET_MOVERESIZE_WINDOW) should call this function. 
.PP
This will send a request to the Window Manager. See _NET_MOVERESIZE_WINDOW description for details.
.PP
\fBParameters:\fP
.RS 4
\fIwindow\fP The client window that would be resized/moved. 
.br
\fIflags\fP Flags specifying the operation (see _NET_MOVERESIZE_WINDOW description) 
.br
\fIx\fP Requested X position for the window 
.br
\fIy\fP Requested Y position for the window 
.br
\fIwidth\fP Requested width for the window 
.br
\fIheight\fP Requested height for the window
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 1618 of file netwm.cpp.
.SS "void NETRootInfo::restackRequest (Window window, \fBRequestSource\fP source, Window above, int detail, Time timestamp)"
.PP
Sends the _NET_RESTACK_WINDOW request. 
.PP
\fBSince:\fP
.RS 4
3.3 
.RE
.PP

.PP
Definition at line 1648 of file netwm.cpp.
.PP
Referenced by restackRequest().
.SS "void NETRootInfo::restackRequest (Window window, Window above, int detail)"
.PP
\fBDeprecated\fP
.RS 4
\fBSince:\fP
.RS 4
3.2 
.RE
.PP
.RE
.PP

.PP
Definition at line 1643 of file netwm.cpp.
.PP
References restackRequest().
.SS "void NETRootInfo::event (XEvent * event, unsigned long * properties, int properties_size)"
.PP
This function takes the passed XEvent and returns an OR'ed list of NETRootInfo properties that have changed in the properties argument. 
.PP
The new information will be read immediately by the class. The elements of the properties argument are as they would be passed to the constructor, if the array is not large enough, changed properties that don't fit in it won't be listed there (they'll be updated in the class though).
.PP
\fBParameters:\fP
.RS 4
\fIevent\fP the event 
.br
\fIproperties\fP properties that changed 
.br
\fIproperties_size\fP size of the passed properties array 
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 1746 of file netwm.cpp.
.PP
References NETRootInfo2::changeActiveWindow(), changeActiveWindow(), changeCurrentDesktop(), changeDesktopGeometry(), changeDesktopViewport(), changeNumberOfDesktops(), closeWindow(), event(), NETRootInfo2::gotPing(), NETRootInfo3::gotTakeActivity(), NETSize::height, moveResize(), NETRootInfo2::moveResizeWindow(), NETRootInfo2::restackWindow(), NETRootInfo3::restackWindow(), NETSize::width, NETPoint::x, and NETPoint::y.
.PP
Referenced by event().
.SS "unsigned long NETRootInfo::event (XEvent * event)"
.PP
This function takes the passed XEvent and returns an OR'ed list of NETRootInfo properties that have changed. 
.PP
The new information will be read immediately by the class. This overloaded version returns only a single mask, and therefore cannot check state of all properties like the other variant.
.PP
\fBParameters:\fP
.RS 4
\fIevent\fP the event
.RE
.PP
\fBReturns:\fP
.RS 4
the properties 
.RE
.PP

.PP
Definition at line 1739 of file netwm.cpp.
.PP
References event().
.SS "virtual void NETRootInfo::addClient (Window window)\fC [inline, protected, virtual]\fP"
.PP
A Client should subclass NETRootInfo and reimplement this function when it wants to know when a window has been added. 
.PP
\fBParameters:\fP
.RS 4
\fIwindow\fP the id of the window to add 
.RE
.PP

.PP
Definition at line 618 of file netwm.h.
.SS "virtual void NETRootInfo::removeClient (Window window)\fC [inline, protected, virtual]\fP"
.PP
A Client should subclass NETRootInfo and reimplement this function when it wants to know when a window has been removed. 
.PP
\fBParameters:\fP
.RS 4
\fIwindow\fP the id of the window to remove 
.RE
.PP

.PP
Definition at line 626 of file netwm.h.
.SS "virtual void NETRootInfo::addSystemTrayWin (Window window)\fC [inline, protected, virtual]\fP"
.PP
A Client should subclass NETRootInfo and reimplement this function when it wants to know when a system tray window has been added. 
.PP
This is a \fBKDE\fP 2.0 extension.
.PP
\fBParameters:\fP
.RS 4
\fIwindow\fP the id of the window to add 
.RE
.PP

.PP
Definition at line 635 of file netwm.h.
.SS "virtual void NETRootInfo::removeSystemTrayWin (Window window)\fC [inline, protected, virtual]\fP"
.PP
A Client should subclass NETRootInfo and reimplement this function when it wants to know when a system tray window has been removed. 
.PP
This is a \fBKDE\fP 2.0 extension.
.PP
\fBParameters:\fP
.RS 4
\fIwindow\fP the id of the window to remove 
.RE
.PP

.PP
Definition at line 644 of file netwm.h.
.SS "virtual void NETRootInfo::changeNumberOfDesktops (int numberOfDesktops)\fC [inline, protected, virtual]\fP"
.PP
A Window Manager should subclass NETRootInfo and reimplement this function when it wants to know when a Client made a request to change the number of desktops. 
.PP
\fBParameters:\fP
.RS 4
\fInumberOfDesktops\fP the new number of desktops 
.RE
.PP

.PP
Definition at line 653 of file netwm.h.
.PP
Referenced by event().
.SS "virtual void NETRootInfo::changeDesktopGeometry (int desktop, const \fBNETSize\fP & geom)\fC [inline, protected, virtual]\fP"
.PP
A Window Manager should subclass NETRootInfo and reimplement this function when it wants to know when a Client made a request to change the specified desktop geometry. 
.PP
\fBParameters:\fP
.RS 4
\fIdesktop\fP the number of the desktop
.br
\fIgeom\fP the new size 
.RE
.PP

.PP
Definition at line 664 of file netwm.h.
.PP
Referenced by event().
.SS "virtual void NETRootInfo::changeDesktopViewport (int desktop, const \fBNETPoint\fP & viewport)\fC [inline, protected, virtual]\fP"
.PP
A Window Manager should subclass NETRootInfo and reimplement this function when it wants to know when a Client made a request to change the specified desktop viewport. 
.PP
\fBParameters:\fP
.RS 4
\fIdesktop\fP the number of the desktop
.br
\fIviewport\fP the new position of the viewport 
.RE
.PP

.PP
Definition at line 675 of file netwm.h.
.PP
Referenced by event().
.SS "virtual void NETRootInfo::changeCurrentDesktop (int desktop)\fC [inline, protected, virtual]\fP"
.PP
A Window Manager should subclass NETRootInfo and reimplement this function when it wants to know when a Client made a request to change the current desktop. 
.PP
\fBParameters:\fP
.RS 4
\fIdesktop\fP the number of the desktop 
.RE
.PP

.PP
Definition at line 684 of file netwm.h.
.PP
Referenced by event().
.SS "virtual KDE_DEPRECATED void NETRootInfo::changeActiveWindow (Window window)\fC [inline, protected, virtual]\fP"
.PP
\fBDeprecated\fP
.RS 4
Use \fBNETRootInfo2::changeActiveWindow()\fP instead. A Window Manager should subclass NETRootInfo and reimplement this function when it wants to know when a Client made a request to change the active (focused) window. The \fBchangeActiveWindow()\fP method in \fBNETRootInfo2\fP should be used instead. 
.RE
.PP
\fBParameters:\fP
.RS 4
\fIwindow\fP the id of the window to activate 
.RE
.PP

.PP
Definition at line 695 of file netwm.h.
.PP
Referenced by event().
.SS "virtual void NETRootInfo::closeWindow (Window window)\fC [inline, protected, virtual]\fP"
.PP
A Window Manager should subclass NETRootInfo and reimplement this function when it wants to know when a Client made a request to close a window. 
.PP
\fBParameters:\fP
.RS 4
\fIwindow\fP the id of the window to close 
.RE
.PP

.PP
Definition at line 703 of file netwm.h.
.PP
Referenced by event().
.SS "virtual void NETRootInfo::moveResize (Window window, int x_root, int y_root, unsigned long direction)\fC [inline, protected, virtual]\fP"
.PP
A Window Manager should subclass NETRootInfo and reimplement this function when it wants to know when a Client made a request to start a move/resize. 
.PP
\fBParameters:\fP
.RS 4
\fIwindow\fP The window that wants to move/resize
.br
\fIx_root\fP X position of the cursor relative to the root window.
.br
\fIy_root\fP Y position of the cursor relative to the root window.
.br
\fIdirection\fP One of \fBNET::Direction\fP (see base class documentation for a description of the different directions). 
.RE
.PP

.PP
Definition at line 718 of file netwm.h.
.PP
Referenced by event().

.SH "Author"
.PP 
Generated automatically by Doxygen for kdecore Library from the source code.
