wxActiveXEvent Class Reference
[Events]

#include <wx/msw/ole/activex.h>

Inheritance diagram for wxActiveXEvent:

wxCommandEvent wxEvent wxObject

List of all members.


Detailed Description

An event class for handling activex events passed from wxActiveXContainer.

ActiveX events are basically a function call with the parameters passed through an array of wxVariants along with a return value that is a wxVariant itself. What type the parameters or return value are depends on the context (i.e. what the .idl specifies).

Note that unlike the third party wxActiveX function names are not supported.

Events:

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxActiveXEvent& event)

Event macros:
Availability:  only available for the wxMSW port.

Library:  wxBase

Category:  Events

Public Member Functions

DISPID GetDispatchId (int idx) const
size_t ParamCount () const
wxString ParamName (size_t idx) const
wxString ParamType (size_t idx) const
wxVariant operator[] (size_t idx)

Member Function Documentation

DISPID wxActiveXEvent::GetDispatchId ( int  idx  )  const

Returns the dispatch id of this activex event. This is the numeric value from the .idl file specified by the id().

size_t wxActiveXEvent::ParamCount (  )  const

Obtains the number of parameters passed through the activex event.

wxString wxActiveXEvent::ParamName ( size_t  idx  )  const

Obtains the param name of the param number idx specifies as a string.

wxString wxActiveXEvent::ParamType ( size_t  idx  )  const

Obtains the param type of the param number idx specifies as a string.

wxVariant wxActiveXEvent::operator[] ( size_t  idx  ) 

Obtains the actual parameter value specified by idx.



wxWidgets logo

[ top ]