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