\section{NETWin\-Info Class Reference}
\label{classNETWinInfo}\index{NETWinInfo@{NETWinInfo}}
Common API for application window properties/protocols.  


{\tt \#include $<$netwm.h$>$}

Inheritance diagram for NETWin\-Info:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=53pt]{classNETWinInfo__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for NETWin\-Info:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=53pt]{classNETWinInfo__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item 
enum \{ {\bf PROTOCOLS}, 
{\bf PROTOCOLS2}, 
{\bf PROPERTIES\_\-SIZE}
 \}
\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf NETWin\-Info} (Display $\ast$display, Window window, Window root\-Window, const unsigned long properties[$\,$], int properties\_\-size, {\bf Role} role=Client)
\item 
{\bf NETWin\-Info} (Display $\ast$display, Window window, Window root\-Window, unsigned long properties, {\bf Role} role=Client)
\item 
{\bf NETWin\-Info} (const {\bf NETWin\-Info} \&wininfo)
\item 
virtual {\bf $\sim$NETWin\-Info} ()
\item 
const {\bf NETWin\-Info} \& {\bf operator=} (const {\bf NETWin\-Info} \&wintinfo)
\item 
bool {\bf has\-NETSupport} () const 
\item 
const unsigned long $\ast$ {\bf passed\-Properties} () const 
\item 
unsigned long {\bf properties} () const KDE\_\-DEPRECATED
\item 
{\bf NETRect} {\bf icon\-Geometry} () const 
\item 
unsigned long {\bf state} () const 
\item 
{\bf NETExtended\-Strut} {\bf extended\-Strut} () const 
\item 
{\bf NETStrut} {\bf strut} () const 
\item 
{\bf Window\-Type} {\bf window\-Type} (unsigned long supported\_\-types) const 
\item 
{\bf Window\-Type} {\bf window\-Type} () const KDE\_\-DEPRECATED
\item 
const char $\ast$ {\bf name} () const 
\item 
const char $\ast$ {\bf visible\-Name} () const 
\item 
const char $\ast$ {\bf icon\-Name} () const 
\item 
const char $\ast$ {\bf visible\-Icon\-Name} () const 
\item 
int {\bf desktop} () const 
\item 
int {\bf pid} () const 
\item 
Bool {\bf handled\-Icons} () const 
\item 
Window {\bf kde\-System\-Tray\-Win\-For} () const 
\item 
{\bf Mapping\-State} {\bf mapping\-State} () const 
\item 
void {\bf set\-Icon} ({\bf NETIcon} icon, Bool replace=True)
\item 
void {\bf set\-Icon\-Geometry} ({\bf NETRect} geometry)
\item 
void {\bf set\-Extended\-Strut} (const {\bf NETExtended\-Strut} \&extended\_\-strut)
\item 
void {\bf set\-Strut} ({\bf NETStrut} strut)
\item 
void {\bf set\-State} (unsigned long state, unsigned long mask)
\item 
void {\bf set\-Window\-Type} ({\bf Window\-Type} type)
\item 
void {\bf set\-Name} (const char $\ast$name)
\item 
void {\bf set\-Visible\-Name} (const char $\ast$visible\-Name)
\item 
void {\bf set\-Icon\-Name} (const char $\ast$name)
\item 
void {\bf set\-Visible\-Icon\-Name} (const char $\ast$name)
\item 
void {\bf set\-Desktop} (int desktop)
\item 
void {\bf set\-Pid} (int pid)
\item 
void {\bf set\-Handled\-Icons} (Bool handled)
\item 
void {\bf set\-KDESystem\-Tray\-Win\-For} (Window window)
\item 
void {\bf set\-KDEFrame\-Strut} ({\bf NETStrut} strut)
\item 
{\bf NETIcon} {\bf icon} (int width=-1, int height=-1) const 
\item 
void {\bf set\-User\-Time} (Time time)\label{classNETWinInfo_a39}

\item 
Time {\bf user\-Time} () const 
\item 
void {\bf set\-Startup\-Id} (const char $\ast$startup\_\-id)\label{classNETWinInfo_a41}

