stf::Plugin Struct Reference

User-defined plugin. More...

#include <stf.h>

Collaboration diagram for stf::Plugin:

List of all members.

Public Member Functions
	Plugin (const wxString &menuEntry_, const PluginFunc &pluginFunc_, const UserInput &input_=UserInput())
	Constructor.
	~Plugin ()
	Destructor.
Public Attributes
int	id
wxString	menuEntry
PluginFunc	pluginFunc
UserInput	input
Static Public Attributes
static int	n_plugins

---

Detailed Description

User-defined plugin.

Class used for extending Stimfit's functionality: The client supplies a new menu entry and an ExtFunc that will be called upon selection of that entry.

---

Constructor & Destructor Documentation

stf::Plugin::Plugin	(	const wxString &	menuEntry_,
		const PluginFunc &	pluginFunc_,
		const UserInput &	input_ = UserInput()
	)		[inline]

Constructor.

Parameters:

menuEntry_	Menu entry string for this plugin.
pluginFunc_	Function to be executed by this plugin.
input_	Dialog entries required by this plugin.

References n_plugins.

---

Member Data Documentation

int stf::Plugin::id

The plugin id; set automatically upon construction, so don't touch.

UserInput stf::Plugin::input

Dialog entries

wxString stf::Plugin::menuEntry

Menu entry string for this plugin.

int stf::Plugin::n_plugins [static]

Static plugin counter. Initialised in plugins/plugins.cpp.

Referenced by Plugin().

PluginFunc stf::Plugin::pluginFunc

The function to be executed by this plugin.

---

The documentation for this struct was generated from the following file:

• src/stimfit/stf.h