SalomeApp_Module Class Reference

Base class for all salome modules.

#include <SalomeApp_Module.h>

Inheritance diagram for SalomeApp_Module:

Public Slots
virtual bool	activateModule (SUIT_Study *)
virtual void	studyClosed (SUIT_Study *)
virtual void	onObjectClicked (SUIT_DataObject *, int)
	Virtual public slot.
virtual bool	deactivateModule (SUIT_Study *)
void	MenuItem ()
virtual void	connectToStudy (CAM_Study *)
	Connect data model of the module to the active study.
virtual void	studyChanged (SUIT_Study *, SUIT_Study *)
	Called when study is changed (obsolete).
virtual void	onApplicationClosed (SUIT_Application *)
	Called when application is closed.
Public Member Functions
	SalomeApp_Module (const QString &)
virtual	~SalomeApp_Module ()
virtual QString	engineIOR () const =0
SalomeApp_Application *	getApp () const
virtual void	storeVisualParameters (int savePoint)
	Virtual public.
virtual void	restoreVisualParameters (int savePoint)
	Virtual public.
virtual LightApp_Selection *	createSelection () const
virtual bool	renameAllowed (const QString &) const
	Check if this object is can't be renamed in place.
virtual bool	renameObject (const QString &, const QString &)
	Show warning message box and return c\ false in case if current study locked, true otherwise.
virtual void	initialize (CAM_Application *)
virtual void	windows (QMap< int, int > &) const
virtual void	viewManagers (QStringList &) const
virtual void	contextMenuPopup (const QString &, QMenu *, QString &)
virtual void	createPreferences ()
virtual void	update (const int)
	Update something in accordance with update flags.
virtual void	updateObjBrowser (bool=true, SUIT_DataObject *=0)
virtual void	selectionChanged ()
virtual void	preferencesChanged (const QString &, const QString &)
virtual void	studyActivated ()
virtual LightApp_Displayer *	displayer ()
virtual bool	canCopy () const
virtual bool	canPaste () const
virtual void	copy ()
	Copies the current selection into clipboard.
virtual void	paste ()
	Pastes the current data in the clipboard.
int	createMenu (const QString &, const int, const int=-1, const int=-1, const int=-1)
int	createMenu (const QString &, const QString &, const int=-1, const int=-1, const int=-1)
int	createMenu (const int, const int, const int=-1, const int=-1)
int	createMenu (const int, const QString &, const int=-1, const int=-1)
int	createMenu (QAction *, const int, const int=-1, const int=-1, const int=-1)
int	createMenu (QAction *, const QString &, const int=-1, const int=-1, const int=-1)
QString	name () const
	Get module (internal) name.
QString	moduleName () const
	Get module title (user name)
virtual QPixmap	moduleIcon () const
	Get module icon.
virtual QString	iconName () const
	Get module icon's name.
CAM_DataModel *	dataModel () const
	Get data model.
CAM_Application *	application () const
	Get application.
virtual void	updateCommandsStatus ()
	Update menu/toolbar actions.
virtual void	putInfo (const QString &, const int=-1)
	Put the text message into the status bar of the application main window.
bool	isActiveModule () const
	Check if the module is active.
virtual void	setMenuShown (const bool)
	Show/hide all module's menus.
void	setMenuShown (QAction *, const bool)
	Show/hide specified menu item.
void	setMenuShown (const int, const bool)
	Show/hide specified menu item.
virtual void	setToolShown (const bool)
	Show/hide all module's toolbars.
void	setToolShown (QAction *, const bool)
	Show/hide specified toolbar item.
void	setToolShown (const int, const bool)
	Show/hide specified toolbar item.
Protected Slots
virtual void	onModelSaved ()
virtual void	onModelOpened ()
virtual void	onModelClosed ()
virtual void	onOperationStopped (SUIT_Operation *)
	Virtual protected slot called when operation stopped.
virtual void	onOperationDestroyed ()
	Virtual protected slot called when operation destroyed.
virtual void	onShowHide ()
virtual void	onViewManagerAdded (SUIT_ViewManager *)
virtual void	onViewManagerRemoved (SUIT_ViewManager *)
Protected Member Functions
virtual CAM_DataModel *	createDataModel ()
virtual void	extractContainers (const SALOME_ListIO &, SALOME_ListIO &) const
virtual QtxPopupMgr *	popupMgr ()
LightApp_Preferences *	preferences () const
virtual bool	reusableOperation (const int id)
int	addPreference (const QString &label)
int	addPreference (const QString &label, const int pId, const int=LightApp_Preferences::Auto, const QString &section=QString(), const QString &param=QString())
QVariant	preferenceProperty (const int, const QString &) const
void	setPreferenceProperty (const int, const QString &, const QVariant &)
void	startOperation (const int)
	Starts operation with given identifier.
