.TH "DCOPStub" kde3 "11 Jun 2005" "Version Version 3.4.1" "dcop Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
DCOPStub \- Abstract base class for dcop stubs as created by the dcopidl2cpp compiler.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <dcopstub.h>\fP
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBStatus\fP { \fBCallSucceeded\fP, \fBCallFailed\fP }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBDCOPStub\fP (const \fBQCString\fP &app, const \fBQCString\fP &obj)"
.br
.ti -1c
.RI "\fBDCOPStub\fP (\fBDCOPClient\fP *client, const \fBQCString\fP &app, const \fBQCString\fP &obj)"
.br
.ti -1c
.RI "\fBDCOPStub\fP (const \fBDCOPRef\fP &ref)"
.br
.ti -1c
.RI "\fBQCString\fP \fBapp\fP () const "
.br
.ti -1c
.RI "\fBQCString\fP \fBobj\fP () const "
.br
.ti -1c
.RI "Status \fBstatus\fP () const "
.br
.ti -1c
.RI "bool \fBok\fP () const "
.br
.in -1c
.SS "Protected Types"

.in +1c
.ti -1c
.RI "enum \fBnever_use_t\fP { \fBnever_use\fP }"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBsetStatus\fP (Status _status)"
.br
.ti -1c
.RI "virtual void \fBcallFailed\fP ()"
.br
.ti -1c
.RI "\fBDCOPClient\fP * \fBdcopClient\fP ()"
.br
.ti -1c
.RI "\fBDCOPStub\fP (never_use_t)"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Abstract base class for dcop stubs as created by the dcopidl2cpp compiler. 
.PP
Definition at line 41 of file dcopstub.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "DCOPStub::DCOPStub (const \fBQCString\fP & app, const \fBQCString\fP & obj)"
.PP
Creates a DCOPStub for application \fCapp\fP and object \fCobj\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIapp\fP the application id 
.br
\fIobj\fP the object id 
.RE
.PP

.PP
Definition at line 36 of file dcopstub.cpp.
.SS "DCOPStub::DCOPStub (\fBDCOPClient\fP * client, const \fBQCString\fP & app, const \fBQCString\fP & obj)"
.PP
Creates a DCOPStub for application \fCapp\fP and object \fCobj\fP that operates on the \fBDCOPClient\fP \fCclient\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIclient\fP the \fBDCOPClient\fP 
.br
\fIapp\fP the application id 
.br
\fIobj\fP the object id 
.RE
.PP

.PP
Definition at line 41 of file dcopstub.cpp.
.SS "DCOPStub::DCOPStub (const \fBDCOPRef\fP & ref)\fC [explicit]\fP"
.PP
Creates a DCOPStub for application ref.app() and object ref.obj(). 
.PP
\fBParameters:\fP
.RS 4
\fIref\fP the DCOP reference 
.RE
.PP

.PP
Definition at line 50 of file dcopstub.cpp.
.SH "Member Function Documentation"
.PP 
.SS "\fBQCString\fP DCOPStub::app () const"
.PP
Return the application id. 
.PP
\fBReturns:\fP
.RS 4
the application id 
.RE
.PP

.PP
Definition at line 87 of file dcopstub.cpp.
.SS "\fBQCString\fP DCOPStub::obj () const"
.PP
Return the object id. 
.PP
\fBReturns:\fP
.RS 4
the object id 
.RE
.PP

.PP
Definition at line 92 of file dcopstub.cpp.
.SS "DCOPStub::Status DCOPStub::status () const"
.PP
Return the status of the last call, either \fCCallSucceeded\fP or \fCCallFailed\fP. 
.PP
\fBReturns:\fP
.RS 4
the status of the last call 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBok()\fP; 
.RE
.PP

.PP
Definition at line 67 of file dcopstub.cpp.
.SS "bool DCOPStub::ok () const"
.PP
Return whether no error occurred,. 
.PP
\fBReturns:\fP
.RS 4
true if the last call was successful, false otherwise 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBstatus()\fP; 
.RE
.PP

.PP
Definition at line 77 of file dcopstub.cpp.
.SS "void DCOPStub::setStatus (Status _status)\fC [protected]\fP"
.PP
Sets the status to status. 
.PP
Possible values are 'CallSucceeded' and 'CallFailed' 
.PP
\fBParameters:\fP
.RS 4
\fI_status\fP the new status 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBstatus()\fP 
.RE
.PP

.PP
Definition at line 72 of file dcopstub.cpp.
.PP
Referenced by callFailed().
.SS "void DCOPStub::callFailed ()\fC [protected, virtual]\fP"
.PP
Invoked whenever a call fails. 
.PP
The default implementation sets the status to CallFailed. 
.PP
Definition at line 82 of file dcopstub.cpp.
.PP
References setStatus().
.SS "\fBDCOPClient\fP * DCOPStub::dcopClient ()\fC [protected]\fP"
.PP
The dcopClient this stub operates on. 
.PP
Either the specific one specified in the constructor or \fBDCOPClient::mainClient\fP. 
.PP
\fBReturns:\fP
.RS 4
the stub's \fBDCOPClient\fP 
.RE
.PP

.PP
Definition at line 60 of file dcopstub.cpp.
.PP
References DCOPClient::mainClient().

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