Base class for tool plugins. More...
#include <cbplugin.h>
Inheritance diagram for cbToolPlugin:
Collaboration diagram for cbToolPlugin:
Public Member Functions | |
| cbToolPlugin () | |
| virtual int | Execute ()=0 |
| Execute the plugin. More... | |
 Public Member Functions inherited from cbPlugin | |
| cbPlugin () | |
| In default cbPlugin's constructor the associated PluginInfo structure is filled with default values. More... | |
| ~cbPlugin () override | |
| cbPlugin destructor. More... | |
| virtual PluginType | GetType () const |
| The plugin must return its type on request. More... | |
| virtual int | GetConfigurationPriority () const |
| Return the plugin's configuration priority. More... | |
| virtual int | GetConfigurationGroup () const |
| Return the configuration group for this plugin. More... | |
| virtual cbConfigurationPanel * | GetConfigurationPanel (cb_optional wxWindow *parent) |
| Return plugin's configuration panel. More... | |
| virtual cbConfigurationPanel * | GetProjectConfigurationPanel (cb_optional wxWindow *parent, cb_optional cbProject *project) |
| Return plugin's configuration panel for projects. More... | |
| virtual void | BuildMenu (cb_optional wxMenuBar *menuBar) |
| This method is called by Code::Blocks and is used by the plugin to add any menu items it needs on Code::Blocks's menu bar. More... | |
| virtual void | BuildModuleMenu (cb_optional const ModuleType type, cb_optional wxMenu *menu, cb_optional const FileTreeData *data=nullptr) |
| This method is called by Code::Blocks core modules (EditorManager, ProjectManager etc) and is used by the plugin to add any menu items it needs in the module's popup menu. More... | |
| virtual bool | BuildToolBar (cb_optional wxToolBar *toolBar) |
| This method is called by Code::Blocks and is used by the plugin to add any toolbar items it needs on Code::Blocks's toolbar. More... | |
| virtual int | GetToolBarPriority () |
| This method return the priority of the plugin's toolbar, the less value indicates a more preceding position when C::B starts with no configuration file. More... | |
| virtual void | CreateStatusField (cbStatusBar *statusBar) |
| This method is called by Code::Blocks and is used by the plugin to add a field on Code::Blocks's statusbar. More... | |
| bool | IsAttached () const |
| See whether this plugin is attached or not. More... | |
| virtual bool | CanDetach () const |
| See whether this plugin can be detached (unloaded) or not. More... | |
Private Member Functions | |
| void | BuildMenu (cb_unused wxMenuBar *menuBar) override |
| void | RemoveMenu (cb_unused wxMenuBar *menuBar) |
| void | BuildModuleMenu (cb_unused const ModuleType type, cb_unused wxMenu *menu, cb_unused const FileTreeData *data=nullptr) override |
| bool | BuildToolBar (cb_unused wxToolBar *toolBar) override |
| void | RemoveToolBar (cb_unused wxToolBar *toolBar) |
Additional Inherited Members | |
| Protected Member Functions inherited from cbPlugin | |
| virtual void | OnAttach () |
| Any descendent plugin should override this virtual method and perform any necessary initialization. More... | |
| virtual void | OnRelease (cb_optional bool appShutDown) |
| Any descendent plugin should override this virtual method and perform any necessary de-initialization. More... | |
| virtual void | NotImplemented (const wxString &log) const |
| This method logs a "Not implemented" message and is provided for convenience only. More... | |
| Protected Attributes inherited from cbPlugin | |
| PluginType | m_Type |
| Holds the plugin's type. More... | |
| bool | m_IsAttached |
| Holds the "attached" state. More... | |
Detailed Description
Base class for tool plugins.
This plugin is automatically managed by Code::Blocks, so the inherited functions to build menus/toolbars are hidden.
Tool plugins are automatically added under the "Plugins" menu.
Definition at line 658 of file cbplugin.h.
Constructor & Destructor Documentation
◆ cbToolPlugin()
| cbToolPlugin::cbToolPlugin | ( | ) |
Definition at line 986 of file cbplugin.cpp.
References cbPlugin::m_Type, and ptTool.
Member Function Documentation
◆ BuildMenu()
|
inlineoverrideprivate |
Definition at line 672 of file cbplugin.h.
◆ BuildModuleMenu()
|
inlineoverrideprivate |
Definition at line 674 of file cbplugin.h.
◆ BuildToolBar()
|
inlineoverrideprivate |
Definition at line 675 of file cbplugin.h.
◆ Execute()
|
pure virtual |
Execute the plugin.
This is the only function needed by a cbToolPlugin. This will be called when the user selects the plugin from the "Plugins" menu.
◆ RemoveMenu()
|
inlineprivate |
Definition at line 673 of file cbplugin.h.
◆ RemoveToolBar()
|
inlineprivate |
Definition at line 676 of file cbplugin.h.
The documentation for this class was generated from the following files:
