\section{KMain\-Window\-Interface Class Reference}
\label{classKMainWindowInterface}\index{KMainWindowInterface@{KMainWindowInterface}}
{\bf DCOP} interface to {\bf KMain\-Window}{\rm (p.\,\pageref{classKMainWindow})}.  


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

Inheritance diagram for KMain\-Window\-Interface:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=77pt]{classKMainWindowInterface__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KMain\-Window\-Interface:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=257pt]{classKMainWindowInterface__coll__graph}
\end{center}
\end{figure}
\subsection*{DCOP Member Functions}
\begin{CompactItemize}
\item 
QCString\-List {\bf actions} ()
\item 
bool {\bf activate\-Action} ({\bf QCString} action)
\item 
bool {\bf disable\-Action} ({\bf QCString} action)
\item 
bool {\bf enable\-Action} ({\bf QCString} action)
\item 
bool {\bf action\-Is\-Enabled} ({\bf QCString} action)
\item 
{\bf QCString} {\bf action\-Tool\-Tip} ({\bf QCString} action)
\item 
{\bf DCOPRef} {\bf action} (const {\bf QCString} \&name)
\item 
{\bf QMap}$<$ {\bf QCString}, {\bf DCOPRef} $>$ {\bf action\-Map} ()
\item 
int {\bf get\-Win\-ID} ()
\item 
void {\bf grab\-Window\-To\-Clip\-Board} ()
\item 
void {\bf hide} ()\label{classKMainWindowInterface_z10}

\item 
void {\bf maximize} ()\label{classKMainWindowInterface_z11}

\item 
void {\bf minimize} ()\label{classKMainWindowInterface_z12}

\item 
void {\bf resize} (int new\-Width, int new\-Height)\label{classKMainWindowInterface_z13}

\item 
void {\bf move} (int new\-X, int new\-Y)\label{classKMainWindowInterface_z14}

\item 
void {\bf set\-Geometry} (int new\-X, int new\-Y, int new\-Width, int new\-Height)\label{classKMainWindowInterface_z15}

\item 
void {\bf raise} ()\label{classKMainWindowInterface_z16}

\item 
void {\bf lower} ()\label{classKMainWindowInterface_z17}

\item 
void {\bf restore} ()\label{classKMainWindowInterface_z18}

\item 
void {\bf show} ()\label{classKMainWindowInterface_z19}

\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf KMain\-Window\-Interface} ({\bf KMain\-Window} $\ast$main\-Window)
\item 
{\bf $\sim$KMain\-Window\-Interface} ()
\item 
QCString\-List {\bf functions\-Dynamic} ()\label{classKMainWindowInterface_a2}

\item 
bool {\bf process\-Dynamic} (const {\bf QCString} \&fun, const {\bf QByte\-Array} \&data, {\bf QCString} \&reply\-Type, {\bf QByte\-Array} \&reply\-Data)\label{classKMainWindowInterface_a3}

\end{CompactItemize}


\subsection{Detailed Description}
{\bf DCOP} interface to {\bf KMain\-Window}{\rm (p.\,\pageref{classKMainWindow})}. 

This is the main interface to the {\bf KMain\-Window}{\rm (p.\,\pageref{classKMainWindow})}. This will provide a consistent {\bf DCOP} interface to all {\bf KDE} applications that use it.

\begin{Desc}
\item[Author:]Ian Reinhart Geiser $<${\tt geiseri@yahoo.com}$>$ \end{Desc}




Definition at line 40 of file kmainwindowiface.h.

\subsection{Constructor \& Destructor Documentation}
\index{KMainWindowInterface@{KMain\-Window\-Interface}!KMainWindowInterface@{KMainWindowInterface}}
\index{KMainWindowInterface@{KMainWindowInterface}!KMainWindowInterface@{KMain\-Window\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KMain\-Window\-Interface::KMain\-Window\-Interface ({\bf KMain\-Window} $\ast$ {\em main\-Window})}\label{classKMainWindowInterface_a0}


Construct a new interface object. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em main\-Window}]- The parent {\bf KMain\-Window}{\rm (p.\,\pageref{classKMainWindow})} object that will provide us with the {\bf KAction}{\rm (p.\,\pageref{classKAction})} objects.\end{description}
\end{Desc}


Definition at line 31 of file kmainwindowiface.cpp.

References KXMLGUIClient::action\-Collection().\index{KMainWindowInterface@{KMain\-Window\-Interface}!~KMainWindowInterface@{$\sim$KMainWindowInterface}}
\index{~KMainWindowInterface@{$\sim$KMainWindowInterface}!KMainWindowInterface@{KMain\-Window\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KMain\-Window\-Interface::$\sim${\bf KMain\-Window\-Interface} ()}\label{classKMainWindowInterface_a1}


Destructor Cleans up the dcop action proxy object. 



Definition at line 39 of file kmainwindowiface.cpp.

\subsection{Member Function Documentation}
\index{KMainWindowInterface@{KMain\-Window\-Interface}!actions@{actions}}
\index{actions@{actions}!KMainWindowInterface@{KMain\-Window\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}QCString\-List KMain\-Window\-Interface::actions ()}\label{classKMainWindowInterface_z0}


Return a list of actions available to the application's window. 

\begin{Desc}
\item[Returns:]A QCString\-List containing valid names actions.\end{Desc}


Definition at line 45 of file kmainwindowiface.cpp.\index{KMainWindowInterface@{KMain\-Window\-Interface}!activateAction@{activateAction}}
\index{activateAction@{activateAction}!KMainWindowInterface@{KMain\-Window\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KMain\-Window\-Interface::activate\-Action ({\bf QCString} {\em action})}\label{classKMainWindowInterface_z1}


Activates the requested action. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em action}]The name of the action to activate. The names of valid actions can be found by calling {\bf actions()}{\rm (p.\,\pageref{classKMainWindowInterface_z0})}. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The success of the operation.\end{Desc}