\item 
const char $\ast$ {\bf startup\-Id} () const 
\item 
void {\bf set\-Allowed\-Actions} (unsigned long actions)
\item 
unsigned long {\bf allowed\-Actions} () const 
\item 
Window {\bf transient\-For} () const \label{classNETWinInfo_a45}

\item 
Window {\bf group\-Leader} () const 
\item 
const char $\ast$ {\bf window\-Class\-Class} () const 
\item 
const char $\ast$ {\bf window\-Class\-Name} () const 
\item 
const char $\ast$ {\bf window\-Role} () const 
\item 
const char $\ast$ {\bf client\-Machine} () const 
\item 
void {\bf kde\-Geometry} ({\bf NETRect} \&frame, {\bf NETRect} \&window)
\item 
void {\bf event} (XEvent $\ast$event, unsigned long $\ast$properties, int properties\_\-size)
\item 
unsigned long {\bf event} (XEvent $\ast$event)
\end{CompactItemize}
\subsection*{Static Public Attributes}
\begin{CompactItemize}
\item 
static const int {\bf On\-All\-Desktops} = NET::On\-All\-Desktops
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
virtual void {\bf change\-Desktop} (int desktop)
\item 
virtual void {\bf change\-State} (unsigned long state, unsigned long mask)
\item 
virtual void {\bf virtual\_\-hook} (int id, void $\ast$data)\label{classNETWinInfo_b2}

\end{CompactItemize}


\subsection{Detailed Description}
Common API for application window properties/protocols. 

The NETWin\-Info class provides a common API for clients and window managers to set/read/change properties on an application window as defined by the {\bf NET}{\rm (p.\,\pageref{classNET})} Window Manager Specification.

\begin{Desc}
\item[Author:]Bradley T. Hughes $<${\tt bhughes@trolltech.com}$>$ \end{Desc}
\begin{Desc}
\item[See also:]{\bf NET}{\rm (p.\,\pageref{classNET})} 

{\bf NETRoot\-Info}{\rm (p.\,\pageref{classNETRootInfo})} 

KWin 

{\tt http://www.freedesktop.org/standards/wm-spec/} \end{Desc}




Definition at line 865 of file netwm.h.

\subsection{Member Enumeration Documentation}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}anonymous enum}\label{classNETWinInfo_w3}


Indexes for the properties array. 

\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 872 of file netwm.h.

\subsection{Constructor \& Destructor Documentation}
\index{NETWinInfo@{NETWin\-Info}!NETWinInfo@{NETWinInfo}}
\index{NETWinInfo@{NETWinInfo}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}NETWin\-Info::NETWin\-Info (Display $\ast$ {\em display}, Window {\em window}, Window {\em root\-Window}, const unsigned long {\em properties}[$\,$], int {\em properties\_\-size}, {\bf Role} {\em role} = {\tt Client})}\label{classNETWinInfo_a0}


Create a NETWin\-Info object, which will be used to set/read/change information stored on an application window. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em display}]An X11 Display struct.\item[{\em window}]The Window id of the application window.\item[{\em root\-Window}]The Window id of the root window.\item[{\em properties}]An array of elements listing all properties the client is interested in.The elements contain OR'ed values of constants from the {\bf NET}{\rm (p.\,\pageref{classNET})} base class, in the following order: [0]= {\bf NET::Property}{\rm (p.\,\pageref{classNET_w121})}, [1]= {\bf NET::Property2}{\rm (p.\,\pageref{classNET_w122})}. In future versions, the list may be extended. In case you pass less elements, the missing ones will be replaced with default values.\item[{\em properties\_\-size}]The number of elements in the properties array.\item[{\em role}]Select the application role. If this argument is omitted, the role will default to Client.\end{description}
\end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 2581 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!NETWinInfo@{NETWinInfo}}
\index{NETWinInfo@{NETWinInfo}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}NETWin\-Info::NETWin\-Info (Display $\ast$ {\em display}, Window {\em window}, Window {\em root\-Window}, unsigned long {\em properties}, {\bf Role} {\em role} = {\tt Client})}\label{classNETWinInfo_a1}


This constructor differs from the above one only in the way it accepts the list of properties the client is interested in. 

The properties argument is equivalent to the first element of the properties array in the above constructor. 

Definition at line 2644 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!NETWinInfo@{NETWinInfo}}
\index{NETWinInfo@{NETWinInfo}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}NETWin\-Info::NETWin\-Info (const {\bf NETWin\-Info} \& {\em wininfo})}\label{classNETWinInfo_a2}


Creates a shared copy of the specified NETWin\-Info object. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em wininfo}]the NETWin\-Info to copy \end{description}
\end{Desc}


Definition at line 2701 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!~NETWinInfo@{$\sim$NETWinInfo}}
\index{~NETWinInfo@{$\sim$NETWinInfo}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}NETWin\-Info::$\sim${\bf NETWin\-Info} ()\hspace{0.3cm}{\tt  [virtual]}}\label{classNETWinInfo_a3}


Destroys the NETWin\-Info object. 



Definition at line 2707 of file netwm.cpp.

\subsection{Member Function Documentation}
\index{NETWinInfo@{NETWin\-Info}!operator=@{operator=}}
\index{operator=@{operator=}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf NETWin\-Info} \& NETWin\-Info::operator= (const {\bf NETWin\-Info} \& {\em wintinfo})}\label{classNETWinInfo_a4}


Assignment operator. 

Ensures that the shared data reference counts are correct. 

Definition at line 2716 of file netwm.cpp.

References p, and role.\index{NETWinInfo@{NETWin\-Info}!hasNETSupport@{hasNETSupport}}
\index{hasNETSupport@{hasNETSupport}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool NETWin\-Info::has\-NETSupport () const}\label{classNETWinInfo_a5}


Returns true if the window has any window type set, even if the type itself is not known to this implementation. 

Presence of a window type as specified by the NETWM spec is considered as the window supporting this specification. \begin{Desc}
\item[Since:]3.2 \end{Desc}
\begin{Desc}
\item[Returns:]true if the window has support for the NETWM spec \end{Desc}


Definition at line 4210 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!passedProperties@{passedProperties}}
\index{passedProperties@{passedProperties}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const unsigned long $\ast$ NETWin\-Info::passed\-Properties () const}\label{classNETWinInfo_a6}


Returns the properties argument passed to the constructor. 

The size is the maximum array size the constructor accepts.

\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 4247 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!properties@{properties}}
\index{properties@{properties}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}unsigned long NETWin\-Info::properties () const}\label{classNETWinInfo_a7}


\begin{Desc}
\item[{\bf Deprecated}]\end{Desc}
Returns an OR'ed list of protocols passed to the constructor.

\begin{Desc}
\item[Returns:]an OR'ed list of protocols\end{Desc}
\begin{Desc}
\item[See also:]{\bf NET::Property}{\rm (p.\,\pageref{classNET_w121})} \end{Desc}


Definition at line 4251 of file netwm.cpp.

Referenced by event().\index{NETWinInfo@{NETWin\-Info}!iconGeometry@{iconGeometry}}
\index{iconGeometry@{iconGeometry}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf NETRect} NETWin\-Info::icon\-Geometry () const}\label{classNETWinInfo_a8}


Returns the icon geometry. 

\begin{Desc}
\item[Returns:]the geometry of the icon \end{Desc}


Definition at line 4112 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!state@{state}}
\index{state@{state}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}unsigned long NETWin\-Info::state () const}\label{classNETWinInfo_a9}


Returns the state of the window (see the {\bf NET}{\rm (p.\,\pageref{classNET})} base class documentation for a description of the various states). 

\begin{Desc}
\item[Returns:]the state of the window \end{Desc}


Definition at line 4117 of file netwm.cpp.

Referenced by event().\index{NETWinInfo@{NETWin\-Info}!extendedStrut@{extendedStrut}}
\index{extendedStrut@{extendedStrut}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf NETExtended\-Strut} NETWin\-Info::extended\-Strut () const}\label{classNETWinInfo_a10}


Returns the extended (partial) strut specified by this client. 

See \_\-NET\_\-WM\_\-STRUT\_\-PARTIAL in the spec. 

Definition at line 4126 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!strut@{strut}}
\index{strut@{strut}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf NETStrut} NETWin\-Info::strut () const}\label{classNETWinInfo_a11}


\begin{Desc}
\item[{\bf Deprecated}]use strut\-Partial() Returns the strut specified by this client. \end{Desc}
\begin{Desc}
\item[Returns:]the strut of the window \end{Desc}


Definition at line 4122 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!windowType@{windowType}}
\index{windowType@{windowType}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf NET::Window\-Type} NETWin\-Info::window\-Type (unsigned long {\em supported\_\-types}) const}\label{classNETWinInfo_a12}


Returns the window type for this client (see the {\bf NET}{\rm (p.\,\pageref{classNET})} base class documentation for a description of the various window types). 

Since clients may specify several windows types for a window in order to support backwards compatibility and extensions not available in the NETWM spec, you should specify all window types you application supports (see the {\bf NET::Window\-Type\-Mask}{\rm (p.\,\pageref{classNET_w115})} mask values for various window types). This method will return the first window type that is listed in the supported types, or NET::Unknown if none of the window types is supported.

\begin{Desc}
\item[Returns:]the type of the window \end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 4154 of file netwm.cpp.

References NET::type\-Matches\-Mask().\index{NETWinInfo@{NETWin\-Info}!windowType@{windowType}}
\index{windowType@{windowType}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf NET::Window\-Type} NETWin\-Info::window\-Type () const}\label{classNETWinInfo_a13}


\begin{Desc}
\item[{\bf Deprecated}]Returns the window type for this client (see the {\bf NET}{\rm (p.\,\pageref{classNET})} base class documentation for a description of the various window types). \end{Desc}
\begin{Desc}
\item[Returns:]the type of the window \end{Desc}


Definition at line 4165 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!name@{name}}
\index{name@{name}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ NETWin\-Info::name () const}\label{classNETWinInfo_a14}


Returns the name of the window in UTF-8 format. 

\begin{Desc}
\item[Returns:]the name of the window \end{Desc}


Definition at line 4170 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!visibleName@{visibleName}}
\index{visibleName@{visibleName}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ NETWin\-Info::visible\-Name () const}\label{classNETWinInfo_a15}


Returns the visible name as set by the window manager in UTF-8 format. 

\begin{Desc}
\item[Returns:]the visible name of the window \end{Desc}


Definition at line 4175 of file netwm.cpp.

Referenced by set\-Visible\-Name().\index{NETWinInfo@{NETWin\-Info}!iconName@{iconName}}
\index{iconName@{iconName}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ NETWin\-Info::icon\-Name () const}\label{classNETWinInfo_a16}


Returns the iconic name of the window in UTF-8 format. 

Note that this has nothing to do with icons, but it's for \char`\"{}iconic\char`\"{} representations of the window (taskbars etc.), that should be shown when the window is in iconic state. See description of \_\-NET\_\-WM\_\-ICON\_\-NAME for details.

\begin{Desc}
\item[Returns:]the iconic name \end{Desc}


Definition at line 4180 of file netwm.cpp.

Referenced by set\-Icon\-Name().\index{NETWinInfo@{NETWin\-Info}!visibleIconName@{visibleIconName}}
\index{visibleIconName@{visibleIconName}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ NETWin\-Info::visible\-Icon\-Name () const}\label{classNETWinInfo_a17}


Returns the visible iconic name as set by the window manager in UTF-8 format. 

Note that this has nothing to do with icons, but it's for \char`\"{}iconic\char`\"{} representations of the window (taskbars etc.), that should be shown when the window is in iconic state. See description of \_\-NET\_\-WM\_\-VISIBLE\_\-ICON\_\-NAME for details.

\begin{Desc}
\item[Returns:]the visible iconic name \end{Desc}


Definition at line 4185 of file netwm.cpp.

Referenced by set\-Visible\-Icon\-Name().\index{NETWinInfo@{NETWin\-Info}!desktop@{desktop}}
\index{desktop@{desktop}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int NETWin\-Info::desktop () const}\label{classNETWinInfo_a18}


Returns the desktop where the window is residing. 

\begin{Desc}
\item[Returns:]the number of the window's desktop\end{Desc}
\begin{Desc}
\item[See also:]{\bf On\-All\-Desktops()}{\rm (p.\,\pageref{classNETWinInfo_s0})} \end{Desc}


Definition at line 4190 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!pid@{pid}}
\index{pid@{pid}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int NETWin\-Info::pid () const}\label{classNETWinInfo_a19}


Returns the process id for the client window. 

\begin{Desc}
\item[Returns:]the process id of the window \end{Desc}


Definition at line 4194 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!handledIcons@{handledIcons}}
\index{handledIcons@{handledIcons}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Bool NETWin\-Info::handled\-Icons () const}\label{classNETWinInfo_a20}


Returns whether or not this client handles icons. 

\begin{Desc}
\item[Returns:]true if this client handles icons, false otherwise \end{Desc}


Definition at line 4238 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!kdeSystemTrayWinFor@{kdeSystemTrayWinFor}}
\index{kdeSystemTrayWinFor@{kdeSystemTrayWinFor}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Window NETWin\-Info::kde\-System\-Tray\-Win\-For () const}\label{classNETWinInfo_a21}


Returns a Window id, telling the window manager which window we are representing. 

\begin{Desc}
\item[Returns:]the window id \end{Desc}


Definition at line 4243 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!mappingState@{mappingState}}
\index{mappingState@{mappingState}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf NET::Mapping\-State} NETWin\-Info::mapping\-State () const}\label{classNETWinInfo_a22}


Returns the mapping state for the window (see the {\bf NET}{\rm (p.\,\pageref{classNET})} base class documentation for a description of mapping state). 

\begin{Desc}
\item[Returns:]the mapping state \end{Desc}


Definition at line 4256 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!setIcon@{setIcon}}
\index{setIcon@{setIcon}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NETWin\-Info::set\-Icon ({\bf NETIcon} {\em icon}, Bool {\em replace} = {\tt True})}\label{classNETWinInfo_a23}


Set icons for the application window. 

If replace is True, then the specified icon is defined to be the only icon. If replace is False, then the specified icon is added to a list of icons.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em icon}]the new icon\item[{\em replace}]true to replace, false to append to the list of icons \end{description}
\end{Desc}


Definition at line 2736 of file netwm.cpp.

References NETIcon::data, NETSize::height, NETIcon::size, and NETSize::width.\index{NETWinInfo@{NETWin\-Info}!setIconGeometry@{setIconGeometry}}
\index{setIconGeometry@{setIconGeometry}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NETWin\-Info::set\-Icon\-Geometry ({\bf NETRect} {\em geometry})}\label{classNETWinInfo_a24}


Set the icon geometry for the application window. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em geometry}]the new icon geometry \end{description}
\end{Desc}


Definition at line 2790 of file netwm.cpp.

References NETSize::height, NETRect::pos, NETRect::size, NETSize::width, NETPoint::x, and NETPoint::y.\index{NETWinInfo@{NETWin\-Info}!setExtendedStrut@{setExtendedStrut}}
\index{setExtendedStrut@{setExtendedStrut}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NETWin\-Info::set\-Extended\-Strut (const {\bf NETExtended\-Strut} \& {\em extended\_\-strut})}\label{classNETWinInfo_a25}


Set the extended (partial) strut for the application window. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em extended\_\-strut}]the new strut \end{description}
\end{Desc}


Definition at line 2806 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!setStrut@{setStrut}}
\index{setStrut@{setStrut}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NETWin\-Info::set\-Strut ({\bf NETStrut} {\em strut})}\label{classNETWinInfo_a26}


\begin{Desc}
\item[{\bf Deprecated}]use {\bf set\-Extended\-Strut()}{\rm (p.\,\pageref{classNETWinInfo_a25})} Set the strut for the application window. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em strut}]the new strut \end{description}
\end{Desc}


Definition at line 2830 of file netwm.cpp.

References NETStrut::bottom, NETStrut::left, NETStrut::right, and NETStrut::top.\index{NETWinInfo@{NETWin\-Info}!setState@{setState}}
\index{setState@{setState}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NETWin\-Info::set\-State (unsigned long {\em state}, unsigned long {\em mask})}\label{classNETWinInfo_a27}


