%
% automatically generated by HelpGen $Revision$ from
% controlbar.h at 05/Jan/02 22:50:59
%


\section{\class{cbPluginBase}}\label{cbpluginbase}


abstract base class for all control-bar related plugins
 
\wxheading{Derived from}

\helpref{wxEvtHandler}{wxevthandler}

\wxheading{Data structures}

\latexignore{\rtfignore{\wxheading{Members}}}


\membersection{cbPluginBase::cbPluginBase}\label{cbpluginbasecbpluginbase}

\func{}{cbPluginBase}{\param{wxFrameLayout* }{pPanel}, \param{int }{paneMask = wxALL\_PANES}}


\func{}{cbPluginBase}{\void}


\membersection{cbPluginBase::\destruct{cbPluginBase}}\label{cbpluginbasedtor}

\func{}{\destruct{cbPluginBase}}{\void}

NOTE:: pointer positions of mouse-events sent to plugins
are always in pane's coordinates (pane's to which
this plugin is hooked)
destroys the whole plugin chain of connected plagins


\membersection{cbPluginBase::GetPaneMask}\label{cbpluginbasegetpanemask}

\func{int}{GetPaneMask}{\void}


\membersection{cbPluginBase::IsReady}\label{cbpluginbaseisready}

\func{bool}{IsReady}{\void}


\membersection{cbPluginBase::OnInitPlugin}\label{cbpluginbaseoninitplugin}

\func{void}{OnInitPlugin}{\void}

override this method to do plugin-specific initialization
(at this point plugin is already attached to the frame layout,
and pane masks are set)


\membersection{cbPluginBase::ProcessEvent}\label{cbpluginbaseprocessevent}

\func{bool}{ProcessEvent}{\param{wxEvent\& }{event}}

overriden, to determine whether the target pane specified in the
event, matches the pane mask of this plugin (specific plugins
do not override this method)