<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/extensions/activeqt/container/qaxobject.cpp:33 --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>QAxObject Class</title> <style type="text/css"><!-- fn { margin-left: 1cm; text-indent: -1cm; } a:link { color: #004faf; text-decoration: none } a:visited { color: #672967; text-decoration: none } body { background: #ffffff; color: black; } --></style> </head> <body> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr bgcolor="#E5E5E5"> <td valign=center> <a href="index.html"> <font color="#004faf">Home</font></a> | <a href="classes.html"> <font color="#004faf">All Classes</font></a> | <a href="mainclasses.html"> <font color="#004faf">Main Classes</font></a> | <a href="annotated.html"> <font color="#004faf">Annotated</font></a> | <a href="groups.html"> <font color="#004faf">Grouped Classes</font></a> | <a href="functions.html"> <font color="#004faf">Functions</font></a> </td> <td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QAxObject Class Reference<br><small>[<a href="qaxcontainer.html">QAxContainer module</a>]</small></h1> <p>The QAxObject class provides a QObject that wraps a COM object. <a href="#details">More...</a> <p>This class is part of the <b>Qt ActiveQt Extension</b>. <p><tt>#include <<a href="qaxobject-h.html">qaxobject.h</a>></tt> <p>Inherits <a href="qobject.html">QObject</a> and <a href="qaxbase.html">QAxBase</a>. <p>Inherited by <a href="qaxscriptengine.html">QAxScriptEngine</a>. <p><a href="qaxobject-members.html">List of all member functions.</a> <h2>Public Members</h2> <ul> <li class=fn><a href="#QAxObject"><b>QAxObject</b></a> ( QObject * parent = 0, const char * name = 0 )</li> <li class=fn><a href="#QAxObject-2"><b>QAxObject</b></a> ( const QString & c, QObject * parent = 0, const char * name = 0 )</li> <li class=fn><a href="#QAxObject-3"><b>QAxObject</b></a> ( IUnknown * iface, QObject * parent = 0, const char * name = 0 )</li> <li class=fn><a href="#~QAxObject"><b>~QAxObject</b></a> ()</li> </ul> <h2>Important Inherited Members</h2> <ul> <li class=fn>QVariant <a href="#dynamicCall"><b>dynamicCall</b></a> ( 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 ( ) )</li> <li class=fn>QVariant <a href="#dynamicCall-2"><b>dynamicCall</b></a> ( const QCString & function, QValueList<QVariant> & vars )</li> <li class=fn>QAxObject * <a href="#querySubObject"><b>querySubObject</b></a> ( 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 ( ) )</li> </ul> <hr><a name="details"></a><h2>Detailed Description</h2> <p> This class is defined in the <b>Qt <a href="activeqt.html#ActiveQt">ActiveQt</a> Extension</b>, which can be found in the <tt>qt/extensions</tt> directory. It is not included in the main Qt API. <p> The QAxObject class provides a <a href="qobject.html">QObject</a> that wraps a COM object. <p> <p> 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 Qt properties, slots and signals. The base class, <a href="qaxbase.html">QAxBase</a>, provides an API to access the COM object directly through the IUnknown pointer. <p> QAxObject is a QObject and can be used as such, e.g. it can be organized in an object hierarchy, receive events and connect to signals and slots. <p> <b>Warning:</b> You can subclass QAxObject, but you cannot use the <a href="metaobjects.html#Q_OBJECT">Q_OBJECT</a> macro in the subclass (the generated <a href="moc.html#moc">moc</a>-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 <a href="qobject.html">QObject</a> subclass. <p> <hr><h2>Member Function Documentation</h2> <h3 class=fn><a name="QAxObject"></a>QAxObject::QAxObject ( <a href="qobject.html">QObject</a> * parent = 0, const char * name = 0 ) </h3> Creates an empty COM object and propagates <em>parent</em> and <em>name</em> to the <a href="qobject.html">QObject</a> constructor. To initialize the object, call <a href="qaxbase.html#setControl">setControl</a>. <h3 class=fn><a name="QAxObject-2"></a>QAxObject::QAxObject ( const <a href="qstring.html">QString</a> & c, <a href="qobject.html">QObject</a> * parent = 0, const char * name = 0 ) </h3> Creates a QAxObject that wraps the COM object <em>c</em>. <em>parent</em> and <em>name</em> are propagated to the <a href="qwidget.html">QWidget</a> contructor. <p> <p>See also <a href="qaxbase.html#control-prop">control</a>. <h3 class=fn><a name="QAxObject-3"></a>QAxObject::QAxObject ( IUnknown * iface, <a href="qobject.html">QObject</a> * parent = 0, const char * name = 0 ) </h3> Creates a QAxObject that wraps the COM object referenced by <em>iface</em>. <em>parent</em> and <em>name</em> are propagated to the <a href="qobject.html">QObject</a> contructor. <h3 class=fn><a name="~QAxObject"></a>QAxObject::~QAxObject () </h3> Releases the COM object and destroys the QAxObject, cleaning up all allocated resources. <h3 class=fn><a href="qvariant.html">QVariant</a> <a name="dynamicCall"></a>QAxBase::dynamicCall ( const <a href="qcstring.html">QCString</a> & function, const <a href="qvariant.html">QVariant</a> & var1 = QVariant ( ), const <a href="qvariant.html">QVariant</a> & var2 = QVariant ( ), const <a href="qvariant.html">QVariant</a> & var3 = QVariant ( ), const <a href="qvariant.html">QVariant</a> & var4 = QVariant ( ), const <a href="qvariant.html">QVariant</a> & var5 = QVariant ( ), const <a href="qvariant.html">QVariant</a> & var6 = QVariant ( ), const <a href="qvariant.html">QVariant</a> & var7 = QVariant ( ), const <a href="qvariant.html">QVariant</a> & var8 = QVariant ( ) ) </h3> Calls the COM object's method <em>function</em>, passing the parameters <em>var1</em>, <em>var1</em>, <em>var2</em>, <em>var3</em>, <em>var4</em>, <em>var5</em>, <em>var6</em>, <em>var7</em> and <em>var8</em>, and returns the value returned by the method, or an invalid <a href="qvariant.html">QVariant</a> if the method does not return a value or when the function call failed. <p> If <em>function</em> is a method of the object the string must be provided as the full prototype, for example as it would be written in a <a href="qobject.html#connect">QObject::connect</a>() call. <pre> activeX->dynamicCall( "Navigate(const <a href="qstring.html">QString</a>&)", "www.trolltech.com" ); </pre> <p> Alternatively a function can be called passing the parameters embedded in the string, e.g. above function can also be invoked using <pre> activeX->dynamicCall("Navigate(\"www.trolltech.com\"); </pre> 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. <p> If <em>function</em> is a property the string has to be the name of the property. The property setter is called when <em>var1</em> is a valid QVariant, otherwise the getter is called. <pre> activeX->dynamicCall( "Value", 5 ); <a href="qstring.html">QString</a> text = activeX->dynamicCall( "Text" ).toString(); </pre> Note that it is faster to get and set properties using <a href="qobject.html#property">QObject::property</a>() and <a href="qobject.html#setProperty">QObject::setProperty</a>(). <p> It is only possible to call functions through <a href="qaxbase.html#dynamicCall">dynamicCall</a>() that have parameters or return values of datatypes supported by <a href="qvariant.html">QVariant</a>. See the <a href="qaxbase.html">QAxBase</a> 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 <a href="qaxbase.html#queryInterface">queryInterface</a>() to retrieve the appropriate COM interface, and use the function directly. <p> <pre> IWebBrowser2 *webBrowser = 0; activeX->queryInterface( IID_IWebBrowser2, (void**)&webBrowser ); if ( webBrowser ) { webBrowser->Navigate2( pvarURL ); webBrowser->Release(); } </pre> <p> This is also more efficient. <p>Example: <a href="qaxcontainer-example-qutlook.html#x2720">qutlook/centralwidget.cpp</a>. <h3 class=fn><a href="qvariant.html">QVariant</a> <a name="dynamicCall-2"></a>QAxBase::dynamicCall ( const <a href="qcstring.html">QCString</a> & function, <a href="qvaluelist.html">QValueList</a><QVariant> & vars ) </h3> This is an overloaded member function, provided for convenience. It behaves essentially like the above function. <p> Calls the COM object's method <em>function</em>, passing the parameters in <em>vars</em>, 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 <a href="qvariant.html">QVariant</a> object. <p> The QVariant objects in <em>vars</em> are updated when the method has out-parameters. <h3 class=fn><a href="qaxobject.html">QAxObject</a> * <a name="querySubObject"></a>QAxBase::querySubObject ( const <a href="qcstring.html">QCString</a> & name, const <a href="qvariant.html">QVariant</a> & var1 = QVariant ( ), const <a href="qvariant.html">QVariant</a> & var2 = QVariant ( ), const <a href="qvariant.html">QVariant</a> & var3 = QVariant ( ), const <a href="qvariant.html">QVariant</a> & var4 = QVariant ( ), const <a href="qvariant.html">QVariant</a> & var5 = QVariant ( ), const <a href="qvariant.html">QVariant</a> & var6 = QVariant ( ), const <a href="qvariant.html">QVariant</a> & var7 = QVariant ( ), const <a href="qvariant.html">QVariant</a> & var8 = QVariant ( ) ) </h3> Returns a pointer to a QAxObject wrapping the COM object provided by the method or property <em>name</em>, passing passing the parameters <em>var1</em>, <em>var1</em>, <em>var2</em>, <em>var3</em>, <em>var4</em>, <em>var5</em>, <em>var6</em>, <em>var7</em> and <em>var8</em>. <p> If <em>name</em> is provided by a method the string must include the full function prototype. <p> If <em>name</em> is a property the string must be the name of the property, and <em>var1</em>, ... <em>var8</em> are ignored. <p> The returned QAxObject is a child of this object (which is either of type QAxObject or <a href="qaxwidget.html">QAxWidget</a>), 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. <p> 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. <p> <pre> <a href="qaxwidget.html">QAxWidget</a> outlook( "Outlook.Application" ); QAxObject *session = outlook.<a href="qaxbase.html#querySubObject">querySubObject</a>( "Session" ); if ( session ) { QAxObject *defFolder = session-><a href="qaxbase.html#querySubObject">querySubObject</a>( "GetDefaultFolder(OlDefaultFolders)", "olFolderContacts" ); //... } </pre> <p>Example: <a href="qaxcontainer-example-qutlook.html#x2721">qutlook/centralwidget.cpp</a>. <!-- eof --> <hr><p> This file is part of the <a href="index.html">Qt toolkit</a>. Copyright © 1995-2007 <a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center> <table width=100% cellspacing=0 border=0><tr> <td>Copyright © 2007 <a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a> <td align=right><div align=right>Qt 3.3.8</div> </table></div></address></body> </html>