This class implements GUI module for CORBA engine-based Python SALOME modules. More...

#include <SALOME_PYQT_Module.h>

Inheritance diagram for SALOME_PYQT_Module:

Public Member Functions
	SALOME_PYQT_Module ()
	Constructor. More...

	~SALOME_PYQT_Module ()
	Destructor. More...

QString	engineIOR () const
	Get module engine IOR. More...

void	initialize (CAM_Application *)
	Initialization of the module. More...

bool	activateModule (SUIT_Study *)
	Activation of the module. More...

bool	deactivateModule (SUIT_Study *)
	Deactivation of the module. More...

void	windows (QMap< int, int > &) const
	Get the dockable windows associated with the module. More...

void	viewManagers (QStringList &) const
	Define the compatible view windows associated with the module. More...

void	studyActivated ()
	Process study activation. More...

void	contextMenuPopup (const QString &, QMenu *, QString &)
	Process context popup menu request. More...

void	createPreferences ()
	Export preferences for the Python module. More...

void	preferencesChanged (const QString &, const QString &)
	Process module's preferences changing. More...

void	studyClosed (SUIT_Study *)
	Called when study is closed. More...

bool	isDraggable (const SUIT_DataObject *) const
	Test if object what can be dragged by the user. More...

bool	isDropAccepted (const SUIT_DataObject *) const
	Test if drop operation can be done on the where object. More...

void	dropObjects (const DataObjectList &, SUIT_DataObject *, const int, Qt::DropAction)
	Perform drop operation. More...

Public Member Functions inherited from SalomeApp_Module
	SalomeApp_Module (const QString &)

virtual	~SalomeApp_Module ()

SalomeApp_Application *	getApp () const

virtual void	storeVisualParameters (int savePoint)
	Virtual public. More...

virtual void	restoreVisualParameters (int savePoint)
	Virtual public. More...

virtual LightApp_Selection *	createSelection () const

Public Member Functions inherited from LightApp_Module
	LightApp_Module (const QString &)

virtual	~LightApp_Module ()

LightApp_Application *	getApp () const

virtual void	update (const int)
	Update something in accordance with update flags. More...

virtual void	updateObjBrowser (bool=true, SUIT_DataObject *=0)

virtual void	selectionChanged ()

virtual void	message (const QString &)

virtual LightApp_Displayer *	displayer ()

virtual bool	canCopy () const

virtual bool	canPaste () const

virtual void	copy ()
	Copies the current selection into clipboard. More...

virtual void	paste ()
	Pastes the current data in the clipboard. More...

virtual bool	renameAllowed (const QString &) const
	Return `true` if object can be renamed. More...

virtual bool	renameObject (const QString &, const QString &)
	Return `true` if rename operation finished successfully, `false` otherwise. More...

virtual void	updateModuleVisibilityState ()

Public Member Functions inherited from CAM_Module
	CAM_Module ()
	Default constructor. More...

	CAM_Module (const QString &)
	Constructor. More...

virtual	~CAM_Module ()
	Destructor. More...

QString	name () const
	Get module (internal) name. More...

QString	moduleName () const
	Get module title (user name) More...

virtual QPixmap	moduleIcon () const
	Get module icon. More...

virtual QString	iconName () const
	Get module icon's name. More...

CAM_DataModel *	dataModel () const
	Get data model. More...

CAM_Application *	application () const
	Get application. More...

virtual void	updateCommandsStatus ()
	Update menu/toolbar actions. More...

virtual void	putInfo (const QString &, const int=-1)
	Put the text message into the status bar of the application main window. More...

int	showNotification (const QString &message, const QString &title, int timeout=-1)
	Shows the notifications with spectified text, title and automatic close timeout. Notification will be automatically closed after specified timeout in msec. If timeout is zero then automatic closing doesn't performed. More...

void	hideNotification (const QString &message)
	Closes the notifications with spectified text. More...

void	hideNotification (int id)
	Closes the notifications with spectified identifier. More...

bool	isActiveModule () const
	Check if the module is active. More...

virtual void	setMenuShown (const bool)
	Show/hide all module's menus. More...

void	setMenuShown (QAction *, const bool)
	Show/hide specified menu item. More...

void	setMenuShown (const int, const bool)
	Show/hide specified menu item. More...

virtual void	setToolShown (const bool)
	Show/hide all module's toolbars. More...

void	setToolShown (QAction *, const bool)
	Show/hide specified toolbar item. More...

void	setToolShown (const int, const bool)
	Show/hide specified toolbar item. More...

virtual bool	activateOperation (int actionId)
	Activate GUI operation of module by its ID. This method is called from CAM_Application::startOperation(). More...

virtual bool	activateOperation (const QString &actionId)
	Activate GUI operation of module by its ID. This method is called from CAM_Application::startOperation(). More...

virtual bool	activateOperation (const QString &actionId, const QString &pluginName)
	Activate GUI operation of module by its ID and pluginName. This method is called from CAM_Application::startOperation(). More...

QtxActionMenuMgr *	menuMgr () const
	Get menu manager. More...

QtxActionToolMgr *	toolMgr () const
	Get toolbar manager. More...

virtual QAction *	action (const int) const
	Get action by specified id. More...

virtual int	actionId (const QAction *) const
	Get action ID. More...

virtual 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. More...

virtual QAction *	createAction (const int, const QString &, const QIcon &, const QString &, const QString &, const QKeySequence &, QObject =0, const bool=false, QObject =0, const char *=0, const QString &=QString())
	Create new instance of QtxAction and register action with specified id. More...

QtxActionGroup *	createActionGroup (const int, const bool=true)
	Create new action group. More...

int	createTool (const QString &, const QString &=QString())
	Create toolbar with speicifed name. More...

int	createTool (const int, const int, const int=-1)
	Add toolbar item. More...

int	createTool (const int, const QString &, const int=-1)
	Add toolbar item. More...

int	createTool (QAction *, const int, const int=-1, const int=-1)
	Add toolbar item. More...

int	createTool (QAction *, const QString &, const int=-1, const int=-1)
	Add toolbar item. More...

void	clearTool (const QString &title)

int	createMenu (const QString &, const int, const int=-1, const int=-1, const int=-1, QMenu *=0)
	Create menu or submenu. More...

int	createMenu (const QString &, const QString &, const int=-1, const int=-1, const int=-1)
	Create menu or submenu. More...

int	createMenu (const int, const int, const int=-1, const int=-1)
	Add menu item. More...

int	createMenu (const int, const QString &, const int=-1, const int=-1)
	Add menu item. More...

int	createMenu (QAction *, const int, const int=-1, const int=-1, const int=-1)
	Add menu item. More...

int	createMenu (QAction *, const QString &, const int=-1, const int=-1, const int=-1)
	Add menu item. More...

virtual void	logAction (QAction *)
	Log given action. More...

bool	isActionLoggingEnabled () const
	Return `true` if action logging is enabled. More...

void	setActionLoggingEnabled (bool)
	Enable / disable action logging. More...

Private Attributes
PyModuleHelper *	myHelper

Additional Inherited Members
Public Slots inherited from LightApp_Module
virtual void	onObjectClicked (SUIT_DataObject *, int)
	Virtual public slot. More...

void	onOBDestroyed ()

void	MenuItem ()

virtual void	updateInfoPanel ()

Public Slots inherited from CAM_Module
virtual void	connectToStudy (CAM_Study *)
	Connect data model of the module to the active study. More...

virtual void	studyChanged (SUIT_Study , SUIT_Study )
	Called when study is changed (obsolete). More...

virtual void	onApplicationClosed (SUIT_Application *)
	Called when application is closed. More...

virtual void	moduleActionActivated ()
	Called when an action is triggered. More...

Static Public Member Functions inherited from CAM_Module
static QAction *	separator ()
	Create separator action. More...

Protected Slots inherited from LightApp_Module
virtual void	onModelSaved ()

virtual void	onModelOpened ()

virtual void	onModelClosed ()

virtual void	onOperationStopped (SUIT_Operation *)
	Virtual protected slot called when operation stopped. More...

virtual void	onOperationDestroyed ()
	Virtual protected slot called when operation destroyed. More...

virtual void	onShowHide ()

virtual void	onViewManagerAdded (SUIT_ViewManager *)

virtual void	onViewManagerRemoved (SUIT_ViewManager *)

Protected Member Functions inherited from SalomeApp_Module
virtual CAM_DataModel *	createDataModel ()

