<HTML>
<HEAD>
<TITLE>Source: kdcopactionproxy.h</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>Source: kdcopactionproxy.h</h1>
</TD>
<TD valign="top" align="right" colspan="1"></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<pre>
/* This file is part of the KDE project
Copyright (C) 1999 Simon Hausmann <hausmann@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
#ifndef __kdcopactionproxy_h__
#define __kdcopactionproxy_h__
#include <dcopobject.h>
#include <dcopref.h>
class KActionCollection;
class KAction;
/**
* The KDCOPActionProxy class provides an easy way to publish a collection of @ref KAction objects
* through DCOP. For the DCOP client the exported actions behave like full-fledged DCOP objects,
* providing full access to the KAction object functionality in the server.
*
* This class can generate DCOP object ids for given action objects, which it automatically
* processes, as being a @ref DCOPObjectProxy .
*
* @short A proxy class publishing a DCOP interface for actions.
*/
class KDCOPActionProxy : public DCOPObjectProxy
{
public:
/**
* Constructs a dcop action proxy, being able to export the actions of the provided
* @ref KActionCollection through DCOP, using the parent DCOPObject's object id to
* generate unique object ids for the actions.
*/
KDCOPActionProxy( KActionCollection *actionCollection, DCOPObject *parent );
/**
* Use this constructor if do not want to provide the exportable actions through a
* @ref KActionCollection . You have to reimplement the virtual @ref #actions() and
* @ref #action() methods if you use this constructor.
*/
KDCOPActionProxy( DCOPObject *parent );
/**
* Destructor.
*/
~KDCOPActionProxy();
/**
* Returns a list of exportable actions. The default implementation returns a list of actions
* provided by a @ref KActionCollection, if the first constructor has been used.
*/
virtual QValueList<KAction *> actions() const;
/**
* Returns an action object with the given name. The default implementation queries the action object
* from the @ref KActionCollection, if the first constructor has been used.
*/
virtual KAction *action( const char *name ) const;
/**
* 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.
*
* You can construct a global DCOP object referenence using DCOPRef. For example like
* DCOPRef( kapp->dcopClient()->appId, actionProxy->actionObjectId( actionName ) );
*
* The action with the given name has to be available through the @ref action method.
*/
virtual QCString actionObjectId( const QCString &name ) const;
/**
* 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() ) .
*/
virtual QMap<QCString,DCOPRef> actionMap( const QCString &appId = QCString() ) const;
/**
* Internal reimplementation of @ref DCOPObjectProxy::process .
*/
virtual bool process( const QCString &obj, const QCString &fun, const QByteArray &data,
QCString &replyType, QByteArray &replyData );
/**
* Called by the @ref process method and takes care of processing the object request for an
* action object.
*/
virtual bool processAction( const QCString &obj, const QCString &fun, const QByteArray &data,
QCString &replyType, QByteArray &replyData, KAction *action );
private:
void init( KActionCollection *collection, DCOPObject *parent );
class KDCOPActionProxyPrivate;
KDCOPActionProxyPrivate *d;
};
#endif
</pre>
<HR>
<table>
<tr><td><small>Generated by: qateam on updates.mandrakesoft.com on Mon Dec 30 16:09:05 2002, using kdoc 2.0a53.</small></td></tr>
</table>
</BODY>
</HTML>
