.TH "KDCOPPropertyProxy" 3 "28 Jan 2004" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KDCOPPropertyProxy \- The KDCOPPropertyProxy class provides an easy way to publish \fBQt\fP properties of a \fBQObject\fP through DCOP.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kdcoppropertyproxy.h>\fP
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKDCOPPropertyProxy\fP (\fBQObject\fP *object)"
.br
.RI "\fIConvenience constructor. \fP"
.ti -1c
.RI "\fB~KDCOPPropertyProxy\fP ()"
.br
.RI "\fIDestructor. \fP"
.ti -1c
.RI "bool \fBisPropertyRequest\fP (const  \fBQCString\fP &fun)"
.br
.RI "\fIConvenience method, when using this class as object. \fP"
.ti -1c
.RI "bool \fBprocessPropertyRequest\fP (const  \fBQCString\fP &fun, const  \fBQByteArray\fP &data, \fBQCString\fP &replyType, \fBQByteArray\fP &replyData)"
.br
.RI "\fIConvenience method, when using this class as object. \fP"
.ti -1c
.RI "\fBQValueList\fP< \fBQCString\fP > \fBfunctions\fP ()"
.br
.RI "\fIConvenience method, when using this class as object. \fP"
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "\fBQValueList\fP< \fBQCString\fP > \fBfunctions\fP (\fBQObject\fP *object)"
.br
.RI "\fIReturns a semicolon-separated list of functions understood by the PropertyProxy for the given \fBQObject\fP argument. \fP"
.ti -1c
.RI "bool \fBisPropertyRequest\fP (const  \fBQCString\fP &fun, \fBQObject\fP *object)"
.br
.RI "\fIReturns true if the method request in the fun argument matches the signature of the three standard property methods or set/get methods for the properties of the object argument. \fP"
.ti -1c
.RI "bool \fBprocessPropertyRequest\fP (const  \fBQCString\fP &fun, const  \fBQByteArray\fP &data, \fBQCString\fP &replyType, \fBQByteArray\fP &replyData, \fBQObject\fP *object)"
.br
.RI "\fIProcesses the given DCOP method request by translating the request into a setProperty/property call on the given \fBQObject\fP argument. \fP"
.in -1c
.SH "Detailed Description"
.PP 
The KDCOPPropertyProxy class provides an easy way to publish \fBQt\fP properties of a \fBQObject\fP through DCOP. 

The class provides DCOP equivalents for the \fBQt\fP property methods setProperty() , property() and propertyNames() and also provides automatic set/get methods for the properties of a \fBQObject\fP. That means for example if your object provides a \fBQString\fP property called foo , then KDCOPPropertyProxy translates DCOP calls 'setFoo( QString )' and 'QString foo()' automatically into the corresponding setProperty/property calls. 
.PP
Definition at line 38 of file kdcoppropertyproxy.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KDCOPPropertyProxy::KDCOPPropertyProxy (\fBQObject\fP * object)"
.PP
Convenience constructor. Use it if you want to use this class as object, in contrary to using the static methods of this class and providing a \fBQObject\fP argument for each call. Definition at line 55 of file kdcoppropertyproxy.cpp.
.SS "KDCOPPropertyProxy::~\fBKDCOPPropertyProxy\fP ()"
.PP
Destructor. Definition at line 61 of file kdcoppropertyproxy.cpp.
.SH "Member Function Documentation"
.PP 
.SS "bool KDCOPPropertyProxy::isPropertyRequest (const \fBQCString\fP & fun)"
.PP
Convenience method, when using this class as object. See documentation of the constructor and static isPropertyRequest method. Definition at line 66 of file kdcoppropertyproxy.cpp.
.SS "bool KDCOPPropertyProxy::processPropertyRequest (const \fBQCString\fP & fun, const \fBQByteArray\fP & data, \fBQCString\fP & replyType, \fBQByteArray\fP & replyData)"
.PP
Convenience method, when using this class as object. See documentation of the constructor and static processPropertyRequest method. Definition at line 71 of file kdcoppropertyproxy.cpp.
.SS "\fBQValueList\fP< \fBQCString\fP > KDCOPPropertyProxy::functions ()"
.PP
Convenience method, when using this class as object. See documentation of the constructor and static functions method. Definition at line 77 of file kdcoppropertyproxy.cpp.
.SS "\fBQValueList\fP< \fBQCString\fP > KDCOPPropertyProxy::functions (\fBQObject\fP * object)\fC [static]\fP"
.PP
Returns a semicolon-separated list of functions understood by the PropertyProxy for the given \fBQObject\fP argument. Returns 'property(QCString);setProperty(QCString,QVariant);propertyNames();' plus set/get methods for the properties of the given object argument.
.PP
\fBSee also:\fP
.RS 4
\fBDCOPObject::functions()\fP 
.RE
.PP
Definition at line 94 of file kdcoppropertyproxy.cpp.
.PP
References QMetaObject::findProperty(), QObject::metaObject(), KStdAction::name(), QMetaObject::property(), QMetaObject::propertyNames(), QMetaProperty::type(), and QMetaProperty::writable().
.SS "bool KDCOPPropertyProxy::isPropertyRequest (const \fBQCString\fP & fun, \fBQObject\fP * object)\fC [static]\fP"
.PP
Returns true if the method request in the fun argument matches the signature of the three standard property methods or set/get methods for the properties of the object argument. Use this method in your own \fBDCOPObject\fP dispatcher to check if the DCOP request is a property request which can be handled by this class. Definition at line 82 of file kdcoppropertyproxy.cpp.
.SS "bool KDCOPPropertyProxy::processPropertyRequest (const \fBQCString\fP & fun, const \fBQByteArray\fP & data, \fBQCString\fP & replyType, \fBQByteArray\fP & replyData, \fBQObject\fP * object)\fC [static]\fP"
.PP
Processes the given DCOP method request by translating the request into a setProperty/property call on the given \fBQObject\fP argument. Definition at line 128 of file kdcoppropertyproxy.cpp.
.PP
References QValueList::append(), QObject::metaObject(), QVariant::nameToType(), QObject::property(), QObject::setProperty(), QVariant::toBool(), QVariant::toIconSet(), QVariant::type(), and QVariant::typeName().

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