]> git.saurik.com Git - wxWidgets.git/blame - contrib/docs/latex/fl/cbpluginbase.tex
Removed old classes and functions
[wxWidgets.git] / contrib / docs / latex / fl / cbpluginbase.tex
CommitLineData
499b2ed8
JS
1%
2% automatically generated by HelpGen $Revision$ from
4cbc57f0 3% controlbar.h at 21/Jan/02 21:14:14
499b2ed8
JS
4%
5
6
7\section{\class{cbPluginBase}}\label{cbpluginbase}
8
9
4cbc57f0
JS
10Abstract base class for all control-bar related plugins.
11Note: pointer positions of mouse events sent to plugins
12are always in the pane's coordinates (the pane to which
13this plugin is hooked).
14
499b2ed8
JS
15\wxheading{Derived from}
16
17\helpref{wxEvtHandler}{wxevthandler}
18
4cbc57f0
JS
19\wxheading{Include files}
20
6e8515a3 21<wx/fl/controlbar.h>
4cbc57f0 22
499b2ed8
JS
23\wxheading{Data structures}
24
25\latexignore{\rtfignore{\wxheading{Members}}}
26
27
28\membersection{cbPluginBase::cbPluginBase}\label{cbpluginbasecbpluginbase}
29
30\func{}{cbPluginBase}{\param{wxFrameLayout* }{pPanel}, \param{int }{paneMask = wxALL\_PANES}}
31
4cbc57f0
JS
32Constructor taking layout panel and a mask.
33
499b2ed8
JS
34
35\func{}{cbPluginBase}{\void}
36
4cbc57f0
JS
37Default constructor.
38
499b2ed8
JS
39
40\membersection{cbPluginBase::\destruct{cbPluginBase}}\label{cbpluginbasedtor}
41
42\func{}{\destruct{cbPluginBase}}{\void}
43
4cbc57f0 44Destructor. Destroys the whole plugin chain of connected plugins.
499b2ed8
JS
45
46
47\membersection{cbPluginBase::GetPaneMask}\label{cbpluginbasegetpanemask}
48
49\func{int}{GetPaneMask}{\void}
50
4cbc57f0
JS
51Returns the pane mask.
52
499b2ed8
JS
53
54\membersection{cbPluginBase::IsReady}\label{cbpluginbaseisready}
55
56\func{bool}{IsReady}{\void}
57
4cbc57f0
JS
58Returns TRUE if the plugin is ready to receive events.
59
499b2ed8
JS
60
61\membersection{cbPluginBase::OnInitPlugin}\label{cbpluginbaseoninitplugin}
62
63\func{void}{OnInitPlugin}{\void}
64
4cbc57f0
JS
65Override this method to do plugin-specific initialization.
66At this point plugin is already attached to the frame layout,
67and pane masks are set.
499b2ed8
JS
68
69
70\membersection{cbPluginBase::ProcessEvent}\label{cbpluginbaseprocessevent}
71
72\func{bool}{ProcessEvent}{\param{wxEvent\& }{event}}
73
4cbc57f0
JS
74Overridden to determine whether the target pane specified in the
75event matches the pane mask of this plugin (specific plugins
76do not override this method).
499b2ed8 77