open_iA 2025.6
Loading...
Searching...
No Matches
iAModuleInterface Class Referenceabstract

Base class for a module interface. More...

#include <iAModuleInterface.h>

Inheritance diagram for iAModuleInterface:
[legend]
Collaboration diagram for iAModuleInterface:
[legend]

Public Member Functions

virtual ~iAModuleInterface ()
 
virtual void Initialize ()=0
 Override to add references to the module in the core code, for example menu entries.
 
virtual void SaveSettings () const
 Override to store custom settings of this module; called when program is shut down.
 

Detailed Description

Base class for a module interface.

A class derived from this class (or any class derived from it, see e.g. iAGUIModuleInterface), and having a name in the form iA<ModuleName>ModuleInterface needs to be part of each module. E.g. the FeatureScout module needs to contain a class iAFeatureScoutModuleInterface. At least the Initialize method needs to be overriden in order to add the custom code of the module to open_iA. This can either be the addition of some filters, or adding an entry directly to open_iA's toolbar or menu.

Constructor & Destructor Documentation

◆ ~iAModuleInterface()

iAModuleInterface::~iAModuleInterface ( )
virtual

Member Function Documentation

◆ Initialize()

virtual void iAModuleInterface::Initialize ( )
pure virtual

Override to add references to the module in the core code, for example menu entries.

Implemented in iAGUIModuleInterface.

◆ SaveSettings()

void iAModuleInterface::SaveSettings ( ) const
virtual

Override to store custom settings of this module; called when program is shut down.

Reimplemented in iAGUIModuleInterface.


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