diff options
author | Michele Calgaro <michele.calgaro@yahoo.it> | 2024-06-13 11:12:50 +0900 |
---|---|---|
committer | Michele Calgaro <michele.calgaro@yahoo.it> | 2024-06-14 10:09:21 +0900 |
commit | 8a071b48ef8c8900163227ccc622833e26ba4064 (patch) | |
tree | d55e89acc80cb967dc1b3d32b94281941c6ae77f /doc/man | |
parent | 7bc57326e69b9c3f0eaeda63e4a49b67ba611426 (diff) | |
download | tqt3-8a071b48ef8c8900163227ccc622833e26ba4064.tar.gz tqt3-8a071b48ef8c8900163227ccc622833e26ba4064.zip |
Remove documentation about activeqt, because the latter is part of the commercial edition of Qt3
Signed-off-by: Michele Calgaro <michele.calgaro@yahoo.it>
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/man3/TQAxAggregated.3qt | 1 | ||||
-rw-r--r-- | doc/man/man3/TQAxBase.3qt | 1 | ||||
-rw-r--r-- | doc/man/man3/TQAxBindable.3qt | 1 | ||||
-rw-r--r-- | doc/man/man3/TQAxFactory.3qt | 1 | ||||
-rw-r--r-- | doc/man/man3/TQAxObject.3qt | 1 | ||||
-rw-r--r-- | doc/man/man3/TQAxScript.3qt | 1 | ||||
-rw-r--r-- | doc/man/man3/TQAxScriptEngine.3qt | 1 | ||||
-rw-r--r-- | doc/man/man3/TQAxScriptManager.3qt | 1 | ||||
-rw-r--r-- | doc/man/man3/TQAxWidget.3qt | 1 | ||||
-rw-r--r-- | doc/man/man3/tqaxaggregated.3qt | 143 | ||||
-rw-r--r-- | doc/man/man3/tqaxbase.3qt | 561 | ||||
-rw-r--r-- | doc/man/man3/tqaxbindable.3qt | 152 | ||||
-rw-r--r-- | doc/man/man3/tqaxfactory.3qt | 436 | ||||
-rw-r--r-- | doc/man/man3/tqaxobject.3qt | 183 | ||||
-rw-r--r-- | doc/man/man3/tqaxscript.3qt | 169 | ||||
-rw-r--r-- | doc/man/man3/tqaxscriptengine.3qt | 123 | ||||
-rw-r--r-- | doc/man/man3/tqaxscriptmanager.3qt | 197 | ||||
-rw-r--r-- | doc/man/man3/tqaxwidget.3qt | 215 | ||||
-rw-r--r-- | doc/man/man3/tqobject.3qt | 2 | ||||
-rw-r--r-- | doc/man/man3/tqwidget.3qt | 2 |
20 files changed, 2 insertions, 2190 deletions
diff --git a/doc/man/man3/TQAxAggregated.3qt b/doc/man/man3/TQAxAggregated.3qt deleted file mode 100644 index d05590c34..000000000 --- a/doc/man/man3/TQAxAggregated.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/tqaxaggregated.3qt diff --git a/doc/man/man3/TQAxBase.3qt b/doc/man/man3/TQAxBase.3qt deleted file mode 100644 index 84be97693..000000000 --- a/doc/man/man3/TQAxBase.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/tqaxbase.3qt diff --git a/doc/man/man3/TQAxBindable.3qt b/doc/man/man3/TQAxBindable.3qt deleted file mode 100644 index affde1f63..000000000 --- a/doc/man/man3/TQAxBindable.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/tqaxbindable.3qt diff --git a/doc/man/man3/TQAxFactory.3qt b/doc/man/man3/TQAxFactory.3qt deleted file mode 100644 index c1881659c..000000000 --- a/doc/man/man3/TQAxFactory.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/tqaxfactory.3qt diff --git a/doc/man/man3/TQAxObject.3qt b/doc/man/man3/TQAxObject.3qt deleted file mode 100644 index f99792754..000000000 --- a/doc/man/man3/TQAxObject.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/tqaxobject.3qt diff --git a/doc/man/man3/TQAxScript.3qt b/doc/man/man3/TQAxScript.3qt deleted file mode 100644 index 4e66e409f..000000000 --- a/doc/man/man3/TQAxScript.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/tqaxscript.3qt diff --git a/doc/man/man3/TQAxScriptEngine.3qt b/doc/man/man3/TQAxScriptEngine.3qt deleted file mode 100644 index 61f57d540..000000000 --- a/doc/man/man3/TQAxScriptEngine.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/tqaxscriptengine.3qt diff --git a/doc/man/man3/TQAxScriptManager.3qt b/doc/man/man3/TQAxScriptManager.3qt deleted file mode 100644 index fdc829434..000000000 --- a/doc/man/man3/TQAxScriptManager.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/tqaxscriptmanager.3qt diff --git a/doc/man/man3/TQAxWidget.3qt b/doc/man/man3/TQAxWidget.3qt deleted file mode 100644 index 5c02f767c..000000000 --- a/doc/man/man3/TQAxWidget.3qt +++ /dev/null @@ -1 +0,0 @@ -.so man3/tqaxwidget.3qt diff --git a/doc/man/man3/tqaxaggregated.3qt b/doc/man/man3/tqaxaggregated.3qt deleted file mode 100644 index e963957ca..000000000 --- a/doc/man/man3/tqaxaggregated.3qt +++ /dev/null @@ -1,143 +0,0 @@ -'\" t -.TH QAxAggregated 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- -.\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the -.\" license file included in the distribution for a complete license -.\" statement. -.\" -.ad l -.nh -.SH NAME -QAxAggregated \- Abstract base class for implementations of additional COM interfaces -.SH SYNOPSIS -This class is part of the \fBQt ActiveQt Extension\fR. -.PP -\fC#include <qaxbindable.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "virtual long \fBqueryInterface\fR ( const QUuid & iid, void ** iface ) = 0" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "IUnknown * \fBcontrollingUnknown\fR () const" -.br -.ti -1c -.BI "TQWidget * \fBwidget\fR () const" -.br -.ti -1c -.BI "TQObject * \fBobject\fR () const" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main TQt API. -.PP -The QAxAggregated class is an abstract base class for implementations of additional COM interfaces. -.PP -Create a subclass of QAxAggregated and reimplement queryInterface() to support additional COM interfaces. Use multiple inheritance from those COM interfaces. Implement the IUnknown interface of those COM interfaces by delegating the calls to QueryInterface(), AddRef() and Release() to the interface provided by controllingUnknown(). -.PP -Use the widget() method if you need to make calls to the TQWidget implementing the ActiveX control. You must not store that pointer in your subclass (unless you use QGuardedPtr), as the TQWidget can be destroyed by the ActiveQt framework at any time. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "IUnknown * QAxAggregated::controllingUnknown () const\fC [protected]\fR" -Returns the IUnknown interface of the ActiveX control. Implement the IUnknown interface in your QAxAggregated subclass to delegate calls to QueryInterface(), AddRef() and Release() to the interface provided by this function. -.PP -.nf -.br - HRESULT AxImpl::QueryInterface( REFIID iid, void **iface ) -.br - { -.br - return controllingUnknown()->QueryInterface( iid, iface ); -.br - } -.br -.br - unsigned long AxImpl::AddRef() -.br - { -.br - return controllingUnknown()->AddRef(); -.br - } -.br -.br - unsigned long AxImpl::Release() -.br - { -.br - return controllingUnknown()->Release(); -.br - } -.br -.fi -.PP -The QAXAGG_IUNKNOWN macro expands to the code above, and you can use it in the class declaration of your subclass. -.SH "TQObject * QAxAggregated::object () const\fC [protected]\fR" -Returns a pointer to the TQObject subclass implementing the COM object. This function might return 0. -.PP -\fBWarning:\fR You must not store the returned pointer, unless you use a QGuardedPtr, since the TQObject can be destroyed by ActiveQt at any time. -.SH "long QAxAggregated::queryInterface ( const QUuid & iid, void ** iface )\fC [pure virtual]\fR" -Reimplement this pure virtual function to support additional COM interfaces. Set the value of \fIiface\fR to point to this object to support the interface \fIiid\fR. Note that you must cast the \fCthis\fR pointer to the appropriate superclass. -.PP -.nf -.br - long AxImpl::queryInterface( const QUuid &iid, void **iface ) -.br - { -.br - *iface = 0; -.br - if ( iid == IID_ISomeCOMInterface ) -.br - *iface = (ISomeCOMInterface*)this; -.br - else -.br - return E_NOINTERFACE; -.br -.br - AddRef(); -.br - return S_OK; -.br - } -.br -.fi -.PP -Return the standard COM results S_OK (interface is supported) or E_NOINTERFACE (requested interface is not supported). -.PP -\fBWarning:\fR Even though you must implement the IUnknown interface if you implement any COM interface you must not support the IUnknown interface in your queryInterface() implementation. -.SH "TQWidget * QAxAggregated::widget () const\fC [protected]\fR" -Returns a pointer to the TQWidget subclass implementing the ActiveX control. This function might return 0. -.PP -\fBWarning:\fR -You must not store the returned pointer, unless you use a -QGuardedPtr, since the TQWidget can be destroyed by ActiveQt at any -time. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaxaggregated.html -.BR http://www.trolltech.com/faq/tech.html -.SH COPYRIGHT -Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the -license file included in the distribution for a complete license -statement. -.SH AUTHOR -Generated automatically from the source code. -.SH BUGS -If you find a bug in Qt, please report it as described in -.BR http://doc.trolltech.com/bughowto.html . -Good bug reports help us to help you. Thank you. -.P -The definitive TQt documentation is provided in HTML format; it is -located at $TQTDIR/doc/html and can be read using TQt Assistant or with -a web browser. This man page is provided as a convenience for those -users who prefer man pages, although this format is not officially -supported by Trolltech. -.P -If you find errors in this manual page, please report them to -.BR qt-bugs@trolltech.com . -Please include the name of the manual page (tqaxaggregated.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/tqaxbase.3qt b/doc/man/man3/tqaxbase.3qt deleted file mode 100644 index 51d6f4d8d..000000000 --- a/doc/man/man3/tqaxbase.3qt +++ /dev/null @@ -1,561 +0,0 @@ -'\" t -.TH QAxBase 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- -.\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the -.\" license file included in the distribution for a complete license -.\" statement. -.\" -.ad l -.nh -.SH NAME -QAxBase \- Abstract class that provides an API to initalize and access a COM object -.SH SYNOPSIS -This class is part of the \fBQt ActiveQt Extension\fR. -.PP -\fC#include <qaxbase.h>\fR -.PP -Inherited by QAxObject and QAxWidget. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAxBase\fR ( IUnknown * iface = 0 )" -.br -.ti -1c -.BI "virtual \fB~QAxBase\fR ()" -.br -.ti -1c -.BI "TQString \fBcontrol\fR () const" -.br -.ti -1c -.BI "long \fBqueryInterface\fR ( const QUuid & uuid, void ** iface ) const" -.br -.ti -1c -.BI "QVariant \fBdynamicCall\fR ( 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 ( ) )" -.br -.ti -1c -.BI "QVariant \fBdynamicCall\fR ( const QCString & function, TQValueList<QVariant> & vars )" -.br -.ti -1c -.BI "QAxObject * \fBquerySubObject\fR ( const QCString & name, 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 ( ) )" -.br -.ti -1c -.BI "PropertyBag \fBpropertyBag\fR () const" -.br -.ti -1c -.BI "void \fBsetPropertyBag\fR ( const PropertyBag & bag )" -.br -.ti -1c -.BI "TQString \fBgenerateDocumentation\fR ()" -.br -.ti -1c -.BI "virtual bool \fBpropertyWritable\fR ( const char * prop ) const" -.br -.ti -1c -.BI "virtual void \fBsetPropertyWritable\fR ( const char * prop, bool ok )" -.br -.ti -1c -.BI "bool \fBisNull\fR () const" -.br -.ti -1c -.BI "QVariant \fBasVariant\fR () const" -.br -.ti -1c -.BI "enum \fBPropertyBag\fR { }" -.br -.ti -1c -.BI "virtual void \fBclear\fR ()" -.br -.ti -1c -.BI "bool \fBsetControl\fR ( const TQString & )" -.br -.ti -1c -.BI "void \fBdisableMetaObject\fR ()" -.br -.ti -1c -.BI "void \fBdisableClassInfo\fR ()" -.br -.ti -1c -.BI "void \fBdisableEventSink\fR ()" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBsignal\fR ( const TQString & name, int argc, void * argv )" -.br -.ti -1c -.BI "void \fBpropertyChanged\fR ( const TQString & name )" -.br -.ti -1c -.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 "TQString \fBcontrol\fR - the name of the COM object wrapped by this QAxBase object" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual bool \fBinitialize\fR ( IUnknown ** ptr )" -.br -.ti -1c -.BI "bool \fBinitializeRemote\fR ( IUnknown ** ptr )" -.br -.ti -1c -.BI "bool \fBinitializeLicensed\fR ( IUnknown ** ptr )" -.br -.ti -1c -.BI "bool \fBinitializeActive\fR ( IUnknown ** ptr )" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main TQt API. -.PP -The QAxBase class is an abstract class that provides an API to initalize and access a COM object. -.PP -QAxBase is an abstract class that cannot be used directly, and is instantiated through the subclasses QAxObject and QAxWidget. This class provides the API to access the COM object directly through its IUnknown implementation. If the COM object implements the IDispatch interface, the properties and methods of that object become available as TQt properties and slots. -.PP -.nf -.br - connect( buttonBack, TQ_SIGNAL(clicked()), webBrowser, TQ_SLOT(GoBack()) ); -.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 TQObjects, so you can use setProperty() and property() as with TQObject). Properties with multiple parameters are not supported. -.PP -.nf -.br - activeX->setProperty( "text", "some text" ); -.br - int value = activeX->property( "value" ); -.br -.fi -.PP -Write-functions for properties and other methods exposed by the object's IDispatch implementation can be called directly using dynamicCall(), or indirectly as slots connected to a signal. -.PP -.nf -.br - webBrowser->dynamicCall( "GoHome()" ); -.br -.fi -.PP -Outgoing events supported by the COM object are emitted as standard TQt signals. -.PP -.nf -.br - connect( webBrowser, TQ_SIGNAL(TitleChanged(const TQString&)), -.br - this, TQ_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 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 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) TQValueList<QVariant> const TQValueList<QVariant>& TQValueList<QVariant>& SAFEARRAY(BYTE) QByteArray const QByteArray& QByteArray& SAFEARRAY(BSTR) TQStringList const TQStringList& TQStringList& 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> -.PP -Supported are also enumerations, and typedefs to supported types. -.PP -To call the methods of a COM interface described by the following IDL -.PP -.nf -.br - dispinterface IControl -.br - { -.br - properties: -.br - [id(1)] BSTR text; -.br - [id(2)] IFontDisp *font; -.br -.br - methods: -.br - [id(6)] void showColumn( [in] int i ); -.br - [id(3)] bool addColumn( [in] BSTR t ); -.br - [id(4)] int fillList( [in, out] SAFEARRAY(VARIANT) *list ); -.br - [id(5)] IDispatch *item( [in] int i ); -.br - }; -.br -.fi -use the QAxBase API like this: -.PP -.nf -.br - QAxObject object( "<CLSID>" ); -.br -.br - TQString text = object.property( "text" ).toString(); -.br - object.setProperty( "font", QFont( "Times New Roman", 12 ) ); -.br -.br - connect( this, TQ_SIGNAL(clicked(int)), &object, TQ_SLOT(showColumn(int)) ); -.br - bool ok = object.dynamicCall( "addColumn(const TQString&)", "Column 1" ).toBool(); -.br -.br - TQValueList<QVariant> varlist; -.br - TQValueList<QVariant> parameters; -.br - parameters << QVariant( varlist ); -.br - int n = object.dynamicCall( "fillList(TQValueList<QVariant>&)", parameters ).toInt(); -.br -.br - QAxObject *item = object.querySubItem( "item(int)", 5 ); -.br -.fi -.PP -Note that the TQValueList the object should fill has to be provided as an element in the parameter list of QVariants. -.PP -If you need to access properties or pass parameters of unsupported datatypes you must access the COM object directly through its IDispatch implementation or other interfaces. Those interfaces can be retrieved through queryInterface(). -.PP -.nf -.br - IUnknown *iface = 0; -.br - activeX->queryInterface( IID_IUnknown, (void**)&iface ); -.br - if ( iface ) { -.br - // use the interface -.br - iface->Release(); -.br - } -.br -.fi -.PP -To get the definition of the COM interfaces you will have to use the header files provided with the component you want to use. Some compilers can also import type libraries using the #import compiler directive. See the component documentation to find out which type libraries you have to import, and how to use them. -.PP -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 TQMap<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. -.SH "QAxBase::~QAxBase ()\fC [virtual]\fR" -Shuts down the COM object and destroys the QAxBase object. -.PP -See also clear(). -.SH "QVariant QAxBase::asVariant () const" -Returns a QVariant that wraps the COM object. The variant can then be used as a parameter in e.g. dynamicCall(). -.SH "void QAxBase::clear ()\fC [virtual]\fR" -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 "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. -.PP -Note that this function must be called immediately after construction of the object (without passing an object identifier), and before calling QAxWidget->setControl(). -.SH "void QAxBase::disableEventSink ()" -Disables the event sink implementation for this ActiveX container. If you don't intend to listen to the ActiveX control's events use this function to speed up the meta object generation. -.PP -Some ActiveX controls might be unstable when connected to an event sink. To get OLE events you must use standard COM methods to register your own event sink. Use queryInterface() to get access to the raw COM object. -.PP -Note that this function should be called immediately after construction of the object (without passing an object identifier), and before calling QAxWidget->setControl(). -.SH "void QAxBase::disableMetaObject ()" -Disables the meta object generation for this ActiveX container. This also disables the event sink and class info generation. If you don't intend to use the TQt meta object implementation call this function to speed up the meta object generation. -.PP -Some ActiveX controls might be unstable when used with OLE automation. Use standard COM methods to use those controls through the COM interfaces provided by queryInterface(). -.PP -Note that this function must be called immediately after construction of the object (without passing an object identifier), and before calling QAxWidget->setControl(). -.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 TQObject::connect() call. -.PP -.nf -.br - activeX->dynamicCall( "Navigate(const TQString&)", "www.trolltech.com" ); -.br -.fi -.PP -Alternatively a function can be called passing the parameters embedded in the string, e.g. above function can also be invoked using -.PP -.nf -.br - activeX->dynamicCall("Navigate(\\"www.trolltech.com\\"); -.br -.fi -All parameters are passed as strings; it depends on the control whether they are interpreted correctly, and is slower than using the prototype with correctly typed parameters. -.PP -If \fIfunction\fR is a property the string has to be the name of the property. The property setter is called when \fIvar1\fR is a valid QVariant, otherwise the getter is called. -.PP -.nf -.br - activeX->dynamicCall( "Value", 5 ); -.br - TQString text = activeX->dynamicCall( "Text" ).toString(); -.br -.fi -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 -.nf -.br - IWebBrowser2 *webBrowser = 0; -.br - activeX->queryInterface( IID_IWebBrowser2, (void**)&webBrowser ); -.br - if ( webBrowser ) { -.br - webBrowser->Navigate2( pvarURL ); -.br - webBrowser->Release(); -.br - } -.br -.fi -.PP -This is also more efficient. -.PP -Example: qutlook/centralwidget.cpp. -.SH "QVariant QAxBase::dynamicCall ( const QCString & function, TQValueList<QVariant> & vars )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -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 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 "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 TQTextBrowser 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. -.PP -The default implementation interprets the string returned by control(), and calls initializeRemote(), initializeLicensed() or initializeActive() if the string matches the respective patterns. If no pattern is matched, or if remote or licensed initialization fails, CoCreateInstance is used directly to create the object. -.PP -See the control property documentation for details about supported patterns. -.PP -The interface returned in \fIptr\fR must be referenced exactly once when this function returns. The interface provided by e.g. CoCreateInstance is already referenced, and there is no need to reference it again. -.SH "bool QAxBase::initializeActive ( IUnknown ** ptr )\fC [protected]\fR" -Returns an active instance running on the current machine, and returns the IUnknown interface to the running object in \fIptr\fR. This function returns TRUE if successful, otherwise returns FALSE. -.PP -This function is called by initialize() if the control string contains the substring "}&". -.PP -See also initialize(). -.SH "bool QAxBase::initializeLicensed ( IUnknown ** ptr )\fC [protected]\fR" -Creates an instance of a licensed control, and returns the IUnknown interface to the object in \fIptr\fR. This functions returns TRUE if successful, otherwise returns FALSE. -.PP -This function is called by initialize() if the control string contains the substring "}:". The license key needs to follow this substring. -.PP -See also initialize(). -.SH "bool QAxBase::initializeRemote ( IUnknown ** ptr )\fC [protected]\fR" -Creates the instance on a remote server, and returns the IUnknown interface to the object in \fIptr\fR. This function returns TRUE if successful, otherwise returns FALSE. -.PP -This function is called by initialize() if the control string contains the substring "/{". The information about the remote machine needs to be provided in front of the substring. -.PP -See also initialize(). -.SH "bool QAxBase::isNull () const" -Returns TRUE if there is no COM object loaded by this wrapper; otherwise return FALSE. -.PP -See also control. -.SH "PropertyBag QAxBase::propertyBag () const" -Returns a name:value map of all the properties exposed by the COM object. -.PP -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 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. -.PP -\fBWarning:\fR Depending on the control implementation this setting might be ignored for some properties. -.PP -See also setPropertyWritable() and propertyChanged(). -.SH "long QAxBase::queryInterface ( const QUuid & uuid, void ** iface ) const" -Requests the interface \fIuuid\fR from the COM object and sets the value of \fIiface\fR to the provided interface, or to 0 if the requested interface could not be provided. -.PP -Returns the result of the QueryInterface implementation of the COM object. -.PP -See also control. -.SH "QAxObject * QAxBase::querySubObject ( const QCString & name, 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 ( ) )" -Returns a pointer to a QAxObject wrapping the COM object provided by the method or property \fIname\fR, passing passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR. -.PP -If \fIname\fR is provided by a method the string must include the full function prototype. -.PP -If \fIname\fR is a property the string must be the name of the property, and \fIvar1\fR, ... \fIvar8\fR are ignored. -.PP -The returned QAxObject is a child of this object (which is either of type QAxObject or QAxWidget), and is deleted when this object is deleted. It is however safe to delete the returned object yourself, and you should do so when you iterate over lists of subobjects. -.PP -COM enabled applications usually have an object model publishing certain elements of the application as dispatch interfaces. Use this method to navigate the hierarchy of the object model, e.g. -.PP -.nf -.br - QAxWidget outlook( "Outlook.Application" ); -.br - QAxObject *session = outlook.querySubObject( "Session" ); -.br - if ( session ) { -.br - QAxObject *defFolder = session->querySubObject( -.br - "GetDefaultFolder(OlDefaultFolders)", -.br - "olFolderContacts" ); -.br - //... -.br - } -.br -.fi -.PP -Example: qutlook/centralwidget.cpp. -.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. -.PP -\fBWarning:\fR You should only set property bags that have been returned by the propertyBag function, as it cannot be guaranteed that the property bag implementation of the COM object supports the same properties that are available through the IDispatch interface. -.PP -See also propertyBag(). -.SH "void QAxBase::setPropertyWritable ( const char * prop, bool ok )\fC [virtual]\fR" -Sets the property \fIprop\fR to writable if \fIok\fR is TRUE, otherwise sets \fIprop\fR to be read-only. By default, all properties are writable. -.PP -\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 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 TQString &name, int argc, void *argv ) -.br - { -.br - VARIANTARG *params = (VARIANTARG*)argv; -.br - if ( name.startsWith( "BeforeNavigate2(" ) ) { -.br - IDispatch *pDisp = params[argc-1].pdispVal; -.br - VARIANTARG URL = *params[argc-2].pvarVal; -.br - VARIANTARG Flags = *params[argc-3].pvarVal; -.br - VARIANTARG TargetFrameName = *params[argc-4].pvarVal; -.br - VARIANTARG PostData = *params[argc-5].pvarVal; -.br - VARIANTARG Headers = *params[argc-6].pvarVal; -.br - bool *Cancel = params[argc-7].pboolVal; -.br - } -.br - } -.br -.fi -.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 "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. -.PP -The most efficient way to set this property is by using the registered component's UUID, e.g. -.PP -.nf -.br - ctrl->setControl( "{8E27C92B-1264-101C-8A2F-040224009C02}" ); -.br -.fi -The second fastest way is to use the registered control's class name (with or without version number), e.g. -.PP -.nf -.br - ctrl->setControl( "MSCal.Calendar" ); -.br -.fi -The slowest, but easiest way to use is to use the control's full name, e.g. -.PP -.nf -.br - ctrl->setControl( "Calendar Control 9.0" ); -.br -.fi -.PP -If the component's UUID is used the following patterns can be used to initialize the control on a remote machine, to initialize a licensed control or to connect to a running object: -.TP -To initialize the control on a different machine use the following pattern: -.IP -.nf -.br - <domain/username>:<password>@server/{8E27C92B-1264-101C-8A2F-040224009C02} -.br -.fi -.TP -To initialize a licensed control use the following pattern: -.IP -.nf -.br - {8E27C92B-1264-101C-8A2F-040224009C02}:<LicenseKey> -.br -.fi -.TP -To connect to an already running object use the following pattern: -.IP -.nf -.br - {8E27C92B-1264-101C-8A2F-040224009C02}& -.br -.fi -The first two patterns can be combined, e.g. to initialize a licensed control on a remote machine: -.PP -.nf -.br - ctrl->setControl("DOMAIN/user:password@server/{8E27C92B-1264-101C-8A2F-040224009C02}:LicenseKey"); -.br -.fi -.PP -The control's read function always returns the control's UUID, if provided including the license key, and the name of the server, but not including the username, the domain or the password. -.PP -Set this property's value with setControl() and get this property's value with control(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaxbase.html -.BR http://www.trolltech.com/faq/tech.html -.SH COPYRIGHT -Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the -license file included in the distribution for a complete license -statement. -.SH AUTHOR -Generated automatically from the source code. -.SH BUGS -If you find a bug in Qt, please report it as described in -.BR http://doc.trolltech.com/bughowto.html . -Good bug reports help us to help you. Thank you. -.P -The definitive TQt documentation is provided in HTML format; it is -located at $TQTDIR/doc/html and can be read using TQt Assistant or with -a web browser. This man page is provided as a convenience for those -users who prefer man pages, although this format is not officially -supported by Trolltech. -.P -If you find errors in this manual page, please report them to -.BR qt-bugs@trolltech.com . -Please include the name of the manual page (tqaxbase.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/tqaxbindable.3qt b/doc/man/man3/tqaxbindable.3qt deleted file mode 100644 index 9627667a5..000000000 --- a/doc/man/man3/tqaxbindable.3qt +++ /dev/null @@ -1,152 +0,0 @@ -'\" t -.TH QAxBindable 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- -.\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the -.\" license file included in the distribution for a complete license -.\" statement. -.\" -.ad l -.nh -.SH NAME -QAxBindable \- Interface between a TQWidget and an ActiveX client -.SH SYNOPSIS -This class is part of the \fBQt ActiveQt Extension\fR. -.PP -\fC#include <qaxbindable.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAxBindable\fR ()" -.br -.ti -1c -.BI "virtual \fB~QAxBindable\fR ()" -.br -.ti -1c -.BI "virtual QAxAggregated * \fBcreateAggregate\fR ()" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "void \fBreportError\fR ( int code, const TQString & src, const TQString & desc, const TQString & context = TQString::null )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "bool \fBrequestPropertyChange\fR ( const char * property )" -.br -.ti -1c -.BI "void \fBpropertyChanged\fR ( const char * property )" -.br -.ti -1c -.BI "IUnknown * \fBclientSite\fR () const" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main TQt API. -.PP -The QAxBindable class provides an interface between a TQWidget and an ActiveX client. -.PP -The functions provided by this class allow an ActiveX control to communicate property changes to a client application. Inherit your control class from both TQWidget (directly or indirectly) and this class to get access to this class's functions. The meta object compiler requires you to inherit from TQWidget \fIfirst\fR. -.PP -.nf -.br - class MyActiveX : public TQWidget, public QAxBindable -.br - { -.br - TQ_OBJECT -.br - TQ_PROPERTY( int value READ value WRITE setValue ) -.br - public: -.br - MyActiveX( TQWidget *parent = 0, const char *name = 0 ); -.br - ... -.br -.br - int value() const; -.br - void setValue( int ); -.br - }; -.br -.fi -.PP -When implementing the property write function, use requestPropertyChange() to get permission from the ActiveX client application to change this property. When the property changes, call propertyChanged() to notify the ActiveX client application about the change. If a fatal error occurs in the control, use the static reportError() function to notify the client. -.PP -Use the interface returned by clientSite() to call the ActiveX client. To implement additional COM interfaces in your ActiveX control, reimplement createAggregate() to return a new object of a QAxAggregated subclass. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAxBindable::QAxBindable ()" -Constructs an empty QAxBindable object. -.SH "QAxBindable::~QAxBindable ()\fC [virtual]\fR" -Destroys the QAxBindable object. -.SH "IUnknown * QAxBindable::clientSite () const\fC [protected]\fR" -Returns a pointer to the client site interface for this ActiveX object, or null if no client site has been set. -.PP -Call QueryInterface() on the returned interface to get the interface you want to call. -.SH "QAxAggregated * QAxBindable::createAggregate ()\fC [virtual]\fR" -Reimplement this function when you want to implement additional COM interfaces in the ActiveX control, or when you want to provide alternative implementations of COM interfaces. Return a new object of a QAxAggregated subclass. -.PP -The default implementation returns the null pointer. -.SH "void QAxBindable::propertyChanged ( const char * property )\fC [protected]\fR" -Call this function to notify the client that is hosting this ActiveX control that the property \fIproperty\fR has been changed. -.PP -This function is usually called at the end of the property's write function. -.PP -See also requestPropertyChange(). -.SH "void QAxBindable::reportError ( int code, const TQString & src, const TQString & desc, const TQString & context = TQString::null )\fC [static]\fR" -Reports an error to the client application. \fIcode\fR is a control-defined error code. \fIdesc\fR is a human-readable description of the error intended for the application user. \fIsrc\fR is the name of the source for the error, typically the ActiveX server name. \fIcontext\fR can be the location of a help file with more information about the error. If \fIcontext\fR ends with a number in brackets, e.g. [12], this number will be interpreted as the context ID in the help file. -.SH "bool QAxBindable::requestPropertyChange ( const char * property )\fC [protected]\fR" -Call this function to request permission to change the property \fIproperty\fR from the client that is hosting this ActiveX control. Returns TRUE if the client allows the change; otherwise returns FALSE. -.PP -This function is usually called first in the write function for \fIproperty\fR, and writing is abandoned if the function returns FALSE. -.PP -.nf -.br - void MyActiveQt::setText( const TQString &text ) -.br - { -.br - if ( !requestPropertyChange( "text" ) ) -.br - return; -.br -.br - // update property -.br -.br - propertyChanged( "text" ); -.br - } -.br -.fi -.PP -See also propertyChanged(). - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaxbindable.html -.BR http://www.trolltech.com/faq/tech.html -.SH COPYRIGHT -Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the -license file included in the distribution for a complete license -statement. -.SH AUTHOR -Generated automatically from the source code. -.SH BUGS -If you find a bug in Qt, please report it as described in -.BR http://doc.trolltech.com/bughowto.html . -Good bug reports help us to help you. Thank you. -.P -The definitive TQt documentation is provided in HTML format; it is -located at $TQTDIR/doc/html and can be read using TQt Assistant or with -a web browser. This man page is provided as a convenience for those -users who prefer man pages, although this format is not officially -supported by Trolltech. -.P -If you find errors in this manual page, please report them to -.BR qt-bugs@trolltech.com . -Please include the name of the manual page (tqaxbindable.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/tqaxfactory.3qt b/doc/man/man3/tqaxfactory.3qt deleted file mode 100644 index 4ce81b59a..000000000 --- a/doc/man/man3/tqaxfactory.3qt +++ /dev/null @@ -1,436 +0,0 @@ -'\" t -.TH QAxFactory 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- -.\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the -.\" license file included in the distribution for a complete license -.\" statement. -.\" -.ad l -.nh -.SH NAME -QAxFactory \- Defines a factory for the creation of COM components -.SH SYNOPSIS -This class is part of the \fBQt ActiveQt Extension\fR. -.PP -\fC#include <qaxfactory.h>\fR -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAxFactory\fR ( const QUuid & libid, const QUuid & appid )" -.br -.ti -1c -.BI "virtual \fB~QAxFactory\fR ()" -.br -.ti -1c -.BI "virtual TQStringList \fBfeatureList\fR () const = 0" -.br -.ti -1c -.BI "virtual TQWidget * \fBcreate\fR ( const TQString & key, TQWidget * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "virtual TQObject * \fBcreateObject\fR ( const TQString & key, TQObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "virtual QMetaObject * \fBmetaObject\fR ( const TQString & key ) const" -.br -.ti -1c -.BI "virtual bool \fBcreateObjectWrapper\fR ( TQObject * object, IDispatch ** wrapper )" -.br -.ti -1c -.BI "virtual QUuid \fBclassID\fR ( const TQString & key ) const" -.br -.ti -1c -.BI "virtual QUuid \fBinterfaceID\fR ( const TQString & key ) const" -.br -.ti -1c -.BI "virtual QUuid \fBeventsID\fR ( const TQString & key ) const" -.br -.ti -1c -.BI "virtual QUuid \fBtypeLibID\fR () const" -.br -.ti -1c -.BI "virtual QUuid \fBappID\fR () const" -.br -.ti -1c -.BI "virtual void \fBregisterClass\fR ( const TQString & key, QSettings * settings ) const" -.br -.ti -1c -.BI "virtual void \fBunregisterClass\fR ( const TQString & key, QSettings * settings ) const" -.br -.ti -1c -.BI "virtual bool \fBvalidateLicenseKey\fR ( const TQString & key, const TQString & licenseKey ) const" -.br -.ti -1c -.BI "virtual TQString \fBexposeToSuperClass\fR ( const TQString & key ) const" -.br -.ti -1c -.BI "virtual bool \fBstayTopLevel\fR ( const TQString & key ) const" -.br -.ti -1c -.BI "virtual bool \fBhasStockEvents\fR ( const TQString & key ) const" -.br -.ti -1c -.BI "virtual bool \fBisService\fR () const" -.br -.ti -1c -.BI "enum \fBServerType\fR { SingleInstance, MultipleInstances }" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "bool \fBisServer\fR ()" -.br -.ti -1c -.BI "TQString \fBserverDirPath\fR ()" -.br -.ti -1c -.BI "TQString \fBserverFilePath\fR ()" -.br -.ti -1c -.BI "bool \fBstartServer\fR ( ServerType type = MultipleInstances )" -.br -.ti -1c -.BI "bool \fBstopServer\fR ()" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main TQt API. -.PP -The QAxFactory class defines a factory for the creation of COM components. -.PP - -.PP -Implement this factory once in your ActiveX server to provide information about the components the server can create. If your server supports just a single ActiveX control, you can use the default factory implementation instead of implementing the factory yourself. Use the QAXFACTORY_DEFAULT macro in any implementation file (e.g. main.cpp) to instantiate and export the default factory: -.PP -.nf -.br - #include <ntqapplication.h> -.br - #include <qaxfactory.h> -.br -.br - #include "theactivex.h" -.br -.br - QAXFACTORY_DEFAULT( -.br - TheActiveX, // widget class -.br - "{01234567-89AB-CDEF-0123-456789ABCDEF}", // class ID -.br - "{01234567-89AB-CDEF-0123-456789ABCDEF}", // interface ID -.br - "{01234567-89AB-CDEF-0123-456789ABCDEF}", // event interface ID -.br - "{01234567-89AB-CDEF-0123-456789ABCDEF}", // type library ID -.br - "{01234567-89AB-CDEF-0123-456789ABCDEF}" // application ID -.br - ) -.br -.fi -.PP -If you implement your own factory reimplement the pure virtual functions, provide the unique identifiers for the ActiveX controls, and use the QAXFACTORY_EXPORT macro to instantiate and export it: -.PP -.nf -.br - TQStringList ActiveQtFactory::featureList() const -.br - { -.br - TQStringList list; -.br - list << "ActiveX1"; -.br - list << "ActiveX2"; -.br - ... -.br - return list; -.br - } -.br -.br - TQWidget *ActiveQtFactory::create( const TQString &key, TQWidget *parent, const char *name ) -.br - { -.br - if ( key == "ActiveX1" ) -.br - return new ActiveX1( parent, name ); -.br - if ( key == "ActiveX2" ) -.br - return new ActiveX2( parent, name ); -.br - ... -.br - return 0; -.br - } -.br -.br - QUuid ActiveQtFactory::classID( const TQString &key ) const -.br - { -.br - if ( key == "ActiveX1" ) -.br - return "{01234567-89AB-CDEF-0123-456789ABCDEF}"; -.br - ... -.br - return QUuid(); -.br - } -.br -.br - QUuid ActiveQtFactory::interfaceID( const TQString &key ) const -.br - { -.br - if ( key == "ActiveX1" ) -.br - return "{01234567-89AB-CDEF-0123-456789ABCDEF}"; -.br - ... -.br - return QUuid(); -.br - } -.br -.br - QUuid ActiveQtFactory::eventsID( const TQString &key ) const -.br - { -.br - if ( key == "ActiveX1" ) -.br - return "{01234567-89AB-CDEF-0123-456789ABCDEF}"; -.br - ... -.br - return QUuid(); -.br - } -.br -.br - QAXFACTORY_EXPORT( -.br - MyFactory, // factory class -.br - "{01234567-89AB-CDEF-0123-456789ABCDEF}", // type library ID -.br - "{01234567-89AB-CDEF-0123-456789ABCDEF}" // application ID -.br - ) -.br -.fi -.PP -If you use the \fCTQ_CLASSINFO\fR macro to provide the unique identifiers or other attributes for your class you can use the QAXFACTORY_BEGIN, QAXCLASS and QAXFACTORY_END macros to expose one or more classes as COM objects. -.PP -.nf -.br - QAXFACTORY_BEGIN( -.br - "{01234567-89AB-CDEF-0123-456789ABCDEF}", // type library ID -.br - "{01234567-89AB-CDEF-0123-456789ABCDEF}" // application ID -.br - ) -.br - QAXCLASS(Class1) -.br - QAXCLASS(Class2) -.br - QAXFACTORY_END() -.br -.fi -.PP -Only one QAxFactory implementation may be instantiated and exported by an ActiveX server application. This instance is accessible through the global qAxFactory() function. -.PP -A factory can also reimplement the registerClass() and unregisterClass() functions to set additional flags for an ActiveX control in the registry. To limit the number of methods or properties a widget class exposes from its parent classes reimplement exposeToSuperClass(). -.SS "Member Type Documentation" -.SH "QAxFactory::ServerType" -This enum specifies the different types of servers that can be started with startServer. -.TP -\fCQAxFactory::SingleInstance\fR - The server can create only one instance of each supplied class. -.TP -\fCQAxFactory::MultipleInstances\fR - The server can create multiple instances of each supplied class. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAxFactory::QAxFactory ( const QUuid & libid, const QUuid & appid )" -Constructs a QAxFactory object that returns \fIlibid\fR and \fIappid\fR in the implementation of the respective interface functions. -.SH "QAxFactory::~QAxFactory ()\fC [virtual]\fR" -Destroys the QAxFactory object. -.SH "QUuid QAxFactory::appID () const\fC [virtual]\fR" -Reimplement this function to return the ActiveX server's application identifier. -.SH "QUuid QAxFactory::classID ( const TQString & key ) const\fC [virtual]\fR" -Reimplement this function to return the class identifier for each \fIkey\fR returned by the featureList() implementation, or an empty QUuid if this factory doesn't support the value of \fIkey\fR. -.PP -The default implementation interprets \fIkey\fR as the class name, and returns the value of the TQ_CLASSINFO entry "ClassID". -.SH "TQWidget * QAxFactory::create ( const TQString & key, TQWidget * parent = 0, const char * name = 0 )\fC [virtual]\fR" -Reimplement this function to return a new widget for \fIkey\fR. Propagate \fIparent\fR and \fIname\fR to the TQWidget constructor. Return 0 if this factory doesn't support the value of \fIkey\fR. -.PP -The returned widget will be exposed as an ActiveX control, e.g. a COM object that can be embedded as a control into applications. -.PP -The default implementation returns 0. -.SH "TQObject * QAxFactory::createObject ( const TQString & key, TQObject * parent = 0, const char * name = 0 )\fC [virtual]\fR" -Reimplement this function to return a new object for \fIkey\fR. Propagate \fIparent\fR and \fIname\fR to the TQWidget constructor. Return 0 if this factory doesn't support the value of \fIkey\fR. -.PP -If the object returned is a TQWidget it will be exposed as an ActiveX control, otherwise the returned object will be exposed as a COM object. -.PP -The default implementation returns the result QAxFactory::create() if \fIparent\fR is 0 or a widget, otherwise returns 0. -.SH "bool QAxFactory::createObjectWrapper ( TQObject * object, IDispatch ** wrapper )\fC [virtual]\fR" -Reimplement this function to provide the COM object for \fIobject\fR in \fIwrapper\fR. Return TRUE if the function was successfull, otherwise return FALSE. -.PP -The default implementation creates a generic automation wrapper based on the meta object information of \fIobject\fR. -.SH "QUuid QAxFactory::eventsID ( const TQString & key ) const\fC [virtual]\fR" -Reimplement this function to return the identifier of the event interface for each \fIkey\fR returned by the featureList() implementation, or an empty QUuid if this factory doesn't support the value of \fIkey\fR. -.PP -The default implementation interprets \fIkey\fR as the class name, and returns the value of the TQ_CLASSINFO entry "EventsID". -.SH "TQString QAxFactory::exposeToSuperClass ( const TQString & key ) const\fC [virtual]\fR" -Reimplement this function to return the name of the super class of \fIkey\fR up to which methods and properties should be exposed by the ActiveX control. -.PP -The default implementation interprets \fIkey\fR as the class name, and returns the value of the TQ_CLASSINFO entry "ToSuperClass". If no such value is set the null-string is returned, and the functions and properties of all the super classes including TQWidget will be exposed. -.PP -To only expose the functions and properties of the class itself, reimplement this function to return \fIkey\fR. -.SH "TQStringList QAxFactory::featureList () const\fC [pure virtual]\fR" -Reimplement this function to return a list of the widgets (class names) supported by this factory. -.SH "bool QAxFactory::hasStockEvents ( const TQString & key ) const\fC [virtual]\fR" -Reimplement this function to return TRUE if the ActiveX control \fIkey\fR should support the standard ActiveX events -.TP -Click -.TP -DblClick -.TP -KeyDown -.TP -KeyPress -.TP -KeyUp -.TP -MouseDown -.TP -MouseUp -.TP -MouseMove -.PP -The default implementation interprets \fIkey\fR as the class name, and returns TRUE if the value of the TQ_CLASSINFO entry "StockEvents" is "yes". Otherwise this function returns FALSE. -.SH "QUuid QAxFactory::interfaceID ( const TQString & key ) const\fC [virtual]\fR" -Reimplement this function to return the interface identifier for each \fIkey\fR returned by the featureList() implementation, or an empty QUuid if this factory doesn't support the value of \fIkey\fR. -.PP -The default implementation interprets \fIkey\fR as the class name, and returns the value of the TQ_CLASSINFO entry "InterfaceID". -.SH "bool QAxFactory::isServer ()\fC [static]\fR" -Returns TRUE if the application has been started (by COM) as an ActiveX server, otherwise returns FALSE. -.PP -.nf -.br - int main( int argc, char**argv ) -.br - { -.br - QApplication app( argc, argv ); -.br -.br - if ( !QAxFactory::isServer() ) { -.br - // initialize for stand-alone execution -.br - } -.br -.br - return app.exec() // standard event processing -.br - } -.br -.fi -.SH "bool QAxFactory::isService () const\fC [virtual]\fR" -Reimplement this function to return TRUE if the server is running as a persistent service (e.g. an NT service) and should not terminate even when all objects provided have been released. -.PP -The default implementation returns FALSE. -.SH "QMetaObject * QAxFactory::metaObject ( const TQString & key ) const\fC [virtual]\fR" -Reimplement this function to return the QMetaObject corresponding to \fIkey\fR, or 0 if this factory doesn't support the value of \fIkey\fR. -.PP -The default implementation returns the QMetaObject for the class \fIkey\fR. -.SH "void QAxFactory::registerClass ( const TQString & key, QSettings * settings ) const\fC [virtual]\fR" -Registers additional values for the class \fIkey\fR in the system registry using the \fIsettings\fR object. The standard values have already been registed by the framework, but additional values, e.g. implemented categories, can be added in an implementation of this function. -.PP -.nf -.br - settings->writeEntry( "/CLSID/" + classID(key) + "/Implemented Categories/{00000000-0000-0000-000000000000}/.", TQString::null ); -.br -.fi -.PP -If you reimplement this function you must also reimplement unregisterClass() to remove the additional registry values. -.PP -See also QSettings. -.SH "TQString QAxFactory::serverDirPath ()\fC [static]\fR" -Returns the directory that contains the server binary. -.PP -For out-of-process servers this is the same as QApplication::applicationDirPath(). For in-process servers that function returns the directory that contains the hosting application. -.SH "TQString QAxFactory::serverFilePath ()\fC [static]\fR" -Returns the file path of the server binary. -.PP -For out-of-process servers this is the same as QApplication::applicationFilePath(). For in-process servers that function returns the file path of the hosting application. -.SH "bool QAxFactory::startServer ( ServerType type = MultipleInstances )\fC [static]\fR" -Starts the COM server with \fItype\fR and returns TRUE if successful, otherwise returns FALSE. -.PP -Calling this function if the server is already running (or for an in-process server) does nothing and returns TRUE. -.PP -The server is started automatically with \fItype\fR set to MultipleUse if the server executable has been started with the \fC-activex\fR command line parameter. -.SH "bool QAxFactory::stayTopLevel ( const TQString & key ) const\fC [virtual]\fR" -Reimplement this function to return TRUE if the ActiveX control \fIkey\fR should be a top level window, e.g. a dialog. The default implementation returns FALSE. -.SH "bool QAxFactory::stopServer ()\fC [static]\fR" -Stops the COM server and returns TRUE if successful, otherwise returns FALSE. -.PP -Calling this function if the server is not running (or for an in-process server) does nothing and returns TRUE. -.PP -Stopping the server will not invalidate existing objects, but no new objects can be created from the existing server process. Usually COM will start a new server process if additional objects are requested. -.PP -The server is stopped automatically when the main() function returns. -.SH "QUuid QAxFactory::typeLibID () const\fC [virtual]\fR" -Reimplement this function to return the ActiveX server's type library identifier. -.SH "void QAxFactory::unregisterClass ( const TQString & key, QSettings * settings ) const\fC [virtual]\fR" -Unregisters any additional values for the class \fIkey\fR from the system registry using the \fIsettings\fR object. -.PP -.nf -.br - settings->removeEntry( "/CLSID/" + classID(key) + "/Implemented Categories/{00000000-0000-0000-000000000000}/." ); -.br -.fi -.PP -See also registerClass() and QSettings. -.SH "bool QAxFactory::validateLicenseKey ( const TQString & key, const TQString & licenseKey ) const\fC [virtual]\fR" -Reimplement this function to return TRUE if \fIlicenseKey\fR is a valid license for the class \fIkey\fR, or if the current machine is licensed. -.PP -The default implementation returns TRUE if the class \fIkey\fR is not -licensed (ie. no TQ_CLASSINFO attribute "LicenseKey"), or if -\fIlicenseKey\fR matches the value of the "LicenseKey" attribute, or -if the machine is licensed through a .LIC file with the same filename -as this COM server. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaxfactory.html -.BR http://www.trolltech.com/faq/tech.html -.SH COPYRIGHT -Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the -license file included in the distribution for a complete license -statement. -.SH AUTHOR -Generated automatically from the source code. -.SH BUGS -If you find a bug in Qt, please report it as described in -.BR http://doc.trolltech.com/bughowto.html . -Good bug reports help us to help you. Thank you. -.P -The definitive TQt documentation is provided in HTML format; it is -located at $TQTDIR/doc/html and can be read using TQt Assistant or with -a web browser. This man page is provided as a convenience for those -users who prefer man pages, although this format is not officially -supported by Trolltech. -.P -If you find errors in this manual page, please report them to -.BR qt-bugs@trolltech.com . -Please include the name of the manual page (tqaxfactory.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/tqaxobject.3qt b/doc/man/man3/tqaxobject.3qt deleted file mode 100644 index 3019e2e0a..000000000 --- a/doc/man/man3/tqaxobject.3qt +++ /dev/null @@ -1,183 +0,0 @@ -'\" t -.TH QAxObject 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- -.\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the -.\" license file included in the distribution for a complete license -.\" statement. -.\" -.ad l -.nh -.SH NAME -QAxObject \- TQObject that wraps a COM object -.SH SYNOPSIS -This class is part of the \fBQt ActiveQt Extension\fR. -.PP -\fC#include <qaxobject.h>\fR -.PP -Inherits TQObject and QAxBase. -.PP -Inherited by QAxScriptEngine. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAxObject\fR ( TQObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQAxObject\fR ( const TQString & c, TQObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fBQAxObject\fR ( IUnknown * iface, TQObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QAxObject\fR ()" -.br -.in -1c -.SS "Important Inherited Members" -.in +1c -.ti -1c -.BI "QVariant \fBdynamicCall\fR ( 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 ( ) )" -.br -.ti -1c -.BI "QVariant \fBdynamicCall\fR ( const QCString & function, TQValueList<QVariant> & vars )" -.br -.ti -1c -.BI "QAxObject * \fBquerySubObject\fR ( const QCString & name, 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 ( ) )" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main TQt API. -.PP -The QAxObject class provides a TQObject that wraps a COM object. -.PP -A QAxObject can be instantiated as an empty object, with the name of the COM object it should wrap, or with a pointer to the IUnknown that represents an existing COM object. If the COM object implements the IDispatch interface, the properties, methods and events of that object become available as TQt properties, slots and signals. The base class, QAxBase, provides an API to access the COM object directly through the IUnknown pointer. -.PP -QAxObject is a TQObject and can be used as such, e.g. it can be organized in an object hierarchy, receive events and connect to signals and slots. -.PP -\fBWarning:\fR You can subclass QAxObject, but you cannot use the TQ_OBJECT macro in the subclass (the generated moc-file will not compile), so you cannot add further signals, slots or properties. This limitation is due to the metaobject information generated in runtime. To work around this problem, aggregate the QAxObject as a member of the TQObject subclass. -.PP -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAxObject::QAxObject ( TQObject * parent = 0, const char * name = 0 )" -Creates an empty COM object and propagates \fIparent\fR and \fIname\fR to the TQObject constructor. To initialize the object, call setControl. -.SH "QAxObject::QAxObject ( const TQString & c, TQObject * parent = 0, const char * name = 0 )" -Creates a QAxObject that wraps the COM object \fIc\fR. \fIparent\fR and \fIname\fR are propagated to the TQWidget contructor. -.PP -See also control. -.SH "QAxObject::QAxObject ( IUnknown * iface, TQObject * parent = 0, const char * name = 0 )" -Creates a QAxObject that wraps the COM object referenced by \fIiface\fR. \fIparent\fR and \fIname\fR are propagated to the TQObject contructor. -.SH "QAxObject::~QAxObject ()" -Releases the COM object and destroys the QAxObject, cleaning up all allocated resources. -.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 TQObject::connect() call. -.PP -.nf -.br - activeX->dynamicCall( "Navigate(const TQString&)", "www.trolltech.com" ); -.br -.fi -.PP -Alternatively a function can be called passing the parameters embedded in the string, e.g. above function can also be invoked using -.PP -.nf -.br - activeX->dynamicCall("Navigate(\\"www.trolltech.com\\"); -.br -.fi -All parameters are passed as strings; it depends on the control whether they are interpreted correctly, and is slower than using the prototype with correctly typed parameters. -.PP -If \fIfunction\fR is a property the string has to be the name of the property. The property setter is called when \fIvar1\fR is a valid QVariant, otherwise the getter is called. -.PP -.nf -.br - activeX->dynamicCall( "Value", 5 ); -.br - TQString text = activeX->dynamicCall( "Text" ).toString(); -.br -.fi -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 -.nf -.br - IWebBrowser2 *webBrowser = 0; -.br - activeX->queryInterface( IID_IWebBrowser2, (void**)&webBrowser ); -.br - if ( webBrowser ) { -.br - webBrowser->Navigate2( pvarURL ); -.br - webBrowser->Release(); -.br - } -.br -.fi -.PP -This is also more efficient. -.PP -Example: qutlook/centralwidget.cpp. -.SH "QVariant QAxBase::dynamicCall ( const QCString & function, TQValueList<QVariant> & vars )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -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 "QAxObject * QAxBase::querySubObject ( const QCString & name, 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 ( ) )" -Returns a pointer to a QAxObject wrapping the COM object provided by the method or property \fIname\fR, passing passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR. -.PP -If \fIname\fR is provided by a method the string must include the full function prototype. -.PP -If \fIname\fR is a property the string must be the name of the property, and \fIvar1\fR, ... \fIvar8\fR are ignored. -.PP -The returned QAxObject is a child of this object (which is either of type QAxObject or QAxWidget), and is deleted when this object is deleted. It is however safe to delete the returned object yourself, and you should do so when you iterate over lists of subobjects. -.PP -COM enabled applications usually have an object model publishing certain elements of the application as dispatch interfaces. Use this method to navigate the hierarchy of the object model, e.g. -.PP -.nf -.br - QAxWidget outlook( "Outlook.Application" ); -.br - QAxObject *session = outlook.querySubObject( "Session" ); -.br - if ( session ) { -.br - QAxObject *defFolder = session->querySubObject( -.br - "GetDefaultFolder(OlDefaultFolders)", -.br - "olFolderContacts" ); -.br - //... -.br - } -.br -.fi -.PP -Example: qutlook/centralwidget.cpp. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaxobject.html -.BR http://www.trolltech.com/faq/tech.html -.SH COPYRIGHT -Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the -license file included in the distribution for a complete license -statement. -.SH AUTHOR -Generated automatically from the source code. -.SH BUGS -If you find a bug in Qt, please report it as described in -.BR http://doc.trolltech.com/bughowto.html . -Good bug reports help us to help you. Thank you. -.P -The definitive TQt documentation is provided in HTML format; it is -located at $TQTDIR/doc/html and can be read using TQt Assistant or with -a web browser. This man page is provided as a convenience for those -users who prefer man pages, although this format is not officially -supported by Trolltech. -.P -If you find errors in this manual page, please report them to -.BR qt-bugs@trolltech.com . -Please include the name of the manual page (tqaxobject.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/tqaxscript.3qt b/doc/man/man3/tqaxscript.3qt deleted file mode 100644 index c339d10ce..000000000 --- a/doc/man/man3/tqaxscript.3qt +++ /dev/null @@ -1,169 +0,0 @@ -'\" t -.TH QAxScript 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- -.\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the -.\" license file included in the distribution for a complete license -.\" statement. -.\" -.ad l -.nh -.SH NAME -QAxScript \- Wrapper around script code -.SH SYNOPSIS -This class is part of the \fBQt ActiveQt Extension\fR. -.PP -\fC#include <qaxscript.h>\fR -.PP -Inherits TQObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBFunctionFlags\fR { FunctionNames = 0, FunctionSignatures }" -.br -.ti -1c -.BI "\fBQAxScript\fR ( const TQString & name, QAxScriptManager * manager )" -.br -.ti -1c -.BI "\fB~QAxScript\fR ()" -.br -.ti -1c -.BI "bool \fBload\fR ( const TQString & code, const TQString & language = TQString::null )" -.br -.ti -1c -.BI "TQStringList \fBfunctions\fR ( FunctionFlags flags = FunctionNames ) const" -.br -.ti -1c -.BI "TQString \fBscriptCode\fR () const" -.br -.ti -1c -.BI "TQString \fBscriptName\fR () const" -.br -.ti -1c -.BI "QAxScriptEngine * \fBscriptEngine\fR () const" -.br -.ti -1c -.BI "QVariant \fBcall\fR ( const TQString & 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 ( ) )" -.br -.ti -1c -.BI "QVariant \fBcall\fR ( const TQString & function, TQValueList<QVariant> & arguments )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBentered\fR ()" -.br -.ti -1c -.BI "void \fBfinished\fR ()" -.br -.ti -1c -.BI "void \fBfinished\fR ( const QVariant & result )" -.br -.ti -1c -.BI "void \fBfinished\fR ( int code, const TQString & source, const TQString & description, const TQString & help )" -.br -.ti -1c -.BI "void \fBstateChanged\fR ( int state )" -.br -.ti -1c -.BI "void \fBerror\fR ( int code, const TQString & description, int sourcePosition, const TQString & sourceText )" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main TQt API. -.PP -The QAxScript class provides a wrapper around script code. -.PP -Every instance of the QAxScript class represents a piece of scripting code in a particular scripting language. The code is loaded into the script engine using load(). Functions declared in the code can be called using call(). -.PP -The script provides scriptEngine() provides feedback to the application through signals. The most important signal is the error() signal. Direct access to the QAxScriptEngine is provided through the scriptEngine() function. -.PP -\fBWarning:\fR This class is not available with the bcc5.5 and MingW compilers. -.SS "Member Type Documentation" -.SH "QAxScript::FunctionFlags" -This FunctionFlags enum describes formatting for function introspection. -.TP -\fCQAxScript::FunctionNames\fR - Only function names are returned. -.TP -\fCQAxScript::FunctionSignatures\fR - Returns the functions with signatures. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAxScript::QAxScript ( const TQString & name, QAxScriptManager * manager )" -Constructs a QAxScript object called \fIname\fR and registers it with the QAxScriptManager \fImanager\fR. This is usually done by the QAxScriptManager class when loading a script. -.PP -A script should always have a name. A manager is necessary to allow the script code to reference objects in the application. The \fImanager\fR takes ownership of the object. -.SH "QAxScript::~QAxScript ()" -Destroys the object, releasing all allocated resources. -.SH "QVariant QAxScript::call ( const TQString & 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 \fIfunction\fR, passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR as arguments and returns the value returned by the function, or an invalid QVariant if the function does not return a value or when the function call failed. -.PP -See QAxScriptManager::call() for more information about how to call script functions. -.SH "QVariant QAxScript::call ( const TQString & function, TQValueList<QVariant> & arguments )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Calls \fIfunction\fR passing \fIarguments\fR as parameters, and returns the result. Returns when the script's execution has finished. -.PP -See QAxScriptManager::call() for more information about how to call script functions. -.SH "void QAxScript::entered ()\fC [signal]\fR" -This signal is emitted when a script engine has started executing code. -.SH "void QAxScript::error ( int code, const TQString & description, int sourcePosition, const TQString & sourceText )\fC [signal]\fR" -This signal is emitted when an execution error occured while running a script. -.PP -\fIcode\fR, \fIdescription\fR, \fIsourcePosition\fR and \fIsourceText\fR contain information about the execution error. -.SH "void QAxScript::finished ()\fC [signal]\fR" -This signal is emitted when a script engine has finished executing code. -.SH "void QAxScript::finished ( const QVariant & result )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIresult\fR contains the script's result. This will be an invalid QVariant if the script has no return value. -.SH "void QAxScript::finished ( int code, const TQString & source, const TQString & description, const TQString & help )\fC [signal]\fR" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -\fIcode\fR, \fIsource\fR, \fIdescription\fR and \fIhelp\fR contain exception information when the script terminated. -.SH "TQStringList QAxScript::functions ( FunctionFlags flags = FunctionNames ) const" -Returns a list of all the functions in this script if the respective script engine supports introspection; otherwise returns an empty list. The functions are either provided with full prototypes or only as names, depending on the value of \fIflags\fR. -.PP -See also QAxScriptEngine::hasIntrospection(). -.SH "bool QAxScript::load ( const TQString & code, const TQString & language = TQString::null )" -Loads the script source \fIcode\fR written in language \fIlanguage\fR into the script engine. Returns TRUE if \fIcode\fR was successfully entered into the script engine; otherwise returns FALSE. -.PP -If \fIlanguage\fR is empty (the default) it will be determined heuristically. If \fIcode\fR contains the string \fCEnd Sub\fR it will be interpreted as VBScript, otherwise as JScript. Additional scripting languages can be registered using QAxScript::registerEngine(). -.PP -This function can only be called once for each QAxScript object, which is done automatically when using QAxScriptManager::load(). -.SH "TQString QAxScript::scriptCode () const" -Returns the script's code, or the null-string if no code has been loaded yet. -.PP -See also load(). -.SH "QAxScriptEngine * QAxScript::scriptEngine () const" -Returns a pointer to the script engine. -.PP -You can use the object returned to connect signals to the script functions, or to access the script engine directly. -.SH "TQString QAxScript::scriptName () const" -Returns the name of the script. -.SH "void QAxScript::stateChanged ( int state )\fC [signal]\fR" -This signal is emitted when a script engine changes state. -\fIstate\fR can be any value in the QAxScriptEngineState enumeration. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaxscript.html -.BR http://www.trolltech.com/faq/tech.html -.SH COPYRIGHT -Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the -license file included in the distribution for a complete license -statement. -.SH AUTHOR -Generated automatically from the source code. -.SH BUGS -If you find a bug in Qt, please report it as described in -.BR http://doc.trolltech.com/bughowto.html . -Good bug reports help us to help you. Thank you. -.P -The definitive TQt documentation is provided in HTML format; it is -located at $TQTDIR/doc/html and can be read using TQt Assistant or with -a web browser. This man page is provided as a convenience for those -users who prefer man pages, although this format is not officially -supported by Trolltech. -.P -If you find errors in this manual page, please report them to -.BR qt-bugs@trolltech.com . -Please include the name of the manual page (tqaxscript.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/tqaxscriptengine.3qt b/doc/man/man3/tqaxscriptengine.3qt deleted file mode 100644 index efcfb8343..000000000 --- a/doc/man/man3/tqaxscriptengine.3qt +++ /dev/null @@ -1,123 +0,0 @@ -'\" t -.TH QAxScriptEngine 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- -.\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the -.\" license file included in the distribution for a complete license -.\" statement. -.\" -.ad l -.nh -.SH NAME -QAxScriptEngine \- Wrapper around a script engine -.SH SYNOPSIS -This class is part of the \fBQt ActiveQt Extension\fR. -.PP -\fC#include <qaxscript.h>\fR -.PP -Inherits QAxObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "enum \fBState\fR { Uninitialized = 0, Initialized = 5, Started = 1, Connected = 2, Disconnected = 3, Closed = 4 }" -.br -.ti -1c -.BI "\fBQAxScriptEngine\fR ( const TQString & language, QAxScript * script )" -.br -.ti -1c -.BI "\fB~QAxScriptEngine\fR ()" -.br -.ti -1c -.BI "bool \fBisValid\fR () const" -.br -.ti -1c -.BI "bool \fBhasIntrospection\fR () const" -.br -.ti -1c -.BI "TQString \fBscriptLanguage\fR () const" -.br -.ti -1c -.BI "State \fBstate\fR () const" -.br -.ti -1c -.BI "void \fBsetState\fR ( State st )" -.br -.ti -1c -.BI "void \fBaddItem\fR ( const TQString & name )" -.br -.ti -1c -.BI "long \fBqueryInterface\fR ( const QUuid & uuid, void ** iface ) const" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main TQt API. -.PP -The QAxScriptEngine class provides a wrapper around a script engine. -.PP -Every instance of the QAxScriptEngine class represents an interpreter for script code in a particular scripting language. The class is usually not used directly. The QAxScript and QAxScriptManager classes provide convenient functions to handle and call script code. -.PP -Direct access to the script engine is provided through queryInterface(). -.PP -\fBWarning:\fR This class is not available with the bcc5.5 and MingW compilers. -.SS "Member Type Documentation" -.SH "QAxScriptEngine::State" -The State enumeration defines the different states a script engine can be in. -.TP -\fCQAxScriptEngine::Uninitialized\fR - The script has been created, but not yet initialized -.TP -\fCQAxScriptEngine::Initialized\fR - The script has been initialized, but is not running -.TP -\fCQAxScriptEngine::Started\fR - The script can execute code, but does not yet handle events -.TP -\fCQAxScriptEngine::Connected\fR - The script can execute code and is connected so that it can handle events -.TP -\fCQAxScriptEngine::Disconnected\fR - The script is loaded, but is not connected to event sources -.TP -\fCQAxScriptEngine::Closed\fR - The script has been closed. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAxScriptEngine::QAxScriptEngine ( const TQString & language, QAxScript * script )" -Constructs a QAxScriptEngine object interpreting script code in \fIlanguage\fR provided by the code in \fIscript\fR. This is usually done by the QAxScript class when loading a script. -.PP -Instances of QAxScriptEngine should always have both a language and a script. -.SH "QAxScriptEngine::~QAxScriptEngine ()" -Destroys the QAxScriptEngine object, releasing all allocated resources. -.SH "void QAxScriptEngine::addItem ( const TQString & name )" -Registers an item with the script engine. Script code can refer to this item using \fIname\fR. -.SH "bool QAxScriptEngine::hasIntrospection () const" -Returns TRUE if the script engine supports introspection; otherwise returns FALSE. -.SH "bool QAxScriptEngine::isValid () const" -Returns TRUE if the script engine has been initialized correctly; otherwise returns FALSE. -.SH "long QAxScriptEngine::queryInterface ( const QUuid & uuid, void ** iface ) const" -Requests the interface \fIuuid\fR from the script engine object and sets the value of \fIiface\fR to the provided interface, or to 0 if the requested interface could not be provided. -.PP -Returns the result of the QueryInterface implementation of the COM object. -.SH "TQString QAxScriptEngine::scriptLanguage () const" -Returns the scripting language, for example "VBScript", or "JScript". -.SH "void QAxScriptEngine::setState ( State st )" -Sets the state of the script engine to \fIst\fR. Calling this function is usually not necessary. -.SH "State QAxScriptEngine::state () const" -Returns the state of the script engine. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaxscriptengine.html -.BR http://www.trolltech.com/faq/tech.html -.SH COPYRIGHT -Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the -license file included in the distribution for a complete license -statement. -.SH AUTHOR -Generated automatically from the source code. -.SH BUGS -If you find a bug in Qt, please report it as described in -.BR http://doc.trolltech.com/bughowto.html . -Good bug reports help us to help you. Thank you. -.P -The definitive TQt documentation is provided in HTML format; it is -located at $TQTDIR/doc/html and can be read using TQt Assistant or with -a web browser. This man page is provided as a convenience for those -users who prefer man pages, although this format is not officially -supported by Trolltech. -.P -If you find errors in this manual page, please report them to -.BR qt-bugs@trolltech.com . -Please include the name of the manual page (tqaxscriptengine.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/tqaxscriptmanager.3qt b/doc/man/man3/tqaxscriptmanager.3qt deleted file mode 100644 index bafa492d6..000000000 --- a/doc/man/man3/tqaxscriptmanager.3qt +++ /dev/null @@ -1,197 +0,0 @@ -'\" t -.TH QAxScriptManager 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- -.\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the -.\" license file included in the distribution for a complete license -.\" statement. -.\" -.ad l -.nh -.SH NAME -QAxScriptManager \- Bridge between application objects and script code -.SH SYNOPSIS -This class is part of the \fBQt ActiveQt Extension\fR. -.PP -\fC#include <qaxscript.h>\fR -.PP -Inherits TQObject. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAxScriptManager\fR ( TQObject * parent = 0, const char * name = 0 )" -.br -.ti -1c -.BI "\fB~QAxScriptManager\fR ()" -.br -.ti -1c -.BI "void \fBaddObject\fR ( QAxBase * object )" -.br -.ti -1c -.BI "void \fBaddObject\fR ( TQObject * object )" -.br -.ti -1c -.BI "TQStringList \fBfunctions\fR ( QAxScript::FunctionFlags flags = QAxScript::FunctionNames ) const" -.br -.ti -1c -.BI "TQStringList \fBscriptNames\fR () const" -.br -.ti -1c -.BI "QAxScript * \fBscript\fR ( const TQString & name ) const" -.br -.ti -1c -.BI "QAxScript * \fBload\fR ( const TQString & code, const TQString & name, const TQString & language )" -.br -.ti -1c -.BI "QAxScript * \fBload\fR ( const TQString & file, const TQString & name )" -.br -.ti -1c -.BI "QVariant \fBcall\fR ( const TQString & 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 ( ) )" -.br -.ti -1c -.BI "QVariant \fBcall\fR ( const TQString & function, TQValueList<QVariant> & arguments )" -.br -.in -1c -.SS "Signals" -.in +1c -.ti -1c -.BI "void \fBerror\fR ( QAxScript * script, int code, const TQString & description, int sourcePosition, const TQString & sourceText )" -.br -.in -1c -.SS "Static Public Members" -.in +1c -.ti -1c -.BI "bool \fBregisterEngine\fR ( const TQString & name, const TQString & extension, const TQString & code = TQString ( ) )" -.br -.ti -1c -.BI "TQString \fBscriptFileFilter\fR ()" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main TQt API. -.PP -The QAxScriptManager class provides a bridge between application objects and script code. -.PP -The QAxScriptManager acts as a bridge between the COM objects embedded in the TQt application through QAxObject or QAxWidget, and the scripting languages available through the Windows Script technologies, usually JScript and VBScript. -.PP -Create one QAxScriptManager for each separate document in your application, and add the COM objects the scripts need to access using addObject(). Then load() the script sources and invoke the functions using call(). -.PP -\fBWarning:\fR This class is not available with the bcc5.5 and MingW compilers. -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAxScriptManager::QAxScriptManager ( TQObject * parent = 0, const char * name = 0 )" -Creates a QAxScriptManager object. \fIparent\fR and \fIname\fR are passed on to the TQObject constructor. -.PP -It is usual to create one QAxScriptManager for each document in an application. -.SH "QAxScriptManager::~QAxScriptManager ()" -Destroys the objects, releasing all allocated resources. -.SH "void QAxScriptManager::addObject ( QAxBase * object )" -Adds \fIobject\fR to the manager. Scripts handled by this manager can access the object in the code using the object's name property. -.PP -You must add all the necessary objects before loading any scripts. -.SH "void QAxScriptManager::addObject ( TQObject * object )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Adds a generic COM wrapper for \fIobject\fR to the manager. \fIobject\fR must be exposed as a COM object using the functionality provided by the QAxServer module.. Applications using this function you must link against the qaxserver library. -.SH "QVariant QAxScriptManager::call ( const TQString & 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 \fIfunction\fR, passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR as arguments and returns the value returned by the function, or an invalid QVariant if the function does not return a value or when the function call failed. The call returns when the script's execution has finished. -.PP -In most script engines the only supported parameter type is "const QVariant&", for example, to call a JavaScript function -.PP -.nf -.br - function setNumber(number) -.br - { -.br - n = number; -.br - } -.br -.fi -use -.PP -.nf -.br - TQValueList args; -.br - args << 5; -.br - script->call("setNumber(const QVariant&)", args); -.br -.fi -As with dynamicCall the parameters can directly be embedded in the function string. -.PP -.nf -.br - script->call("setNumber(5)"); -.br -.fi -However, this is slower. -.PP -Functions provided by script engines that don't support introspection are not available and must be called directly using QAxScript::call() on the respective script object. -.PP -Note that calling this function can be significantely slower than using call() on the respective QAxScript directly. -.SH "QVariant QAxScriptManager::call ( const TQString & function, TQValueList<QVariant> & arguments )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Calls \fIfunction\fR passing \fIarguments\fR as parameters, and returns the result. Returns when the script's execution has finished. -.SH "void QAxScriptManager::error ( QAxScript * script, int code, const TQString & description, int sourcePosition, const TQString & sourceText )\fC [signal]\fR" -This signal is emitted when an execution error occured while running \fIscript\fR. -.PP -\fIcode\fR, \fIdescription\fR, \fIsourcePosition\fR and \fIsourceText\fR contain information about the execution error. -.SH "TQStringList QAxScriptManager::functions ( QAxScript::FunctionFlags flags = QAxScript::FunctionNames ) const" -Returns a list with all the functions that are available. Functions provided by script engines that don't support introspection are not included in the list. The functions are either provided with full prototypes or only as names, depending on the value of \fIflags\fR. -.SH "QAxScript * QAxScriptManager::load ( const TQString & code, const TQString & name, const TQString & language )" -Loads the script source \fIcode\fR using the script engine for \fIlanguage\fR. The script can later be referred to using its \fIname\fR which should not be empty. -.PP -The function returns a pointer to the script for the given \fIcode\fR if the \fIcode\fR was loaded successfully; otherwise it returns 0. -.PP -If \fIlanguage\fR is empty it will be determined heuristically. If \fIcode\fR contains the string "End Sub" it will be interpreted as VBScript, otherwise as JScript. Additional script engines can be registered using registerEngine(). -.PP -You must add all the objects necessary (using addObject()) \fIbefore\fR loading any scripts. If \fIcode\fR declares a function that is already available (no matter in which language) the first function is overloaded and can no longer be called via call(); but it will still be available by calling its script directly. -.PP -See also addObject(), scriptNames(), and functions(). -.SH "QAxScript * QAxScriptManager::load ( const TQString & file, const TQString & name )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -Loads the source code from the \fIfile\fR. The script can later be referred to using its \fIname\fR which should not be empty. -.PP -The function returns a pointer to the script engine for the code in \fIfile\fR if \fIfile\fR was loaded successfully; otherwise it returns 0. -.PP -The script engine used is determined from the file's extension. By default ".js" files are interpreted as JScript files, and ".vbs" and ".dsm" files are interpreted as VBScript. Additional script engines can be registered using registerEngine(). -.SH "bool QAxScriptManager::registerEngine ( const TQString & name, const TQString & extension, const TQString & code = TQString ( ) )\fC [static]\fR" -Registers the script engine called \fIname\fR and returns TRUE if the engine was found; otherwise does nothing and returns FALSE. -.PP -The script engine will be used when loading files with the given \fIextension\fR, or when loading source code that contains the string \fIcode\fR. -.SH "QAxScript * QAxScriptManager::script ( const TQString & name ) const" -Returns the script called \fIname\fR. -.PP -You can use the returned pointer to call functions directly through QAxScript::call(), to access the script engine directly, or to delete and thus unload the script. -.SH "TQString QAxScriptManager::scriptFileFilter ()\fC [static]\fR" -Returns a file filter listing all the supported script languages. This filter string is convenient for use with QFileDialog. -.SH "TQStringList QAxScriptManager::scriptNames () const" -Returns a list with the names of all the scripts. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaxscriptmanager.html -.BR http://www.trolltech.com/faq/tech.html -.SH COPYRIGHT -Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the -license file included in the distribution for a complete license -statement. -.SH AUTHOR -Generated automatically from the source code. -.SH BUGS -If you find a bug in Qt, please report it as described in -.BR http://doc.trolltech.com/bughowto.html . -Good bug reports help us to help you. Thank you. -.P -The definitive TQt documentation is provided in HTML format; it is -located at $TQTDIR/doc/html and can be read using TQt Assistant or with -a web browser. This man page is provided as a convenience for those -users who prefer man pages, although this format is not officially -supported by Trolltech. -.P -If you find errors in this manual page, please report them to -.BR qt-bugs@trolltech.com . -Please include the name of the manual page (tqaxscriptmanager.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/tqaxwidget.3qt b/doc/man/man3/tqaxwidget.3qt deleted file mode 100644 index 448584e3a..000000000 --- a/doc/man/man3/tqaxwidget.3qt +++ /dev/null @@ -1,215 +0,0 @@ -'\" t -.TH QAxWidget 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- -.\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the -.\" license file included in the distribution for a complete license -.\" statement. -.\" -.ad l -.nh -.SH NAME -QAxWidget \- TQWidget that wraps an ActiveX control -.SH SYNOPSIS -This class is part of the \fBQt ActiveQt Extension\fR. -.PP -\fC#include <qaxwidget.h>\fR -.PP -Inherits TQWidget and QAxBase. -.PP -.SS "Public Members" -.in +1c -.ti -1c -.BI "\fBQAxWidget\fR ( TQWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fBQAxWidget\fR ( const TQString & c, TQWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fBQAxWidget\fR ( IUnknown * iface, TQWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -.br -.ti -1c -.BI "\fB~QAxWidget\fR ()" -.br -.in -1c -.SS "Important Inherited Members" -.in +1c -.ti -1c -.BI "QVariant \fBdynamicCall\fR ( 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 ( ) )" -.br -.ti -1c -.BI "QVariant \fBdynamicCall\fR ( const QCString & function, TQValueList<QVariant> & vars )" -.br -.ti -1c -.BI "QAxObject * \fBquerySubObject\fR ( const QCString & name, 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 ( ) )" -.br -.in -1c -.SS "Protected Members" -.in +1c -.ti -1c -.BI "virtual bool \fBcreateHostWindow\fR ( bool initialized )" -.br -.ti -1c -.BI "virtual bool \fBtranslateKeyEvent\fR ( int message, int keycode ) const" -.br -.in -1c -.SH DESCRIPTION -This class is defined in the \fBQt ActiveQt Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main TQt API. -.PP -The QAxWidget class is a TQWidget that wraps an ActiveX control. -.PP -A QAxWidget can be instantiated as an empty object, with the name of the ActiveX control it should wrap, or with an existing interface pointer to the ActiveX control. The ActiveX control's properties, methods and events which only use supported data types, become available as TQt properties, slots and signals. The base class QAxBase provides an API to access the ActiveX directly through the IUnknown pointer. -.PP -QAxWidget is a TQWidget and can be used as such, e.g. it can be organized in a widget hierarchy, receive events or act as an event filter. Standard widget properties, e.g. enabled are supported, but it depends on the ActiveX control to implement support for ambient properties like e.g. palette or font. QAxWidget tries to provide the necessary hints. -.PP -\fBWarning:\fR You can subclass QAxWidget, but you cannot use the TQ_OBJECT macro in the subclass (the generated moc-file will not compile), so you cannot add further signals, slots or properties. This limitation is due to the metaobject information generated in runtime. To work around this problem, aggregate the QAxWidget as a member of the TQObject subclass. -.PP -.SH MEMBER FUNCTION DOCUMENTATION -.SH "QAxWidget::QAxWidget ( TQWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Creates an empty QAxWidget widget and propagates \fIparent\fR, \fIname\fR and \fIf\fR to the TQWidget constructor. To initialize a control, call setControl. -.SH "QAxWidget::QAxWidget ( const TQString & c, TQWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Creates an QAxWidget widget and initializes the ActiveX control \fIc\fR. \fIparent\fR, \fIname\fR and \fIf\fR are propagated to the TQWidget contructor. -.PP -See also control. -.SH "QAxWidget::QAxWidget ( IUnknown * iface, TQWidget * parent = 0, const char * name = 0, WFlags f = 0 )" -Creates a QAxWidget that wraps the COM object referenced by \fIiface\fR. \fIparent\fR, \fIname\fR and \fIf\fR are propagated to the TQWidget contructor. -.SH "QAxWidget::~QAxWidget ()" -Shuts down the ActiveX control and destroys the QAxWidget widget, cleaning up all allocated resources. -.PP -See also clear(). -.SH "bool QAxWidget::createHostWindow ( bool initialized )\fC [virtual protected]\fR" -Creates the client site for the ActiveX control, and returns TRUE if the control could be embedded successfully, otherwise returns FALSE. If \fIinitialized\fR is TRUE the control has already been initialized. -.PP -This function is called by initialize(). If you reimplement initialize to customize the actual control instantiation, call this function in your reimplementation to have the control embedded by the default client side. Creates the client site for the ActiveX control, and returns TRUE if the control could be embedded successfully, otherwise returns FALSE. -.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 TQObject::connect() call. -.PP -.nf -.br - activeX->dynamicCall( "Navigate(const TQString&)", "www.trolltech.com" ); -.br -.fi -.PP -Alternatively a function can be called passing the parameters embedded in the string, e.g. above function can also be invoked using -.PP -.nf -.br - activeX->dynamicCall("Navigate(\\"www.trolltech.com\\"); -.br -.fi -All parameters are passed as strings; it depends on the control whether they are interpreted correctly, and is slower than using the prototype with correctly typed parameters. -.PP -If \fIfunction\fR is a property the string has to be the name of the property. The property setter is called when \fIvar1\fR is a valid QVariant, otherwise the getter is called. -.PP -.nf -.br - activeX->dynamicCall( "Value", 5 ); -.br - TQString text = activeX->dynamicCall( "Text" ).toString(); -.br -.fi -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 -.nf -.br - IWebBrowser2 *webBrowser = 0; -.br - activeX->queryInterface( IID_IWebBrowser2, (void**)&webBrowser ); -.br - if ( webBrowser ) { -.br - webBrowser->Navigate2( pvarURL ); -.br - webBrowser->Release(); -.br - } -.br -.fi -.PP -This is also more efficient. -.PP -Example: qutlook/centralwidget.cpp. -.SH "QVariant QAxBase::dynamicCall ( const QCString & function, TQValueList<QVariant> & vars )" -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.PP -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 "QAxObject * QAxBase::querySubObject ( const QCString & name, 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 ( ) )" -Returns a pointer to a QAxObject wrapping the COM object provided by the method or property \fIname\fR, passing passing the parameters \fIvar1\fR, \fIvar1\fR, \fIvar2\fR, \fIvar3\fR, \fIvar4\fR, \fIvar5\fR, \fIvar6\fR, \fIvar7\fR and \fIvar8\fR. -.PP -If \fIname\fR is provided by a method the string must include the full function prototype. -.PP -If \fIname\fR is a property the string must be the name of the property, and \fIvar1\fR, ... \fIvar8\fR are ignored. -.PP -The returned QAxObject is a child of this object (which is either of type QAxObject or QAxWidget), and is deleted when this object is deleted. It is however safe to delete the returned object yourself, and you should do so when you iterate over lists of subobjects. -.PP -COM enabled applications usually have an object model publishing certain elements of the application as dispatch interfaces. Use this method to navigate the hierarchy of the object model, e.g. -.PP -.nf -.br - QAxWidget outlook( "Outlook.Application" ); -.br - QAxObject *session = outlook.querySubObject( "Session" ); -.br - if ( session ) { -.br - QAxObject *defFolder = session->querySubObject( -.br - "GetDefaultFolder(OlDefaultFolders)", -.br - "olFolderContacts" ); -.br - //... -.br - } -.br -.fi -.PP -Example: qutlook/centralwidget.cpp. -.SH "bool QAxWidget::translateKeyEvent ( int message, int keycode ) const\fC [virtual protected]\fR" -Reimplement this function to pass certain key events to the ActiveX control. \fImessage\fR is the Window message identifier specifying the message type (ie. WM_KEYDOWN), and \fIkeycode\fR is the virtual keycode (ie. VK_TAB). -.PP -If the function returns TRUE the key event is passed on to the ActiveX control, which then either processes the event or passes the event on to Qt. -.PP -If the function returns FALSE the processing of the key event is ignored by ActiveQt, ie. the ActiveX control might handle it or not. -.PP -The default implementation returns TRUE for the following cases: -.PP -<center>.nf -.TS -l - l. WM_SYSKEYDOWN WM_SYSKEYUP WM_KEYDOWN All keycodes VK_MENU -.TE -.fi -</center> -.PP -This table is the result of experimenting with popular ActiveX controls, -ie. Internet Explorer and Microsoft Office applications, but for some -controls it might require modification. - -.SH "SEE ALSO" -.BR http://doc.trolltech.com/qaxwidget.html -.BR http://www.trolltech.com/faq/tech.html -.SH COPYRIGHT -Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the -license file included in the distribution for a complete license -statement. -.SH AUTHOR -Generated automatically from the source code. -.SH BUGS -If you find a bug in Qt, please report it as described in -.BR http://doc.trolltech.com/bughowto.html . -Good bug reports help us to help you. Thank you. -.P -The definitive TQt documentation is provided in HTML format; it is -located at $TQTDIR/doc/html and can be read using TQt Assistant or with -a web browser. This man page is provided as a convenience for those -users who prefer man pages, although this format is not officially -supported by Trolltech. -.P -If you find errors in this manual page, please report them to -.BR qt-bugs@trolltech.com . -Please include the name of the manual page (tqaxwidget.3qt) and the Qt -version (3.3.8). diff --git a/doc/man/man3/tqobject.3qt b/doc/man/man3/tqobject.3qt index a43f1d0d0..1c1aa9a1c 100644 --- a/doc/man/man3/tqobject.3qt +++ b/doc/man/man3/tqobject.3qt @@ -15,7 +15,7 @@ All the functions in this class are reentrant when TQt is built with thread supp .PP Inherits Qt. .PP -Inherited by QAccel, QAccessibleObject, QAction, QApplication, QAssistantClient, QDataPump, QAxObject, QAxScript, QAxScriptManager, TQWidget, TQCanvas, TQStyle, QClipboard, QCopChannel, QDns, QLayout, QDragObject, TQEditorFactory, QEventLoop, QFileIconProvider, QNetworkProtocol, QWSKeyboardHandler, QNetworkOperation, QNPInstance, TQObjectCleanupHandler, QProcess, QServerSocket, QSessionManager, QSignal, QSignalMapper, QSocket, QSocketNotifier, QSound, TQSqlDatabase, TQSqlDriver, TQSqlForm, TQStyleSheet, QTimer, QToolTipGroup, QTranslator, QUrlOperator, and QValidator. +-Inherited by QAccel, QAccessibleObject, QAction, QApplication, QAssistantClient, QDataPump, TQWidget, TQCanvas, TQStyle, QClipboard, QCopChannel, QDns, QLayout, QDragObject, TQEditorFactory, QEventLoop, QFileIconProvider, QNetworkProtocol, QWSKeyboardHandler, QNetworkOperation, QNPInstance, TQObjectCleanupHandler, QProcess, QServerSocket, QSessionManager, QSignal, QSignalMapper, QSocket, QSocketNotifier, QSound, TQSqlDatabase, TQSqlDriver, TQSqlForm, TQStyleSheet, QTimer, QToolTipGroup, QTranslator, QUrlOperator, and QValidator. .PP .SS "Public Members" .in +1c diff --git a/doc/man/man3/tqwidget.3qt b/doc/man/man3/tqwidget.3qt index f9cc34d46..aac46de70 100644 --- a/doc/man/man3/tqwidget.3qt +++ b/doc/man/man3/tqwidget.3qt @@ -13,7 +13,7 @@ TQWidget \- The base class of all user interface objects .PP Inherits TQObject and QPaintDevice. .PP -Inherited by QAxWidget, QButton, QFrame, QDialog, QComboBox, TQDataBrowser, TQDataView, QDateTimeEditBase, QDateTimeEdit, QDesktopWidget, QDial, QDockArea, QGLWidget, QHeader, QMainWindow, QMotifWidget, QNPWidget, QScrollBar, QSizeGrip, QSlider, QSpinBox, QSplashScreen, QStatusBar, QTabBar, QTabWidget, QWorkspace, and QXtWidget. +Inherited by QButton, QFrame, QDialog, QComboBox, TQDataBrowser, TQDataView, QDateTimeEditBase, QDateTimeEdit, QDesktopWidget, QDial, QDockArea, QGLWidget, QHeader, QMainWindow, QMotifWidget, QNPWidget, QScrollBar, QSizeGrip, QSlider, QSpinBox, QSplashScreen, QStatusBar, QTabBar, QTabWidget, QWorkspace, and QXtWidget. .PP .SS "Public Members" .in +1c |