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

   1 \section{wx\-Auto\-Ole\-Interface$<$ I $>$ Class Template Reference}
   2 \label{classwxAutoOleInterface}\index{wxAutoOleInterface@{wxAutoOleInterface}}
   3 {\tt \#include $<$wxactivex.h$>$}
   4
   5
   6
   7 \subsection{Detailed Description}
   8 \subsubsection*{template$<$class I$>$ class wx\-Auto\-Ole\-Interface$<$ I $>$}
   9
  10 Template class for smart interface handling.
  11
  12 \begin{itemize}
  13 \item Automatically dereferences ole interfaces\item Smart Copy Semantics\item Can Create Interfaces\item Can query for other interfaces \end{itemize}
  14
  15
  16
  17
  18 Definition at line 45 of file wxactivex.h.\subsection*{Public Member Functions}
  19 \begin{CompactItemize}
  20 \item
  21 \index{wxAutoOleInterface@{wxAutoOleInterface}!wxAutoOleInterface@{wxAutoOleInterface}}\index{wxAutoOleInterface@{wxAutoOleInterface}!wxAutoOleInterface@{wxAutoOleInterface}}
  22 {\bf wx\-Auto\-Ole\-Interface} (I $\ast$p\-Interface=NULL)\label{classwxAutoOleInterface_a0}
  23
  24 \begin{CompactList}\small\item\em takes ownership of an existing interface Assumed to already have a Add\-Ref() applied\item\end{CompactList}\item
  25 \index{wxAutoOleInterface@{wxAutoOleInterface}!wxAutoOleInterface@{wxAutoOleInterface}}\index{wxAutoOleInterface@{wxAutoOleInterface}!wxAutoOleInterface@{wxAutoOleInterface}}
  26 {\bf wx\-Auto\-Ole\-Interface} (REFIID riid, IUnknown $\ast$p\-Unk)\label{classwxAutoOleInterface_a1}
  27
  28 \begin{CompactList}\small\item\em queries for an interface\item\end{CompactList}\item
  29 \index{wxAutoOleInterface@{wxAutoOleInterface}!wxAutoOleInterface@{wxAutoOleInterface}}\index{wxAutoOleInterface@{wxAutoOleInterface}!wxAutoOleInterface@{wxAutoOleInterface}}
  30 {\bf wx\-Auto\-Ole\-Interface} (REFIID riid, IDispatch $\ast$p\-Dispatch)\label{classwxAutoOleInterface_a2}
  31
  32 \begin{CompactList}\small\item\em queries for an interface\item\end{CompactList}\item
  33 \index{wxAutoOleInterface@{wxAutoOleInterface}!wxAutoOleInterface@{wxAutoOleInterface}}\index{wxAutoOleInterface@{wxAutoOleInterface}!wxAutoOleInterface@{wxAutoOleInterface}}
  34 {\bf wx\-Auto\-Ole\-Interface} (REFCLSID clsid, REFIID riid)\label{classwxAutoOleInterface_a3}
  35
  36 \begin{CompactList}\small\item\em Creates an Interface.\item\end{CompactList}\item
  37 \index{wxAutoOleInterface@{wxAutoOleInterface}!wxAutoOleInterface@{wxAutoOleInterface}}\index{wxAutoOleInterface@{wxAutoOleInterface}!wxAutoOleInterface@{wxAutoOleInterface}}
  38 {\bf wx\-Auto\-Ole\-Interface} (const wx\-Auto\-Ole\-Interface$<$ I $>$ \&ti)\label{classwxAutoOleInterface_a4}
  39
  40 \begin{CompactList}\small\item\em copy constructor\item\end{CompactList}\item
  41 \index{operator=@{operator=}!wxAutoOleInterface@{wxAutoOleInterface}}\index{wxAutoOleInterface@{wxAutoOleInterface}!operator=@{operator=}}
  42 wx\-Auto\-Ole\-Interface$<$ I $>$ \& {\bf operator=} (const wx\-Auto\-Ole\-Interface$<$ I $>$ \&ti)\label{classwxAutoOleInterface_a5}
  43
  44 \begin{CompactList}\small\item\em assignment operator\item\end{CompactList}\item
  45 \index{operator=@{operator=}!wxAutoOleInterface@{wxAutoOleInterface}}\index{wxAutoOleInterface@{wxAutoOleInterface}!operator=@{operator=}}
  46 wx\-Auto\-Ole\-Interface$<$ I $>$ \& {\bf operator=} (I $\ast$\&ti)\label{classwxAutoOleInterface_a6}
  47
  48 \begin{CompactList}\small\item\em takes ownership of an existing interface Assumed to already have a Add\-Ref() applied\item\end{CompactList}\item
  49 \index{~wxAutoOleInterface@{$\sim$wxAutoOleInterface}!wxAutoOleInterface@{wxAutoOleInterface}}\index{wxAutoOleInterface@{wxAutoOleInterface}!~wxAutoOleInterface@{$\sim$wxAutoOleInterface}}
  50 {\bf $\sim$wx\-Auto\-Ole\-Interface} ()\label{classwxAutoOleInterface_a7}
  51
  52 \begin{CompactList}\small\item\em invokes {\bf Free()}\item\end{CompactList}\item
  53 \index{Free@{Free}!wxAutoOleInterface@{wxAutoOleInterface}}\index{wxAutoOleInterface@{wxAutoOleInterface}!Free@{Free}}
  54 void {\bf Free} ()\label{classwxAutoOleInterface_a8}
  55
  56 \begin{CompactList}\small\item\em Releases interface (i.e decrements ref\-Count).\item\end{CompactList}\item
  57 \index{QueryInterface@{QueryInterface}!wxAutoOleInterface@{wxAutoOleInterface}}\index{wxAutoOleInterface@{wxAutoOleInterface}!QueryInterface@{QueryInterface}}
  58 HRESULT {\bf Query\-Interface} (REFIID riid, IUnknown $\ast$p\-Unk)\label{classwxAutoOleInterface_a9}
  59
  60 \begin{CompactList}\small\item\em queries for an interface\item\end{CompactList}\item
  61 \index{CreateInstance@{CreateInstance}!wxAutoOleInterface@{wxAutoOleInterface}}\index{wxAutoOleInterface@{wxAutoOleInterface}!CreateInstance@{CreateInstance}}
  62 HRESULT {\bf Create\-Instance} (REFCLSID clsid, REFIID riid)\label{classwxAutoOleInterface_a10}
  63
  64 \begin{CompactList}\small\item\em Create a Interface instance.\item\end{CompactList}\item
  65 \index{operator I *@{operator I $\ast$}!wxAutoOleInterface@{wxAutoOleInterface}}\index{wxAutoOleInterface@{wxAutoOleInterface}!operator I *@{operator I $\ast$}}
  66 {\bf operator I $\ast$} () const\label{classwxAutoOleInterface_a11}
  67
  68 \begin{CompactList}\small\item\em returns the interface pointer\item\end{CompactList}\item
  69 \index{operator->@{operator-$>$}!wxAutoOleInterface@{wxAutoOleInterface}}\index{wxAutoOleInterface@{wxAutoOleInterface}!operator->@{operator-$>$}}
  70 I $\ast$ {\bf operator $\rightarrow$ } ()\label{classwxAutoOleInterface_a12}
  71
  72 \begin{CompactList}\small\item\em returns the dereferenced interface pointer\item\end{CompactList}\item
  73 \index{GetRef@{GetRef}!wxAutoOleInterface@{wxAutoOleInterface}}\index{wxAutoOleInterface@{wxAutoOleInterface}!GetRef@{GetRef}}
  74 I $\ast$$\ast$ {\bf Get\-Ref} ()\label{classwxAutoOleInterface_a13}
  75
  76 \begin{CompactList}\small\item\em returns a pointer to the interface pointer\item\end{CompactList}\item
  77 \index{Ok@{Ok}!wxAutoOleInterface@{wxAutoOleInterface}}\index{wxAutoOleInterface@{wxAutoOleInterface}!Ok@{Ok}}
  78 bool {\bf Ok} () const\label{classwxAutoOleInterface_a14}
  79
  80 \begin{CompactList}\small\item\em returns true if we have a valid interface pointer\item\end{CompactList}\end{CompactItemize}
  81
  82
  83 The documentation for this class was generated from the following file:\begin{CompactItemize}
  84 \item
  85 {\bf wxactivex.h}\end{CompactItemize}