wxPython/contrib/activex/wxie/doxydoc/wxactivex_8h.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>wxactivex.h File Reference</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3-rc3 -->
   7 <center>
   8 <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>
   9 <hr><h1>wxactivex.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
  10 implements <a class="el" href="classwxActiveX.html">wxActiveX</a> window class and OLE tools
  11 <p>
  12
  13 <p>
  14 Definition in file <a class="el" href="wxactivex_8h-source.html">wxactivex.h</a>.
  15 <p>
  16 <code>#include &lt;wx/setup.h&gt;</code><br>
  17 <code>#include &lt;wx/wx.h&gt;</code><br>
  18 <code>#include &lt;wx/variant.h&gt;</code><br>
  19 <code>#include &lt;wx/datetime.h&gt;</code><br>
  20 <code>#include &lt;oleidl.h&gt;</code><br>
  21 <code>#include &lt;exdisp.h&gt;</code><br>
  22 <code>#include &lt;docobj.h&gt;</code><br>
  23 <code>#include &lt;iostream&gt;</code><br>
  24 <code>#include &lt;vector&gt;</code><br>
  25 <code>#include &lt;map&gt;</code><br>
  26
  27 <p>
  28 <a href="wxactivex_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
  29 <tr><td></td></tr>
  30 <tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
  31 <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>
  32 <tr><td nowrap align=right valign=top>namespace &nbsp;</td><td valign=bottom><b>std</b></td></tr>
  33 <tr><td colspan=2><br><h2>Data Structures</h2></td></tr>
  34 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classwxAutoOleInterface.html">wxAutoOleInterface</a></td></tr>
  35 <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>
  36 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX.html">wxActiveX</a></td></tr>
  37 <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>
  38 <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>
  39 <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>
  40 <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>
  41 <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>
  42 <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>
  43 <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>
  44 <tr><td colspan=2><br><h2>Defines</h2></td></tr>
  45 <tr><td nowrap align=right valign=top><a name="a10" doxytag="wxactivex.h::EVT_ACTIVEX"></a>
  46 #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>
  47 <tr><td>&nbsp;</td><td><font size=-1><em>Event handle for events by name.</em></font><br><br></td></tr>
  48 <tr><td nowrap align=right valign=top><a name="a11" doxytag="wxactivex.h::EVT_ACTIVEX_DISPID"></a>
  49 #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>
  50 <tr><td>&nbsp;</td><td><font size=-1><em>Event handle for events by DISPID (dispath id).</em></font><br><br></td></tr>
  51 <tr><td colspan=2><br><h2>Functions</h2></td></tr>
  52 <tr><td nowrap align=right valign=top><a name="a13" doxytag="wxactivex.h::OLEHResultToString"></a>
  53 wxString&nbsp;</td><td valign=bottom><a class="el" href="wxactivex_8h.html#a13">OLEHResultToString</a> (HRESULT hr)</td></tr>
  54 <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>
  55 <tr><td nowrap align=right valign=top><a name="a14" doxytag="wxactivex.h::GetIIDName"></a>
  56 wxString&nbsp;</td><td valign=bottom><a class="el" href="wxactivex_8h.html#a14">GetIIDName</a> (REFIID riid)</td></tr>
  57 <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>
  58 </table>
  59 <hr><h2>Define Documentation</h2>
  60 <a name="a3" doxytag="wxactivex.h::DECLARE_OLE_UNKNOWN"></a><p>
  61 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  62   <tr>
  63     <td class="md">
  64       <table cellpadding="0" cellspacing="0" border="0">
  65         <tr>
  66           <td class="md" nowrap valign="top"> #define DECLARE_OLE_UNKNOWN</td>
  67           <td class="md" valign="top">(&nbsp;</td>
  68           <td class="md" nowrap valign="top">cls&nbsp;</td>
  69           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
  70           <td class="md" valign="top">)&nbsp;</td>
  71           <td class="md" nowrap>
  72       </table>
  73     </td>
  74   </tr>
  75 </table>
  76 <table cellspacing=5 cellpadding=0 border=0>
  77   <tr>
  78     <td>
  79       &nbsp;
  80     </td>
  81     <td>
  82
  83 <p>
  84 <b>Value:</b><div class="fragment"><pre><span class="keyword">private</span>:\
  85     <span class="keyword">class </span>TAutoInitInt\
  86     {\
  87         <span class="keyword">public</span>:\
  88         LONG l;\
  89         TAutoInitInt() : l(0) {}\
  90     };\
  91     TAutoInitInt refCount, lockCount;\
  92     wxOleInit oleInit;\
  93         <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);\
  94     <span class="keyword">public</span>:\
  95     LONG GetRefCount();\
  96         HRESULT STDMETHODCALLTYPE QueryInterface(REFIID iid, <span class="keywordtype">void</span> ** ppvObject);\
  97         ULONG STDMETHODCALLTYPE AddRef();\
  98         ULONG STDMETHODCALLTYPE Release();\
  99     ULONG STDMETHODCALLTYPE AddLock();\
 100         ULONG STDMETHODCALLTYPE ReleaseLock()
 101 </pre></div>
 102 <p>
 103 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>
 104   </tr>
 105 </table>
 106 <a name="a5" doxytag="wxactivex.h::DEFINE_OLE_BASE"></a><p>
 107 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 108   <tr>
 109     <td class="md">
 110       <table cellpadding="0" cellspacing="0" border="0">
 111         <tr>
 112           <td class="md" nowrap valign="top"> #define DEFINE_OLE_BASE</td>
 113           <td class="md" valign="top">(&nbsp;</td>
 114           <td class="md" nowrap valign="top">cls&nbsp;</td>
 115           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 116           <td class="md" valign="top">)&nbsp;</td>
 117           <td class="md" nowrap>
 118       </table>
 119     </td>
 120   </tr>
 121 </table>
 122 <table cellspacing=5 cellpadding=0 border=0>
 123   <tr>
 124     <td>
 125       &nbsp;
 126     </td>
 127     <td>
 128
 129 <p>
 130 <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)\
 131         {\
 132                 *_interface = NULL;\
 133             desc = NULL;
 134 </pre></div>
 135 <p>
 136 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>
 137   </tr>
 138 </table>
 139 <a name="a6" doxytag="wxactivex.h::OLE_INTERFACE"></a><p>
 140 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 141   <tr>
 142     <td class="md">
 143       <table cellpadding="0" cellspacing="0" border="0">
 144         <tr>
 145           <td class="md" nowrap valign="top"> #define OLE_INTERFACE</td>
 146           <td class="md" valign="top">(&nbsp;</td>
 147           <td class="md" nowrap valign="top">_iid,         <tr>
 148           <td></td>
 149           <td></td>
 150           <td class="md" nowrap>_type&nbsp;</td>
 151           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 152           <td class="md" valign="top">)&nbsp;</td>
 153           <td class="md" nowrap>
 154       </table>
 155     </td>
 156   </tr>
 157 </table>
 158 <table cellspacing=5 cellpadding=0 border=0>
 159   <tr>
 160     <td>
 161       &nbsp;
 162     </td>
 163     <td>
 164
 165 <p>
 166 <b>Value:</b><div class="fragment"><pre><span class="keywordflow">if</span> (IsEqualIID(iid, _iid))\
 167     {\
 168         WXOLE_TRACE(<span class="stringliteral">"Found Interface &lt;"</span> # _type <span class="stringliteral">"&gt;"</span>);\
 169         *_interface = (IUnknown *) (_type *) self;\
 170         desc = # _iid;\
 171         <span class="keywordflow">return</span>;\
 172     }
 173 </pre></div>
 174 <p>
 175 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>
 176   </tr>
 177 </table>
 178 <a name="a8" doxytag="wxactivex.h::OLE_INTERFACE_CUSTOM"></a><p>
 179 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 180   <tr>
 181     <td class="md">
 182       <table cellpadding="0" cellspacing="0" border="0">
 183         <tr>
 184           <td class="md" nowrap valign="top"> #define OLE_INTERFACE_CUSTOM</td>
 185           <td class="md" valign="top">(&nbsp;</td>
 186           <td class="md" nowrap valign="top">func&nbsp;</td>
 187           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 188           <td class="md" valign="top">)&nbsp;</td>
 189           <td class="md" nowrap>
 190       </table>
 191     </td>
 192   </tr>
 193 </table>
 194 <table cellspacing=5 cellpadding=0 border=0>
 195   <tr>
 196     <td>
 197       &nbsp;
 198     </td>
 199     <td>
 200
 201 <p>
 202 <b>Value:</b><div class="fragment"><pre><span class="keywordflow">if</span> (func(self, iid, _interface, desc))\
 203         {\
 204         <span class="keywordflow">return</span>;\
 205         }
 206 </pre></div>
 207 <p>
 208 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>
 209   </tr>
 210 </table>
 211 <hr><address style="align: right;"><small>Generated on Tue Apr 1 14:51:12 2003 for wxActiveX by
 212 <a href="http://www.doxygen.org/index.html">
 213 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 214 width=110 height=53></a>1.3-rc3 </small></address>
 215 </body>
 216 </html>