wxPython/contrib/activex/wxie/latex/wxactivex_8h.tex

   1 \section{wxactivex.h File Reference}
   2 \label{wxactivex_8h}\index{wxactivex.h@{wxactivex.h}}
   3
   4
   5 \subsection{Detailed Description}
   6 implements {\bf wx\-Active\-X} window class and OLE tools
   7
   8
   9
  10 Definition in file {\bf wxactivex.h}.
  11
  12 {\tt \#include $<$wx/setup.h$>$}\par
  13 {\tt \#include $<$wx/wx.h$>$}\par
  14 {\tt \#include $<$wx/variant.h$>$}\par
  15 {\tt \#include $<$wx/datetime.h$>$}\par
  16 {\tt \#include $<$oleidl.h$>$}\par
  17 {\tt \#include $<$exdisp.h$>$}\par
  18 {\tt \#include $<$docobj.h$>$}\par
  19 {\tt \#include $<$iostream$>$}\par
  20 {\tt \#include $<$vector$>$}\par
  21 {\tt \#include $<$map$>$}\par
  22 \subsection*{Namespaces}
  23 \begin{CompactItemize}
  24 \item
  25 namespace {\bf NS\_\-wx\-Active\-X}
  26 \item
  27 namespace {\bf std}
  28 \end{CompactItemize}
  29 \subsection*{Data Structures}
  30 \begin{CompactItemize}
  31 \item
  32 class {\bf wx\-Auto\-Ole\-Interface}
  33 \begin{CompactList}\small\item\em Template class for smart interface handling.\item\end{CompactList}\item
  34 class {\bf wx\-Active\-X}
  35 \begin{CompactList}\small\item\em Main class for embedding a Active\-X control.\item\end{CompactList}\item
  36 class {\bf Param\-X}
  37 \begin{CompactList}\small\item\em General parameter and return type infoformation for Events, Properties and Methods.\item\end{CompactList}\item
  38 class {\bf Func\-X}
  39 \begin{CompactList}\small\item\em Type \& Parameter info for Events and Methods.\item\end{CompactList}\item
  40 class {\bf Prop\-X}
  41 \begin{CompactList}\small\item\em Type info for properties.\item\end{CompactList}\end{CompactItemize}
  42 \subsection*{Defines}
  43 \begin{CompactItemize}
  44 \item
  45 \index{EVT_ACTIVEX@{EVT\_\-ACTIVEX}!wxactivex.h@{wxactivex.h}}\index{wxactivex.h@{wxactivex.h}!EVT_ACTIVEX@{EVT\_\-ACTIVEX}}
  46 \#define {\bf EVT\_\-ACTIVEX}(id, event\-Name, fn)\ DECLARE\_\-EVENT\_\-TABLE\_\-ENTRY(Register\-Active\-XEvent(wx\-T(event\-Name)), id, -1, (wx\-Object\-Event\-Function) (wx\-Event\-Function) (wx\-Active\-XEvent\-Function) \& fn, (wx\-Object $\ast$) NULL ),\label{wxactivex_8h_a10}
  47
  48 \begin{CompactList}\small\item\em Event handle for events by name.\item\end{CompactList}\item
  49 \index{EVT_ACTIVEX_DISPID@{EVT\_\-ACTIVEX\_\-DISPID}!wxactivex.h@{wxactivex.h}}\index{wxactivex.h@{wxactivex.h}!EVT_ACTIVEX_DISPID@{EVT\_\-ACTIVEX\_\-DISPID}}
  50 \#define {\bf EVT\_\-ACTIVEX\_\-DISPID}(id, event\-Disp\-Id, fn)\ DECLARE\_\-EVENT\_\-TABLE\_\-ENTRY(Register\-Active\-XEvent(event\-Disp\-Id), id, -1, (wx\-Object\-Event\-Function) (wx\-Event\-Function) (wx\-Active\-XEvent\-Function) \& fn, (wx\-Object $\ast$) NULL ),\label{wxactivex_8h_a11}
  51
  52 \begin{CompactList}\small\item\em Event handle for events by DISPID (dispath id).\item\end{CompactList}\end{CompactItemize}
  53 \subsection*{Functions}
  54 \begin{CompactItemize}
  55 \item
  56 \index{OLEHResultToString@{OLEHResultToString}!wxactivex.h@{wxactivex.h}}\index{wxactivex.h@{wxactivex.h}!OLEHResultToString@{OLEHResultToString}}
  57 wx\-String {\bf OLEHResult\-To\-String} (HRESULT hr)\label{wxactivex_8h_a13}
  58
  59 \begin{CompactList}\small\item\em Converts a std HRESULT to its error code. Hardcoded, by no means a definitive list.\item\end{CompactList}\item
  60 \index{GetIIDName@{GetIIDName}!wxactivex.h@{wxactivex.h}}\index{wxactivex.h@{wxactivex.h}!GetIIDName@{GetIIDName}}
  61 wx\-String {\bf Get\-IIDName} (REFIID riid)\label{wxactivex_8h_a14}
  62
  63 \begin{CompactList}\small\item\em Returns the string description of a IID. Hardcoded, by no means a definitive list.\item\end{CompactList}\end{CompactItemize}
  64
  65
  66 \subsection{Define Documentation}
  67 \index{wxactivex.h@{wxactivex.h}!DECLARE_OLE_UNKNOWN@{DECLARE\_\-OLE\_\-UNKNOWN}}
  68 \index{DECLARE_OLE_UNKNOWN@{DECLARE\_\-OLE\_\-UNKNOWN}!wxactivex.h@{wxactivex.h}}
  69 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define DECLARE\_\-OLE\_\-UNKNOWN(cls)}\label{wxactivex_8h_a3}
  70
  71
  72 {\bf Value:}
  73
  74 \footnotesize\begin{verbatim}private:\
  75     class TAutoInitInt\
  76     {\
  77         public:\
  78         LONG l;\
  79         TAutoInitInt() : l(0) {}\
  80     };\
  81     TAutoInitInt refCount, lockCount;\
  82     wxOleInit oleInit;\
  83         static void _GetInterface(cls *self, REFIID iid, void **_interface, const char *&desc);\
  84     public:\
  85     LONG GetRefCount();\
  86         HRESULT STDMETHODCALLTYPE QueryInterface(REFIID iid, void ** ppvObject);\
  87         ULONG STDMETHODCALLTYPE AddRef();\
  88         ULONG STDMETHODCALLTYPE Release();\
  89     ULONG STDMETHODCALLTYPE AddLock();\
  90         ULONG STDMETHODCALLTYPE ReleaseLock()
  91 \end{verbatim}\normalsize
  92
  93
  94 Definition at line 184 of file wxactivex.h.\index{wxactivex.h@{wxactivex.h}!DEFINE_OLE_BASE@{DEFINE\_\-OLE\_\-BASE}}
  95 \index{DEFINE_OLE_BASE@{DEFINE\_\-OLE\_\-BASE}!wxactivex.h@{wxactivex.h}}
  96 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define DEFINE\_\-OLE\_\-BASE(cls)}\label{wxactivex_8h_a5}
  97
  98
  99 {\bf Value:}
 100
 101 \footnotesize\begin{verbatim}void cls::_GetInterface(cls *self, REFIID iid, void **_interface, const char *&desc)\
 102         {\
 103                 *_interface = NULL;\
 104             desc = NULL;
 105 \end{verbatim}\normalsize
 106
 107
 108 Definition at line 264 of file wxactivex.h.\index{wxactivex.h@{wxactivex.h}!OLE_INTERFACE@{OLE\_\-INTERFACE}}
 109 \index{OLE_INTERFACE@{OLE\_\-INTERFACE}!wxactivex.h@{wxactivex.h}}
 110 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define OLE\_\-INTERFACE(\_\-iid, \_\-type)}\label{wxactivex_8h_a6}
 111
 112
 113 {\bf Value:}
 114
 115 \footnotesize\begin{verbatim}if (IsEqualIID(iid, _iid))\
 116     {\
 117         WXOLE_TRACE("Found Interface <" # _type ">");\
 118         *_interface = (IUnknown *) (_type *) self;\
 119         desc = # _iid;\
 120         return;\
 121     }
 122 \end{verbatim}\normalsize
 123
 124
 125 Definition at line 270 of file wxactivex.h.\index{wxactivex.h@{wxactivex.h}!OLE_INTERFACE_CUSTOM@{OLE\_\-INTERFACE\_\-CUSTOM}}
 126 \index{OLE_INTERFACE_CUSTOM@{OLE\_\-INTERFACE\_\-CUSTOM}!wxactivex.h@{wxactivex.h}}
 127 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define OLE\_\-INTERFACE\_\-CUSTOM(func)}\label{wxactivex_8h_a8}
 128
 129
 130 {\bf Value:}
 131
 132 \footnotesize\begin{verbatim}if (func(self, iid, _interface, desc))\
 133         {\
 134         return;\
 135         }
 136 \end{verbatim}\normalsize
 137
 138
 139 Definition at line 281 of file wxactivex.h.