\section{DCOPStub Class Reference}
\label{classDCOPStub}\index{DCOPStub@{DCOPStub}}
Abstract base class for dcop stubs as created by the dcopidl2cpp compiler.  


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

Collaboration diagram for DCOPStub:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=57pt]{classDCOPStub__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item 
enum {\bf Status} \{ {\bf Call\-Succeeded}, 
{\bf Call\-Failed}
 \}
\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf DCOPStub} (const  {\bf QCString} \&app, const  {\bf QCString} \&obj)
\begin{CompactList}\small\item\em Creates a DCOPStub for application {\tt app} and object {\tt obj}. \item\end{CompactList}\item 
{\bf DCOPStub} ({\bf DCOPClient} $\ast$client, const  {\bf QCString} \&app, const  {\bf QCString} \&obj)
\begin{CompactList}\small\item\em Creates a DCOPStub for application {\tt app} and object {\tt obj} that operates on the {\bf DCOPClient}{\rm (p.\,\pageref{classDCOPClient})} {\tt client}. \item\end{CompactList}\item 
{\bf QCString} {\bf app} () const 
\begin{CompactList}\small\item\em Return the application id. \item\end{CompactList}\item 
{\bf QCString} {\bf obj} () const 
\begin{CompactList}\small\item\em Return the object id. \item\end{CompactList}\item 
Status {\bf status} () const 
\begin{CompactList}\small\item\em Return the status of the last call, either {\tt Call\-Succeeded} or {\tt Call\-Failed}. \item\end{CompactList}\item 
bool {\bf ok} () const 
\begin{CompactList}\small\item\em Return whether no error occured,. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Types}
\begin{CompactItemize}
\item 
enum {\bf never\_\-use\_\-t} \{ {\bf never\_\-use}
 \}
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
void {\bf set\-Status} (Status \_\-status)
\begin{CompactList}\small\item\em Sets the status to status. \item\end{CompactList}\item 
virtual void {\bf call\-Failed} ()
\begin{CompactList}\small\item\em Invoked whenever a call fails. \item\end{CompactList}\item 
{\bf DCOPClient} $\ast$ {\bf dcop\-Client} ()
\begin{CompactList}\small\item\em The dcop\-Client this stub operates on. \item\end{CompactList}\item 
{\bf DCOPStub} (never\_\-use\_\-t)\label{classDCOPStub_b3}

\item 
virtual void {\bf virtual\_\-hook} (int id, void $\ast$data)\label{classDCOPStub_b4}

\end{CompactItemize}


\subsection{Detailed Description}
Abstract base class for dcop stubs as created by the dcopidl2cpp compiler. 



Definition at line 39 of file dcopstub.h.

\subsection{Constructor \& Destructor Documentation}
\index{DCOPStub@{DCOPStub}!DCOPStub@{DCOPStub}}
\index{DCOPStub@{DCOPStub}!DCOPStub@{DCOPStub}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}DCOPStub::DCOPStub (const {\bf QCString} \& {\em app}, const {\bf QCString} \& {\em obj})}\label{classDCOPStub_a0}


Creates a DCOPStub for application {\tt app} and object {\tt obj}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em app}]the application id \item[{\em obj}]the object id \end{description}
\end{Desc}


Definition at line 35 of file dcopstub.cpp.\index{DCOPStub@{DCOPStub}!DCOPStub@{DCOPStub}}
\index{DCOPStub@{DCOPStub}!DCOPStub@{DCOPStub}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}DCOPStub::DCOPStub ({\bf DCOPClient} $\ast$ {\em client}, const {\bf QCString} \& {\em app}, const {\bf QCString} \& {\em obj})}\label{classDCOPStub_a1}


Creates a DCOPStub for application {\tt app} and object {\tt obj} that operates on the {\bf DCOPClient}{\rm (p.\,\pageref{classDCOPClient})} {\tt client}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em client}]the {\bf DCOPClient}{\rm (p.\,\pageref{classDCOPClient})} \item[{\em app}]the application id \item[{\em obj}]the object id \end{description}
\end{Desc}


Definition at line 40 of file dcopstub.cpp.

\subsection{Member Function Documentation}
\index{DCOPStub@{DCOPStub}!app@{app}}
\index{app@{app}!DCOPStub@{DCOPStub}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QCString} DCOPStub::app () const}\label{classDCOPStub_a3}


Return the application id. 

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


Definition at line 81 of file dcopstub.cpp.\index{DCOPStub@{DCOPStub}!obj@{obj}}
\index{obj@{obj}!DCOPStub@{DCOPStub}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QCString} DCOPStub::obj () const}\label{classDCOPStub_a4}


Return the object id. 

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


Definition at line 86 of file dcopstub.cpp.\index{DCOPStub@{DCOPStub}!status@{status}}
\index{status@{status}!DCOPStub@{DCOPStub}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}DCOPStub::Status DCOPStub::status () const}\label{classDCOPStub_a5}


Return the status of the last call, either {\tt Call\-Succeeded} or {\tt Call\-Failed}. 

\begin{Desc}
\item[Returns:]the status of the last call \end{Desc}
\begin{Desc}
\item[See also:]{\bf ok()}{\rm (p.\,\pageref{classDCOPStub_a6})}; \end{Desc}


Definition at line 61 of file dcopstub.cpp.\index{DCOPStub@{DCOPStub}!ok@{ok}}
\index{ok@{ok}!DCOPStub@{DCOPStub}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool DCOPStub::ok () const}\label{classDCOPStub_a6}


Return whether no error occured,. 

\begin{Desc}
\item[Returns:]true if the last call was successful, false otherwise \end{Desc}
\begin{Desc}
\item[See also:]{\bf status()}{\rm (p.\,\pageref{classDCOPStub_a5})}; \end{Desc}


Definition at line 71 of file dcopstub.cpp.\index{DCOPStub@{DCOPStub}!setStatus@{setStatus}}
\index{setStatus@{setStatus}!DCOPStub@{DCOPStub}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void DCOPStub::set\-Status (Status {\em \_\-status})\hspace{0.3cm}{\tt  [protected]}}\label{classDCOPStub_b0}


Sets the status to status. 

Possible values are 'Call\-Succeeded' and 'Call\-Failed' \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-status}]the new status \end{description}
\end{Desc}
\begin{Desc}
\item[See also:]{\bf status()}{\rm (p.\,\pageref{classDCOPStub_a5})} \end{Desc}


Definition at line 66 of file dcopstub.cpp.

Referenced by call\-Failed().\index{DCOPStub@{DCOPStub}!callFailed@{callFailed}}
\index{callFailed@{callFailed}!DCOPStub@{DCOPStub}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void DCOPStub::call\-Failed ()\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classDCOPStub_b1}


Invoked whenever a call fails. 

The default implementation sets the status to Call\-Failed. 

Definition at line 76 of file dcopstub.cpp.

References set\-Status().\index{DCOPStub@{DCOPStub}!dcopClient@{dcopClient}}
\index{dcopClient@{dcopClient}!DCOPStub@{DCOPStub}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf DCOPClient} $\ast$ DCOPStub::dcop\-Client ()\hspace{0.3cm}{\tt  [protected]}}\label{classDCOPStub_b2}


The dcop\-Client this stub operates on. 

Either the specific one specified in the constructor or {\bf DCOPClient::main\-Client}{\rm (p.\,\pageref{classDCOPClient_e2})}. \begin{Desc}
\item[Returns:]the stub's {\bf DCOPClient}{\rm (p.\,\pageref{classDCOPClient})} \end{Desc}


Definition at line 54 of file dcopstub.cpp.

References DCOPClient::main\-Client().

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