stf::Extension Struct Reference

User-defined Python extension. More...

#include <stf.h>

Collaboration diagram for stf::Extension:

List of all members.

Public Member Functions
	Extension (const std::string &menuEntry_, void *pyFunc_, const std::string &description_, bool requiresFile_)
	Constructor.
	~Extension ()
	Destructor.
Public Attributes
int	id
std::string	menuEntry
void *	pyFunc
std::string	description
bool	requiresFile
Static Public Attributes
static int	n_extensions

---

Detailed Description

User-defined Python extension.

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

---

Constructor & Destructor Documentation

stf::Extension::Extension	(	const std::string &	menuEntry_,
		void *	pyFunc_,
		const std::string &	description_,
		bool	requiresFile_
	)		[inline]

Constructor.

Parameters:

menuEntry_	Menu entry string for this extension.
pyFunc_	Python function to be called.
description_	Description for this function.
requiresFile_	Whether a file needs to be open for this function to work

References n_extensions.

---

Member Data Documentation

std::string stf::Extension::description

Description for this function.

int stf::Extension::id

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

std::string stf::Extension::menuEntry

Menu entry string for this extension.

int stf::Extension::n_extensions [static]

Static extension counter. Initialised in extensions/extensions.cpp.

Referenced by Extension().

void* stf::Extension::pyFunc

Python function to be called.

bool stf::Extension::requiresFile

Whether a file needs to be open for this function to work

---

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

• src/stimfit/stf.h