.TH "KDCOPActionProxy" 3 "28 Jan 2004" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KDCOPActionProxy \- The KDCOPActionProxy class provides an easy way to publish a collection of \fBKAction\fP objects through DCOP. A proxy class publishing a DCOP interface for actions.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kdcopactionproxy.h>\fP
.PP
Inherits \fBDCOPObjectProxy\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKDCOPActionProxy\fP (\fBKActionCollection\fP *actionCollection, \fBDCOPObject\fP *parent)"
.br
.RI "\fIConstructs a dcop action proxy, being able to export the actions of the provided \fBKActionCollection\fP through DCOP, using the parent DCOPObject's object id to generate unique object ids for the actions. \fP"
.ti -1c
.RI "\fBKDCOPActionProxy\fP (\fBDCOPObject\fP *parent)"
.br
.RI "\fIUse this constructor if do not want to provide the exportable actions through a \fBKActionCollection\fP . \fP"
.ti -1c
.RI "\fB~KDCOPActionProxy\fP ()"
.br
.RI "\fIDestructor. \fP"
.ti -1c
.RI "virtual \fBQValueList\fP< \fBKAction\fP * > \fBactions\fP () const "
.br
.RI "\fIReturns a list of exportable actions. \fP"
.ti -1c
.RI "virtual \fBKAction\fP * \fBaction\fP (const  char *name) const "
.br
.RI "\fIReturns an action object with the given name. \fP"
.ti -1c
.RI "virtual \fBQCString\fP \fBactionObjectId\fP (const  \fBQCString\fP &name) const "
.br
.RI "\fIUse this method to retrieve a DCOP object id for an action with the given name. \fP"
.ti -1c
.RI "virtual \fBQMap\fP< \fBQCString\fP, \fBDCOPRef\fP > \fBactionMap\fP (const  \fBQCString\fP &appId=\fBQCString\fP()) const "
.br
.RI "\fIReturns a map of all exported actions, with the action name as keys and a global DCOP reference as data entries. \fP"
.ti -1c
.RI "virtual bool \fBprocess\fP (const  \fBQCString\fP &obj, const  \fBQCString\fP &fun, const  \fBQByteArray\fP &data, \fBQCString\fP &replyType, \fBQByteArray\fP &replyData)"
.br
.RI "\fIInternal reimplementation of \fBDCOPObjectProxy::process\fP . \fP"
.ti -1c
.RI "virtual bool \fBprocessAction\fP (const  \fBQCString\fP &obj, const  \fBQCString\fP &fun, const  \fBQByteArray\fP &data, \fBQCString\fP &replyType, \fBQByteArray\fP &replyData, \fBKAction\fP *action)"
.br
.RI "\fICalled by the \fBprocess\fP method and takes care of processing the object request for an action object. \fP"
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
The KDCOPActionProxy class provides an easy way to publish a collection of \fBKAction\fP objects through DCOP. A proxy class publishing a DCOP interface for actions. 

For the DCOP client the exported actions behave like full-fledged DCOP objects, providing full access to the \fBKAction\fP object functionality in the server.
.PP
This class can generate DCOP object ids for given action objects, which it automatically processes, as being a \fBDCOPObjectProxy\fP .
.PP
Definition at line 38 of file kdcopactionproxy.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KDCOPActionProxy::KDCOPActionProxy (\fBKActionCollection\fP * actionCollection, \fBDCOPObject\fP * parent)"
.PP
Constructs a dcop action proxy, being able to export the actions of the provided \fBKActionCollection\fP through DCOP, using the parent DCOPObject's object id to generate unique object ids for the actions. Definition at line 46 of file kdcopactionproxy.cpp.
.SS "KDCOPActionProxy::KDCOPActionProxy (\fBDCOPObject\fP * parent)"
.PP
Use this constructor if do not want to provide the exportable actions through a \fBKActionCollection\fP . You have to reimplement the virtual \fBactions\fP() and \fBaction\fP() methods if you use this constructor. Definition at line 51 of file kdcopactionproxy.cpp.
.SS "KDCOPActionProxy::~\fBKDCOPActionProxy\fP ()"
.PP
Destructor. Definition at line 65 of file kdcopactionproxy.cpp.
.SH "Member Function Documentation"
.PP 
.SS "\fBQValueList\fP< \fBKAction\fP * > KDCOPActionProxy::actions () const\fC [virtual]\fP"
.PP
Returns a list of exportable actions. The default implementation returns a list of actions provided by a \fBKActionCollection\fP, if the first constructor has been used. Definition at line 70 of file kdcopactionproxy.cpp.
.PP
Referenced by actionMap().
.SS "\fBKAction\fP * KDCOPActionProxy::action (const char * name) const\fC [virtual]\fP"
.PP
Returns an action object with the given name. The default implementation queries the action object from the \fBKActionCollection\fP, if the first constructor has been used. Definition at line 78 of file kdcopactionproxy.cpp.
.PP
References KStdAccel::name().
.PP
Referenced by process().
.SS "\fBQCString\fP KDCOPActionProxy::actionObjectId (const \fBQCString\fP & name) const\fC [virtual]\fP"
.PP
Use this method to retrieve a DCOP object id for an action with the given name. This class automatically takes care of processing DCOP object requests for the returned object id.
.PP
You can construct a global DCOP object referenence using \fBDCOPRef\fP. For example like \fBDCOPRef\fP( kapp->dcopClient()->appId, actionProxy->actionObjectId( actionName ) );
.PP
The action with the given name has to be available through the \fBaction\fP method. Definition at line 86 of file kdcopactionproxy.cpp.
.PP
References KStdAccel::name().
.PP
Referenced by actionMap().
.SS "\fBQMap\fP< \fBQCString\fP, \fBDCOPRef\fP > KDCOPActionProxy::actionMap (const \fBQCString\fP & appId = \fBQCString\fP()) const\fC [virtual]\fP"
.PP
Returns a map of all exported actions, with the action name as keys and a global DCOP reference as data entries. The appId argument is used to specify the appid component of the DCOP reference. By default the global application id is used ( kapp->dcopClient()->appId() ) . Definition at line 91 of file kdcopactionproxy.cpp.
.PP
References actionObjectId(), actions(), QValueList::begin(), QValueList::end(), KStdAccel::end(), QMap::insert(), and QCString::isEmpty().
.SS "bool KDCOPActionProxy::process (const \fBQCString\fP & obj, const \fBQCString\fP & fun, const \fBQByteArray\fP & data, \fBQCString\fP & replyType, \fBQByteArray\fP & replyData)\fC [virtual]\fP"
.PP
Internal reimplementation of \fBDCOPObjectProxy::process\fP . Reimplemented from \fBDCOPObjectProxy\fP.
.PP
Definition at line 108 of file kdcopactionproxy.cpp.
.PP
References action(), QCString::left(), QCString::mid(), and processAction().
.SS "bool KDCOPActionProxy::processAction (const \fBQCString\fP & obj, const \fBQCString\fP & fun, const \fBQByteArray\fP & data, \fBQCString\fP & replyType, \fBQByteArray\fP & replyData, \fBKAction\fP * action)\fC [virtual]\fP"
.PP
Called by the \fBprocess\fP method and takes care of processing the object request for an action object. Definition at line 121 of file kdcopactionproxy.cpp.
.PP
References KStdAccel::action(), KDCOPPropertyProxy::functions(), and KDCOPPropertyProxy::processPropertyRequest().
.PP
Referenced by process().

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