Main Page Modules Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members Related Pages

DCOPRef Class Reference

#include <dcopref.h>

List of all members.

Public Methods

DCOPRef ()

DCOPRef (const DCOPRef &ref)

DCOPRef (const QCString &app, const QCString &obj="")

DCOPRef (DCOPObject *object)

DCOPRef (const QCString &app, const QCString &obj, const QCString &type)

bool isNull () const

QCString app () const

QCString obj () const

QCString object () const

QCString type () const

DCOPRef & operator= (const DCOPRef &)

void setRef (const QCString &app, const QCString &obj="")

void setRef (const QCString &app, const QCString &obj, const QCString &type)

void clear ()

DCOPClient * dcopClient () const

void setDCOPClient (DCOPClient *client)

DCOPReply call (const QCString &fun)

template<class T1> DCOPReply call (const QCString &fun, const T1 &t1)

template<class T1, class T2> DCOPReply call (const QCString &fun, const T1 &t1, const T2 &t2)

template<class T1, class T2, class T3> DCOPReply call (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3)

template<class T1, class T2, class T3, class T4> DCOPReply call (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4)

template<class T1, class T2, class T3, class T4, class T5> DCOPReply call (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4, const T5 &t5)

template<class T1, class T2, class T3, class T4, class T5, class T6> DCOPReply call (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4, const T5 &t5, const T6 &t6)

template<class T1, class T2, class T3, class T4, class T5, class T6, class T7> DCOPReply call (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4, const T5 &t5, const T6 &t6, const T7 &t7)

template<class T1, class T2, class T3, class T4, class T5, class T6, class T7, class T8> DCOPReply call (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4, const T5 &t5, const T6 &t6, const T7 &t7, const T8 &t8)

bool send (const QCString &fun)

template<class T1> bool send (const QCString &fun, const T1 &t1)

template<class T1, class T2> bool send (const QCString &fun, const T1 &t1, const T2 &t2)

template<class T1, class T2, class T3> bool send (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3)

template<class T1, class T2, class T3, class T4> bool send (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4)

template<class T1, class T2, class T3, class T4, class T5> bool send (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4, const T5 &t5)

template<class T1, class T2, class T3, class T4, class T5, class T6> bool send (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4, const T5 &t5, const T6 &t6)

template<class T1, class T2, class T3, class T4, class T5, class T6, class T7> bool send (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4, const T5 &t5, const T6 &t6, const T7 &t7)

template<class T1, class T2, class T3, class T4, class T5, class T6, class T7, class T8> bool send (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4, const T5 &t5, const T6 &t6, const T7 &t7, const T8 &t8)

Detailed Description

A DCOPRef(erence) encapsulates a remote DCOP object as a triple <app,obj,type> where type is optional. It allows for calling and passing DCOP objects.

A DCOP reference makes it possible to return references to other DCOP objects in a DCOP interface, for example in the method giveMeAnotherObject() in an interface like this:

	class Example : public DCOPObject
	{
	   K_DCOP
	...
	k_dcop:
	   DCOPRef giveMeAnotherObject();
	   int doSomething( QString, float, bool );
	   ASYNC pingMe( QCString message );
	   UserType userFunction( UserType );
	};

In addition, the reference can operate as a comfortable generic stub to call remote DCOP objects in cases where no DCOPStub is available. The advantage of using DCOPRef instead of the low-level functions DCOPClient::call() and DCOPClient::send() are the nicer syntax and the implicit runtime error checking.

Say you want to call the method "doSomething" from the above interface on an object called "example" that lives in application "foo". Using DCOPRef, you would write

	DCOPRef example( "foo", "example" );
	int result = example.call( "doSomething", "Hello World", (float)2.5, true );

If it is important for you to know whether the call succeeded or not, you can use the slightly more elaborate pattern:

	DCOPRef example( "foo", "example" );
	DCOPReply reply = example.call( "doSomething", "Hello World", (float)2.5, true );
	if ( reply.isValid() ) {
	    int result = reply;
	    // ...
	}