Definition at line 58 of file kmainwindowiface.cpp.\index{KMainWindowInterface@{KMain\-Window\-Interface}!disableAction@{disableAction}}
\index{disableAction@{disableAction}!KMainWindowInterface@{KMain\-Window\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KMain\-Window\-Interface::disable\-Action ({\bf QCString} {\em action})}\label{classKMainWindowInterface_z2}


Disables the requested action. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em action}]The name of the action to disable. The names of valid actions can be found by calling {\bf actions()}{\rm (p.\,\pageref{classKMainWindowInterface_z0})}. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The success of the operation.\end{Desc}


Definition at line 71 of file kmainwindowiface.cpp.\index{KMainWindowInterface@{KMain\-Window\-Interface}!enableAction@{enableAction}}
\index{enableAction@{enableAction}!KMainWindowInterface@{KMain\-Window\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KMain\-Window\-Interface::enable\-Action ({\bf QCString} {\em action})}\label{classKMainWindowInterface_z3}


Enables the requested action. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em action}]The name of the action to enable. The names of valid actions can be found by calling {\bf actions()}{\rm (p.\,\pageref{classKMainWindowInterface_z0})}. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The success of the operation.\end{Desc}


Definition at line 84 of file kmainwindowiface.cpp.\index{KMainWindowInterface@{KMain\-Window\-Interface}!actionIsEnabled@{actionIsEnabled}}
\index{actionIsEnabled@{actionIsEnabled}!KMainWindowInterface@{KMain\-Window\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KMain\-Window\-Interface::action\-Is\-Enabled ({\bf QCString} {\em action})}\label{classKMainWindowInterface_z4}


Returns the status of the requested action. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em action}]The name of the action. The names of valid actions can be found by calling {\bf actions()}{\rm (p.\,\pageref{classKMainWindowInterface_z0})}. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The state of the action, true - enabled, false - disabled.\end{Desc}


Definition at line 97 of file kmainwindowiface.cpp.\index{KMainWindowInterface@{KMain\-Window\-Interface}!actionToolTip@{actionToolTip}}
\index{actionToolTip@{actionToolTip}!KMainWindowInterface@{KMain\-Window\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QCString} KMain\-Window\-Interface::action\-Tool\-Tip ({\bf QCString} {\em action})}\label{classKMainWindowInterface_z5}


Returns the tool tip text of the requested action. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em action}]The name of the action to activate. The names of valid actions can be found by calling {\bf actions()}{\rm (p.\,\pageref{classKMainWindowInterface_z0})}. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]A {\bf QCString} containing the text of the action's tool tip.\end{Desc}


Definition at line 109 of file kmainwindowiface.cpp.\index{KMainWindowInterface@{KMain\-Window\-Interface}!action@{action}}
\index{action@{action}!KMainWindowInterface@{KMain\-Window\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf DCOPRef} KMain\-Window\-Interface::action (const {\bf QCString} \& {\em name})}\label{classKMainWindowInterface_z6}


Returns a dcop reference to the selected {\bf KAction}{\rm (p.\,\pageref{classKAction})}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em name}]The name of the action. The names of valid actions can be found by calling {\bf actions()}{\rm (p.\,\pageref{classKMainWindowInterface_z0})}. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]A {\bf DCOPRef} for the kaction. \end{Desc}


Definition at line 122 of file kmainwindowiface.cpp.\index{KMainWindowInterface@{KMain\-Window\-Interface}!actionMap@{actionMap}}
\index{actionMap@{actionMap}!KMainWindowInterface@{KMain\-Window\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QMap}$<$ {\bf QCString}, {\bf DCOPRef} $>$ KMain\-Window\-Interface::action\-Map ()}\label{classKMainWindowInterface_z7}


Returns and action map. 



Definition at line 127 of file kmainwindowiface.cpp.\index{KMainWindowInterface@{KMain\-Window\-Interface}!getWinID@{getWinID}}
\index{getWinID@{getWinID}!KMainWindowInterface@{KMain\-Window\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int KMain\-Window\-Interface::get\-Win\-ID ()}\label{classKMainWindowInterface_z8}


Returns the ID of the current main window. 

This is useful for automated screen captures or other evil widget fun. \begin{Desc}
\item[Returns:]A integer value of the main window's ID. \end{Desc}


Definition at line 132 of file kmainwindowiface.cpp.\index{KMainWindowInterface@{KMain\-Window\-Interface}!grabWindowToClipBoard@{grabWindowToClipBoard}}
\index{grabWindowToClipBoard@{grabWindowToClipBoard}!KMainWindowInterface@{KMain\-Window\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KMain\-Window\-Interface::grab\-Window\-To\-Clip\-Board ()}\label{classKMainWindowInterface_z9}


Copies a pixmap representation of the current main window to the clipboard. 



Definition at line 136 of file kmainwindowiface.cpp.

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