Set the state for the application window (see the {\bf NET}{\rm (p.\,\pageref{classNET})} base class documentation for a description of window state). 

Note that the constructor needs to be passed NET::WMState in properties even if it's only used for setting the state without reading it.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em state}]the name state\item[{\em mask}]the mask for the state \end{description}
\end{Desc}


Definition at line 2846 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!setWindowType@{setWindowType}}
\index{setWindowType@{setWindowType}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NETWin\-Info::set\-Window\-Type ({\bf Window\-Type} {\em type})}\label{classNETWinInfo_a28}


Sets the window type for this client (see the {\bf NET}{\rm (p.\,\pageref{classNET})} base class documentation for a description of the various window types). 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em type}]the window type \end{description}
\end{Desc}


Definition at line 3050 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!setName@{setName}}
\index{setName@{setName}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NETWin\-Info::set\-Name (const char $\ast$ {\em name})}\label{classNETWinInfo_a29}


Sets the name for the application window. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em name}]the new name of the window \end{description}
\end{Desc}


Definition at line 3128 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!setVisibleName@{setVisibleName}}
\index{setVisibleName@{setVisibleName}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NETWin\-Info::set\-Visible\-Name (const char $\ast$ {\em visible\-Name})}\label{classNETWinInfo_a30}


For Window Managers only: set the visible name ( i.e. 

xterm, xterm $<$2$>$, xterm $<$3$>$, ... )

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em visible\-Name}]the new visible name \end{description}
\end{Desc}


Definition at line 3142 of file netwm.cpp.

References visible\-Name().\index{NETWinInfo@{NETWin\-Info}!setIconName@{setIconName}}
\index{setIconName@{setIconName}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NETWin\-Info::set\-Icon\-Name (const char $\ast$ {\em name})}\label{classNETWinInfo_a31}


Sets the iconic name for the application window. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em name}]the new iconic name \end{description}
\end{Desc}


Definition at line 3156 of file netwm.cpp.

References icon\-Name().\index{NETWinInfo@{NETWin\-Info}!setVisibleIconName@{setVisibleIconName}}
\index{setVisibleIconName@{setVisibleIconName}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NETWin\-Info::set\-Visible\-Icon\-Name (const char $\ast$ {\em name})}\label{classNETWinInfo_a32}


For Window Managers only: set the visible iconic name ( i.e. 

xterm, xterm $<$2$>$, xterm $<$3$>$, ... )

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em name}]the new visible iconic name \end{description}
\end{Desc}


Definition at line 3170 of file netwm.cpp.

References visible\-Icon\-Name().\index{NETWinInfo@{NETWin\-Info}!setDesktop@{setDesktop}}
\index{setDesktop@{setDesktop}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NETWin\-Info::set\-Desktop (int {\em desktop})}\label{classNETWinInfo_a33}


Set which window the desktop is (should be) on. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em desktop}]the number of the new desktop\end{description}
\end{Desc}
\begin{Desc}
\item[See also:]{\bf On\-All\-Desktops()}{\rm (p.\,\pageref{classNETWinInfo_s0})} \end{Desc}


Definition at line 3184 of file netwm.cpp.

References On\-All\-Desktops.\index{NETWinInfo@{NETWin\-Info}!setPid@{setPid}}
\index{setPid@{setPid}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NETWin\-Info::set\-Pid (int {\em pid})}\label{classNETWinInfo_a34}


Set the application window's process id. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em pid}]the window's process id \end{description}
\end{Desc}


Definition at line 3228 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!setHandledIcons@{setHandledIcons}}
\index{setHandledIcons@{setHandledIcons}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NETWin\-Info::set\-Handled\-Icons (Bool {\em handled})}\label{classNETWinInfo_a35}


Set whether this application window handles icons. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em handled}]true if the window handles icons, false otherwise \end{description}
\end{Desc}


Definition at line 3238 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!setKDESystemTrayWinFor@{setKDESystemTrayWinFor}}
\index{setKDESystemTrayWinFor@{setKDESystemTrayWinFor}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NETWin\-Info::set\-KDESystem\-Tray\-Win\-For (Window {\em window})}\label{classNETWinInfo_a36}


