Computer Assited Medical Intervention Tool Kit  version 3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
camitk::ActionExtension Class Referenceabstract

This class describes what is a generic Action extension. More...

#include <ActionExtension.h>

+ Inheritance diagram for camitk::ActionExtension:

Public Member Functions

const ActionListgetActions ()
 get the list of actions registered y this extension More...
 
virtual QString getDescription ()=0
 returns the action extension small description (to be overriden in your ActionExtension) More...
 
virtual QString getName ()=0
 returns the action extension name (to be overriden in your ActionExtension) More...
 
virtual void init ()=0
 this method should just call registerNewAction(MyAction) for any MyAction class you need to register by this extension More...
 
virtual ~ActionExtension ()
 destructor More...
 

Protected Member Functions

 ActionExtension ()
 constructor More...
 
void registerAction (Action *)
 register an action instance More...
 

Protected Attributes

ActionList actions
 the list of actions More...
 

Detailed Description

This class describes what is a generic Action extension.

To add a ActionExtension to CamiTK core, write a new class that inherits from this class.

The following methods HAVE to be redefined in your subclass:

See also
BasicMeshExtension For an example of an extension registering more than one actions

Constructor & Destructor Documentation

camitk::ActionExtension::ActionExtension ( )
inlineprotected

constructor

virtual camitk::ActionExtension::~ActionExtension ( )
virtual

destructor

Member Function Documentation

const ActionList& camitk::ActionExtension::getActions ( )

get the list of actions registered y this extension

virtual QString camitk::ActionExtension::getDescription ( )
pure virtual
virtual QString camitk::ActionExtension::getName ( )
pure virtual
virtual void camitk::ActionExtension::init ( )
pure virtual
void camitk::ActionExtension::registerAction ( Action )
protected

register an action instance

Member Data Documentation

ActionList camitk::ActionExtension::actions
protected

the list of actions


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