iATool Class Reference

Base class for all tools; a tool is some collection of user interface elements that provides additional visualization or computation capabilities. More...

#include <iATool.h>

Collaboration diagram for iATool:

Public Member Functions
	iATool (iAMainWindow *mainWnd, iAMdiChild *child)
	Create the user interface elements of this tool.
virtual	~iATool ()
	virtual destructor, to enable proper destruction in derived classes and to avoid warnings
virtual void	loadState (QSettings &projectFile, QString const &fileName)
	Load the state of the tool from the given settings.
virtual void	saveState (QSettings &projectFile, QString const &fileName)
	Save the current state of the tool, so that the current window can be restored from the stored data via the loadState method The default implementation writes a key "Active" with value true so that the fact that the tool is loaded is persisted In case your tools status should not be stored in that way, overwrite the method with an empty implementation!

Protected Attributes
iAMdiChild *	m_child
	indicate whether this tool should be loaded only once the rendering of datasets has been fully initialized (true) or if it can be loaded once the child window is created (false)
iAMainWindow *	m_mainWindow

Detailed Description

Base class for all tools; a tool is some collection of user interface elements that provides additional visualization or computation capabilities.

Typical ways how iATool is used/created:

• a new iATool-derived class is created
• if state is available, the loadState method is called (

  See also

  loadState)

Constructor & Destructor Documentation

iATool()

iATool::iATool	(	iAMainWindow *	mainWnd,
		iAMdiChild *	child )

Create the user interface elements of this tool.

Note: Since this constructor is also called before loading a previous state via loadState, it should set up everything that is required for the tool, but should NOT perform any user interaction (e.g., asking the user for parameters or names of files to load)

~iATool()

iATool::~iATool ( )

virtual

virtual destructor, to enable proper destruction in derived classes and to avoid warnings

Member Function Documentation

loadState()

void iATool::loadState ( QSettings & projectFile, QString const & fileName )

virtual

Load the state of the tool from the given settings.

saveState()

void iATool::saveState ( QSettings & projectFile, QString const & fileName )

virtual

Save the current state of the tool, so that the current window can be restored from the stored data via the loadState method The default implementation writes a key "Active" with value true so that the fact that the tool is loaded is persisted In case your tools status should not be stored in that way, overwrite the method with an empty implementation!

Member Data Documentation

m_child

iAMdiChild* iATool::m_child

protected

indicate whether this tool should be loaded only once the rendering of datasets has been fully initialized (true) or if it can be loaded once the child window is created (false)

m_mainWindow

iAMainWindow* iATool::m_mainWindow

protected

---

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

• libs/guibase/iATool.h
• libs/guibase/iAToolRegistry.cpp