For curiosity, here is how you would achieve the exactly same functionality by using DCOPClient::call() directly:

    QByteArray data, replyData;
    QCString replyType;
    QDataStream arg( data, IO_WriteOnly );
    arg << QString("hello world" ), (float) 2.5 << true;
    if ( DCOPClient::mainClient()->call( app, obj,
			     "doSomething(QString,float,bool)",
			     data, replyType, replyData ) ) {
	if ( replyType == "int" ) {
	    int result;
	    QDataStream reply( replyData, IO_ReadOnly );
	    reply >> result;
	    // ...
	}
    }

As you might see from the code snippet, the DCOPRef has to "guess" the names of the datatypes of the arguments to construct a dcop call. This is done through global inline overloads of the dcopTypeName function, for example

	inline const char* dcopTypeName( const QString& ) { return "QString"; }

If you use custom data types that do support QDataStream but have no corrsponding dcopTypeName overload, you can either provide such an overload or use a DCOPArg wrapper that allows you to specify the type.

	UserType userType;
	DCOPReply reply = example.call( "userFunction", DCOPArg( userType, "UserType" ) );

Similar, when you retrieve such a data type, you can use an explicit call to DCOPReply::get():

	UserType userType;
	reply.get( userType, "UserType" );

The function send() works very similar to call(), only that it returns a simple bool on whether the signal could be sent or not:

	if ( example.pingMe( "message" ) == false )
	   qWarning("could not ping example" );

A DCOP reference operates on DCOPClient::mainClient(), unless you explicitely specify another client with setDCOPClient().

See also:: DCOPArg , DCOPReply , DCOPObject

Author:: Matthias Ettrich <ettrich@kde.org>, Torben Weis <weis@kde.org>

Definition at line 275 of file dcopref.h.

Constructor & Destructor Documentation

DCOPRef::DCOPRef ( )

Creates a null reference.

DCOPRef::DCOPRef ( const DCOPRef & ref )

Copy constructor.

DCOPRef::DCOPRef ( const QCString & app,

const QCString & obj = ""

)

Creates a reference for application app and object obj
Parameters:

app The name of an application as registered by the dcopserver.

obj The name of the dcop object.

DCOPRef::DCOPRef ( DCOPObject * object )

Creates a reference to an existing dcop object
Parameters:

object The dcop object to create the ref to.

DCOPRef::DCOPRef ( const QCString & app,

const QCString & obj,

const QCString & type

)

Creates a reference for application app and object obj with a specified type type.
Parameters:

app The name of an application as registered by the dcopserver.

obj The name of the dcop object

type The object's type

Member Function Documentation

QCString DCOPRef::app ( )

Name of the application in which the object resides.
Returns:
the application's id. Can be null or empty if not set.

template<class T1, class T2, class T3, class T4, class T5, class T6, class T7, class T8>

DCOPReply DCOPRef::call ( const QCString & fun,

const T1 & t1,

const T2 & t2,

const T3 & t3,

const T4 & t4,

const T5 & t5,

const T6 & t6,

const T7 & t7,

const T8 & t8

) [inline]

Calls the function fun on the object referenced by this reference.
Parameters:

fun the name of the DCOP function. This can be either the full function signature (e.g. "setName(QString)") or only the function's name (e.g. "setName"). In the latter case the exact signature will be guessed from the arguments

t1 the first argument of the function. This can be a supported base type or a DCOPArg object.

t2 the second argument of the function. This can be a supported base type or a DCOPArg object.

t3 the third argument of the function. This can be a supported base type or a DCOPArg object.

t4 the fourth argument of the function. This can be a supported base type or a DCOPArg object.

t5 the fifth argument of the function. This can be a supported base type or a DCOPArg object.

t6 the sixth argument of the function. This can be a supported base type or a DCOPArg object.

t7 the seventh argument of the function. This can be a supported base type or a DCOPArg object.

t8 the eigth argument of the function. This can be a supported base type or a DCOPArg object.

Returns:
the DCOPReply object. Is invalid (DCOPReply::isValid()) when an error occurred.
See also:
send() , DCOPArg
Since:
3.1

Definition at line 708 of file dcopref.h.

