diff options
| author | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2012-01-26 23:32:43 -0600 |
|---|---|---|
| committer | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2012-01-26 23:32:43 -0600 |
| commit | ea318d1431c89e647598c510c4245c6571aa5f46 (patch) | |
| tree | 996d29b80c30d453dda86d1a23162d441628f169 /doc/html/qaxbase.html | |
| parent | aaf89d4b48f69c9293feb187db26362e550b5561 (diff) | |
| download | tqt3-ea318d1431c89e647598c510c4245c6571aa5f46.tar.gz tqt3-ea318d1431c89e647598c510c4245c6571aa5f46.zip | |
Update to latest tqt3 automated conversion
Diffstat (limited to 'doc/html/qaxbase.html')
| -rw-r--r-- | doc/html/qaxbase.html | 86 |
1 files changed, 43 insertions, 43 deletions
diff --git a/doc/html/qaxbase.html b/doc/html/qaxbase.html index 41c40da28..85cd20a0a 100644 --- a/doc/html/qaxbase.html +++ b/doc/html/qaxbase.html @@ -79,7 +79,7 @@ to initalize and access a COM object. <li class=fn>bool <a href="#initializeActive"><b>initializeActive</b></a> ( IUnknown ** ptr )</li> </ul> <hr><a name="details"></a><h2>Detailed Description</h2> -<p> This class is defined in the <b>TQt <a href="activeqt.html#ActiveTQt">ActiveTQt</a> Extension</b>, which can be found in the <tt>qt/extensions</tt> directory. It is not included in the main TQt API. +<p> This class is defined in the <b>TQt <a href="activentqt.html#ActiveTQt">ActiveTQt</a> Extension</b>, which can be found in the <tt>qt/extensions</tt> directory. It is not included in the main TQt API. <p> <p> The TQAxBase class is an abstract class that provides an API @@ -99,7 +99,7 @@ become available as TQt properties and slots. <p> 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 <a href="qobject.html#setProperty">setProperty()</a> and <a href="qobject.html#property">property()</a> as with <a href="qobject.html">TQObject</a>). Properties +Object Model (both subclasses are TQObjects, so you can use <a href="ntqobject.html#setProperty">setProperty()</a> and <a href="ntqobject.html#property">property()</a> as with <a href="ntqobject.html">TQObject</a>). Properties with multiple parameters are not supported. <p> <pre> activeX->setProperty( "text", "some text" ); @@ -116,14 +116,14 @@ object's IDispatch implementation can be called directly using <p> Outgoing events supported by the COM object are emitted as standard TQt signals. <p> <pre> - connect( webBrowser, SIGNAL(TitleChanged(const <a href="qstring.html">TQString</a>&)), - this, SLOT(setCaption(const <a href="qstring.html">TQString</a>&)) ); + connect( webBrowser, SIGNAL(TitleChanged(const <a href="ntqstring.html">TQString</a>&)), + this, SLOT(setCaption(const <a href="ntqstring.html">TQString</a>&)) ); </pre> <p> TQAxBase transparently converts between COM data types and the equivalent TQt data types. Some COM types have no equivalent TQt data structure. <p> 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 <a href="qobject.html">TQObject</a> property +The second column is the TQt type that can be used with the <a href="ntqobject.html">TQObject</a> 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. @@ -141,7 +141,7 @@ type that is used in the prototype of signals and slots for out-parameters. <tr bgcolor="#d0d0d0"> <td valign="top">BSTR <td valign="top">TQString -<td valign="top">const <a href="qstring.html">TQString</a>& +<td valign="top">const <a href="ntqstring.html">TQString</a>& <td valign="top">TQString& <tr bgcolor="#f0f0f0"> <td valign="top">char, short, int, long @@ -161,7 +161,7 @@ type that is used in the prototype of signals and slots for out-parameters. <tr bgcolor="#d0d0d0"> <td valign="top">DATE <td valign="top">TQDateTime -<td valign="top">const <a href="qdatetime.html">TQDateTime</a>& +<td valign="top">const <a href="ntqdatetime.html">TQDateTime</a>& <td valign="top">TQDateTime& <tr bgcolor="#f0f0f0"> <td valign="top">CY @@ -171,12 +171,12 @@ type that is used in the prototype of signals and slots for out-parameters. <tr bgcolor="#d0d0d0"> <td valign="top">OLE_COLOR <td valign="top">TQColor -<td valign="top">const <a href="qcolor.html">TQColor</a>& +<td valign="top">const <a href="ntqcolor.html">TQColor</a>& <td valign="top">TQColor& <tr bgcolor="#f0f0f0"> <td valign="top">SAFEARRAY(VARIANT) <td valign="top">TQValueList<TQVariant> -<td valign="top">const <a href="qvaluelist.html">TQValueList</a><TQVariant>& +<td valign="top">const <a href="ntqvaluelist.html">TQValueList</a><TQVariant>& <td valign="top">TQValueList<TQVariant>& <tr bgcolor="#d0d0d0"> <td valign="top">SAFEARRAY(BYTE) @@ -186,22 +186,22 @@ type that is used in the prototype of signals and slots for out-parameters. <tr bgcolor="#f0f0f0"> <td valign="top">SAFEARRAY(BSTR) <td valign="top">TQStringList -<td valign="top">const <a href="qstringlist.html">TQStringList</a>& +<td valign="top">const <a href="ntqstringlist.html">TQStringList</a>& <td valign="top">TQStringList& <tr bgcolor="#d0d0d0"> <td valign="top">VARIANT <td valign="top">type-dependent -<td valign="top">const <a href="qvariant.html">TQVariant</a>& +<td valign="top">const <a href="ntqvariant.html">TQVariant</a>& <td valign="top">TQVariant& <tr bgcolor="#f0f0f0"> <td valign="top">IFontDisp* <td valign="top">TQFont -<td valign="top">const <a href="qfont.html">TQFont</a>& +<td valign="top">const <a href="ntqfont.html">TQFont</a>& <td valign="top">TQFont& <tr bgcolor="#d0d0d0"> <td valign="top">IPictureDisp* <td valign="top">TQPixmap -<td valign="top">const <a href="qpixmap.html">TQPixmap</a>& +<td valign="top">const <a href="ntqpixmap.html">TQPixmap</a>& <td valign="top">TQPixmap& <tr bgcolor="#f0f0f0"> <td valign="top">IDispatch* @@ -240,21 +240,21 @@ use the TQAxBase API like this: <pre> <a href="qaxobject.html">TQAxObject</a> object( "<CLSID>" ); - <a href="qstring.html">TQString</a> text = object.<a href="qobject.html#property">property</a>( "text" ).toString(); - object.<a href="qobject.html#setProperty">setProperty</a>( "font", TQFont( "Times New Roman", 12 ) ); + <a href="ntqstring.html">TQString</a> text = object.<a href="ntqobject.html#property">property</a>( "text" ).toString(); + object.<a href="ntqobject.html#setProperty">setProperty</a>( "font", TQFont( "Times New Roman", 12 ) ); connect( this, SIGNAL(clicked(int)), &object, SLOT(showColumn(int)) ); - bool ok = object.<a href="#dynamicCall">dynamicCall</a>( "addColumn(const <a href="qstring.html">TQString</a>&)", "Column 1" ).toBool(); + bool ok = object.<a href="#dynamicCall">dynamicCall</a>( "addColumn(const <a href="ntqstring.html">TQString</a>&)", "Column 1" ).toBool(); - <a href="qvaluelist.html">TQValueList</a><TQVariant> varlist; - <a href="qvaluelist.html">TQValueList</a><TQVariant> parameters; + <a href="ntqvaluelist.html">TQValueList</a><TQVariant> varlist; + <a href="ntqvaluelist.html">TQValueList</a><TQVariant> parameters; parameters << TQVariant( varlist ); int n = object.<a href="#dynamicCall">dynamicCall</a>( "fillList(TQValueList<TQVariant>&)", parameters ).toInt(); <a href="qaxobject.html">TQAxObject</a> *item = object.querySubItem( "item(int)", 5 ); </pre> -<p> Note that the <a href="qvaluelist.html">TQValueList</a> the object should fill has to be provided as an +<p> Note that the <a href="ntqvaluelist.html">TQValueList</a> the object should fill has to be provided as an element in the parameter list of TQVariants. <p> If you need to access properties or pass parameters of unsupported datatypes you must access the COM object directly through its @@ -281,7 +281,7 @@ data as provided by the COM event. <hr><h2>Member Type Documentation</h2> <h3 class=fn><a name="PropertyBag-enum"></a>TQAxBase::PropertyBag</h3> -<p> A <a href="qmap.html">TQMap</a><TQString,TQVariant> that can store properties as name:value pairs. +<p> A <a href="ntqmap.html">TQMap</a><TQString,TQVariant> that can store properties as name:value pairs. <hr><h2>Member Function Documentation</h2> <h3 class=fn><a name="TQAxBase"></a>TQAxBase::TQAxBase ( IUnknown * iface = 0 ) @@ -294,9 +294,9 @@ object. Shuts down the COM object and destroys the TQAxBase object. <p> <p>See also <a href="#clear">clear</a>(). -<h3 class=fn><a href="qvariant.html">TQVariant</a> <a name="asVariant"></a>TQAxBase::asVariant () const +<h3 class=fn><a href="ntqvariant.html">TQVariant</a> <a name="asVariant"></a>TQAxBase::asVariant () const </h3> -Returns a <a href="qvariant.html">TQVariant</a> that wraps the COM object. The variant can +Returns a <a href="ntqvariant.html">TQVariant</a> that wraps the COM object. The variant can then be used as a parameter in e.g. <a href="#dynamicCall">dynamicCall</a>(). <h3 class=fn>void <a name="clear"></a>TQAxBase::clear ()<tt> [virtual]</tt> @@ -306,7 +306,7 @@ Disconnects and destroys the COM object. destructor to call <a href="#clear">clear</a>(), and call this implementation at the end of your clear() function. -<h3 class=fn><a href="qstring.html">TQString</a> <a name="control"></a>TQAxBase::control () const +<h3 class=fn><a href="ntqstring.html">TQString</a> <a name="control"></a>TQAxBase::control () const </h3><p>Returns the name of the COM object wrapped by this TQAxBase object. See the <a href="qaxbase.html#control-prop">"control"</a> property for details. <h3 class=fn>void <a name="disableClassInfo"></a>TQAxBase::disableClassInfo () @@ -344,18 +344,18 @@ the COM interfaces provided by <a href="#queryInterface">queryInterface</a>(). construction of the object (without passing an object identifier), and before calling <a href="qaxwidget.html">TQAxWidget</a>->setControl(). -<h3 class=fn><a href="qvariant.html">TQVariant</a> <a name="dynamicCall"></a>TQAxBase::dynamicCall ( const <a href="qcstring.html">TQCString</a> & function, const <a href="qvariant.html">TQVariant</a> & var1 = TQVariant ( ), const <a href="qvariant.html">TQVariant</a> & var2 = TQVariant ( ), const <a href="qvariant.html">TQVariant</a> & var3 = TQVariant ( ), const <a href="qvariant.html">TQVariant</a> & var4 = TQVariant ( ), const <a href="qvariant.html">TQVariant</a> & var5 = TQVariant ( ), const <a href="qvariant.html">TQVariant</a> & var6 = TQVariant ( ), const <a href="qvariant.html">TQVariant</a> & var7 = TQVariant ( ), const <a href="qvariant.html">TQVariant</a> & var8 = TQVariant ( ) ) +<h3 class=fn><a href="ntqvariant.html">TQVariant</a> <a name="dynamicCall"></a>TQAxBase::dynamicCall ( const <a href="ntqcstring.html">TQCString</a> & function, const <a href="ntqvariant.html">TQVariant</a> & var1 = TQVariant ( ), const <a href="ntqvariant.html">TQVariant</a> & var2 = TQVariant ( ), const <a href="ntqvariant.html">TQVariant</a> & var3 = TQVariant ( ), const <a href="ntqvariant.html">TQVariant</a> & var4 = TQVariant ( ), const <a href="ntqvariant.html">TQVariant</a> & var5 = TQVariant ( ), const <a href="ntqvariant.html">TQVariant</a> & var6 = TQVariant ( ), const <a href="ntqvariant.html">TQVariant</a> & var7 = TQVariant ( ), const <a href="ntqvariant.html">TQVariant</a> & var8 = TQVariant ( ) ) </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">TQVariant</a> if the method does not return +the method, or an invalid <a href="ntqvariant.html">TQVariant</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">TQObject::connect</a>() call. +<a href="ntqobject.html#connect">TQObject::connect</a>() call. <pre> - activeX->dynamicCall( "Navigate(const <a href="qstring.html">TQString</a>&)", "www.trolltech.com" ); + activeX->dynamicCall( "Navigate(const <a href="ntqstring.html">TQString</a>&)", "www.trolltech.com" ); </pre> <p> Alternatively a function can be called passing the parameters embedded @@ -372,14 +372,14 @@ property. The property setter is called when <em>var1</em> is a valid TQVariant, otherwise the getter is called. <pre> activeX->dynamicCall( "Value", 5 ); - <a href="qstring.html">TQString</a> text = activeX->dynamicCall( "Text" ).toString(); + <a href="ntqstring.html">TQString</a> text = activeX->dynamicCall( "Text" ).toString(); </pre> Note that it is faster to get and set properties using -<a href="qobject.html#property">TQObject::property</a>() and <a href="qobject.html#setProperty">TQObject::setProperty</a>(). +<a href="ntqobject.html#property">TQObject::property</a>() and <a href="ntqobject.html#setProperty">TQObject::setProperty</a>(). <p> It is only possible to call functions through <a href="#dynamicCall">dynamicCall</a>() that have parameters or return values of datatypes supported by -<a href="qvariant.html">TQVariant</a>. See the TQAxBase class documentation for a list of +<a href="ntqvariant.html">TQVariant</a>. See the TQAxBase 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="#queryInterface">queryInterface</a>() to retrieve the appropriate COM interface, and @@ -396,18 +396,18 @@ use the function directly. <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">TQVariant</a> <a name="dynamicCall-2"></a>TQAxBase::dynamicCall ( const <a href="qcstring.html">TQCString</a> & function, <a href="qvaluelist.html">TQValueList</a><TQVariant> & vars ) +<h3 class=fn><a href="ntqvariant.html">TQVariant</a> <a name="dynamicCall-2"></a>TQAxBase::dynamicCall ( const <a href="ntqcstring.html">TQCString</a> & function, <a href="ntqvaluelist.html">TQValueList</a><TQVariant> & 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">TQVariant</a> object. +<a href="ntqvariant.html">TQVariant</a> object. <p> The TQVariant objects in <em>vars</em> are updated when the method has out-parameters. -<h3 class=fn>void <a name="exception"></a>TQAxBase::exception ( int code, const <a href="qstring.html">TQString</a> & source, const <a href="qstring.html">TQString</a> & desc, const <a href="qstring.html">TQString</a> & help )<tt> [signal]</tt> +<h3 class=fn>void <a name="exception"></a>TQAxBase::exception ( int code, const <a href="ntqstring.html">TQString</a> & source, const <a href="ntqstring.html">TQString</a> & desc, const <a href="ntqstring.html">TQString</a> & help )<tt> [signal]</tt> </h3> <p> This signal is emitted when the COM object throws an exception while called using the OLE automation @@ -415,12 +415,12 @@ interface IDispatch. <em>code</em>, <em>source</em>, <em>desc</em> and <em>help< provided by the COM server and can be used to provide useful feedback to the end user. <em>help</em> includes the help file, and the help context ID in brackets, e.g. "filename [id]". -<h3 class=fn><a href="qstring.html">TQString</a> <a name="generateDocumentation"></a>TQAxBase::generateDocumentation () +<h3 class=fn><a href="ntqstring.html">TQString</a> <a name="generateDocumentation"></a>TQAxBase::generateDocumentation () </h3> <p> 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 <a href="qtextbrowser.html">TQTextBrowser</a> widget. +or use it in e.g. a <a href="ntqtextbrowser.html">TQTextBrowser</a> widget. <h3 class=fn>bool <a name="initialize"></a>TQAxBase::initialize ( IUnknown ** ptr )<tt> [virtual protected]</tt> </h3> @@ -486,7 +486,7 @@ of the COM object returns all properties, or that the properties returned are the same as those available through the IDispatch interface. -<h3 class=fn>void <a name="propertyChanged"></a>TQAxBase::propertyChanged ( const <a href="qstring.html">TQString</a> & name )<tt> [signal]</tt> +<h3 class=fn>void <a name="propertyChanged"></a>TQAxBase::propertyChanged ( const <a href="ntqstring.html">TQString</a> & name )<tt> [signal]</tt> </h3> <p> If the COM object supports property notification, this signal gets @@ -501,7 +501,7 @@ Depending on the control implementation this setting might be ignored for some properties. <p> <p>See also <a href="#setPropertyWritable">setPropertyWritable</a>() and <a href="#propertyChanged">propertyChanged</a>(). -<h3 class=fn>long <a name="queryInterface"></a>TQAxBase::queryInterface ( const <a href="quuid.html">TQUuid</a> & uuid, void ** iface ) const +<h3 class=fn>long <a name="queryInterface"></a>TQAxBase::queryInterface ( const <a href="ntquuid.html">TQUuid</a> & uuid, void ** iface ) const </h3> Requests the interface <em>uuid</em> from the COM object and sets the value of <em>iface</em> to the provided interface, or to 0 if the @@ -509,7 +509,7 @@ requested interface could not be provided. <p> Returns the result of the QueryInterface implementation of the COM object. <p> <p>See also <a href="#control-prop">control</a>. -<h3 class=fn><a href="qaxobject.html">TQAxObject</a> * <a name="querySubObject"></a>TQAxBase::querySubObject ( const <a href="qcstring.html">TQCString</a> & name, const <a href="qvariant.html">TQVariant</a> & var1 = TQVariant ( ), const <a href="qvariant.html">TQVariant</a> & var2 = TQVariant ( ), const <a href="qvariant.html">TQVariant</a> & var3 = TQVariant ( ), const <a href="qvariant.html">TQVariant</a> & var4 = TQVariant ( ), const <a href="qvariant.html">TQVariant</a> & var5 = TQVariant ( ), const <a href="qvariant.html">TQVariant</a> & var6 = TQVariant ( ), const <a href="qvariant.html">TQVariant</a> & var7 = TQVariant ( ), const <a href="qvariant.html">TQVariant</a> & var8 = TQVariant ( ) ) +<h3 class=fn><a href="qaxobject.html">TQAxObject</a> * <a name="querySubObject"></a>TQAxBase::querySubObject ( const <a href="ntqcstring.html">TQCString</a> & name, const <a href="ntqvariant.html">TQVariant</a> & var1 = TQVariant ( ), const <a href="ntqvariant.html">TQVariant</a> & var2 = TQVariant ( ), const <a href="ntqvariant.html">TQVariant</a> & var3 = TQVariant ( ), const <a href="ntqvariant.html">TQVariant</a> & var4 = TQVariant ( ), const <a href="ntqvariant.html">TQVariant</a> & var5 = TQVariant ( ), const <a href="ntqvariant.html">TQVariant</a> & var6 = TQVariant ( ), const <a href="ntqvariant.html">TQVariant</a> & var7 = TQVariant ( ), const <a href="ntqvariant.html">TQVariant</a> & var8 = TQVariant ( ) ) </h3> Returns a pointer to a <a href="qaxobject.html">TQAxObject</a> wrapping the COM object provided by the method or property <em>name</em>, passing passing the parameters @@ -539,7 +539,7 @@ this method to navigate the hierarchy of the object model, e.g. <p>Example: <a href="qaxcontainer-example-qutlook.html#x2721">qutlook/centralwidget.cpp</a>. -<h3 class=fn>bool <a name="setControl"></a>TQAxBase::setControl ( const <a href="qstring.html">TQString</a> & ) +<h3 class=fn>bool <a name="setControl"></a>TQAxBase::setControl ( const <a href="ntqstring.html">TQString</a> & ) </h3><p>Sets the name of the COM object wrapped by this TQAxBase object. See the <a href="qaxbase.html#control-prop">"control"</a> property for details. <h3 class=fn>void <a name="setPropertyBag"></a>TQAxBase::setPropertyBag ( const <a href="qaxbase.html#PropertyBag-enum">PropertyBag</a> & bag ) @@ -563,7 +563,7 @@ Depending on the control implementation this setting might be ignored for some properties. <p> <p>See also <a href="#propertyWritable">propertyWritable</a>() and <a href="#propertyChanged">propertyChanged</a>(). -<h3 class=fn>void <a name="signal"></a>TQAxBase::signal ( const <a href="qstring.html">TQString</a> & name, int argc, void * argv )<tt> [signal]</tt> +<h3 class=fn>void <a name="signal"></a>TQAxBase::signal ( const <a href="ntqstring.html">TQString</a> & name, int argc, void * argv )<tt> [signal]</tt> </h3> <p> This generic signal gets emitted when the COM object issues the @@ -573,10 +573,10 @@ 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. <p> <pre> - void Receiver::slot( const <a href="qstring.html">TQString</a> &name, int argc, void *argv ) + void Receiver::slot( const <a href="ntqstring.html">TQString</a> &name, int argc, void *argv ) { VARIANTARG *params = (VARIANTARG*)argv; - if ( name.<a href="qstring.html#startsWith">startsWith</a>( "BeforeNavigate2(" ) ) { + if ( name.<a href="ntqstring.html#startsWith">startsWith</a>( "BeforeNavigate2(" ) ) { IDispatch *pDisp = params[argc-1].pdispVal; VARIANTARG URL = *params[argc-2].pvarVal; VARIANTARG Flags = *params[argc-3].pvarVal; @@ -592,7 +592,7 @@ parameter in the function. types. Otherwise, connect directly to the signal <em>name</em>. <hr><h2>Property Documentation</h2> -<h3 class=fn><a href="qstring.html">TQString</a> <a name="control-prop"></a>control</h3> +<h3 class=fn><a href="ntqstring.html">TQString</a> <a name="control-prop"></a>control</h3> <p>This property holds the name of the COM object wrapped by this TQAxBase object. <p>Setting this property initilializes the COM object. Any COM object previously set is shut down. |