1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
%
% automatically generated by HelpGen $Revision: 13938 $ from
% controlbar.h at 21/Jan/02 21:14:14
%
\section{\class{cbPluginBase}}\label{cbpluginbase}
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}
<wx/fl/controlbar.h>
\wxheading{Data structures}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{cbPluginBase::cbPluginBase}\label{cbpluginbasecbpluginbase}
\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}
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.
\membersection{cbPluginBase::ProcessEvent}\label{cbpluginbaseprocessevent}
\func{bool}{ProcessEvent}{\param{wxEvent\& }{event}}
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).
|