template<class T1, class T2, class T3, class T4, class T5, class T6, class T7>

DCOPReply DCOPRef::call ( const QCString & fun,

const T1 & t1,

const T2 & t2,

const T3 & t3,

const T4 & t4,

const T5 & t5,

const T6 & t6,

const T7 & t7

) [inline]

Calls the function fun on the object referenced by this reference.
Parameters:

fun the name of the DCOP function. This can be either the full function signature (e.g. "setName(QString)") or only the function's name (e.g. "setName"). In the latter case the exact signature will be guessed from the arguments

t1 the first argument of the function. This can be a supported base type or a DCOPArg object.

t2 the second argument of the function. This can be a supported base type or a DCOPArg object.

t3 the third argument of the function. This can be a supported base type or a DCOPArg object.

t4 the fourth argument of the function. This can be a supported base type or a DCOPArg object.

t5 the fifth argument of the function. This can be a supported base type or a DCOPArg object.

t6 the sixth argument of the function. This can be a supported base type or a DCOPArg object.

t7 the seventh argument of the function. This can be a supported base type or a DCOPArg object.

Returns:
the DCOPReply object. Is invalid (DCOPReply::isValid()) when an error occurred.
See also:
send() , DCOPArg
Since:
3.1

Definition at line 655 of file dcopref.h.

template<class T1, class T2, class T3, class T4, class T5, class T6>

DCOPReply DCOPRef::call ( const QCString & fun,

const T1 & t1,

const T2 & t2,

const T3 & t3,

const T4 & t4,

const T5 & t5,

const T6 & t6

) [inline]

Calls the function fun on the object referenced by this reference.
Parameters:

fun the name of the DCOP function. This can be either the full function signature (e.g. "setName(QString)") or only the function's name (e.g. "setName"). In the latter case the exact signature will be guessed from the arguments

t1 the first argument of the function. This can be a supported base type or a DCOPArg object.

t2 the second argument of the function. This can be a supported base type or a DCOPArg object.

t3 the third argument of the function. This can be a supported base type or a DCOPArg object.

t4 the fourth argument of the function. This can be a supported base type or a DCOPArg object.

t5 the fifth argument of the function. This can be a supported base type or a DCOPArg object.

t6 the sixth argument of the function. This can be a supported base type or a DCOPArg object.

Returns:
the DCOPReply object. Is invalid (DCOPReply::isValid()) when an error occurred.
See also:
send() , DCOPArg
Since:
3.1

Definition at line 606 of file dcopref.h.

template<class T1, class T2, class T3, class T4, class T5>

DCOPReply DCOPRef::call ( const QCString & fun,

const T1 & t1,

const T2 & t2,

const T3 & t3,

const T4 & t4,

const T5 & t5

) [inline]

Calls the function fun on the object referenced by this reference.
Parameters:

fun the name of the DCOP function. This can be either the full function signature (e.g. "setName(QString)") or only the function's name (e.g. "setName"). In the latter case the exact signature will be guessed from the arguments

t1 the first argument of the function. This can be a supported base type or a DCOPArg object.

t2 the second argument of the function. This can be a supported base type or a DCOPArg object.

t3 the third argument of the function. This can be a supported base type or a DCOPArg object.

t4 the fourth argument of the function. This can be a supported base type or a DCOPArg object.

t5 the fifth argument of the function. This can be a supported base type or a DCOPArg object.

Returns:
the DCOPReply object. Is invalid (DCOPReply::isValid()) when an error occurred.
See also:
send() , DCOPArg
Since:
3.1

Definition at line 561 of file dcopref.h.

template<class T1, class T2, class T3, class T4>

DCOPReply DCOPRef::call ( const QCString & fun,

const T1 & t1,

const T2 & t2,

const T3 & t3,

const T4 & t4

) [inline]

Calls the function fun on the object referenced by this reference.
Parameters:

fun the name of the DCOP function. This can be either the full function signature (e.g. "setName(QString)") or only the function's name (e.g. "setName"). In the latter case the exact signature will be guessed from the arguments

t1 the first argument of the function. This can be a supported base type or a DCOPArg object.

