class KDCOPActionProxy

# class KDCOPActionProxy | A proxy class publishing a DCOP interface for actions. More...
Definition | `#include <kdcopactionproxy.h>`
Inherits | DCOPObjectProxy (dcop) [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### Public Methods

- KDCOPActionProxy ( KActionCollection *actionCollection, DCOPObject *parent )
- KDCOPActionProxy ( DCOPObject *parent )
- ~KDCOPActionProxy ()
- virtual QValueList<KAction *> actions () const
- virtual KAction * action ( const char *name ) const
- virtual QCString actionObjectId ( const QCString &name ) const
- virtual QMap<QCString,DCOPRef> actionMap ( const QCString &appId = QCString() ) const
- virtual bool process ( const QCString &obj, const QCString &fun, const QByteArray &data, QCString &replyType, QByteArray &replyData )
- virtual bool processAction ( const QCString &obj, const QCString &fun, const QByteArray &data, QCString &replyType, QByteArray &replyData, KAction *action )

#### Protected Methods

- virtual void virtual_hook ( int id, void* data )

## Detailed Description

The KDCOPActionProxy class provides an easy way to publish a collection of 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 DCOPObjectProxy .

KDCOPActionProxy ( KActionCollection *actionCollection, DCOPObject *parent ) | ### KDCOPActionProxy

Constructs a dcop action proxy, being able to export the actions of the provided KActionCollection through DCOP, using the parent DCOPObject's object id to generate unique object ids for the actions.

KDCOPActionProxy ( DCOPObject *parent ) | ### KDCOPActionProxy

Use this constructor if do not want to provide the exportable actions through a KActionCollection . You have to reimplement the virtual actions() and action() methods if you use this constructor.

~KDCOPActionProxy () | ### ~KDCOPActionProxy

Destructor.

QValueList<KAction *> actions () | ### actions

[const virtual]

Returns a list of exportable actions. The default implementation returns a list of actions provided by a KActionCollection, if the first constructor has been used.

KAction * action ( const char *name ) | ### action

[const virtual]

Returns an action object with the given name. The default implementation queries the action object from the KActionCollection, if the first constructor has been used.

QCString actionObjectId ( const QCString &name ) | ### actionObjectId

[const virtual]

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 #action method.

QMap<QCString,DCOPRef> actionMap ( const QCString &appId = QCString() ) | ### actionMap

[const virtual]

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() ) .

bool process ( const QCString &obj, const QCString &fun, const QByteArray &data, QCString &replyType, QByteArray &replyData ) | ### process

[virtual]

Internal reimplementation of DCOPObjectProxy::process .

Reimplemented from DCOPObjectProxy.

bool processAction ( const QCString &obj, const QCString &fun, const QByteArray &data, QCString &replyType, QByteArray &replyData, KAction *action ) | ### processAction

[virtual]

Called by the #process method and takes care of processing the object request for an action object.

void virtual_hook ( int id, void* data ) | ### virtual_hook

[protected virtual]

Reimplemented from DCOPObjectProxy.

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:36:37 2003, using kdoc 2.0a54.