Stimfit  0.13.15
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Public Member Functions | Public Attributes | Static Public Attributes
stf::Extension Struct Reference

User-defined Python extension. More...

#include <stf.h>

Collaboration diagram for stf::Extension:
Collaboration graph
[legend]

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.

Definition at line 265 of file stf.h.


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

Definition at line 272 of file stf.h.

References n_extensions.


Member Data Documentation

Description for this function.

Definition at line 288 of file stf.h.

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

Definition at line 284 of file stf.h.

Menu entry string for this extension.

Definition at line 286 of file stf.h.

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

Definition at line 285 of file stf.h.

Referenced by Extension().

Python function to be called.

Definition at line 287 of file stf.h.

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

Definition at line 289 of file stf.h.


The documentation for this struct was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines