projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 557002cf VZ |
1 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 2 | %% Name: activexevt.tex | |
| 3 | %% Purpose: wxActiveXEvent docs | |
| 4 | %% Author: Ryan Norton <wxprojects@comcast.net> | |
| 5 | %% Modified by: | |
| 6 | %% Created: 01/30/2005 | |
| 7 | %% RCS-ID: $Id$ | |
| 8 | %% Copyright: (c) Ryan Norton | |
| 9 | %% License: wxWindows license | |
| 10 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
| 11 | ||
| 12 | \section{\class{wxActiveXEvent}}\label{wxactivexevent} | |
| 13 | ||
| 14 | An event class for handling activex events passed from | |
| 15 | \helpref{wxActiveXContainer}{wxactivexcontainer}. ActiveX events are basically | |
| 16 | a function call with the parameters passed through an array of wxVariants along | |
| 17 | with a return value that is a wxVariant itself. What type the parameters or | |
| 18 | return value are depends on the context (i.e. what the .idl specifies). | |
| 19 | ||
| 20 | Note that unlike the third party wxActiveX function names are not supported. | |
| 21 | ||
| 22 | \wxheading{Derived from} | |
| 23 | ||
| 7376079d VZ |
24 | \helpref{wxCommandEvent}{wxcommandevent}\\ |
| 25 | \helpref{wxEvent}{wxevent}\\ | |
| 26 | \helpref{wxObject}{wxobject} | |
| 557002cf VZ |
27 | |
| 28 | \wxheading{Include files} | |
| 29 | ||
| 30 | <wx/msw/ole/activex.h> | |
| 31 | ||
| 32 | \wxheading{Event table macros} | |
| 33 | ||
| 34 | \twocolwidtha{7cm} | |
| 35 | \begin{twocollist}\itemsep=0pt | |
| 36 | \twocolitem{{\bf EVT\_ACTIVEX(func)}}{ | |
| 37 | Sent when the activex control hosted by \helpref{wxActiveXContainer}{wxactivexcontainer} | |
| 38 | recieves an activex event.} | |
| 39 | \end{twocollist} | |
| 40 | ||
| 41 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 42 | ||
| 43 | \membersection{wxActiveXEvent::ParamCount}\label{wxactivexeventparamcount} | |
| 44 | ||
| 0902898a | 45 | \constfunc{size\_t}{ParamCount}{\void} |
| 557002cf VZ |
46 | |
| 47 | Obtains the number of parameters passed through the activex event. | |
| 48 | ||
| 49 | ||
| 50 | \membersection{wxActiveXEvent::ParamType}\label{wxactivexeventparamtype} | |
| 51 | ||
| 0902898a | 52 | \constfunc{wxString}{ParamType}{\param{size\_t }{idx}} |
| 557002cf VZ |
53 | |
| 54 | Obtains the param type of the param number idx specifies as a string. | |
| 55 | ||
| 56 | ||
| 57 | \membersection{wxActiveXEvent::ParamName}\label{wxactivexeventparamname} | |
| 58 | ||
| 0902898a | 59 | \constfunc{wxString}{ParamName}{\param{size\_t }{idx}} |
| 557002cf VZ |
60 | |
| 61 | Obtains the param name of the param number idx specifies as a string. | |
| 62 | ||
| 63 | ||
| 64 | \membersection{wxActiveXEvent::operator[]}\label{wxactivexeventoparray} | |
| 65 | ||
| 0902898a | 66 | \func{wxVariant&}{operator[]}{\param{size\_t }{idx}} |
| 557002cf VZ |
67 | |
| 68 | Obtains the actual parameter value specified by idx. | |
| 69 | ||
| 70 | ||
| 71 | \membersection{wxActiveXEvent::GetDispatchId}\label{wxactivexeventgetdispatchid} | |
| 72 | ||
| 73 | \constfunc{DISPID}{GetDispatchId}{\param{int }{idx}} | |
| 74 | ||
| 75 | Returns the dispatch id of this activex event. This is the numeric value from | |
| 76 | the .idl file specified by the id(). | |
| b67a86d5 | 77 |