virtual LightApp_Operation *	createOperation (const int) const
	Creates operation with given identifier.
virtual void	updateControls ()
	Updates controls.
virtual bool	isSelectionCompatible ()
	If return false, selection will be cleared at module activation.
LightApp_Operation *	operation (const int) const
	Returns instance of operation by its id; if there is no operation corresponding to this id, null pointer is returned.
void	setName (const QString &)
	Set module (internal) name.
virtual void	setModuleName (const QString &)
	Set module title (user name)
QtxActionMenuMgr *	menuMgr () const
	Get menu manager.
QtxActionToolMgr *	toolMgr () const
	Get toolbar manager.
int	createTool (const QString &)
	Create toolbar with speicifed name.
int	createTool (const int, const int, const int=-1)
	Add toolbar item.
int	createTool (const int, const QString &, const int=-1)
	Add toolbar item.
int	createTool (QAction *, const int, const int=-1, const int=-1)
	Add toolbar item.
int	createTool (QAction *, const QString &, const int=-1, const int=-1)
	Add toolbar item.
QAction *	action (const int) const
	Get action by specified id.
int	actionId (const QAction *) const
	Get action ID.
int	registerAction (const int, QAction *)
	Register action in the internal action map.
bool	unregisterAction (const int)
	Unregister action from the internal action map.
bool	unregisterAction (QAction *)
	Unregister action from the internal action map.
QAction *	createAction (const int, const QString &, const QIcon &, const QString &, const QString &, const int, QObject *=0, const bool=false, QObject *=0, const char *=0, const QString &=QString())
	Create new instance of QtxAction and register action with specified id.
Static Protected Member Functions
static QAction *	separator ()
	Create separator action.
Protected Attributes
bool	myIsFirstActivate
int	myDisplay
int	myErase
int	myDisplayOnly
int	myEraseAll

---

Constructor & Destructor Documentation

SalomeApp_Module::SalomeApp_Module

(

const QString &

name

)

Constructor.

SalomeApp_Module::~SalomeApp_Module

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual QString SalomeApp_Module.engineIOR

(

)

const [pure virtual]