virtual void	extractContainers (const SALOME_ListIO &, SALOME_ListIO &) const

Protected Member Functions inherited from LightApp_Module
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 type=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. More...

virtual LightApp_Operation *	createOperation (const int) const
	Creates operation with given identifier. More...

virtual void	updateControls ()
	Updates controls. More...

virtual bool	isSelectionCompatible ()
	If return false, selection will be cleared at module activation. More...

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. More...

Protected Member Functions inherited from CAM_Module
void	setName (const QString &)
	Set module (internal) name. More...

virtual void	setModuleName (const QString &)
	Set module title (user name) More...

int	registerAction (const int, QAction *)
	Register action in the internal action map. More...

bool	unregisterAction (const int)
	Unregister action from the internal action map. More...

bool	unregisterAction (QAction *)
	Unregister action from the internal action map. More...

virtual bool	abortAllOperations ()

Protected Attributes inherited from LightApp_Module
int	myDisplay

int	myErase

int	myDisplayOnly

int	myEraseAll

bool	myIsFirstActivate

Protected Attributes inherited from CAM_Module
QMap< QAction *, QKeySequence >	myActionShortcutMap
	copy actions shortcut map More...

Detailed Description

This class implements GUI module for CORBA engine-based Python SALOME modules.

Constructor & Destructor Documentation

◆ SALOME_PYQT_Module()

SALOME_PYQT_Module::SALOME_PYQT_Module ( )

Constructor.

References myHelper.

◆ ~SALOME_PYQT_Module()

SALOME_PYQT_Module::~SALOME_PYQT_Module ( )

Destructor.

Member Function Documentation

◆ activateModule()

bool SALOME_PYQT_Module::activateModule ( SUIT_Study * study )

virtual

Activation of the module.

Parameters

study parent study

Returns: true if activation is successful and false otherwise

See also: PyModuleHelper::activate()

Reimplemented from LightApp_Module.

References PyModuleHelper::activate(), LightApp_Module::activateModule(), and myHelper.

◆ contextMenuPopup()

void SALOME_PYQT_Module::contextMenuPopup	(	const QString &	context,
		QMenu *	menu,
		QString &
	)

virtual

Process context popup menu request.

Parameters

context	popup menu context (e.g. "ObjectBrowser")
menu	popup menu
title	popup menu title (not used)

See also: PyModuleHelper::contextMenu()

Reimplemented from LightApp_Module.

References PyModuleHelper::contextMenu(), and myHelper.

◆ createPreferences()

void SALOME_PYQT_Module::createPreferences ( )

virtual

Export preferences for the Python module.

See also: PyModuleHelper::createPreferences()

Reimplemented from LightApp_Module.

References PyModuleHelper::createPreferences(), and myHelper.

◆ deactivateModule()

bool SALOME_PYQT_Module::deactivateModule ( SUIT_Study * study )

virtual

Deactivation of the module.

Parameters

study parent study

Returns: true if deactivation is successful and false otherwise

See also: PyModuleHelper::deactivate()

Reimplemented from LightApp_Module.

References PyModuleHelper::deactivate(), LightApp_Module::deactivateModule(), and myHelper.

◆ dropObjects()

void SALOME_PYQT_Module::dropObjects	(	const DataObjectList &	what,
		SUIT_DataObject *	where,
		const int	row,
		Qt::DropAction	action
	)

virtual

Perform drop operation.

Parameters

what	list of data objects being dropped
where	target data object for drop operation
row	line (child item index) where drop operation is performed to
action	current drop action (copy or move)

See also: PyModuleHelper::dropObjects()

Reimplemented from LightApp_Module.

References CAM_Module::action(), PyModuleHelper::dropObjects(), and myHelper.

◆ engineIOR()

QString SALOME_PYQT_Module::engineIOR ( ) const

virtual

Get module engine IOR.

This function tries to get engine IOR from the Python module using engineIOR() function. That function can load module engine using appropriate container if required. If this function is not available in Python module, the default implementation is used which loads engine to the default FactoryServer container.

Implements SalomeApp_Module.

References PyModuleHelper::engineIOR(), SalomeApp_Module::getApp(), SalomeApp_Application::lcc(), myHelper, and CAM_Module::name().