t2 the second argument of the function. This can be a supported base type or a DCOPArg object.

t3 the third argument of the function. This can be a supported base type or a DCOPArg object.

t4 the fourth argument of the function. This can be a supported base type or a DCOPArg object.

Returns:
the DCOPReply object. Is invalid (DCOPReply::isValid()) when an error occurred.
See also:
send() , DCOPArg
Since:
3.1

Definition at line 520 of file dcopref.h.

template<class T1, class T2, class T3>

DCOPReply DCOPRef::call ( const QCString & fun,

const T1 & t1,

const T2 & t2,

const T3 & t3

) [inline]

Calls the function fun on the object referenced by this reference.
Parameters:

fun the name of the DCOP function. This can be either the full function signature (e.g. "setName(QString)") or only the function's name (e.g. "setName"). In the latter case the exact signature will be guessed from the arguments

t1 the first argument of the function. This can be a supported base type or a DCOPArg object.

t2 the second argument of the function. This can be a supported base type or a DCOPArg object.

t3 the third argument of the function. This can be a supported base type or a DCOPArg object.

Returns:
the DCOPReply object. Is invalid (DCOPReply::isValid()) when an error occurred.
See also:
send() , DCOPArg
Since:
3.1

Definition at line 483 of file dcopref.h.

template<class T1, class T2>

DCOPReply DCOPRef::call ( const QCString & fun,

const T1 & t1,

const T2 & t2

) [inline]

Calls the function fun on the object referenced by this reference.
Parameters:

fun the name of the DCOP function. This can be either the full function signature (e.g. "setName(QString)") or only the function's name (e.g. "setName"). In the latter case the exact signature will be guessed from the arguments

t1 the first argument of the function. This can be a supported base type or a DCOPArg object.

t2 the second argument of the function. This can be a supported base type or a DCOPArg object.

Returns:
the DCOPReply object. Is invalid (DCOPReply::isValid()) when an error occurred.
See also:
send() , DCOPArg
Since:
3.1

Definition at line 450 of file dcopref.h.

template<class T1>

DCOPReply DCOPRef::call ( const QCString & fun,

const T1 & t1

) [inline]

Calls the function fun on the object referenced by this reference.
Parameters:

fun the name of the DCOP function. This can be either the full function signature (e.g. "setName(QString)") or only the function's name (e.g. "setName"). In the latter case the exact signature will be guessed from the arguments

t1 the first argument of the function. This can be a supported base type or a DCOPArg object.

Returns:
the DCOPReply object. Is invalid (DCOPReply::isValid()) when an error occurred.
See also:
send() , DCOPArg
Since:
3.1

Definition at line 422 of file dcopref.h.

DCOPReply DCOPRef::call ( const QCString & fun ) [inline]

Calls the function fun on the object referenced by this reference.
Parameters:

fun the name of the DCOP function. This can be either the full function signature (e.g. "setName(QString)") or only the function's name (e.g. "setName"). In the latter case the exact signature will be guessed from the arguments

Returns:
the DCOPReply object. Is invalid (DCOPReply::isValid()) when an error occurred.
See also:
send() , DCOPArg
Since:
3.1

Definition at line 401 of file dcopref.h.

void DCOPRef::clear ( )

Makes this a null reference.

DCOPClient* DCOPRef::dcopClient ( )

Returns the dcop client the reference operates on. If no client has been set, this is the DCOPClient::mainClient().
Returns:
the DCOPClient of this object
Since:
3.1

bool DCOPRef::isNull ( )

Tests wether it is a null reference.
Returns:
true if this object is a null reference

QCString DCOPRef::obj ( )

Object ID of the referenced object.
Returns:
the id of the referenced object. Can be null or empty if not set.
Since:
3.1

QCString DCOPRef::object ( )

@obsolete

DCOPRef& DCOPRef::operator= ( const DCOPRef & )

Assignment operator. Copies the references data.

template<class T1, class T2, class T3, class T4, class T5, class T6, class T7, class T8>

