ModuleInterface Interface Reference

Defines the module interface. More...

#include <moduleInterface.h>

Inheritance diagram for ModuleInterface:

[legend]

List of all members.

Public Member Functions
virtual QString	getName ()=0
	Get the name of the module.
virtual void	loadPlot (QwtPlot *)=0
	Load the Qwt plot.
virtual void	loadUi (QWidget *)=0
	Load the user interface.
virtual void	loadUiDataXML (QDomDocument *)=0
	Load data into the user interface from an XML file using the Qt DOM classes.
virtual void	saveUiDataXML (QDomDocument *)=0
	Save data from the user interface to an XML file using the Qt DOM classes.
virtual	~ModuleInterface ()
	Virtual destructor.

---

Detailed Description

Defines the module interface.

This class defines the interface which a module must conform to in order to be loaded as a plugin by QtPluginLoader.

---

Member Function Documentation

virtual QString ModuleInterface::getName

(

)

[pure virtual]

Get the name of the module.

The module must provide its name to TRANTOO.

Returns:

QString name

Implemented in APEModuleInterface, MPEModuleInterface, SketcherModuleInterface, and TestModuleInterface.

virtual void ModuleInterface::loadPlot

(

QwtPlot *

)

[pure virtual]

Load the Qwt plot.

This method is called by TRANTOO when it loads the module with the argument being a pointer to the QwtPlot widget (owned by the TRANTOO class MainWindow) which is to be used to plot the data generated by the module.

Parameters:

*

pointer to plot widget

Implemented in APEModuleInterface, MPEModuleInterface, SketcherModuleInterface, and TestModuleInterface.

virtual void ModuleInterface::loadUi

(

QWidget *

)

[pure virtual]

Load the user interface.

This method is called by TRANTOO when it loads the module with the argument being a pointer to the widget (owned by the TRANTOO class MainWindow) which is to be the parent of the module's user interface.

Parameters:

*

pointer to parent widget

Implemented in APEModuleInterface, MPEModuleInterface, SketcherModuleInterface, and TestModuleInterface.

virtual void ModuleInterface::loadUiDataXML

(

QDomDocument *

)

[pure virtual]

Load data into the user interface from an XML file using the Qt DOM classes.

This method is called by TRANTOO when the user wants to load data into the user interface from an xml file. The file is opened and a QDomDocument is created. A pointer to this document is passed to the module which will then attempt to load data from it.

Parameters:

*

pointer to QDomDocument

Implemented in APEModuleInterface, MPEModuleInterface, SketcherModuleInterface, and TestModuleInterface.

virtual void ModuleInterface::saveUiDataXML

(

QDomDocument *

)

[pure virtual]

Save data from the user interface to an XML file using the Qt DOM classes.

This method is called by TRANTOO when the user wants to save data from the user interface to an xml file. The file is opened and a QDomDocument is created. A pointer to this document is passed to the module which will then attempt to save data to it.

Parameters:

*

pointer to QDomDocument

Implemented in APEModuleInterface, MPEModuleInterface, SketcherModuleInterface, and TestModuleInterface.