Base class for a module interface. More...

#include <iAGUIModuleInterface.h>

Inheritance diagram for iAGUIModuleInterface:

Collaboration diagram for iAGUIModuleInterface:

Public Member Functions
	iAGUIModuleInterface ()

virtual	~iAGUIModuleInterface ()

void	Initialize () override=0
	Override to add references to the module in the core code, for example menu entries.

void	SaveSettings () const override
	Override to store custom settings of this module; called when program is shut down.

void	SetMainWindow (iAMainWindow *mainWnd)
	Called by the module dispatcher on module initialization. There should be no need to call this method from user code.

Public Member Functions inherited from iAModuleInterface
virtual	~iAModuleInterface ()

Protected Attributes
iAMainWindow *	m_mainWnd
	access to the main window

Detailed Description

Base class for a module interface.

A class derived from this class, 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

◆ iAGUIModuleInterface()

iAGUIModuleInterface::iAGUIModuleInterface ( )

◆ ~iAGUIModuleInterface()

iAGUIModuleInterface::~iAGUIModuleInterface ( )

virtual

Member Function Documentation

◆ Initialize()

void iAGUIModuleInterface::Initialize ( )

overridepure virtual

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

Implements iAModuleInterface.

◆ SaveSettings()

void iAGUIModuleInterface::SaveSettings ( ) const

overridevirtual

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

Reimplemented from iAModuleInterface.

◆ SetMainWindow()

void iAGUIModuleInterface::SetMainWindow ( iAMainWindow * mainWnd )

Called by the module dispatcher on module initialization. There should be no need to call this method from user code.

Member Data Documentation

◆ m_mainWnd

iAMainWindow* iAGUIModuleInterface::m_mainWnd

protected

access to the main window

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

libs/guibase/iAGUIModuleInterface.h
libs/guibase/iAGUIModuleInterface.cpp

Public Member Functions

Protected Attributes