bool DCOPRef::send ( const QCString & fun,

const T1 & t1,

const T2 & t2,

const T3 & t3,

const T4 & t4,

const T5 & t5,

const T6 & t6,

const T7 & t7,

const T8 & t8

) [inline]

Calls the function fun on the object referenced by this reference. Unlike call() this method does not expect a return value.
Parameters:

fun the name of the DCOP function. This can be either the full function signature (e.g. "setName(QString)") or only the function's name (e.g. "setName"). In the latter case the exact signature will be guessed from the arguments

t1 the first argument of the function. This can be a supported base type or a DCOPArg object.

t2 the second argument of the function. This can be a supported base type or a DCOPArg object.

t3 the third argument of the function. This can be a supported base type or a DCOPArg object.

t4 the fourth argument of the function. This can be a supported base type or a DCOPArg object.

t5 the fifth argument of the function. This can be a supported base type or a DCOPArg object.

t6 the sixth argument of the function. This can be a supported base type or a DCOPArg object.

t7 the seventh argument of the function. This can be a supported base type or a DCOPArg object.

t8 the eigth argument of the function. This can be a supported base type or a DCOPArg object.

Returns:
the DCOPReply object. Is invalid (DCOPReply::isValid()) when an error occurred.
See also:
call() , DCOPArg
Since:
3.1

Definition at line 1054 of file dcopref.h.

template<class T1, class T2, class T3, class T4, class T5, class T6, class T7>

bool DCOPRef::send ( const QCString & fun,

const T1 & t1,

const T2 & t2,

const T3 & t3,

const T4 & t4,

const T5 & t5,

const T6 & t6,

const T7 & t7

) [inline]

Calls the function fun on the object referenced by this reference. Unlike call() this method does not expect a return value.
Parameters:

fun the name of the DCOP function. This can be either the full function signature (e.g. "setName(QString)") or only the function's name (e.g. "setName"). In the latter case the exact signature will be guessed from the arguments

t1 the first argument of the function. This can be a supported base type or a DCOPArg object.

t2 the second argument of the function. This can be a supported base type or a DCOPArg object.

t3 the third argument of the function. This can be a supported base type or a DCOPArg object.

t4 the fourth argument of the function. This can be a supported base type or a DCOPArg object.

t5 the fifth argument of the function. This can be a supported base type or a DCOPArg object.

t6 the sixth argument of the function. This can be a supported base type or a DCOPArg object.

t7 the seventh argument of the function. This can be a supported base type or a DCOPArg object.

Returns:
the DCOPReply object. Is invalid (DCOPReply::isValid()) when an error occurred.
See also:
call() , DCOPArg
Since:
3.1

Definition at line 1001 of file dcopref.h.

template<class T1, class T2, class T3, class T4, class T5, class T6>

bool DCOPRef::send ( const QCString & fun,

const T1 & t1,

const T2 & t2,

const T3 & t3,

const T4 & t4,

const T5 & t5,

const T6 & t6

) [inline]

Calls the function fun on the object referenced by this reference. Unlike call() this method does not expect a return value.
Parameters:

fun the name of the DCOP function. This can be either the full function signature (e.g. "setName(QString)") or only the function's name (e.g. "setName"). In the latter case the exact signature will be guessed from the arguments

t1 the first argument of the function. This can be a supported base type or a DCOPArg object.

t2 the second argument of the function. This can be a supported base type or a DCOPArg object.

t3 the third argument of the function. This can be a supported base type or a DCOPArg object.

t4 the fourth argument of the function. This can be a supported base type or a DCOPArg object.

t5 the fifth argument of the function. This can be a supported base type or a DCOPArg object.

t6 the sixth argument of the function. This can be a supported base type or a DCOPArg object.

Returns:
the DCOPReply object. Is invalid (DCOPReply::isValid()) when an error occurred.
See also:
call() , DCOPArg
Since:
3.1

Definition at line 952 of file dcopref.h.

template<class T1, class T2, class T3, class T4, class T5>

bool DCOPRef::send ( const QCString & fun,

const T1 & t1,

const T2 & t2,

const T3 & t3,

const T4 & t4,

const T5 & t5

) [inline]

