Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Tidied/commented FL header files, regenerated docs and filled out Category section.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@13738 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2002-01-21 22:34:42 +00:00
parent 293a0a8677
commit 4cbc57f086
108 changed files with 7384 additions and 5199 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
contrib/docs/latex/fl/cbpluginbase.tex
View File

@@ -1,18 +1,25 @@
%
% automatically generated by HelpGen $Revision$ from
% controlbar.h at 05/Jan/02 22:50:59
% controlbar.h at 21/Jan/02 21:14:14
%
\section{\class{cbPluginBase}}\label{cbpluginbase}
abstract base class for all control-bar related plugins
Abstract base class for all control-bar related plugins.
Note: pointer positions of mouse events sent to plugins
are always in the pane's coordinates (the pane to which
this plugin is hooked).
\wxheading{Derived from}
\helpref{wxEvtHandler}{wxevthandler}
\wxheading{Include files}
<controlbar.h>
\wxheading{Data structures}
\latexignore{\rtfignore{\wxheading{Members}}}
@@ -22,44 +29,49 @@ abstract base class for all control-bar related plugins
\func{}{cbPluginBase}{\param{wxFrameLayout* }{pPanel}, \param{int }{paneMask = wxALL\_PANES}}
Constructor taking layout panel and a mask.
\func{}{cbPluginBase}{\void}
Default constructor.
\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
Destructor. Destroys the whole plugin chain of connected plugins.
\membersection{cbPluginBase::GetPaneMask}\label{cbpluginbasegetpanemask}
\func{int}{GetPaneMask}{\void}
Returns the pane mask.
\membersection{cbPluginBase::IsReady}\label{cbpluginbaseisready}
\func{bool}{IsReady}{\void}
Returns TRUE if the plugin is ready to receive events.
\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)
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)
Overridden to determine whether the target pane specified in the
event matches the pane mask of this plugin (specific plugins
do not override this method).