projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 499b2ed8 JS |
1 | % |
| 2 | % automatically generated by HelpGen $Revision$ from | |
| 3 | % controlbar.h at 05/Jan/02 22:50:59 | |
| 4 | % | |
| 5 | ||
| 6 | ||
| 7 | \section{\class{cbPluginBase}}\label{cbpluginbase} | |
| 8 | ||
| 9 | ||
| 10 | abstract base class for all control-bar related plugins | |
| 11 | ||
| 12 | \wxheading{Derived from} | |
| 13 | ||
| 14 | \helpref{wxEvtHandler}{wxevthandler} | |
| 15 | ||
| 16 | \wxheading{Data structures} | |
| 17 | ||
| 18 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 19 | ||
| 20 | ||
| 21 | \membersection{cbPluginBase::cbPluginBase}\label{cbpluginbasecbpluginbase} | |
| 22 | ||
| 23 | \func{}{cbPluginBase}{\param{wxFrameLayout* }{pPanel}, \param{int }{paneMask = wxALL\_PANES}} | |
| 24 | ||
| 25 | ||
| 26 | \func{}{cbPluginBase}{\void} | |
| 27 | ||
| 28 | ||
| 29 | \membersection{cbPluginBase::\destruct{cbPluginBase}}\label{cbpluginbasedtor} | |
| 30 | ||
| 31 | \func{}{\destruct{cbPluginBase}}{\void} | |
| 32 | ||
| 33 | NOTE:: pointer positions of mouse-events sent to plugins | |
| 34 | are always in pane's coordinates (pane's to which | |
| 35 | this plugin is hooked) | |
| 36 | destroys the whole plugin chain of connected plagins | |
| 37 | ||
| 38 | ||
| 39 | \membersection{cbPluginBase::GetPaneMask}\label{cbpluginbasegetpanemask} | |
| 40 | ||
| 41 | \func{int}{GetPaneMask}{\void} | |
| 42 | ||
| 43 | ||
| 44 | \membersection{cbPluginBase::IsReady}\label{cbpluginbaseisready} | |
| 45 | ||
| 46 | \func{bool}{IsReady}{\void} | |
| 47 | ||
| 48 | ||
| 49 | \membersection{cbPluginBase::OnInitPlugin}\label{cbpluginbaseoninitplugin} | |
| 50 | ||
| 51 | \func{void}{OnInitPlugin}{\void} | |
| 52 | ||
| 53 | override this method to do plugin-specific initialization | |
| 54 | (at this point plugin is already attached to the frame layout, | |
| 55 | and pane masks are set) | |
| 56 | ||
| 57 | ||
| 58 | \membersection{cbPluginBase::ProcessEvent}\label{cbpluginbaseprocessevent} | |
| 59 | ||
| 60 | \func{bool}{ProcessEvent}{\param{wxEvent\& }{event}} | |
| 61 | ||
| 62 | overriden, to determine whether the target pane specified in the | |
| 63 | event, matches the pane mask of this plugin (specific plugins | |
| 64 | do not override this method) | |
| 65 |