Calls the function fun on the object referenced by this reference. Unlike call() this method does not expect a return value.
Parameters:

fun the name of the DCOP function. This can be either the full function signature (e.g. "setName(QString)") or only the function's name (e.g. "setName"). In the latter case the exact signature will be guessed from the arguments

t1 the first argument of the function. This can be a supported base type or a DCOPArg object.

t2 the second argument of the function. This can be a supported base type or a DCOPArg object.

t3 the third argument of the function. This can be a supported base type or a DCOPArg object.

t4 the fourth argument of the function. This can be a supported base type or a DCOPArg object.

t5 the fifth argument of the function. This can be a supported base type or a DCOPArg object.

Returns:
the DCOPReply object. Is invalid (DCOPReply::isValid()) when an error occurred.
See also:
call() , DCOPArg
Since:
3.1

Definition at line 907 of file dcopref.h.

template<class T1, class T2, class T3, class T4>

bool DCOPRef::send ( const QCString & fun,

const T1 & t1,

const T2 & t2,

const T3 & t3,

const T4 & t4

) [inline]

Calls the function fun on the object referenced by this reference. Unlike call() this method does not expect a return value.
Parameters:

fun the name of the DCOP function. This can be either the full function signature (e.g. "setName(QString)") or only the function's name (e.g. "setName"). In the latter case the exact signature will be guessed from the arguments

t1 the first argument of the function. This can be a supported base type or a DCOPArg object.

t2 the second argument of the function. This can be a supported base type or a DCOPArg object.

t3 the third argument of the function. This can be a supported base type or a DCOPArg object.

t4 the fourth argument of the function. This can be a supported base type or a DCOPArg object.

Returns:
the DCOPReply object. Is invalid (DCOPReply::isValid()) when an error occurred.
See also:
call() , DCOPArg
Since:
3.1

Definition at line 866 of file dcopref.h.

template<class T1, class T2, class T3>

bool DCOPRef::send ( const QCString & fun,

const T1 & t1,

const T2 & t2,

const T3 & t3

) [inline]

Calls the function fun on the object referenced by this reference. Unlike call() this method does not expect a return value.
Parameters:

fun the name of the DCOP function. This can be either the full function signature (e.g. "setName(QString)") or only the function's name (e.g. "setName"). In the latter case the exact signature will be guessed from the arguments

t1 the first argument of the function. This can be a supported base type or a DCOPArg object.

t2 the second argument of the function. This can be a supported base type or a DCOPArg object.

t3 the third argument of the function. This can be a supported base type or a DCOPArg object.

Returns:
the DCOPReply object. Is invalid (DCOPReply::isValid()) when an error occurred.
See also:
call() , DCOPArg
Since:
3.1

Definition at line 829 of file dcopref.h.

template<class T1, class T2>

bool DCOPRef::send ( const QCString & fun,

const T1 & t1,

const T2 & t2

) [inline]

Calls the function fun on the object referenced by this reference. Unlike call() this method does not expect a return value.
Parameters:

fun the name of the DCOP function. This can be either the full function signature (e.g. "setName(QString)") or only the function's name (e.g. "setName"). In the latter case the exact signature will be guessed from the arguments

t1 the first argument of the function. This can be a supported base type or a DCOPArg object.

t2 the second argument of the function. This can be a supported base type or a DCOPArg object.

Returns:
the DCOPReply object. Is invalid (DCOPReply::isValid()) when an error occurred.
See also:
call() , DCOPArg
Since:
3.1

Definition at line 796 of file dcopref.h.

template<class T1>

bool DCOPRef::send ( const QCString & fun,

const T1 & t1

) [inline]

Calls the function fun on the object referenced by this reference. Unlike call() this method does not expect a return value.
Parameters:

fun the name of the DCOP function. This can be either the full function signature (e.g. "setName(QString)") or only the function's name (e.g. "setName"). In the latter case the exact signature will be guessed from the arguments

t1 the first argument of the function. This can be a supported base type or a DCOPArg object.

Returns:
the DCOPReply object. Is invalid (DCOPReply::isValid()) when an error occurred.
See also:
call() , DCOPArg
Since:
3.1

