wxPython/contrib/activex/wxie/doxydoc/classwxActiveX.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 class 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 Class Reference</h1><code>#include &lt;<a class="el" href="wxactivex_8h-source.html">wxactivex.h</a>&gt;</code>
  10 <p>
  11 <hr><a name="_details"></a><h2>Detailed Description</h2>
  12 Main class for embedding a ActiveX control.
  13 <p>
  14 Use by itself or derive from it <dl compact><dt><b>Note:</b></dt><dd>The utility program (wxie) can generate a list of events, methods &amp; properties for a control. First display the control (File|Display), then get the type info (ActiveX|Get Type Info) - these are copied to the clipboard. Eventually this will be expanded to autogenerate wxWindows source files for a control with all methods etc encapsulated. </dd></dl>
  15 <dl compact><dt><b>Usage: </b></dt><dd>construct using a ProgId or class id <div class="fragment"><pre> <span class="keyword">new</span> <a class="code" href="classwxActiveX.html#a0">wxActiveX</a>(parent, CLSID_WebBrowser, id, pos, size, style, name)
  16 </pre></div><div class="fragment"><pre> <span class="keyword">new</span> <a class="code" href="classwxActiveX.html#a0">wxActiveX</a>(parent, <span class="stringliteral">"ShockwaveFlash.ShockwaveFlash"</span>, id, pos, size, style, name)
  17 </pre></div></dd></dl>
  18 <dl compact><dt><b>Properties</b></dt><dd>Properties can be set using <code><a class="el" href="classwxActiveX.html#a11">SetProp()</a></code> and set/retrieved using <code><a class="el" href="classwxActiveX.html#a13">Prop()</a></code> <div class="fragment"><pre> <a class="code" href="classwxActiveX.html#a11">SetProp</a>(name, wxVariant(x))
  19 </pre></div>or <div class="fragment"><pre> wxString <a class="code" href="classwxActiveX.html#a13">Prop</a>(<span class="stringliteral">"&lt;name&gt;"</span>) = x
  20 </pre></div><div class="fragment"><pre> wxString result = <a class="code" href="classwxActiveX.html#a13">Prop</a>(<span class="stringliteral">"&lt;name&gt;"</span>)
  21 </pre></div><div class="fragment"><pre> flash_ctl.Prop(<span class="stringliteral">"movie"</span>) = <span class="stringliteral">"file:///movies/test.swf"</span>;
  22 </pre></div><div class="fragment"><pre> flash_ctl.Prop(<span class="stringliteral">"Playing"</span>) = <span class="keyword">false</span>;
  23 </pre></div><div class="fragment"><pre> wxString current_movie = flash_ctl.Prop(<span class="stringliteral">"movie"</span>);
  24 </pre></div></dd></dl>
  25 <dl compact><dt><b>Methods</b></dt><dd>Methods are invoked with <code><a class="el" href="classwxActiveX.html#a26">CallMethod()</a></code> <div class="fragment"><pre> wxVariant result = <a class="code" href="classwxActiveX.html#a26">CallMethod</a>(<span class="stringliteral">"&lt;name&gt;"</span>, args, nargs = -1)
  26 </pre></div><div class="fragment"><pre> wxVariant args[] = {0L, <span class="stringliteral">"file:///e:/dev/wxie/bug-zap.swf"</span>};
  27     wxVariant result = X-&gt;CallMethod(<span class="stringliteral">"LoadMovie"</span>, args);
  28 </pre></div></dd></dl>
  29 <dl compact><dt><b>events</b></dt><dd>respond to events with the <code><a class="el" href="wxactivex_8h.html#a10">EVT_ACTIVEX(controlId, eventName, handler)</a></code> &amp; <code><a class="el" href="wxactivex_8h.html#a11">EVT_ACTIVEX_DISPID(controlId, eventDispId, handler)</a></code> macros <div class="fragment"><pre>
  30     BEGIN_EVENT_TABLE(wxIEFrame, wxFrame)
  31         <a class="code" href="wxactivex_8h.html#a11">EVT_ACTIVEX_DISPID</a>(ID_MSHTML, DISPID_STATUSTEXTCHANGE,  OnMSHTMLStatusTextChangeX)
  32         <a class="code" href="wxactivex_8h.html#a10">EVT_ACTIVEX</a>(ID_MSHTML, <span class="stringliteral">"BeforeNavigate2"</span>,   OnMSHTMLBeforeNavigate2X)
  33         <a class="code" href="wxactivex_8h.html#a10">EVT_ACTIVEX</a>(ID_MSHTML, <span class="stringliteral">"TitleChange"</span>,       OnMSHTMLTitleChangeX)
  34         <a class="code" href="wxactivex_8h.html#a10">EVT_ACTIVEX</a>(ID_MSHTML, <span class="stringliteral">"NewWindow2"</span>,        OnMSHTMLNewWindow2X)
  35         <a class="code" href="wxactivex_8h.html#a10">EVT_ACTIVEX</a>(ID_MSHTML, <span class="stringliteral">"ProgressChange"</span>,    OnMSHTMLProgressChangeX)
  36     END_EVENT_TABLE()
  37 </pre></div></dd></dl>
  38
  39 <p>
  40
  41 <p>
  42 Definition at line <a class="el" href="wxactivex_8h-source.html#l00329">329</a> of file <a class="el" href="wxactivex_8h-source.html">wxactivex.h</a>.<table border=0 cellpadding=0 cellspacing=0>
  43 <tr><td></td></tr>
  44 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
  45 <tr><td nowrap align=right valign=top><a name="a0" doxytag="wxActiveX::wxActiveX"></a>
  46 &nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX.html#a0">wxActiveX</a> (wxWindow *parent, REFCLSID clsid, wxWindowID id=-1, const wxPoint &amp;pos=wxDefaultPosition, const wxSize &amp;size=wxDefaultSize, long style=0, const wxString &amp;name=wxPanelNameStr)</td></tr>
  47 <tr><td>&nbsp;</td><td><font size=-1><em>Create using clsid.</em></font><br><br></td></tr>
  48 <tr><td nowrap align=right valign=top><a name="a1" doxytag="wxActiveX::wxActiveX"></a>
  49 &nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX.html#a1">wxActiveX</a> (wxWindow *parent, wxString progId, wxWindowID id=-1, const wxPoint &amp;pos=wxDefaultPosition, const wxSize &amp;size=wxDefaultSize, long style=0, const wxString &amp;name=wxPanelNameStr)</td></tr>
  50 <tr><td>&nbsp;</td><td><font size=-1><em>create using progid.</em></font><br><br></td></tr>
  51 <tr><td nowrap align=right valign=top><a name="a3" doxytag="wxActiveX::GetEventCount"></a>
  52 int&nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX.html#a3">GetEventCount</a> () const</td></tr>
  53 <tr><td>&nbsp;</td><td><font size=-1><em>Number of events defined for this control.</em></font><br><br></td></tr>
  54 <tr><td nowrap align=right valign=top>const <a class="el" href="classwxActiveX_1_1FuncX.html">FuncX</a> &amp;&nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX.html#a4">GetEventDesc</a> (int idx) const</td></tr>
  55 <tr><td>&nbsp;</td><td><font size=-1><em>returns event description by index.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
  56 <tr><td nowrap align=right valign=top><a name="a5" doxytag="wxActiveX::GetPropCount"></a>
  57 int&nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX.html#a5">GetPropCount</a> () const</td></tr>
  58 <tr><td>&nbsp;</td><td><font size=-1><em>Number of properties defined for this control.</em></font><br><br></td></tr>
  59 <tr><td nowrap align=right valign=top>const <a class="el" href="classwxActiveX_1_1PropX.html">PropX</a> &amp;&nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX.html#a6">GetPropDesc</a> (int idx) const</td></tr>
  60 <tr><td>&nbsp;</td><td><font size=-1><em>returns property description by index.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
  61 <tr><td nowrap align=right valign=top>const <a class="el" href="classwxActiveX_1_1PropX.html">PropX</a> &amp;&nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX.html#a7">GetPropDesc</a> (wxString name) const</td></tr>
  62 <tr><td>&nbsp;</td><td><font size=-1><em>returns property description by name.</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
  63 <tr><td nowrap align=right valign=top><a name="a8" doxytag="wxActiveX::GetMethodCount"></a>
  64 int&nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX.html#a8">GetMethodCount</a> () const</td></tr>
  65 <tr><td>&nbsp;</td><td><font size=-1><em>Number of methods defined for this control.</em></font><br><br></td></tr>
  66 <tr><td nowrap align=right valign=top>const <a class="el" href="classwxActiveX_1_1FuncX.html">FuncX</a> &amp;&nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX.html#a9">GetMethodDesc</a> (int idx) const</td></tr>
  67 <tr><td>&nbsp;</td><td><font size=-1><em>returns method description by name.</em> <a href="#a9"></a><em></em></font><br><br></td></tr>
  68 <tr><td nowrap align=right valign=top>const <a class="el" href="classwxActiveX_1_1FuncX.html">FuncX</a> &amp;&nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX.html#a10">GetMethodDesc</a> (wxString name) const</td></tr>
  69 <tr><td>&nbsp;</td><td><font size=-1><em>returns method description by name.</em> <a href="#a10"></a><em></em></font><br><br></td></tr>
  70 <tr><td nowrap align=right valign=top><a name="a11" doxytag="wxActiveX::SetProp"></a>
  71 void&nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX.html#a11">SetProp</a> (MEMBERID name, VARIANTARG &amp;value)</td></tr>
  72 <tr><td>&nbsp;</td><td><font size=-1><em>Set property VARIANTARG value by MEMBERID.</em></font><br><br></td></tr>
  73 <tr><td nowrap align=right valign=top><a name="a12" doxytag="wxActiveX::SetProp"></a>
  74 void&nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX.html#a12">SetProp</a> (const wxString &amp;name, const wxVariant &amp;value)</td></tr>
  75 <tr><td>&nbsp;</td><td><font size=-1><em>Set property using wxVariant by name.</em></font><br><br></td></tr>
  76 <tr><td nowrap align=right valign=top>wxPropertySetter&nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX.html#a13">Prop</a> (wxString name)</td></tr>
  77 <tr><td>&nbsp;</td><td><font size=-1><em>Generic Get/Set Property by name. Automatically handles most types.</em> <a href="#a13"></a><em></em></font><br><br></td></tr>
  78 <tr><td nowrap align=right valign=top>wxVariant&nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX.html#a26">CallMethod</a> (wxString name, wxVariant args[], int nargs=-1)</td></tr>
  79 <tr><td>&nbsp;</td><td><font size=-1><em>Call a method of the ActiveX control. Automatically handles most types.</em> <a href="#a26"></a><em></em></font><br><br></td></tr>
  80 <tr><td colspan=2><br><h2>Related Functions</h2></td></tr>
  81 <tr><td colspan=2>(Note that these are not member functions.)<br><br></td></tr>
  82 <tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX.html#k0">MSWVariantToVariant</a> (VARIANTARG &amp;va, wxVariant &amp;vx)</td></tr>
  83 <tr><td>&nbsp;</td><td><font size=-1><em>Convert MSW VARIANTARG to wxVariant. Handles basic types, need to add:<ul>
  84 <li>VT_ARRAY | VT_*</li><li>better support for VT_UNKNOWN (currently treated as void *)</li><li>better support for VT_DISPATCH (currently treated as void *).</li></ul>
  85 </em> <a href="#k0"></a><em></em></font><br><br></td></tr>
  86 <tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classwxActiveX.html#k1">VariantToMSWVariant</a> (const wxVariant &amp;vx, VARIANTARG &amp;va)</td></tr>
  87 <tr><td>&nbsp;</td><td><font size=-1><em>Convert wxVariant to MSW VARIANTARG. Handles basic types, need to add:<ul>
  88 <li>VT_ARRAY | VT_*</li><li>better support for VT_UNKNOWN (currently treated as void *)</li><li>better support for VT_DISPATCH (currently treated as void *).</li></ul>
  89 </em> <a href="#k1"></a><em></em></font><br><br></td></tr>
  90 </table>
  91 <hr><h2>Member Function Documentation</h2>
  92 <a name="a4" doxytag="wxActiveX::GetEventDesc"></a><p>
  93 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  94   <tr>
  95     <td class="md">
  96       <table cellpadding="0" cellspacing="0" border="0">
  97         <tr>
  98           <td class="md" nowrap valign="top"> const <a class="el" href="classwxActiveX_1_1FuncX.html">FuncX</a>&amp; wxActiveX::GetEventDesc </td>
  99           <td class="md" valign="top">(&nbsp;</td>
 100           <td class="md" nowrap valign="top">int&nbsp;</td>
 101           <td class="mdname1" valign="top" nowrap>&nbsp; <em>idx</em>          </td>
 102           <td class="md" valign="top">)&nbsp;</td>
 103           <td class="md" nowrap> const</td>
 104         </tr>
 105
 106       </table>
 107     </td>
 108   </tr>
 109 </table>
 110 <table cellspacing=5 cellpadding=0 border=0>
 111   <tr>
 112     <td>
 113       &nbsp;
 114     </td>
 115     <td>
 116
 117 <p>
 118 returns event description by index.
 119 <p>
 120 throws exception for invalid index     </td>
 121   </tr>
 122 </table>
 123 <a name="a6" doxytag="wxActiveX::GetPropDesc"></a><p>
 124 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 125   <tr>
 126     <td class="md">
 127       <table cellpadding="0" cellspacing="0" border="0">
 128         <tr>
 129           <td class="md" nowrap valign="top"> const <a class="el" href="classwxActiveX_1_1PropX.html">PropX</a>&amp; wxActiveX::GetPropDesc </td>
 130           <td class="md" valign="top">(&nbsp;</td>
 131           <td class="md" nowrap valign="top">int&nbsp;</td>
 132           <td class="mdname1" valign="top" nowrap>&nbsp; <em>idx</em>          </td>
 133           <td class="md" valign="top">)&nbsp;</td>
 134           <td class="md" nowrap> const</td>
 135         </tr>
 136
 137       </table>
 138     </td>
 139   </tr>
 140 </table>
 141 <table cellspacing=5 cellpadding=0 border=0>
 142   <tr>
 143     <td>
 144       &nbsp;
 145     </td>
 146     <td>
 147
 148 <p>
 149 returns property description by index.
 150 <p>
 151 throws exception for invalid index     </td>
 152   </tr>
 153 </table>
 154 <a name="a7" doxytag="wxActiveX::GetPropDesc"></a><p>
 155 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 156   <tr>
 157     <td class="md">
 158       <table cellpadding="0" cellspacing="0" border="0">
 159         <tr>
 160           <td class="md" nowrap valign="top"> const <a class="el" href="classwxActiveX_1_1PropX.html">PropX</a>&amp; wxActiveX::GetPropDesc </td>
 161           <td class="md" valign="top">(&nbsp;</td>
 162           <td class="md" nowrap valign="top">wxString&nbsp;</td>
 163           <td class="mdname1" valign="top" nowrap>&nbsp; <em>name</em>          </td>
 164           <td class="md" valign="top">)&nbsp;</td>
 165           <td class="md" nowrap> const</td>
 166         </tr>
 167
 168       </table>
 169     </td>
 170   </tr>
 171 </table>
 172 <table cellspacing=5 cellpadding=0 border=0>
 173   <tr>
 174     <td>
 175       &nbsp;
 176     </td>
 177     <td>
 178
 179 <p>
 180 returns property description by name.
 181 <p>
 182 throws exception for invalid name     </td>
 183   </tr>
 184 </table>
 185 <a name="a9" doxytag="wxActiveX::GetMethodDesc"></a><p>
 186 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 187   <tr>
 188     <td class="md">
 189       <table cellpadding="0" cellspacing="0" border="0">
 190         <tr>
 191           <td class="md" nowrap valign="top"> const <a class="el" href="classwxActiveX_1_1FuncX.html">FuncX</a>&amp; wxActiveX::GetMethodDesc </td>
 192           <td class="md" valign="top">(&nbsp;</td>
 193           <td class="md" nowrap valign="top">int&nbsp;</td>
 194           <td class="mdname1" valign="top" nowrap>&nbsp; <em>idx</em>          </td>
 195           <td class="md" valign="top">)&nbsp;</td>
 196           <td class="md" nowrap> const</td>
 197         </tr>
 198
 199       </table>
 200     </td>
 201   </tr>
 202 </table>
 203 <table cellspacing=5 cellpadding=0 border=0>
 204   <tr>
 205     <td>
 206       &nbsp;
 207     </td>
 208     <td>
 209
 210 <p>
 211 returns method description by name.
 212 <p>
 213 throws exception for invalid index     </td>
 214   </tr>
 215 </table>
 216 <a name="a10" doxytag="wxActiveX::GetMethodDesc"></a><p>
 217 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 218   <tr>
 219     <td class="md">
 220       <table cellpadding="0" cellspacing="0" border="0">
 221         <tr>
 222           <td class="md" nowrap valign="top"> const <a class="el" href="classwxActiveX_1_1FuncX.html">FuncX</a>&amp; wxActiveX::GetMethodDesc </td>
 223           <td class="md" valign="top">(&nbsp;</td>
 224           <td class="md" nowrap valign="top">wxString&nbsp;</td>
 225           <td class="mdname1" valign="top" nowrap>&nbsp; <em>name</em>          </td>
 226           <td class="md" valign="top">)&nbsp;</td>
 227           <td class="md" nowrap> const</td>
 228         </tr>
 229
 230       </table>
 231     </td>
 232   </tr>
 233 </table>
 234 <table cellspacing=5 cellpadding=0 border=0>
 235   <tr>
 236     <td>
 237       &nbsp;
 238     </td>
 239     <td>
 240
 241 <p>
 242 returns method description by name.
 243 <p>
 244 throws exception for invalid name     </td>
 245   </tr>
 246 </table>
 247 <a name="a13" doxytag="wxActiveX::Prop"></a><p>
 248 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 249   <tr>
 250     <td class="md">
 251       <table cellpadding="0" cellspacing="0" border="0">
 252         <tr>
 253           <td class="md" nowrap valign="top"> wxPropertySetter wxActiveX::Prop </td>
 254           <td class="md" valign="top">(&nbsp;</td>
 255           <td class="md" nowrap valign="top">wxString&nbsp;</td>
 256           <td class="mdname1" valign="top" nowrap>&nbsp; <em>name</em>          </td>
 257           <td class="md" valign="top">)&nbsp;</td>
 258           <td class="md" nowrap><code> [inline]</code></td>
 259         </tr>
 260
 261       </table>
 262     </td>
 263   </tr>
 264 </table>
 265 <table cellspacing=5 cellpadding=0 border=0>
 266   <tr>
 267     <td>
 268       &nbsp;
 269     </td>
 270     <td>
 271
 272 <p>
 273 Generic Get/Set Property by name. Automatically handles most types.
 274 <p>
 275 <dl compact><dt><b>Parameters:</b></dt><dd>
 276   <table border="0" cellspacing="2" cellpadding="0">
 277     <tr><td valign=top><em>name</em>&nbsp;</td><td>Property name to read/set </td></tr>
 278   </table>
 279 </dl>
 280 <dl compact><dt><b>Returns:</b></dt><dd>wxPropertySetter, which has overloads for setting/getting the property </dd></dl>
 281 <p>
 282 <dl compact><dt><b>Usage:</b></dt><dd><ul>
 283 <li>Prop("&lt;name&gt;") = &lt;value&gt;</li><li>var = Prop("&lt;name&gt;")</li><li>e.g:<ul>
 284 <li><div class="fragment"><pre> flash_ctl.Prop(<span class="stringliteral">"movie"</span>) = <span class="stringliteral">"file:///movies/test.swf"</span>;
 285 </pre></div></li><li><div class="fragment"><pre> flash_ctl.Prop(<span class="stringliteral">"Playing"</span>) = <span class="keyword">false</span>;
 286 </pre></div></li><li><div class="fragment"><pre> wxString current_movie = flash_ctl.Prop(<span class="stringliteral">"movie"</span>);
 287 </pre></div></li></ul>
 288 </li></ul>
 289 </dd></dl>
 290 <dl compact><dt><b>Exceptions:</b></dt><dd>
 291   <table border="0" cellspacing="2" cellpadding="0">
 292     <tr><td valign=top><em>raises</em>&nbsp;</td><td>exception if &lt;name&gt; is invalid </td></tr>
 293   </table>
 294 </dl>
 295 <dl compact><dt><b>Note:</b></dt><dd>Have to add a few more type conversions yet ... </dd></dl>
 296
 297 <p>
 298 Definition at line <a class="el" href="wxactivex_8h-source.html#l00458">458</a> of file <a class="el" href="wxactivex_8h-source.html">wxactivex.h</a>.    </td>
 299   </tr>
 300 </table>
 301 <a name="a26" doxytag="wxActiveX::CallMethod"></a><p>
 302 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 303   <tr>
 304     <td class="md">
 305       <table cellpadding="0" cellspacing="0" border="0">
 306         <tr>
 307           <td class="md" nowrap valign="top"> wxVariant wxActiveX::CallMethod </td>
 308           <td class="md" valign="top">(&nbsp;</td>
 309           <td class="md" nowrap valign="top">wxString&nbsp;</td>
 310           <td class="mdname" nowrap>&nbsp; <em>name</em>, </td>
 311         </tr>
 312         <tr>
 313           <td></td>
 314           <td></td>
 315           <td class="md" nowrap>wxVariant&nbsp;</td>
 316           <td class="mdname" nowrap>&nbsp; <em>args</em>[], </td>
 317         </tr>
 318         <tr>
 319           <td></td>
 320           <td></td>
 321           <td class="md" nowrap>int&nbsp;</td>
 322           <td class="mdname" nowrap>&nbsp; <em>nargs</em> = -1</td>
 323         </tr>
 324         <tr>
 325           <td></td>
 326           <td class="md">)&nbsp;</td>
 327           <td class="md" colspan="2"></td>
 328         </tr>
 329
 330       </table>
 331     </td>
 332   </tr>
 333 </table>
 334 <table cellspacing=5 cellpadding=0 border=0>
 335   <tr>
 336     <td>
 337       &nbsp;
 338     </td>
 339     <td>
 340
 341 <p>
 342 Call a method of the ActiveX control. Automatically handles most types.
 343 <p>
 344 <dl compact><dt><b>Parameters:</b></dt><dd>
 345   <table border="0" cellspacing="2" cellpadding="0">
 346     <tr><td valign=top><em>name</em>&nbsp;</td><td>name of method to call </td></tr>
 347     <tr><td valign=top><em>args</em>&nbsp;</td><td>array of wxVariant's, defaults to NULL (no args) </td></tr>
 348     <tr><td valign=top><em>nargs</em>&nbsp;</td><td>number of arguments passed via args. Defaults to actual number of args for the method </td></tr>
 349   </table>
 350 </dl>
 351 <dl compact><dt><b>Returns:</b></dt><dd>wxVariant </dd></dl>
 352 <p>
 353 <dl compact><dt><b>Usage:</b></dt><dd><ul>
 354 <li>result = CallMethod("&lt;name&gt;", args, nargs)</li><li>e.g.</li><li><div class="fragment"><pre>
 355             wxVariant args[] = {0L, <span class="stringliteral">"file:///e:/dev/wxie/bug-zap.swf"</span>};
 356             wxVariant result = X-&gt;CallMethod(<span class="stringliteral">"LoadMovie"</span>, args);
 357 </pre></div></li></ul>
 358 </dd></dl>
 359 <dl compact><dt><b>Exceptions:</b></dt><dd>
 360   <table border="0" cellspacing="2" cellpadding="0">
 361     <tr><td valign=top><em>raises</em>&nbsp;</td><td>exception if &lt;name&gt; is invalid </td></tr>
 362   </table>
 363 </dl>
 364 <dl compact><dt><b>Note:</b></dt><dd>Since wxVariant has built in type conversion, most the std types can be passed easily </dd></dl>
 365     </td>
 366   </tr>
 367 </table>
 368 <hr><h2>Friends And Related Function Documentation</h2>
 369 <a name="k0" doxytag="wxActiveX::MSWVariantToVariant"></a><p>
 370 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 371   <tr>
 372     <td class="md">
 373       <table cellpadding="0" cellspacing="0" border="0">
 374         <tr>
 375           <td class="md" nowrap valign="top"> bool MSWVariantToVariant </td>
 376           <td class="md" valign="top">(&nbsp;</td>
 377           <td class="md" nowrap valign="top">VARIANTARG &amp;&nbsp;</td>
 378           <td class="mdname" nowrap>&nbsp; <em>va</em>, </td>
 379         </tr>
 380         <tr>
 381           <td></td>
 382           <td></td>
 383           <td class="md" nowrap>wxVariant &amp;&nbsp;</td>
 384           <td class="mdname" nowrap>&nbsp; <em>vx</em></td>
 385         </tr>
 386         <tr>
 387           <td></td>
 388           <td class="md">)&nbsp;</td>
 389           <td class="md" colspan="2"><code> [related]</code></td>
 390         </tr>
 391
 392       </table>
 393     </td>
 394   </tr>
 395 </table>
 396 <table cellspacing=5 cellpadding=0 border=0>
 397   <tr>
 398     <td>
 399       &nbsp;
 400     </td>
 401     <td>
 402
 403 <p>
 404 Convert MSW VARIANTARG to wxVariant. Handles basic types, need to add:<ul>
 405 <li>VT_ARRAY | VT_*</li><li>better support for VT_UNKNOWN (currently treated as void *)</li><li>better support for VT_DISPATCH (currently treated as void *).</li></ul>
 406
 407 <p>
 408 <dl compact><dt><b>Parameters:</b></dt><dd>
 409   <table border="0" cellspacing="2" cellpadding="0">
 410     <tr><td valign=top><em>va</em>&nbsp;</td><td>VARAIANTARG to convert from </td></tr>
 411     <tr><td valign=top><em>vx</em>&nbsp;</td><td>Destination wxVariant </td></tr>
 412   </table>
 413 </dl>
 414 <dl compact><dt><b>Returns:</b></dt><dd>success/failure (true/false) </dd></dl>
 415     </td>
 416   </tr>
 417 </table>
 418 <a name="k1" doxytag="wxActiveX::VariantToMSWVariant"></a><p>
 419 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 420   <tr>
 421     <td class="md">
 422       <table cellpadding="0" cellspacing="0" border="0">
 423         <tr>
 424           <td class="md" nowrap valign="top"> bool VariantToMSWVariant </td>
 425           <td class="md" valign="top">(&nbsp;</td>
 426           <td class="md" nowrap valign="top">const wxVariant &amp;&nbsp;</td>
 427           <td class="mdname" nowrap>&nbsp; <em>vx</em>, </td>
 428         </tr>
 429         <tr>
 430           <td></td>
 431           <td></td>
 432           <td class="md" nowrap>VARIANTARG &amp;&nbsp;</td>
 433           <td class="mdname" nowrap>&nbsp; <em>va</em></td>
 434         </tr>
 435         <tr>
 436           <td></td>
 437           <td class="md">)&nbsp;</td>
 438           <td class="md" colspan="2"><code> [related]</code></td>
 439         </tr>
 440
 441       </table>
 442     </td>
 443   </tr>
 444 </table>
 445 <table cellspacing=5 cellpadding=0 border=0>
 446   <tr>
 447     <td>
 448       &nbsp;
 449     </td>
 450     <td>
 451
 452 <p>
 453 Convert wxVariant to MSW VARIANTARG. Handles basic types, need to add:<ul>
 454 <li>VT_ARRAY | VT_*</li><li>better support for VT_UNKNOWN (currently treated as void *)</li><li>better support for VT_DISPATCH (currently treated as void *).</li></ul>
 455
 456 <p>
 457 <dl compact><dt><b>Parameters:</b></dt><dd>
 458   <table border="0" cellspacing="2" cellpadding="0">
 459     <tr><td valign=top><em>vx</em>&nbsp;</td><td>wxVariant to convert from </td></tr>
 460     <tr><td valign=top><em>va</em>&nbsp;</td><td>Destination VARIANTARG </td></tr>
 461   </table>
 462 </dl>
 463 <dl compact><dt><b>Returns:</b></dt><dd>success/failure (true/false) </dd></dl>
 464     </td>
 465   </tr>
 466 </table>
 467 <hr>The documentation for this class was generated from the following file:<ul>
 468 <li><a class="el" href="wxactivex_8h-source.html">wxactivex.h</a></ul>
 469 <hr><address style="align: right;"><small>Generated on Tue Apr 1 14:51:12 2003 for wxActiveX by
 470 <a href="http://www.doxygen.org/index.html">
 471 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 472 width=110 height=53></a>1.3-rc3 </small></address>
 473 </body>
 474 </html>