dcopobject.h

/*
Copyright (c) 1999,2000 Preston Brown <pbrown@kde.org>
Copyright (c) 1999, 2000 Matthias Ettrich <ettrich@kde.org>
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
 
#ifndef _DCOPOBJECT_H
#define _DCOPOBJECT_H
 
#include <tqobject.h>
#include <tqmap.h>
#include <tqstring.h>
#include <tqptrlist.h>
#include <tqvaluelist.h>
#include <kdatastream.h> // needed for proper bool marshalling
#include "tdelibs_export.h"
 
class DCOPClient;
typedef TQValueList<TQCString> QCStringList;
 
// Makros for DCOP interfaces
 
#define K_DCOP \
public:        \
  virtual bool process(const TQCString &fun, const TQByteArray &data, TQCString& replyType, TQByteArray &replyData); \
  QCStringList functions(); \
  QCStringList interfaces(); \
private:
 
#define k_dcop_signals public
#define k_dcop_hidden public
#define k_dcop public
#define ASYNC void
 
class DCOP_EXPORT DCOPObject
{
public:
  DCOPObject();
  DCOPObject(TQObject *obj);
  DCOPObject(const TQCString &objId);
  virtual ~DCOPObject();
 
  TQCString objId() const;
 
  bool setObjId(const TQCString &objId);
 
  virtual bool process(const TQCString &fun, const TQByteArray &data,
               TQCString& replyType, TQByteArray &replyData);
 
 
  virtual bool processDynamic(const TQCString &fun, const TQByteArray &data,
                  TQCString& replyType, TQByteArray &replyData);
 
  virtual QCStringList functionsDynamic();
 
  virtual QCStringList interfacesDynamic();
 
  virtual QCStringList interfaces();
 
  virtual QCStringList functions();
 
  void emitDCOPSignal( const TQCString &signal, const TQByteArray &data);
 
  bool connectDCOPSignal( const TQCString &sender, const TQCString &senderObj,
                          const TQCString &signal,
                          const TQCString &slot,
                          bool Volatile);
 
  bool disconnectDCOPSignal( const TQCString &sender, const TQCString &senderObj,
                             const TQCString &signal,
                             const TQCString &slot);
 
  DCOPClient *callingDcopClient();
 
  void setCallingDcopClient(DCOPClient *);
 
  static bool hasObject(const TQCString &objId);
 
  static DCOPObject *find(const TQCString &objId);
 
 
  static TQPtrList<DCOPObject> match(const TQCString &partialId);
 
  static TQCString objectName( TQObject* obj );
 
private:
  TQCString ident;
 
protected:
  virtual void virtual_hook( int id, void* data );
private:
  class DCOPObjectPrivate;
  DCOPObjectPrivate *d;
};
 
class DCOPObjectProxyPrivate;
class DCOP_EXPORT DCOPObjectProxy
{
public:
    DCOPObjectProxy();
 
    DCOPObjectProxy( DCOPClient*);
 
    virtual ~DCOPObjectProxy();
 
    virtual bool process( const TQCString& obj, const TQCString& fun,
              const TQByteArray& data,
              TQCString& replyType, TQByteArray &replyData );
private:
    void* unused;
    void* unused_too;
    friend class DCOPClient;
    static TQPtrList<DCOPObjectProxy>* proxies;
protected:
    virtual void virtual_hook( int id, void* data );
private:
    DCOPObjectProxyPrivate* d;
};
 
 
 
#endif