.TH "KDCOPActionProxy" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KDCOPActionProxy \- A proxy class publishing a \fBDCOP\fP 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
.ti -1c
.RI "\fBKDCOPActionProxy\fP (\fBDCOPObject\fP *parent)"
.br
.ti -1c
.RI "\fB~KDCOPActionProxy\fP ()"
.br
.ti -1c
.RI "virtual \fBQValueList\fP< \fBKAction\fP * > \fBactions\fP () const "
.br
.ti -1c
.RI "virtual \fBKAction\fP * \fBaction\fP (const char *name) const "
.br
.ti -1c
.RI "virtual \fBQCString\fP \fBactionObjectId\fP (const \fBQCString\fP &name) const "
.br
.ti -1c
.RI "virtual \fBQMap\fP< \fBQCString\fP, \fBDCOPRef\fP > \fBactionMap\fP (const \fBQCString\fP &appId=\fBQCString\fP()) const "
.br
.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
.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
.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 
A proxy class publishing a \fBDCOP\fP interface for actions. 

The KDCOPActionProxy class provides an easy way to publish a collection of \fBKAction\fP objects through \fBDCOP\fP. For the \fBDCOP\fP client the exported actions behave like full-fledged \fBDCOP\fP objects, providing full access to the \fBKAction\fP object functionality in the server.
.PP
This class can generate \fBDCOP\fP object ids for given action objects, which it automatically processes, as being a \fBDCOPObjectProxy\fP . 
.PP
Definition at line 39 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 \fBDCOP\fP, using the parent DCOPObject's object id to generate unique object ids for the actions. 
.PP
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 . 
.PP
You have to reimplement the virtual \fBactions()\fP and \fBaction()\fP methods if you use this constructor. 
.PP
Definition at line 51 of file kdcopactionproxy.cpp.
.SS "KDCOPActionProxy::~\fBKDCOPActionProxy\fP ()"
.PP
Destructor. 
.PP
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. 
.PP
The default implementation returns a list of actions provided by a \fBKActionCollection\fP, if the first constructor has been used. 
.PP
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. 
.PP
The default implementation queries the action object from the \fBKActionCollection\fP, if the first constructor has been used. 
.PP
Definition at line 78 of file kdcopactionproxy.cpp.
.PP
Referenced by process(), and processAction().
.SS "\fBQCString\fP KDCOPActionProxy::actionObjectId (const \fBQCString\fP & name) const\fC [virtual]\fP"
.PP
Use this method to retrieve a \fBDCOP\fP object id for an action with the given name. 
.PP
This class automatically takes care of processing \fBDCOP\fP object requests for the returned object id.
.PP
You can construct a global \fBDCOP\fP 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. 
.PP
Definition at line 86 of file kdcopactionproxy.cpp.
.PP
Referenced by actionMap().
.SS "\fBQMap\fP< \fBQCString\fP, \fBDCOPRef\fP > KDCOPActionProxy::actionMap (const \fBQCString\fP & appId = \fC\fBQCString\fP()\fP) const\fC [virtual]\fP"
.PP
Returns a map of all exported actions, with the action name as keys and a global \fBDCOP\fP reference as data entries. 
.PP
The appId argument is used to specify the appid component of the \fBDCOP\fP reference. By default the global application id is used ( kapp->dcopClient()->appId() ) . 
.PP
Definition at line 91 of file kdcopactionproxy.cpp.
.PP
References actionObjectId(), actions(), QValueList::begin(), QValueList::end(), and QMap::insert().
.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 . 
.PP
Reimplemented from \fBDCOPObjectProxy\fP.
.PP
Definition at line 108 of file kdcopactionproxy.cpp.
.PP
References action(), 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. 
.PP
Definition at line 121 of file kdcopactionproxy.cpp.
.PP
References action(), KAction::activate(), KDCOPPropertyProxy::functions(), KAction::isPlugged(), and KDCOPPropertyProxy::processPropertyRequest().
.PP
Referenced by process().

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