diff options
Diffstat (limited to 'doc/man/man3/tqaxbase.3qt')
| -rw-r--r-- | doc/man/man3/tqaxbase.3qt | 54 |
1 files changed, 27 insertions, 27 deletions
diff --git a/doc/man/man3/tqaxbase.3qt b/doc/man/man3/tqaxbase.3qt index a2fe7c8bf..8b365f36c 100644 --- a/doc/man/man3/tqaxbase.3qt +++ b/doc/man/man3/tqaxbase.3qt @@ -24,7 +24,7 @@ Inherited by QAxObject and QAxWidget. .BI "virtual \fB~QAxBase\fR ()" .br .ti -1c -.BI "QString \fBcontrol\fR () const" +.BI "TQString \fBcontrol\fR () const" .br .ti -1c .BI "long \fBqueryInterface\fR ( const QUuid & uuid, void ** iface ) const" @@ -45,7 +45,7 @@ Inherited by QAxObject and QAxWidget. .BI "void \fBsetPropertyBag\fR ( const PropertyBag & bag )" .br .ti -1c -.BI "QString \fBgenerateDocumentation\fR ()" +.BI "TQString \fBgenerateDocumentation\fR ()" .br .ti -1c .BI "virtual bool \fBpropertyWritable\fR ( const char * prop ) const" @@ -66,7 +66,7 @@ Inherited by QAxObject and QAxWidget. .BI "virtual void \fBclear\fR ()" .br .ti -1c -.BI "bool \fBsetControl\fR ( const QString & )" +.BI "bool \fBsetControl\fR ( const TQString & )" .br .ti -1c .BI "void \fBdisableMetaObject\fR ()" @@ -81,19 +81,19 @@ Inherited by QAxObject and QAxWidget. .SS "Signals" .in +1c .ti -1c -.BI "void \fBsignal\fR ( const QString & name, int argc, void * argv )" +.BI "void \fBsignal\fR ( const TQString & name, int argc, void * argv )" .br .ti -1c -.BI "void \fBpropertyChanged\fR ( const QString & name )" +.BI "void \fBpropertyChanged\fR ( const TQString & name )" .br .ti -1c -.BI "void \fBexception\fR ( int code, const QString & source, const QString & desc, const QString & help )" +.BI "void \fBexception\fR ( int code, const TQString & source, const TQString & desc, const TQString & help )" .br .in -1c .SS "Properties" .in +1c .ti -1c -.BI "QString \fBcontrol\fR - the name of the COM object wrapped by this QAxBase object" +.BI "TQString \fBcontrol\fR - the name of the COM object wrapped by this QAxBase object" .br .in -1c .SS "Protected Members" @@ -124,7 +124,7 @@ QAxBase is an abstract class that cannot be used directly, and is instantiated t .br .fi .PP -Properties exposed by the object's IDispatch implementation can be read and written through the property system provided by the TQt Object Model (both subclasses are QObjects, so you can use setProperty() and property() as with QObject). Properties with multiple parameters are not supported. +Properties exposed by the object's IDispatch implementation can be read and written through the property system provided by the TQt Object Model (both subclasses are QObjects, so you can use setProperty() and property() as with TQObject). Properties with multiple parameters are not supported. .PP .nf .br @@ -146,17 +146,17 @@ Outgoing events supported by the COM object are emitted as standard TQt signals. .PP .nf .br - connect( webBrowser, SIGNAL(TitleChanged(const QString&)), + connect( webBrowser, SIGNAL(TitleChanged(const TQString&)), .br - this, SLOT(setCaption(const QString&)) ); + this, SLOT(setCaption(const TQString&)) ); .br .fi .PP QAxBase transparently converts between COM data types and the equivalent TQt data types. Some COM types have no equivalent TQt data structure. .PP -Supported COM datatypes are listed in the first column of following table. The second column is the TQt type that can be used with the QObject property functions. The third column is the TQt type that is used in the prototype of generated signals and slots for in-parameters, and the last column is the TQt type that is used in the prototype of signals and slots for out-parameters. <center>.nf +Supported COM datatypes are listed in the first column of following table. The second column is the TQt type that can be used with the TQObject property functions. The third column is the TQt type that is used in the prototype of generated signals and slots for in-parameters, and the last column is the TQt type that is used in the prototype of signals and slots for out-parameters. <center>.nf .TS -l - l. COM type TQt property in-parameter out-parameter VARIANT_BOOL bool bool bool& BSTR QString const QString& QString& char, short, int, long int int int& uchar, ushort, uint, ulong uint uint uint& float, double double double double& DATE QDateTime const QDateTime& QDateTime& CY TQ_LLONG TQ_LLONG TQ_LLONG& OLE_COLOR QColor const QColor& QColor& SAFEARRAY(VARIANT) QValueList<QVariant> const QValueList<QVariant>& QValueList<QVariant>& SAFEARRAY(BYTE) QByteArray const QByteArray& QByteArray& SAFEARRAY(BSTR) QStringList const QStringList& QStringList& VARIANT type-dependent const QVariant& QVariant& IFontDisp* QFont const QFont& QFont& IPictureDisp* QPixmap const QPixmap& QPixmap& IDispatch* QAxObject* (read-only) QAxBase::asVariant() QAxObject* (return value) IUnknown* QAxObject* (read-only) QAxBase::asVariant() QAxObject* (return value) SCODE, DECIMAL \fIunsupported\fR \fIunsupported\fR +l - l. COM type TQt property in-parameter out-parameter VARIANT_BOOL bool bool bool& BSTR TQString const TQString& TQString& char, short, int, long int int int& uchar, ushort, uint, ulong uint uint uint& float, double double double double& DATE QDateTime const QDateTime& QDateTime& CY TQ_LLONG TQ_LLONG TQ_LLONG& OLE_COLOR TQColor const TQColor& TQColor& SAFEARRAY(VARIANT) QValueList<QVariant> const QValueList<QVariant>& QValueList<QVariant>& SAFEARRAY(BYTE) QByteArray const QByteArray& QByteArray& SAFEARRAY(BSTR) QStringList const QStringList& QStringList& VARIANT type-dependent const QVariant& QVariant& IFontDisp* QFont const QFont& QFont& IPictureDisp* QPixmap const QPixmap& QPixmap& IDispatch* QAxObject* (read-only) QAxBase::asVariant() QAxObject* (return value) IUnknown* QAxObject* (read-only) QAxBase::asVariant() QAxObject* (return value) SCODE, DECIMAL \fIunsupported\fR \fIunsupported\fR .TE .fi </center> @@ -198,14 +198,14 @@ use the QAxBase API like this: QAxObject object( "<CLSID>" ); .br .br - QString text = object.property( "text" ).toString(); + TQString text = object.property( "text" ).toString(); .br object.setProperty( "font", QFont( "Times New Roman", 12 ) ); .br .br connect( this, SIGNAL(clicked(int)), &object, SLOT(showColumn(int)) ); .br - bool ok = object.dynamicCall( "addColumn(const QString&)", "Column 1" ).toBool(); + bool ok = object.dynamicCall( "addColumn(const TQString&)", "Column 1" ).toBool(); .br .br QValueList<QVariant> varlist; @@ -246,7 +246,7 @@ To get the definition of the COM interfaces you will have to use the header file If you need to react to events that pass parameters of unsupported datatypes you can use the generic signal that delivers the event data as provided by the COM event. .SS "Member Type Documentation" .SH "QAxBase::PropertyBag" -A QMap<QString,QVariant> that can store properties as name:value pairs. +A QMap<TQString,QVariant> that can store properties as name:value pairs. .SH MEMBER FUNCTION DOCUMENTATION .SH "QAxBase::QAxBase ( IUnknown * iface = 0 )" Creates a QAxBase object that wraps the COM object \fIiface\fR. If \fIiface\fR is 0 (the default), use setControl() to instantiate a COM object. @@ -260,7 +260,7 @@ Returns a QVariant that wraps the COM object. The variant can then be used as a Disconnects and destroys the COM object. .PP If you reimplement this function you must also reimplement the destructor to call clear(), and call this implementation at the end of your clear() function. -.SH "QString QAxBase::control () const" +.SH "TQString QAxBase::control () const" Returns the name of the COM object wrapped by this QAxBase object. See the "control" property for details. .SH "void QAxBase::disableClassInfo ()" Disables the class info generation for this ActiveX container. If you don't require any class information about the ActiveX control use this function to speed up the meta object generation. @@ -281,11 +281,11 @@ Note that this function must be called immediately after construction of the obj .SH "QVariant QAxBase::dynamicCall ( const QCString & function, const QVariant & var1 = QVariant ( ), const QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant & var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 = QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )" Calls the COM object's method \fIfunction\fR, passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR, and returns the value returned by the method, or an invalid QVariant if the method does not return a value or when the function call failed. .PP -If \fIfunction\fR is a method of the object the string must be provided as the full prototype, for example as it would be written in a QObject::connect() call. +If \fIfunction\fR is a method of the object the string must be provided as the full prototype, for example as it would be written in a TQObject::connect() call. .PP .nf .br - activeX->dynamicCall( "Navigate(const QString&)", "www.trolltech.com" ); + activeX->dynamicCall( "Navigate(const TQString&)", "www.trolltech.com" ); .br .fi .PP @@ -304,10 +304,10 @@ If \fIfunction\fR is a property the string has to be the name of the property. T .br activeX->dynamicCall( "Value", 5 ); .br - QString text = activeX->dynamicCall( "Text" ).toString(); + TQString text = activeX->dynamicCall( "Text" ).toString(); .br .fi -Note that it is faster to get and set properties using QObject::property() and QObject::setProperty(). +Note that it is faster to get and set properties using TQObject::property() and TQObject::setProperty(). .PP It is only possible to call functions through dynamicCall() that have parameters or return values of datatypes supported by QVariant. See the QAxBase class documentation for a list of supported and unsupported datatypes. If you want to call functions that have unsupported datatypes in the parameter list, use queryInterface() to retrieve the appropriate COM interface, and use the function directly. .PP @@ -336,9 +336,9 @@ This is an overloaded member function, provided for convenience. It behaves esse Calls the COM object's method \fIfunction\fR, passing the parameters in \fIvars\fR, and returns the value returned by the method. If the method does not return a value or when the function call failed this function returns an invalid QVariant object. .PP The QVariant objects in \fIvars\fR are updated when the method has out-parameters. -.SH "void QAxBase::exception ( int code, const QString & source, const QString & desc, const QString & help )\fC [signal]\fR" +.SH "void QAxBase::exception ( int code, const TQString & source, const TQString & desc, const TQString & help )\fC [signal]\fR" This signal is emitted when the COM object throws an exception while called using the OLE automation interface IDispatch. \fIcode\fR, \fIsource\fR, \fIdesc\fR and \fIhelp\fR provide information about the exception as provided by the COM server and can be used to provide useful feedback to the end user. \fIhelp\fR includes the help file, and the help context ID in brackets, e.g. "filename [id]". -.SH "QString QAxBase::generateDocumentation ()" +.SH "TQString QAxBase::generateDocumentation ()" Returns a rich text string with documentation for the wrapped COM object. Dump the string to an HTML-file, or use it in e.g. a QTextBrowser widget. .SH "bool QAxBase::initialize ( IUnknown ** ptr )\fC [virtual protected]\fR" This virtual function is called by setControl() and creates the requested COM object. \fIptr\fR is set to the object's IUnknown implementation. The function returns TRUE if the object initialization succeeded; otherwise the function returns FALSE. @@ -376,7 +376,7 @@ Returns a name:value map of all the properties exposed by the COM object. This is more efficient than getting multiple properties individually if the COM object supports property bags. .PP \fBWarning:\fR It is not guaranteed that the property bag implementation of the COM object returns all properties, or that the properties returned are the same as those available through the IDispatch interface. -.SH "void QAxBase::propertyChanged ( const QString & name )\fC [signal]\fR" +.SH "void QAxBase::propertyChanged ( const TQString & name )\fC [signal]\fR" If the COM object supports property notification, this signal gets emitted when the property called \fIname\fR is changed. .SH "bool QAxBase::propertyWritable ( const char * prop ) const\fC [virtual]\fR" Returns TRUE if the property \fIprop\fR is writable; otherwise returns FALSE. By default, all properties are writable. @@ -422,7 +422,7 @@ COM enabled applications usually have an object model publishing certain element .fi .PP Example: qutlook/centralwidget.cpp. -.SH "bool QAxBase::setControl ( const QString & )" +.SH "bool QAxBase::setControl ( const TQString & )" Sets the name of the COM object wrapped by this QAxBase object. See the "control" property for details. .SH "void QAxBase::setPropertyBag ( const PropertyBag & bag )" Sets the properties of the COM object to the corresponding values in \fIbag\fR. @@ -436,12 +436,12 @@ Sets the property \fIprop\fR to writable if \fIok\fR is TRUE, otherwise sets \fI \fBWarning:\fR Depending on the control implementation this setting might be ignored for some properties. .PP See also propertyWritable() and propertyChanged(). -.SH "void QAxBase::signal ( const QString & name, int argc, void * argv )\fC [signal]\fR" +.SH "void QAxBase::signal ( const TQString & name, int argc, void * argv )\fC [signal]\fR" This generic signal gets emitted when the COM object issues the event \fIname\fR. \fIargc\fR is the number of parameters provided by the event (DISPPARAMS.cArgs), and \fIargv\fR is the pointer to the parameter values (DISPPARAMS.rgvarg). Note that the order of parameter values is turned around, ie. the last element of the array is the first parameter in the function. .PP .nf .br - void Receiver::slot( const QString &name, int argc, void *argv ) + void Receiver::slot( const TQString &name, int argc, void *argv ) .br { .br @@ -471,7 +471,7 @@ This generic signal gets emitted when the COM object issues the event \fIname\fR .PP Use this signal if the event has parameters of unsupported data types. Otherwise, connect directly to the signal \fIname\fR. .SS "Property Documentation" -.SH "QString control" +.SH "TQString control" This property holds the name of the COM object wrapped by this QAxBase object. .PP Setting this property initilializes the COM object. Any COM object previously set is shut down. |