wxWidgets/wxPython/contrib/activex/wxie/doxydoc/wxactivex_8h.html
Robin Dunn b7c75283f2 Lindsay Mathieson's newest wxActiveX class has been wrapped into a new
extension module called wx.activex.  Lots of demo and lib updates to
go along with it.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@26301 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2004-03-23 05:29:50 +00:00

217 lines
11 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>wxactivex.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3-rc3 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
<hr><h1>wxactivex.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
implements <a class="el" href="classwxActiveX.html">wxActiveX</a> window class and OLE tools
<p>
<p>
Definition in file <a class="el" href="wxactivex_8h-source.html">wxactivex.h</a>.
<p>
<code>#include &lt;wx/setup.h&gt;</code><br>
<code>#include &lt;wx/wx.h&gt;</code><br>
<code>#include &lt;wx/variant.h&gt;</code><br>
<code>#include &lt;wx/datetime.h&gt;</code><br>
<code>#include &lt;oleidl.h&gt;</code><br>
<code>#include &lt;exdisp.h&gt;</code><br>
<code>#include &lt;docobj.h&gt;</code><br>
<code>#include &lt;iostream&gt;</code><br>
<code>#include &lt;vector&gt;</code><br>
<code>#include &lt;map&gt;</code><br>
<p>
<a href="wxactivex_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><a class="el" href="namespaceNS__wxActiveX.html">NS_wxActiveX</a></td></tr>
<tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><b>std</b></td></tr>
<tr><td colspan=2><br><h2>Data Structures</h2></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classwxAutoOleInterface.html">wxAutoOleInterface</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Template class for smart interface handling.</em> <a href="classwxAutoOleInterface.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX.html">wxActiveX</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Main class for embedding a ActiveX control.</em> <a href="classwxActiveX.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX_1_1ParamX.html">ParamX</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>General parameter and return type infoformation for Events, Properties and Methods.</em> <a href="classwxActiveX_1_1ParamX.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX_1_1FuncX.html">FuncX</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Type &amp; Parameter info for Events and Methods.</em> <a href="classwxActiveX_1_1FuncX.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX_1_1PropX.html">PropX</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Type info for properties.</em> <a href="classwxActiveX_1_1PropX.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a10" doxytag="wxactivex.h::EVT_ACTIVEX"></a>
#define&nbsp;</td><td valign=bottom><a class="el" href="wxactivex_8h.html#a10">EVT_ACTIVEX</a>(id, eventName, fn)&nbsp;&nbsp;&nbsp;DECLARE_EVENT_TABLE_ENTRY(RegisterActiveXEvent(wxT(eventName)), id, -1, (wxObjectEventFunction) (wxEventFunction) (wxActiveXEventFunction) &amp; fn, (wxObject *) NULL ),</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Event handle for events by name.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a11" doxytag="wxactivex.h::EVT_ACTIVEX_DISPID"></a>
#define&nbsp;</td><td valign=bottom><a class="el" href="wxactivex_8h.html#a11">EVT_ACTIVEX_DISPID</a>(id, eventDispId, fn)&nbsp;&nbsp;&nbsp;DECLARE_EVENT_TABLE_ENTRY(RegisterActiveXEvent(eventDispId), id, -1, (wxObjectEventFunction) (wxEventFunction) (wxActiveXEventFunction) &amp; fn, (wxObject *) NULL ),</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Event handle for events by DISPID (dispath id).</em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a13" doxytag="wxactivex.h::OLEHResultToString"></a>
wxString&nbsp;</td><td valign=bottom><a class="el" href="wxactivex_8h.html#a13">OLEHResultToString</a> (HRESULT hr)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Converts a std HRESULT to its error code. Hardcoded, by no means a definitive list.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a14" doxytag="wxactivex.h::GetIIDName"></a>
wxString&nbsp;</td><td valign=bottom><a class="el" href="wxactivex_8h.html#a14">GetIIDName</a> (REFIID riid)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Returns the string description of a IID. Hardcoded, by no means a definitive list.</em></font><br><br></td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a name="a3" doxytag="wxactivex.h::DECLARE_OLE_UNKNOWN"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define DECLARE_OLE_UNKNOWN</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">cls&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre><span class="keyword">private</span>:\
<span class="keyword">class </span>TAutoInitInt\
{\
<span class="keyword">public</span>:\
LONG l;\
TAutoInitInt() : l(0) {}\
};\
TAutoInitInt refCount, lockCount;\
wxOleInit oleInit;\
<span class="keyword">static</span> <span class="keywordtype">void</span> _GetInterface(cls *self, REFIID iid, <span class="keywordtype">void</span> **_interface, <span class="keyword">const</span> <span class="keywordtype">char</span> *&amp;desc);\
<span class="keyword">public</span>:\
LONG GetRefCount();\
HRESULT STDMETHODCALLTYPE QueryInterface(REFIID iid, <span class="keywordtype">void</span> ** ppvObject);\
ULONG STDMETHODCALLTYPE AddRef();\
ULONG STDMETHODCALLTYPE Release();\
ULONG STDMETHODCALLTYPE AddLock();\
ULONG STDMETHODCALLTYPE ReleaseLock()
</pre></div>
<p>
Definition at line <a class="el" href="wxactivex_8h-source.html#l00184">184</a> of file <a class="el" href="wxactivex_8h-source.html">wxactivex.h</a>. </td>
</tr>
</table>
<a name="a5" doxytag="wxactivex.h::DEFINE_OLE_BASE"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define DEFINE_OLE_BASE</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">cls&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre><span class="keywordtype">void</span> cls::_GetInterface(cls *self, REFIID iid, <span class="keywordtype">void</span> **_interface, <span class="keyword">const</span> <span class="keywordtype">char</span> *&amp;desc)\
{\
*_interface = NULL;\
desc = NULL;
</pre></div>
<p>
Definition at line <a class="el" href="wxactivex_8h-source.html#l00264">264</a> of file <a class="el" href="wxactivex_8h-source.html">wxactivex.h</a>. </td>
</tr>
</table>
<a name="a6" doxytag="wxactivex.h::OLE_INTERFACE"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define OLE_INTERFACE</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">_iid, <tr>
<td></td>
<td></td>
<td class="md" nowrap>_type&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre><span class="keywordflow">if</span> (IsEqualIID(iid, _iid))\
{\
WXOLE_TRACE(<span class="stringliteral">"Found Interface &lt;"</span> # _type <span class="stringliteral">"&gt;"</span>);\
*_interface = (IUnknown *) (_type *) self;\
desc = # _iid;\
<span class="keywordflow">return</span>;\
}
</pre></div>
<p>
Definition at line <a class="el" href="wxactivex_8h-source.html#l00270">270</a> of file <a class="el" href="wxactivex_8h-source.html">wxactivex.h</a>. </td>
</tr>
</table>
<a name="a8" doxytag="wxactivex.h::OLE_INTERFACE_CUSTOM"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define OLE_INTERFACE_CUSTOM</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">func&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre><span class="keywordflow">if</span> (func(self, iid, _interface, desc))\
{\
<span class="keywordflow">return</span>;\
}
</pre></div>
<p>
Definition at line <a class="el" href="wxactivex_8h-source.html#l00281">281</a> of file <a class="el" href="wxactivex_8h-source.html">wxactivex.h</a>. </td>
</tr>
</table>
<hr><address style="align: right;"><small>Generated on Tue Apr 1 14:51:12 2003 for wxActiveX by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.3-rc3 </small></address>
</body>
</html>