Contents Up Previous Next

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).

Derived from

wxEvtHandler

Include files

<wx/fl/controlbar.h>

Data structures

Members

cbPluginBase::cbPluginBase
cbPluginBase::~cbPluginBase
cbPluginBase::GetPaneMask
cbPluginBase::IsReady
cbPluginBase::OnInitPlugin
cbPluginBase::ProcessEvent


cbPluginBase::cbPluginBase

cbPluginBase(wxFrameLayout* pPanel, int paneMask = wxALL_PANES)

Constructor taking layout panel and a mask.

cbPluginBase()

Default constructor.


cbPluginBase::~cbPluginBase

~cbPluginBase()

Destructor. Destroys the whole plugin chain of connected plugins.


cbPluginBase::GetPaneMask

int GetPaneMask()

Returns the pane mask.


cbPluginBase::IsReady

bool IsReady()

Returns TRUE if the plugin is ready to receive events.


cbPluginBase::OnInitPlugin

void OnInitPlugin()

Override this method to do plugin-specific initialization. At this point plugin is already attached to the frame layout, and pane masks are set.


cbPluginBase::ProcessEvent

bool ProcessEvent(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).