Set which window we are representing as a system tray window. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em window}]the window that is represented by the system tray icon \end{description}
\end{Desc}


Definition at line 3290 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!setKDEFrameStrut@{setKDEFrameStrut}}
\index{setKDEFrameStrut@{setKDEFrameStrut}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NETWin\-Info::set\-KDEFrame\-Strut ({\bf NETStrut} {\em strut})}\label{classNETWinInfo_a37}


Set the frame decoration strut. 

This is a {\bf KDE}{\rm (p.\,\pageref{namespaceKDE})} 2.0 extension to aid in writing pager applications.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em strut}]the new strut \end{description}
\end{Desc}


Definition at line 3300 of file netwm.cpp.

References NETStrut::bottom, NETStrut::left, NETStrut::right, and NETStrut::top.\index{NETWinInfo@{NETWin\-Info}!icon@{icon}}
\index{icon@{icon}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf NETIcon} NETWin\-Info::icon (int {\em width} = {\tt -1}, int {\em height} = {\tt -1}) const}\label{classNETWinInfo_a38}


Returns an icon. 

If width and height are passed, the icon returned will be the closest it can find (the next biggest). If width and height are omitted, then the first icon in the list is returned.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em width}]the preferred width for the icon, -1 to ignore\item[{\em height}]the preferred height for the icon, -1 to ignore\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]the icon \end{Desc}


Definition at line 3341 of file netwm.cpp.

References NETIcon::data, NETSize::height, NETIcon::size, and NETSize::width.\index{NETWinInfo@{NETWin\-Info}!userTime@{userTime}}
\index{userTime@{userTime}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Time NETWin\-Info::user\-Time () const}\label{classNETWinInfo_a40}


Returns the time of last user action on the window, or -1 if not set. 

\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 4198 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!startupId@{startupId}}
\index{startupId@{startupId}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ NETWin\-Info::startup\-Id () const}\label{classNETWinInfo_a42}


Returns the startup notification id of the window. 

\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 4202 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!setAllowedActions@{setAllowedActions}}
\index{setAllowedActions@{setAllowedActions}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NETWin\-Info::set\-Allowed\-Actions (unsigned long {\em actions})}\label{classNETWinInfo_a43}


Sets actions that the window manager allows for the window. 

\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 3257 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!allowedActions@{allowedActions}}
\index{allowedActions@{allowedActions}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}unsigned long NETWin\-Info::allowed\-Actions () const}\label{classNETWinInfo_a44}


Returns actions that the window manager allows for the window. 

\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 4206 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!groupLeader@{groupLeader}}
\index{groupLeader@{groupLeader}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Window NETWin\-Info::group\-Leader () const}\label{classNETWinInfo_a46}


Returns the leader window for the group the window is in, if any. 

\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 4218 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!windowClassClass@{windowClassClass}}
\index{windowClassClass@{windowClassClass}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ NETWin\-Info::window\-Class\-Class () const}\label{classNETWinInfo_a47}


Returns the class component of the window class for the window (i.e. 

WM\_\-CLASS property). \begin{Desc}
\item[Since:]3.3 \end{Desc}


Definition at line 4222 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!windowClassName@{windowClassName}}
\index{windowClassName@{windowClassName}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ NETWin\-Info::window\-Class\-Name () const}\label{classNETWinInfo_a48}


Returns the name component of the window class for the window (i.e. 

WM\_\-CLASS property). \begin{Desc}
\item[Since:]3.3 \end{Desc}


Definition at line 4226 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!windowRole@{windowRole}}
\index{windowRole@{windowRole}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ NETWin\-Info::window\-Role () const}\label{classNETWinInfo_a49}


Returns the window role for the window (i.e. 

WM\_\-WINDOW\_\-ROLE property). \begin{Desc}
\item[Since:]3.3 \end{Desc}


Definition at line 4230 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!clientMachine@{clientMachine}}
\index{clientMachine@{clientMachine}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ NETWin\-Info::client\-Machine () const}\label{classNETWinInfo_a50}