engineIOR() should be a pure virtual method, to avoid logical errors!
Implementation in derived classes can return the following values:
module`s engine IOR - means that this is a standard SALOME module with a CORBA engine

• "" (empty string) - means that this not correct SALOME module

Implemented in SALOME_PYQT_Module.

SalomeApp_Application * SalomeApp_Module::getApp

(

)

const

Convenient shortcuts

Gets application.

Reimplemented from LightApp_Module.

References CAM_Module.application().

void SalomeApp_Module::storeVisualParameters

(

int

savePoint

)

[virtual]

This method is called just before the study document is saved, so the module has a possibility to store visual parameters in AttributeParameter attribut

void SalomeApp_Module::restoreVisualParameters

(

int

savePoint

)

[virtual]

This method is called after the study document is opened, so the module has a possibility to restore visual parameters

LightApp_Selection * SalomeApp_Module::createSelection

(

)

const [virtual]

Create and return instance of LightApp_Selection.

Reimplemented from LightApp_Module.

bool SalomeApp_Module::renameAllowed

(

const QString &

entry

)

const [virtual]

This method can be re-implemented in the subclasses. Return true in case if object isn't reference or component (module root).

Parameters:

id

column id

Returns:

true if the item can be renamed by the user in place (e.g. in the Object browser)

Reimplemented from LightApp_Module.

References SUIT_Session.activeApplication(), SUIT_Application.activeStudy(), SalomeApp_Study.findObjectByEntry(), SalomeApp_Study.isComponent(), PyInterp.obj, and SUIT_Session.session().

bool SalomeApp_Module::renameObject	(	const QString &	,
		const QString &
	)		[virtual]

Reimplemented from LightApp_Module.

References _PTR(), SUIT_Session.activeApplication(), SUIT_Application.activeStudy(), SUIT_Application.desktop(), SUIT_Session.session(), and SUIT_MessageBox.warning().

bool SalomeApp_Module::activateModule

(

SUIT_Study *

theStudy

)

[virtual, slot]

Activate module.

Reimplemented from LightApp_Module.

Reimplemented in SALOME_PYQT_Module.

References STD_Application.activeViewManager(), CAM_Module.application(), SUIT_DataObject.children(), OB_Browser.model(), myIsFirstActivate, LightApp_Application.objectBrowser(), onObjectClicked(), SUIT_DataBrowser.root(), and SalomeApp_Application.updateVisibilityState().

void SalomeApp_Module::studyClosed

(

SUIT_Study *

theStudy

)

[virtual, slot]

Redefined to reset internal flags valid for study instance

Reimplemented from CAM_Module.

References CAM_Module.application(), OB_Browser.model(), myIsFirstActivate, LightApp_Application.objectBrowser(), and onObjectClicked().

void SalomeApp_Module::onObjectClicked	(	SUIT_DataObject *	theObject,
		int	theColumn
	)		[virtual, slot]

This method is called after the object inserted into data view to update their visibility state This is default implementation

References SUIT_Session.activeApplication(), SUIT_Application.activeStudy(), LightApp_DataObject.entry(), Qtx.HiddenState, CAM_Module.isActiveModule(), LightApp_Module.myDisplay, LightApp_Module.myErase, SUIT_Session.session(), Qtx.ShownState, LightApp_Module.startOperation(), SUIT_DataObject.VisibilityId, and LightApp_Study.visibilityState().

CAM_DataModel * SalomeApp_Module::createDataModel

(

)

[protected, virtual]

Create new instance of data model and return it.

Reimplemented from LightApp_Module.

Reimplemented in SALOME_PYQT_Module.

void SalomeApp_Module::extractContainers	(	const SALOME_ListIO &	source,
		SALOME_ListIO &	dest
	)		const [protected, virtual]

Converts objects-containers to list of objects, those are contained Other objects must be added without conversion

Parameters:

source	- source list of objects
dest	- list of converted objects

References _PTR(), SUIT_Session.activeApplication(), SUIT_Application.activeStudy(), SALOME_ListIO.Append(), Handle(), SALOME_ListIteratorOfListIO.More(), SALOME_ListIteratorOfListIO.Next(), PyInterp.obj, SUIT_Session.session(), and SALOME_ListIteratorOfListIO.Value().

void LightApp_Module::initialize

(

CAM_Application *

app

)

[virtual, inherited]

Initialize module.

Reimplemented from CAM_Module.

Reimplemented in SALOME_PYQT_ModuleLight.

References CAM_Module.name(), QtxResourceMgr.raiseTranslators(), and SUIT_Application.resourceMgr().

void LightApp_Module::windows

(

QMap< int, int > &

)

const [virtual, inherited]

NOT IMPLEMENTED

Reimplemented in SALOME_PYQT_ModuleLight.

void LightApp_Module::viewManagers

(

QStringList &

)

const [virtual, inherited]

NOT IMPLEMENTED

Reimplemented in SALOME_PYQT_ModuleLight.

void LightApp_Module::contextMenuPopup	(	const QString &	client,
		QMenu *	menu,
		QString &
	)		[virtual, inherited]

Context menu popup.

Reimplemented from CAM_Module.

Reimplemented in SALOME_PYQT_ModuleLight.

References LightApp_Module.createSelection(), LightApp_Module.getApp(), LightApp_Selection.init(), LightApp_Module.popupMgr(), QtxPopupMgr.setMenu(), QtxPopupMgr.setSelection(), and QtxPopupMgr.updateMenu().

void LightApp_Module::createPreferences

(

)

[virtual, inherited]

NOT IMPLEMENTED

Reimplemented in SALOME_PYQT_ModuleLight.

void LightApp_Module::update

(

const int

theFlags

)

[virtual, inherited]

Parameters:

theFlags

- update flags

Update viewer or/and object browser etc. in accordance with update flags ( see LightApp_UpdateFlags enumeration ). Derived modules can redefine this method for their own purposes

References CAM_Module.dataModel(), LightApp_Module.getApp(), LightApp_Application.objectBrowser(), UF_Controls, UF_Model, UF_ObjBrowser, UF_Viewer, LightApp_Module.updateControls(), and SUIT_DataBrowser.updateTree().

void LightApp_Module::updateObjBrowser	(	bool	theIsUpdateDataModel = true,
		SUIT_DataObject *	theDataObject = 0
	)		[virtual, inherited]

Update object browser. For updating model or whole object browser use update() method can be used.

References SUIT_Application.activeStudy(), SUIT_DataBrowser.autoUpdate(), CAM_Module.dataModel(), LightApp_Module.getApp(), LightApp_Application.objectBrowser(), SUIT_DataObject.parent(), SUIT_DataObject.root(), SUIT_DataBrowser.setAutoUpdate(), SUIT_Study.update(), and SUIT_DataBrowser.updateTree().

void LightApp_Module::selectionChanged

(

)

[virtual, inherited]

NOT IMPLEMENTED

void LightApp_Module::preferencesChanged	(	const QString &	,
		const QString &
	)		[virtual, inherited]

NOT IMPLEMENTED

Reimplemented in SALOME_PYQT_ModuleLight.

virtual void LightApp_Module.studyActivated

(

)

[virtual, inherited]

Reimplemented in SALOME_PYQT_ModuleLight.

LightApp_Displayer * LightApp_Module::displayer

(

)

[virtual, inherited]

Must be redefined in order to use standard displayer mechanism

Returns:

displayer of module

bool LightApp_Module::canCopy

(

)

const [virtual, inherited]

virtual method

Returns:

true if module can copy the current selection

bool LightApp_Module::canPaste

(

)

const [virtual, inherited]

virtual method

Returns:

true if module can paste previously copied data

void LightApp_Module::copy

(

)

[virtual, inherited]

virtual method

void LightApp_Module::paste

(

)

[virtual, inherited]

virtual method

int LightApp_Module::createMenu	(	const QString &	subMenu,
		const int	menu,
		const int	id = -1,
		const int	group = -1,
		const int	idx = -1
	)		[inherited]

Reimplemented from CAM_Module.

Reimplemented in SALOME_PYQT_ModuleLight.

int LightApp_Module::createMenu	(	const QString &	subMenu,
		const QString &	menu,
		const int	id = -1,
		const int	group = -1,
		const int	idx = -1
	)		[inherited]

Reimplemented from CAM_Module.

Reimplemented in SALOME_PYQT_ModuleLight.

References LightApp_Module.createMenu().

int LightApp_Module::createMenu	(	const int	id,
		const int	menu,
		const int	group = -1,
		const int	idx = -1
	)		[inherited]

Reimplemented from CAM_Module.

Reimplemented in SALOME_PYQT_ModuleLight.

References LightApp_Module.createMenu().

int LightApp_Module::createMenu	(	const int	id,
		const QString &	menu,
		const int	group = -1,
		const int	idx = -1
	)		[inherited]

Reimplemented from CAM_Module.

Reimplemented in SALOME_PYQT_ModuleLight.

References LightApp_Module.createMenu().

int LightApp_Module::createMenu	(	QAction *	a,
		const int	menu,
		const int	id = -1,
		const int	group = -1,
		const int	idx = -1
	)		[inherited]

Reimplemented from CAM_Module.

Reimplemented in SALOME_PYQT_ModuleLight.

References LightApp_Module.createMenu().

int LightApp_Module::createMenu	(	QAction *	a,
		const QString &	menu,
		const int	id = -1,
		const int	group = -1,
		const int	idx = -1
	)		[inherited]

Reimplemented from CAM_Module.

Reimplemented in SALOME_PYQT_ModuleLight.

References LightApp_Module.createMenu().

bool LightApp_Module::deactivateModule

(

SUIT_Study *

study

)

[virtual, slot, inherited]

Deactivate module.

Reimplemented from CAM_Module.

Reimplemented in SALOME_PYQT_ModuleLight.

References CAM_Module.action(), CAM_Module.application(), CAM_Module.moduleName(), LightApp_Module.myDisplay, LightApp_Module.myErase, LightApp_Module.myOperations, LightApp_Module.mySwitchOp, LightApp_Module.onViewManagerAdded(), LightApp_Module.onViewManagerRemoved(), SUIT_ShortcutMgr.setSectionEnabled(), and SUIT_Application.shortcutMgr().

void LightApp_Module::MenuItem

(

)

[slot, inherited]

NOT IMPLEMENTED

void LightApp_Module::onModelSaved

(

)

[protected, virtual, slot, inherited]

NOT IMPLEMENTED

void LightApp_Module::onModelOpened

(

)

[protected, virtual, slot, inherited]

NOT IMPLEMENTED

void LightApp_Module::onModelClosed

(

)

[protected, virtual, slot, inherited]

NOT IMPLEMENTED

void LightApp_Module::onOperationStopped

(

SUIT_Operation *

)

[protected, virtual, slot, inherited]

Parameters:

theOp

- stopped operation

Virtual protected slot called when operation stopped. Redefine this slot if you want to perform actions after stopping operation

void LightApp_Module::onOperationDestroyed

(

)

[protected, virtual, slot, inherited]

Parameters:

theOp

- destroyed operation

Virtual protected slot called when operation destroyed. Redefine this slot if you want to perform actions after destroying operation. Base implementation removes pointer on destroyed operation from the map of operations

References LightApp_Module.myOperations.

void LightApp_Module::onShowHide

(

)

[protected, virtual, slot, inherited]

SLOT: called on activating of standard operations show/hide

References CAM_Module.actionId(), LightApp_Module.popupMgr(), and LightApp_Module.startOperation().

void LightApp_Module::onViewManagerAdded

(

SUIT_ViewManager *

)

[protected, virtual, slot, inherited]

virtual SLOT: called on view manager adding

void LightApp_Module::onViewManagerRemoved

(

SUIT_ViewManager *

)

[protected, virtual, slot, inherited]

virtual SLOT: called on view manager removing

QtxPopupMgr * LightApp_Module::popupMgr

(

)

[protected, virtual, inherited]

Gets popup manager.(create if not exist)

References CAM_Module.actionId(), CAM_Module.application(), CAM_Module.createAction(), SUIT_Application.desktop(), QtxActionMenuMgr.insert(), LightApp_Module.myDisplay, LightApp_Module.myDisplayOnly, LightApp_Module.myErase, LightApp_Module.myEraseAll, LightApp_Module.myPopupMgr, CAM_Module.name(), LightApp_Module.onShowHide(), CAM_Module.separator(), QtxPopupMgr.setRule(), Plot2d_Viewer.Type(), SPlot2d_Viewer.Type(), VTKViewer_Viewer.Type(), SVTK_Viewer.Type(), OCCViewer_Viewer.Type(), and QtxPopupMgr.VisibleRule.

LightApp_Preferences * LightApp_Module::preferences

(

)

const [protected, inherited]

Gets preferences.

References LightApp_Module.getApp(), and LightApp_Application.preferences().

bool LightApp_Module::reusableOperation

(

const int

id

)

[protected, virtual, inherited]

virtual method called to manage the same operations

int LightApp_Module::addPreference

(

const QString &

label

)

[protected, inherited]

Add preference to preferences.

Reimplemented in SALOME_PYQT_ModuleLight.

References LightApp_Preferences.addPreference(), CAM_Module.moduleName(), and LightApp_Module.preferences().

int LightApp_Module::addPreference	(	const QString &	label,
		const int	pId,
		const int	type = LightApp_Preferences::Auto,
		const QString &	section = QString(),
		const QString &	param = QString()
	)		[protected, inherited]

Add preference to preferences.

Reimplemented in SALOME_PYQT_ModuleLight.

References LightApp_Preferences.addPreference(), CAM_Module.moduleName(), and LightApp_Module.preferences().

QVariant LightApp_Module::preferenceProperty	(	const int	id,
		const QString &	prop
	)		const [protected, inherited]

Gets property of preferences.

Reimplemented in SALOME_PYQT_ModuleLight.

References SUIT_PreferenceMgr.itemProperty(), and LightApp_Module.preferences().

void LightApp_Module::setPreferenceProperty	(	const int	id,
		const QString &	prop,
		const QVariant &	var
	)		[protected, inherited]

Set property of preferences.

Reimplemented in SALOME_PYQT_ModuleLight.

References LightApp_Module.preferences(), and SUIT_PreferenceMgr.setItemProperty().

void LightApp_Module::startOperation

(

const int

id

)

[protected, inherited]

Module stores operations in map. This method starts operation by id. If operation isn't in map, then it will be created by createOperation method and will be inserted to map

Parameters:

id	- identifier of operation to be started

Module stores operations in map. This method starts operation by id. If operation isn't in map, then it will be created by createOperation method and will be inserted to map

References CAM_Module.application(), LightApp_Module.createOperation(), LightApp_Module.myOperations, LightApp_Module.onOperationDestroyed(), LightApp_Module.onOperationStopped(), LightApp_Module.reusableOperation(), LightApp_Operation.setModule(), SUIT_Operation.setStudy(), and SUIT_Operation.start().

LightApp_Operation * LightApp_Module::createOperation

(

const int

id

)

const [protected, virtual, inherited]

Create operation by its id. You must not call this method, it will be called automatically by startOperation. Please redefine this method in current module

Parameters:

id	- identifier of operation to be started

Returns:

Pointer on created operation or NULL if operation is not created

Creates operation with given id. You should not call this method, it will be called automatically from startOperation. You may redefine this method in concrete module to create operations.

References LightApp_ShowHideOp.DISPLAY, LightApp_ShowHideOp.DISPLAY_ONLY, LightApp_ShowHideOp.ERASE, LightApp_ShowHideOp.ERASE_ALL, LightApp_Module.myDisplay, LightApp_Module.myDisplayOnly, LightApp_Module.myErase, and LightApp_Module.myEraseAll.

void LightApp_Module::updateControls

(

)

[protected, virtual, inherited]

Updates (i.e. disable/enable) controls states (menus, tool bars etc.). This method is called from update( UF_Controls ). You may redefine it in concrete module.

bool LightApp_Module::isSelectionCompatible

(

)

[protected, virtual, inherited]

Reimplemented from CAM_Module.

References SUIT_Application.activeStudy(), LightApp_Study.componentDataType(), LightApp_DataObject.componentDataType(), CAM_Module.dataModel(), LightApp_Module.getApp(), Handle(), SALOME_ListIteratorOfListIO.More(), SALOME_ListIteratorOfListIO.Next(), CAM_DataModel.root(), and SALOME_ListIteratorOfListIO.Value().

LightApp_Operation * LightApp_Module::operation

(

const int

id

)

const [protected, inherited]

Parameters:

id	- operation id

Returns:

operation instance

References LightApp_Module.myOperations.

QString CAM_Module::name

(

)

const [inherited]

Returns:

module name

See also:

setName(), moduleName(), setModuleName()

QString CAM_Module::moduleName

(

)

const [inherited]

Returns:

module title

See also:

setModuleName(), name(), setName()

References CAM_Module.myName.

QPixmap CAM_Module::moduleIcon

(

)

const [virtual, inherited]

Returns:

module icon pixmap

See also:

iconName()

References CAM_Module.application(), CAM_Module.iconName(), QtxResourceMgr.loadPixmap(), CAM_Module.myIcon, CAM_Module.name(), and SUIT_Application.resourceMgr().

QString CAM_Module::iconName

(

)

const [virtual, inherited]

This function is used to get module icon's file name. Default implementation returns empty string.

Returns:

module icon's name.

See also:

moduleIcon()

References CAM_Module.application(), CAM_Application.moduleIcon(), and CAM_Module.name().

CAM_DataModel * CAM_Module::dataModel

(

)

const [inherited]

Creates data model, if it is not yet created.

Returns:

data model pointer

See also:

createDataModel()

References CAM_Module.createDataModel(), CAM_DataModel.initialize(), and CAM_Module.myDataModel.

CAM_Application * CAM_Module::application

(

)

const [inherited]

Returns:

application pointer

References CAM_Module.myApp.

void CAM_Module::updateCommandsStatus

(

)

[virtual, inherited]

void CAM_Module::putInfo	(	const QString &	msg,
		const int	msec = -1
	)		[virtual, inherited]

If msec > 0, the message will be shown msec milliseconds. If msec < 0, the message will be constantly displayed until module is active.

Parameters:

msg	text message
msec	message displaying duration in milliseconds

References CAM_Module.application(), CAM_Module.myInfo, and SUIT_Application.putInfo().

bool CAM_Module::isActiveModule

(

)

const [inherited]

Returns:

true if module is active.

References CAM_Application.activeModule(), and CAM_Module.application().

void CAM_Module::setMenuShown

(

const bool

on

)

[virtual, inherited]

Parameters:

on	if true, show menus, otherwise, hide all menus

See also:

setToolShown()

References QtxActionMgr.actionId(), QtxActionMgr.isUpdatesEnabled(), CAM_Module.menuMgr(), CAM_Module.myActionMap, CAM_Module.myMenuShown, CAM_Module.separator(), QtxActionMenuMgr.setShown(), QtxActionMgr.setUpdatesEnabled(), and QtxActionMgr.update().

void CAM_Module::setMenuShown	(	QAction *	a,
		const bool	on
	)		[inherited]

Parameters:

a	action
on	if true, show menu item, otherwise, hide it

References CAM_Module.actionId(), CAM_Module.menuMgr(), and QtxActionMenuMgr.setShown().

void CAM_Module::setMenuShown	(	const int	id,
		const bool	on
	)		[inherited]

Parameters:

id	menu item ID
on	if true, show menu item, otherwise, hide it

References CAM_Module.action(), and CAM_Module.setMenuShown().

void CAM_Module::setToolShown

(

const bool

on

)

[virtual, inherited]

Parameters:

on	if true, show toolbars, otherwise, hide all toolbars

See also:

setMenuShown()

References QtxActionMgr.actionId(), QtxActionMgr.isUpdatesEnabled(), CAM_Module.myActionMap, CAM_Module.myToolShown, CAM_Module.separator(), QtxActionToolMgr.setShown(), QtxActionMgr.setUpdatesEnabled(), CAM_Module.toolMgr(), and QtxActionMgr.update().

void CAM_Module::setToolShown	(	QAction *	a,
		const bool	on
	)		[inherited]

Parameters:

a	action
on	if true, show toolbar item, otherwise, hide it

References CAM_Module.actionId(), QtxActionToolMgr.setShown(), and CAM_Module.toolMgr().

void CAM_Module::setToolShown	(	const int	id,
		const bool	on
	)		[inherited]

Parameters:

id	toolbar item ID
on	if true, show toolbar item, otherwise, hide it

References CAM_Module.action(), and CAM_Module.setToolShown().

void CAM_Module::connectToStudy

(

CAM_Study *

camStudy

)

[virtual, slot, inherited]

Parameters:

camStudy

CAM study object

References SUIT_Study.application(), CAM_Study.containsDataModel(), CAM_Study.insertDataModel(), and CAM_Application.modules().

void CAM_Module::studyChanged	(	SUIT_Study *	,
		SUIT_Study *
	)		[virtual, slot, inherited]

Default implementation does nothing.

Parameters:

oldStudy	old study
newStudy	new study

void CAM_Module::onApplicationClosed

(

SUIT_Application *

theApp

)

[virtual, slot, inherited]

Nullify application pointer if the application is being closed.

Parameters:

theApp

application

References CAM_Module.myApp.

void CAM_Module::setName

(

const QString &

name

)

[protected, inherited]

Parameters:

name	new module name

See also:

name(), moduleName(), setModuleName()

void CAM_Module::setModuleName

(

const QString &

name

)

[protected, virtual, inherited]

Parameters:

name	new module title

See also:

moduleName(), name(), setName()

References CAM_Module.myName, and CAM_Module.name().

QtxActionMenuMgr * CAM_Module::menuMgr

(

)

const [protected, inherited]

Returns:

menu manager pointer

References CAM_Module.application(), SUIT_Application.desktop(), and SUIT_Desktop.menuMgr().

QtxActionToolMgr * CAM_Module::toolMgr

(

)

const [protected, inherited]

Returns:

toolbar manager pointer

References CAM_Module.application(), SUIT_Application.desktop(), and SUIT_Desktop.toolMgr().

int CAM_Module::createTool

(

const QString &

name

)

[protected, inherited]

If the toolbar has been already created, its ID is just returned.

Parameters:

name	toolbar name

Returns:

toolbar ID or -1 if toolbar could not be created

Reimplemented in SALOME_PYQT_ModuleLight.

References QtxActionToolMgr.createToolBar(), CAM_Module.myToolShown, and CAM_Module.toolMgr().

int CAM_Module::createTool	(	const int	id,
		const int	tBar,
		const int	idx = -1
	)		[protected, inherited]

Insert action with id identifier to the toolbar manager. It is assumed that action has been already registered.

Resulting action ID may differ from the requested one. This can happen if requested ID is already in use.

If action has been already added previously, its ID is just returned.

If idx < 0, the action is added to the end of the toolbar.

Parameters:

id	action ID
tBar	toolbar ID
idx	action index (desired position in the toolbar)

Returns:

action ID or -1 if toolbar item could not be added

Reimplemented in SALOME_PYQT_ModuleLight.

References CAM_Module.action(), QtxActionToolMgr.insert(), CAM_Module.myToolShown, CAM_Module.setToolShown(), and CAM_Module.toolMgr().

int CAM_Module::createTool	(	const int	id,
		const QString &	tBar,
		const int	idx = -1
	)		[protected, inherited]

Insert action with id identifier to the toolbar manager. It is assumed that action has been already registered.

Resulting action ID may differ from the requested one. This can happen if requested ID is already in use.

If action has been already added previously, its ID is just returned.

If idx < 0, the action is added to the end of the toolbar.

Parameters:

id	action ID
tBar	toolbar name
idx	action index (desired position in the toolbar)

Returns:

action ID or -1 if toolbar item could not be added

Reimplemented in SALOME_PYQT_ModuleLight.

References CAM_Module.action(), QtxActionToolMgr.insert(), CAM_Module.myToolShown, CAM_Module.setToolShown(), and CAM_Module.toolMgr().

int CAM_Module::createTool	(	QAction *	a,
		const int	tBar,
		const int	id = -1,
		const int	idx = -1
	)		[protected, inherited]

Insert action to the toolbar manager and register it with specified id. Resulting action ID may differ from the requested one. This can happen if requested ID is already in use.

If action has been already added previously, its ID is just returned.

If id < 0, the action ID is generated automatically.

If idx < 0, the action is added to the end of the toolbar.

Parameters:

a	action
tBar	toolbar ID
id	requested action ID
idx	action index (desired position in the toolbar)

Returns:

action ID or -1 if toolbar item could not be added

Reimplemented in SALOME_PYQT_ModuleLight.

References QtxActionToolMgr.insert(), CAM_Module.myToolShown, CAM_Module.registerAction(), CAM_Module.setToolShown(), and CAM_Module.toolMgr().

int CAM_Module::createTool	(	QAction *	a,
		const QString &	tBar,
		const int	id = -1,
		const int	idx = -1
	)		[protected, inherited]

Insert action to the toolbar manager and register it with specified id. Resulting action ID may differ from the requested one. This can happen if requested ID is already in use.

If action has been already added previously, its ID is just returned.

If id < 0, the action ID is generated automatically.

If idx < 0, the action is added to the end of the toolbar.

Parameters:

a	action
tBar	toolbar name
id	requested action ID
idx	action index (desired position in the toolbar)

Returns:

action ID or -1 if toolbar item could not be added

Reimplemented in SALOME_PYQT_ModuleLight.

References QtxActionToolMgr.insert(), CAM_Module.myToolShown, CAM_Module.registerAction(), CAM_Module.setToolShown(), and CAM_Module.toolMgr().

QAction * CAM_Module::separator

(

)

[static, protected, inherited]

Separator action can be used in menus or toolbars.

Returns:

new separator action

Reimplemented in SALOME_PYQT_ModuleLight.

QAction * CAM_Module::action

(

const int

id

)

const [protected, inherited]

Parameters:

id

action ID

Returns:

action or 0 if not found

Reimplemented in SALOME_PYQT_ModuleLight.

References test_table.a, and CAM_Module.myActionMap.

int CAM_Module::actionId

(

const QAction *

a

)

const [protected, inherited]

Parameters:

a

action

Returns:

action ID or -1 if not found

Reimplemented in SALOME_PYQT_ModuleLight.

References test_table.a, and CAM_Module.myActionMap.

int CAM_Module::registerAction	(	const int	id,
		QAction *	a
	)		[protected, inherited]

If action has been already added previously, its ID is just returned. If id < 0, the action ID is generated automatically.

Parameters:

id	action required ID
a	action

Returns:

action ID

References test_table.a, CAM_Module.application(), SUIT_Application.desktop(), CAM_Module.menuMgr(), CAM_Module.myActionMap, QtxActionMgr.registerAction(), and CAM_Module.toolMgr().

bool CAM_Module::unregisterAction

(

const int

id

)

[protected, inherited]

Parameters:

id

action ID

Returns:

true on success or false if action is in use

References CAM_Module.action().

bool CAM_Module::unregisterAction

(

QAction *

a

)

[protected, inherited]

Parameters:

a

action

Returns:

true on success or false if action is in use

References CAM_Module.actionId(), QtxActionMgr.actionId(), CAM_Module.menuMgr(), CAM_Module.toolMgr(), and QtxActionMgr.unRegisterAction().

QAction * CAM_Module::createAction	(	const int	id,
		const QString &	text,
		const QIcon &	icon,
		const QString &	menu,
		const QString &	tip,
		const int	key,
		QObject *	parent = 0,
		const bool	toggle = false,
		QObject *	reciever = 0,
		const char *	member = 0,
		const QString &	shortcutAction = QString()
	)		[protected, inherited]

Resulting action ID may differ from the requested one. This can happen if requested ID is already in use.

If id < 0, the action ID is generated automatically.

Parameters:

id	required action ID
text	tooltip text
icon	action icon
menu	menu text
tip	status bar tip
key	keyboard accelerator
parent	parent object
toggle	if true, the action will be toggled
reciever	action activation signal receiver object
member	action activation signal receiver slot

References test_table.a, and CAM_Module.registerAction().

---

Field Documentation

bool SalomeApp_Module.myIsFirstActivate [protected]

int LightApp_Module.myDisplay [protected, inherited]

int LightApp_Module.myErase [protected, inherited]

int LightApp_Module.myDisplayOnly [protected, inherited]

int LightApp_Module.myEraseAll [protected, inherited]