1 // Copyright (C) 2007-2014 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 // File : SALOME_PYQT_Module.cxx
23 // Author : Vadim SANDLER, Open CASCADE S.A.S. (vadim.sandler@opencascade.com)
25 #include "SALOME_PYQT_Module.h"
26 #include "SALOME_PYQT_PyModule.h"
27 #include "SalomeApp_Application.h"
29 #include <SALOME_LifeCycleCORBA.hxx>
30 #include <Container_init_python.hxx>
33 // NB: Python requests.
34 // General rule for Python requests created by Python-based GUI modules
35 // (SALOME_PYQT_Module and other ones):
36 // all requests should be executed SYNCHRONOUSLY within the main GUI thread.
37 // However, it is obligatory that ANY Python call is wrapped with a request object,
38 // so that ALL Python API calls are serialized with PyInterp_Dispatcher.
40 // NB: Library initialization
41 // Since the SalomePyQtGUI library is not imported in Python it's initialization function
42 // should be called manually (and only once) in order to initialize global sip data
43 // and to get C API from sip : sipBuildResult for example
46 #define INIT_FUNCTION initSalomePyQtGUILight
47 #if defined(SIP_STATIC_MODULE)
48 extern "C" void INIT_FUNCTION();
50 PyMODINIT_FUNC INIT_FUNCTION();
54 \fn CAM_Module* createModule()
55 \brief Module factory function.
58 Creates an instance of SALOME_PYQT_Module object by request
59 of an application when the module is loaded and initialized.
61 \return new module object
65 SALOME_PYQT_EXPORT CAM_Module* createModule()
67 static bool alreadyInitialized = false;
69 if ( !alreadyInitialized ) {
70 // call only once (see comment above) !
71 PyEval_RestoreThread( KERNEL_PYTHON::_gtstate);
73 PyEval_ReleaseThread( KERNEL_PYTHON::_gtstate);
74 alreadyInitialized = !alreadyInitialized;
77 return new SALOME_PYQT_Module();
82 \class SALOME_PYQT_Module
83 \brief This class implements GUI module for CORBA engine-based Python SALOME modules.
89 SALOME_PYQT_Module::SALOME_PYQT_Module()
90 : SalomeApp_Module( "noname" ) // name is set explicitly at the module initialization
93 myHelper = new PyModuleHelper( this );
99 SALOME_PYQT_Module::~SALOME_PYQT_Module()
101 // as myHelper is a QObject, it should be deleted automatically
105 \brief Get module engine IOR
107 This function tries to get engine IOR from the Python module using engineIOR() function.
108 That function can load module engine using appropriate container if required.
109 If this function is not available in Python module, the default implementation
110 is used which loads engine to the default FactoryServer container.
112 QString SALOME_PYQT_Module::engineIOR() const
114 // call helper to get IOR from Python module
117 if ( ior.isEmpty() ) {
118 // first call helper to get IOR from Python module
119 ior = myHelper->engineIOR();
121 if ( ior.isEmpty() ) {
122 // if IOR is still not specified, try default implementation
123 // which loads engine to the default FactoryServer container.
124 Engines::EngineComponent_var comp;
125 // temporary solution
127 comp = getApp()->lcc()->FindOrLoad_Component( "FactoryServer", name().toLatin1() );
129 catch (CORBA::Exception&) {
131 if ( !CORBA::is_nil( comp ) )
132 ior = QString( getApp()->orb()->object_to_string( comp.in() ) );
139 \brief Initialization of the module.
140 \param app parent application object
141 \sa PyModuleHelper::initialize()
143 void SALOME_PYQT_Module::initialize( CAM_Application* app )
145 // call base implementation
146 SalomeApp_Module::initialize( app );
148 // ... then call helper
149 myHelper->initialize( app );
153 \brief Activation of the module.
154 \param study parent study
155 \return \c true if activation is successful and \c false otherwise
156 \sa PyModuleHelper::activate()
158 bool SALOME_PYQT_Module::activateModule( SUIT_Study* study )
160 // call base implementation and then helper
161 return SalomeApp_Module::activateModule( study ) && myHelper->activate( study );
165 \brief Deactivation of the module.
166 \param study parent study
167 \return \c true if deactivation is successful and \c false otherwise
168 \sa PyModuleHelper::deactivate()
170 bool SALOME_PYQT_Module::deactivateModule( SUIT_Study* study )
173 bool res = myHelper->deactivate( study );
175 // ... then call base implementation
176 return SalomeApp_Module::deactivateModule( study ) && res;
180 \brief Get the dockable windows associated with the module.
181 \param winMap output map of dockable windows in form { <window_type> : <dock_area> }
182 \sa PyModuleHelper::windows()
184 void SALOME_PYQT_Module::windows( QMap<int, int>& winMap ) const
186 // get list of dockable windows from helper
187 winMap = myHelper->windows();
191 \brief Define the compatible view windows associated with the module.
192 \param viewList output list of view windows types
193 \sa PyModuleHelper::viewManagers()
195 void SALOME_PYQT_Module::viewManagers( QStringList& viewList ) const
197 // get list of view types from helper
198 viewList = myHelper->viewManagers();
202 \brief Process study activation.
203 \sa PyModuleHelper::studyActivated()
205 void SALOME_PYQT_Module::studyActivated()
208 myHelper->studyActivated( application()->activeStudy() );
212 \brief Process context popup menu request.
213 \param context popup menu context (e.g. "ObjectBrowser")
214 \param menu popup menu
215 \param title popup menu title (not used)
216 \sa PyModuleHelper::contextMenu()
218 void SALOME_PYQT_Module::contextMenuPopup( const QString& context,
223 myHelper->contextMenu( context, menu );
227 \brief Export preferences for the Python module.
228 \sa PyModuleHelper::createPreferences()
230 void SALOME_PYQT_Module::createPreferences()
233 myHelper->createPreferences();
237 \brief Process module's preferences changing.
238 \param section preference resources section
239 \param parameter preference resources parameter name
240 \sa PyModuleHelper::preferencesChanged()
242 void SALOME_PYQT_Module::preferencesChanged( const QString& section, const QString& parameter )
245 myHelper->preferencesChanged( section, parameter );
249 \brief Test if object \a what can be dragged by the user.
250 \param what data object being tested
251 \return \c true if object can be dragged or \c false otherwise
252 \sa PyModuleHelper::isDraggable()
254 bool SALOME_PYQT_Module::isDraggable( const SUIT_DataObject* what ) const
257 return myHelper->isDraggable( what );
261 \brief Test if drop operation can be done on the \a where object.
262 \param where data object being tested
263 \return \c true if if drop operation is supported by object or \c false otherwise
264 \sa PyModuleHelper::isDropAccepted()
266 bool SALOME_PYQT_Module::isDropAccepted( const SUIT_DataObject* where ) const
269 return myHelper->isDropAccepted( where );
273 \brief Perform drop operation
274 \param what list of data objects being dropped
275 \param where target data object for drop operation
276 \param row line (child item index) where drop operation is performed to
277 \param action current drop action (copy or move)
278 \sa PyModuleHelper::dropObjects()
280 void SALOME_PYQT_Module::dropObjects( const DataObjectList& what, SUIT_DataObject* where,
281 const int row, Qt::DropAction action )
284 myHelper->dropObjects( what, where, row, action );