Returns the client machine for the window (i.e. 

WM\_\-CLIENT\_\-MACHINE property). \begin{Desc}
\item[Since:]3.3 \end{Desc}


Definition at line 4234 of file netwm.cpp.\index{NETWinInfo@{NETWin\-Info}!kdeGeometry@{kdeGeometry}}
\index{kdeGeometry@{kdeGeometry}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NETWin\-Info::kde\-Geometry ({\bf NETRect} \& {\em frame}, {\bf NETRect} \& {\em window})}\label{classNETWinInfo_a51}


Places the window frame geometry in frame, and the application window geometry in window. 

Both geometries are relative to the root window.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em frame}]the geometry for the frame\item[{\em window}]the geometry for the window \end{description}
\end{Desc}


Definition at line 3316 of file netwm.cpp.

References NETStrut::bottom, NETStrut::left, NETStrut::right, and NETStrut::top.\index{NETWinInfo@{NETWin\-Info}!event@{event}}
\index{event@{event}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void NETWin\-Info::event (XEvent $\ast$ {\em event}, unsigned long $\ast$ {\em properties}, int {\em properties\_\-size})}\label{classNETWinInfo_a52}


This function takes the passed XEvent and returns an OR'ed list of NETWin\-Info properties that have changed in the properties argument. 

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).

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em event}]the event \item[{\em properties}]properties that changed \item[{\em properties\_\-size}]size of the passed properties array \end{description}
\end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 3386 of file netwm.cpp.

References change\-Desktop(), change\-State(), event(), NETSize::height, On\-All\-Desktops, properties(), NETIcon::size, state(), and NETSize::width.

Referenced by event().\index{NETWinInfo@{NETWin\-Info}!event@{event}}
\index{event@{event}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}unsigned long NETWin\-Info::event (XEvent $\ast$ {\em event})}\label{classNETWinInfo_a53}


This function takes the pass XEvent and returns an OR'ed list of NETWin\-Info properties that have changed. 

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.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em event}]the event\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]the properties \end{Desc}


Definition at line 3379 of file netwm.cpp.

References event().\index{NETWinInfo@{NETWin\-Info}!changeDesktop@{changeDesktop}}
\index{changeDesktop@{changeDesktop}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void NETWin\-Info::change\-Desktop (int {\em desktop})\hspace{0.3cm}{\tt  [inline, protected, virtual]}}\label{classNETWinInfo_b0}


A Window Manager should subclass NETWin\-Info and reimplement this function when it wants to know when a Client made a request to change desktops (ie. 

move to another desktop).

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em desktop}]the number of the desktop \end{description}
\end{Desc}


Definition at line 1359 of file netwm.h.

Referenced by event().\index{NETWinInfo@{NETWin\-Info}!changeState@{changeState}}
\index{changeState@{changeState}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void NETWin\-Info::change\-State (unsigned long {\em state}, unsigned long {\em mask})\hspace{0.3cm}{\tt  [inline, protected, virtual]}}\label{classNETWinInfo_b1}


A Window Manager should subclass NETWin\-Info and reimplement this function when it wants to know when a Client made a request to change state (ie. 

to Shade / Unshade).

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em state}]the new state\item[{\em mask}]the mask for the state \end{description}
\end{Desc}


Definition at line 1370 of file netwm.h.

Referenced by event().

\subsection{Member Data Documentation}
\index{NETWinInfo@{NETWin\-Info}!OnAllDesktops@{OnAllDesktops}}
\index{OnAllDesktops@{OnAllDesktops}!NETWinInfo@{NETWin\-Info}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const int {\bf NETWin\-Info::On\-All\-Desktops} = NET::On\-All\-Desktops\hspace{0.3cm}{\tt  [static]}}\label{classNETWinInfo_s0}


Sentinel value to indicate that the client wishes to be visible on all desktops. 

\begin{Desc}
\item[Returns:]the value to be on all desktops \end{Desc}


Reimplemented from {\bf NET} {\rm (p.\,\pageref{classNET})}.

Definition at line 2579 of file netwm.cpp.

Referenced by event(), and set\-Desktop().

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
netwm.h\item 
netwm.cpp\end{CompactItemize}