Definition at line 768 of file dcopref.h.

bool DCOPRef::send ( const QCString & fun ) [inline]

Calls the function fun on the object referenced by this reference. Unlike call() this method does not expect a return value.
Parameters:

fun the name of the DCOP function. This can be either the full function signature (e.g. "setName(QString)") or only the function's name (e.g. "setName"). In the latter case the exact signature will be guessed from the arguments

Returns:
the DCOPReply object. Is invalid (DCOPReply::isValid()) when an error occurred.
See also:
call()
Since:
3.1

Definition at line 746 of file dcopref.h.

void DCOPRef::setDCOPClient ( DCOPClient * client )

Sets a specific dcop client for this reference. Otherwise DCOPClient::mainClient() is used.
Parameters:

client the new DCOPClient of this object

Since:
3.1

void DCOPRef::setRef ( const QCString & app,

const QCString & obj,

const QCString & type

)

Changes the referenced object.
Parameters:

app the application id.

obj the object id

tyoe the object's type

void DCOPRef::setRef ( const QCString & app,

const QCString & obj = ""

)

Changes the referenced object. Resets the type to unknown (null).
Parameters:

app the application id.

obj the object id

QCString DCOPRef::type ( )

Type of the referenced object. May be null (i.e. unknown).
Returns:
the type of the referenced object, or null if unknown

The documentation for this class was generated from the following file:

dcopref.h

Generated on Wed Aug 13 23:30:03 2003 for kdelibs by

1.2.18


Public Methods
	DCOPRef ()
	DCOPRef (const DCOPRef &ref)
	DCOPRef (const QCString &app, const QCString &obj="")
	DCOPRef (DCOPObject *object)
	DCOPRef (const QCString &app, const QCString &obj, const QCString &type)
bool	isNull () const
QCString	app () const
QCString	obj () const
QCString	object () const
QCString	type () const
DCOPRef &	operator= (const DCOPRef &)
void	setRef (const QCString &app, const QCString &obj="")
void	setRef (const QCString &app, const QCString &obj, const QCString &type)
void	clear ()
DCOPClient *	dcopClient () const
void	setDCOPClient (DCOPClient *client)
DCOPReply	call (const QCString &fun)
template<class T1> DCOPReply	call (const QCString &fun, const T1 &t1)
template<class T1, class T2> DCOPReply	call (const QCString &fun, const T1 &t1, const T2 &t2)
template<class T1, class T2, class T3> DCOPReply	call (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3)
template<class T1, class T2, class T3, class T4> DCOPReply	call (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4)
template<class T1, class T2, class T3, class T4, class T5> DCOPReply	call (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4, const T5 &t5)
template<class T1, class T2, class T3, class T4, class T5, class T6> DCOPReply	call (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4, const T5 &t5, const T6 &t6)
template<class T1, class T2, class T3, class T4, class T5, class T6, class T7> DCOPReply	call (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4, const T5 &t5, const T6 &t6, const T7 &t7)
template<class T1, class T2, class T3, class T4, class T5, class T6, class T7, class T8> DCOPReply	call (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4, const T5 &t5, const T6 &t6, const T7 &t7, const T8 &t8)
bool	send (const QCString &fun)
template<class T1> bool	send (const QCString &fun, const T1 &t1)
template<class T1, class T2> bool	send (const QCString &fun, const T1 &t1, const T2 &t2)
template<class T1, class T2, class T3> bool	send (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3)
template<class T1, class T2, class T3, class T4> bool	send (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4)
template<class T1, class T2, class T3, class T4, class T5> bool	send (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4, const T5 &t5)
template<class T1, class T2, class T3, class T4, class T5, class T6> bool	send (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4, const T5 &t5, const T6 &t6)
template<class T1, class T2, class T3, class T4, class T5, class T6, class T7> bool	send (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4, const T5 &t5, const T6 &t6, const T7 &t7)
template<class T1, class T2, class T3, class T4, class T5, class T6, class T7, class T8> bool	send (const QCString &fun, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4, const T5 &t5, const T6 &t6, const T7 &t7, const T8 &t8)