-# Copyright (C) 2005 CEA/DEN, EDF R&D
+# Copyright (C) 2005 CEA/DEN, EDF R&D
#
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation; either
-# version 2.1 of the License.
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License.
#
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# Lesser General Public License for more details.
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
#
-from qt import *
+# ---
+#
+# File : PYHELLOGUI.py
+# Author : Vadim SANDLER, Open CASCADE S.A.S. (vadim.sandler@opencascade.com)
+#
+# ---
+
import traceback
+import os
+from qt import *
from omniORB import CORBA
from SALOME_NamingServicePy import *
import PYHELLO_ORB
################################################
-# module name
-__MODULE_NAME__ = "PYHELLO"
-__MODULE_ID__ = 1000
-__OBJECT_ID__ = 1010
+# GUI context class
+# Used to store actions, menus, toolbars, etc...
+################################################
+
+class GUIcontext:
+ # module name
+ MODULE_NAME = "PYHELLO"
+ # module icon
+ MODULE_PIXMAP = "PYHELLO.png"
+ # data objects IDs
+ MODULE_ID = 1000
+ OBJECT_ID = 1010
+ FOREIGN_ID = -1
+ # menus/toolbars/actions IDs
+ PYHELLO_MENU_ID = 90
+ HELLO_ID = 941
+ CREATE_OBJECT_ID = 942
+ OPTIONS_ID = 943
+ OPTION_1_ID = 944
+ OPTION_2_ID = 945
+ OPTION_3_ID = 946
+ PYHELLO_TB_ID = 90
+ DELETE_ALL_ID = 951
+ SHOW_ME_ID = 952
+ DELETE_ME_ID = 953
+ RENAME_ME_ID = 954
+ # default object name
+ DEFAULT_NAME = "Object"
+
+ # constructor
+ def __init__( self ):
+ # create top-level menu
+ mid = sgPyQt.createMenu( "PyHello", -1, GUIcontext.PYHELLO_MENU_ID, sgPyQt.defaultMenuGroup() )
+ # create toolbar
+ tid = sgPyQt.createTool( "PyHello" )
+ # create actions and fill menu and toolbar with actions
+ a = sgPyQt.createAction( GUIcontext.HELLO_ID, "Hello", "Hello", "Show hello dialog box", "ExecPYHELLO.png" )
+ sgPyQt.createMenu( a, mid )
+ sgPyQt.createTool( a, tid )
+ a = sgPyQt.createSeparator()
+ sgPyQt.createMenu( a, mid )
+ a = sgPyQt.createAction( GUIcontext.CREATE_OBJECT_ID, "Create object", "Create object", "Create object" )
+ sgPyQt.createMenu( a, mid )
+ a = sgPyQt.createSeparator()
+ sgPyQt.createMenu( a, mid )
+ ag = sgPyQt.createActionGroup( GUIcontext.OPTIONS_ID )
+ a = sgPyQt.createAction( GUIcontext.OPTION_1_ID, "Default name", "Default name", "Use default name for the objects" )
+ a.setToggleAction( True )
+ ag.add( a )
+ a = sgPyQt.createAction( GUIcontext.OPTION_2_ID, "Generate name", "Generate name", "Generate name for the objects" )
+ a.setToggleAction( True )
+ ag.add( a )
+ a = sgPyQt.createAction( GUIcontext.OPTION_3_ID, "Ask name", "Ask name", "Request object name from the user" )
+ a.setToggleAction( True )
+ ag.add( a )
+ sgPyQt.createMenu( ag, mid )
+ default_mode = sgPyQt.integerSetting( "PYHELLO", "creation_mode", 0 )
+ sgPyQt.action( GUIcontext.OPTION_1_ID + default_mode ).setOn( True )
+ # the following action are used in context popup
+ a = sgPyQt.createAction( GUIcontext.DELETE_ALL_ID, "Delete all", "Delete all", "Delete all objects" )
+ a = sgPyQt.createAction( GUIcontext.SHOW_ME_ID, "Show", "Show", "Show object name" )
+ a = sgPyQt.createAction( GUIcontext.DELETE_ME_ID, "Delete", "Delete", "Remove object" )
+ a = sgPyQt.createAction( GUIcontext.RENAME_ME_ID, "Rename", "Rename", "Rename object" )
+ pass
+ pass
+
+################################################
+# Global variables
################################################
+# study-to-context map
+__study2context__ = {}
+# current context
+__current_context__ = None
+# object counter
+__id__ = 0
+
+################################################
+
# Get SALOME PyQt interface
import SalomePyQt
-sgPyQt=SalomePyQt.SalomePyQt()
+sgPyQt = SalomePyQt.SalomePyQt()
# Get SALOME Swig interface
import libSALOME_Swig
################################################
# Internal methods
+################################################
+
+###
+# Check verbose mode
+###
+__verbose__ = None
+def verbose():
+ global __verbose__
+ if __verbose__ is None:
+ try:
+ __verbose__ = int( os.getenv('SALOME_VERBOSE', 0) )
+ except:
+ __verbose__ = 0
+ pass
+ pass
+ return __verbose__
-# --- get PYHELLO engine ---
+###
+# get PYHELLO engine
+###
def _getEngine():
- engine = lcc.FindOrLoadComponent( "FactoryServerPy", __MODULE_NAME__ )
+ engine = lcc.FindOrLoadComponent( "FactoryServerPy", GUIcontext.MODULE_NAME )
return engine
-# --- get active study ---
+###
+# get active study ID
+###
+def _getStudyId():
+ return sgPyQt.getStudyId()
+
+###
+# get active study
+###
def _getStudy():
- studyId = sgPyQt.getStudyId()
+ studyId = _getStudyId()
study = studyManager.GetStudyByID( studyId )
return study
-
-# --- returns 1 if object has children ---
+
+###
+# returns True if object has children
+###
def _hasChildren( sobj ):
if sobj:
study = _getStudy()
while iter.More():
name = iter.Value().GetName()
if name:
- return 1
+ return True
iter.Next()
- return 0
+ pass
+ pass
+ return False
-# --- finds or creates component object ---
+###
+# finds or creates component object
+###
def _findOrCreateComponent():
study = _getStudy()
- father = study.FindComponent( __MODULE_NAME__ )
+ father = study.FindComponent( GUIcontext.MODULE_NAME )
if father is None:
builder = study.NewBuilder()
- father = builder.NewComponent( __MODULE_NAME__ )
+ father = builder.NewComponent( GUIcontext.MODULE_NAME )
attr = builder.FindOrCreateAttribute( father, "AttributeName" )
- attr.SetValue( __MODULE_NAME__ )
+ attr.SetValue( GUIcontext.MODULE_NAME )
+ attr = builder.FindOrCreateAttribute( father, "AttributePixMap" )
+ attr.SetPixMap( GUIcontext.MODULE_PIXMAP )
attr = builder.FindOrCreateAttribute( father, "AttributeLocalID" )
- attr.SetValue( __MODULE_ID__ )
+ attr.SetValue( GUIcontext.MODULE_ID )
try:
builder.DefineComponentInstance( father, _getEngine() )
pass
except:
pass
+ pass
return father
-
+
+###
+# get current GUI context
+###
+def _getContext():
+ global __current_context__
+ return __current_context__
+
+###
+# set and return current GUI context
+# study ID is passed as parameter
+###
+def _setContext( studyID ):
+ global __study2context__, __current_context__
+ if not __study2context__.has_key(studyID):
+ __study2context__[studyID] = GUIcontext()
+ pass
+ __current_context__ = __study2context__[studyID]
+ return __current_context__
+
+###
+# increment object counter in the map
+###
+def _incObjToMap( m, id ):
+ if id not in m: m[id] = 0
+ m[id] += 1
+ pass
+
+###
+# analyse selection
+###
+def _getSelection():
+ selcount = sg.SelectedCount()
+ seltypes = {}
+ study = _getStudy()
+ for i in range( selcount ):
+ entry = sg.getSelected( i )
+ if entry:
+ sobj = study.FindObjectID( entry )
+ if sobj is not None:
+ test, anAttr = sobj.FindAttribute( "AttributeLocalID" )
+ if test:
+ ID = anAttr._narrow( SALOMEDS.AttributeLocalID ).Value()
+ if ID >= 0:
+ _incObjToMap( seltypes, ID )
+ continue
+ pass
+ pass
+ pass
+ _incObjToMap( seltypes, GUIcontext.FOREIGN_ID )
+ pass
+ return selcount, seltypes
+
################################################
# Callback functions
+################################################
-# set workspace (obsolete method, not used)
-def setWorkSpace( pyws ):
- print "PYHELLOGUI::setWorkSpace : ", pyws
+# called when module is initialized
+# perform initialization actions
+def initialize():
+ if verbose() : print "PYHELLOGUI.initialize() : study : %d" % _getStudyId()
+ # set default preferences values
+ if not sgPyQt.hasSetting( "PYHELLO", "def_obj_name"):
+ sgPyQt.addSetting( "PYHELLO", "def_obj_name", GUIcontext.DEFAULT_NAME )
+ if not sgPyQt.hasSetting( "PYHELLO", "creation_mode"):
+ sgPyQt.addSetting( "PYHELLO", "creation_mode", 0 )
+ pass
+
+# called when module is initialized
+# return map of popup windows to be used by the module
+def windows():
+ if verbose() : print "PYHELLOGUI.windows() : study : %d" % _getStudyId()
+ wm = {}
+ wm[SalomePyQt.WT_ObjectBrowser] = Qt.DockLeft
+ wm[SalomePyQt.WT_PyConsole] = Qt.DockBottom
+ return wm
+
+# called when module is initialized
+# return list of 2d/3d views to be used ny the module
+def views():
+ if verbose() : print "PYHELLOGUI.views() : study : %d" % _getStudyId()
+ return []
+
+# called when module is initialized
+# export module's preferences
+def createPreferences():
+ if verbose() : print "PYHELLOGUI.createPreferences() : study : %d" % _getStudyId()
+ gid = sgPyQt.addPreference( "General" )
+ gid = sgPyQt.addPreference( "Object creation", gid )
+ pid = sgPyQt.addPreference( "Default name", gid, SalomePyQt.PT_String, "PYHELLO", "def_obj_name" )
+ pid = sgPyQt.addPreference( "Default creation mode", gid, SalomePyQt.PT_Selector, "PYHELLO", "creation_mode" )
+ sgPyQt.addPreferenceProperty( pid, "strings", 0, QVariant( "Default name" ) )
+ sgPyQt.addPreferenceProperty( pid, "indexes", 0, QVariant( 0 ) )
+ sgPyQt.addPreferenceProperty( pid, "strings", 1, QVariant( "Generate name" ) )
+ sgPyQt.addPreferenceProperty( pid, "indexes", 1, QVariant( 1 ) )
+ sgPyQt.addPreferenceProperty( pid, "strings", 2, QVariant( "Ask name" ) )
+ sgPyQt.addPreferenceProperty( pid, "indexes", 2, QVariant( 2 ) )
pass
# called when module is activated
-def setSettings():
- print "PYHELLOGUI::setSettings"
+# returns True if activating is successfull and False otherwise
+def activate():
+ if verbose() : print "PYHELLOGUI.activate() : study : %d" % _getStudyId()
+ ctx = _setContext( _getStudyId() )
+ return True
+
+# called when module is deactivated
+def deactivate():
+ if verbose() : print "PYHELLOGUI.deactivate() : study : %d" % _getStudyId()
pass
# called when active study is changed
+# active study ID is passed as parameter
def activeStudyChanged( studyID ):
- print "PYHELLOGUI::activeStudyChanged: study ID =", studyID
+ if verbose() : print "PYHELLOGUI.activeStudyChanged(): study : %d" % studyID
+ ctx = _setContext( _getStudyId() )
pass
-# define popup menu
-def definePopup( context, object, parent ):
- object = ""
- parent = ""
-
+# called when popup menu is invoked
+# popup menu and menu context are passed as parameters
+def createPopupMenu( popup, context ):
+ if verbose() : print "PYHELLOGUI.createPopupMenu(): context = %s" % context
+ ctx = _setContext( _getStudyId() )
study = _getStudy()
- if sg.SelectedCount() == 1:
- entry = sg.getSelected( 0 )
- if entry != '':
- sobj = study.FindObjectID( entry )
- if sobj is not None:
- test, anAttr = sobj.FindAttribute( "AttributeLocalID" )
- if test :
- id = anAttr._narrow( SALOMEDS.AttributeLocalID ).Value()
- if ( id >= 0 ):
- object = str( id )
- print "PYHELLOGUI::definePopup :", context, object, parent
- return context, object, parent
-
-# customize popup menu
-def customPopup( popup, context, object, parent ):
- print "PYHELLOGUI::customPopup :", context, object, parent
- try:
- id = int( object )
- if id == __MODULE_ID__:
- study = _getStudy()
- if sg.SelectedCount() == 1:
- entry = sg.getSelected( 0 )
- if entry != '':
- sobj = study.FindObjectID( entry )
- if sobj and not _hasChildren( sobj ):
- popup.removeItem( 951 ) # remove 'Delete All' command
- except:
+ selcount, selected = _getSelection()
+ print selcount, selected
+ if selcount == 1:
+ # one object is selected
+ if GUIcontext.MODULE_ID in selected:
+ # menu for component
+ sgPyQt.action( GUIcontext.DELETE_ALL_ID ).addTo( popup )
+ elif GUIcontext.OBJECT_ID in selected:
+ # menu for object
+ sgPyQt.action( GUIcontext.SHOW_ME_ID ).addTo( popup )
+ sgPyQt.action( GUIcontext.RENAME_ME_ID ).addTo( popup )
+ popup.insertSeparator()
+ sgPyQt.action( GUIcontext.DELETE_ME_ID ).addTo( popup )
+ pass
+ pass
+ elif selcount > 1:
+ # several objects are selected
+ if len( selected ) == 1:
+ if GUIcontext.MODULE_ID in selected:
+ # menu for component
+ sgPyQt.action( GUIcontext.DELETE_ALL_ID ).addTo( popup )
+ elif GUIcontext.OBJECT_ID in selected:
+ # menu for list of objects
+ sgPyQt.action( GUIcontext.DELETE_ME_ID ).addTo( popup )
+ pass
+ pass
pass
pass
-# process GUI action
-def OnGUIEvent(commandID) :
- print "PYHELLOGUI::OnGUIEvent : commandID =",commandID
+# called when GUI action is activated
+# action ID is passed as parameter
+def OnGUIEvent( commandID ):
+ if verbose() : print "PYHELLOGUI.OnGUIEvent(): command = %d" % commandID
if dict_command.has_key( commandID ):
try:
dict_command[commandID]()
except:
traceback.print_exc()
else:
- print "The command is not implemented: ",commandID
+ if verbose() : print "The command is not implemented: %d" % commandID
+ pass
+
+# called when module's preferences are changed
+# preference's resources section and setting name are passed as parameters
+def preferenceChanged( section, setting ):
+ if verbose() : print "PYHELLOGUI.preferenceChanged(): %s / %s" % ( section, setting )
+ pass
+
+# called when active view is changed
+# view ID is passed as parameter
+def activeViewChanged( viewID ):
+ if verbose() : print "PYHELLOGUI.activeViewChanged(): %d" % viewID
+ pass
+
+# called when active view is cloned
+# cloned view ID is passed as parameter
+def viewCloned( viewID ):
+ if verbose() : print "PYHELLOGUI.viewCloned(): %d" % viewID
+ pass
+
+# called when active view is viewClosed
+# view ID is passed as parameter
+def viewClosed( viewID ):
+ if verbose() : print "PYHELLOGUI.viewClosed(): %d" % viewID
+ pass
################################################
# GUI actions implementation
+################################################
-# ----------------------- #
-# Sample dialog box
-# ----------------------- #
+###
+# 'HELLO' dialog box
+###
class MyDialog( QDialog ):
# constructor
def __init__( self, parent = None, modal = 0):
QMessageBox.warning( self, 'Error!', 'Please, enter the name!' )
pass
-# ----------------------- #
+###
+# Show 'HELLO' dialog box
+###
def ShowHELLO():
# create dialog box
d = MyDialog( sgPyQt.getDesktop(), 1 )
# show dialog box
d.exec_loop()
+ pass
-__id__ = 0
-
-# ----------------------- #
+###
+# Create new object
+###
def CreateObject():
- global __id__
+ default_name = str( sgPyQt.stringSetting( "PYHELLO", "def_obj_name", GUIcontext.DEFAULT_NAME ).stripWhiteSpace() )
+ if sgPyQt.action( GUIcontext.OPTION_3_ID ).isOn():
+ # request object name from the user
+ name, ok = QInputDialog.getText( "Create Object", "Enter object name:", QLineEdit.Normal, default_name )
+ if not ok: return
+ name = str( name.stripWhiteSpace() )
+ elif sgPyQt.action( GUIcontext.OPTION_2_ID ).isOn():
+ # generate object name
+ global __id__
+ __id__ = __id__ + 1
+ name = "%s %d" % ( default_name, __id__ )
+ else:
+ name = default_name
+ pass
+ if not name: return
study = _getStudy()
builder = study.NewBuilder()
father = _findOrCreateComponent()
object = builder.NewObject( father )
attr = builder.FindOrCreateAttribute( object, "AttributeName" )
- __id__ = __id__ + 1
- attr.SetValue( "Object " + str( __id__ ) )
+ attr.SetValue( name )
attr = builder.FindOrCreateAttribute( object, "AttributeLocalID" )
- attr.SetValue( __OBJECT_ID__ )
- sg.updateObjBrowser(True)
+ attr.SetValue( GUIcontext.OBJECT_ID )
+ sg.updateObjBrowser( True )
pass
-# ----------------------- #
+###
+# Delete all objects
+###
def DeleteAll():
study = _getStudy()
- father = study.FindComponent( __MODULE_NAME__ )
+ father = study.FindComponent( GUIcontext.MODULE_NAME )
if father:
iter = study.NewChildIterator( father )
builder = study.NewBuilder()
sobj = iter.Value()
iter.Next()
builder.RemoveObjectWithChildren( sobj )
+ pass
sg.updateObjBrowser(True)
+ pass
pass
-# ----------------------- #
+###
+# Show object's name
+###
def ShowMe():
study = _getStudy()
entry = sg.getSelected( 0 )
test, attr = sobj.FindAttribute( "AttributeName" )
if test:
QMessageBox.information( sgPyQt.getDesktop(), 'Info', "My name is '%s'" % attr.Value() )
-
+ pass
+ pass
+ pass
pass
-# ----------------------- #
+###
+# Delete selected object(s)
+###
def Delete():
study = _getStudy()
+ builder = study.NewBuilder()
+ if sg.SelectedCount() <= 0: return
+ for i in range( sg.SelectedCount() ):
+ entry = sg.getSelected( i )
+ if entry != '':
+ sobj = study.FindObjectID( entry )
+ if ( sobj ):
+ builder.RemoveObject( sobj )
+ pass
+ pass
+ pass
+ sg.updateObjBrowser( True )
+ pass
+
+###
+# Rename selected object
+###
+def Rename():
+ study = _getStudy()
+ builder = study.NewBuilder()
entry = sg.getSelected( 0 )
if entry != '':
sobj = study.FindObjectID( entry )
if ( sobj ):
- builder = study.NewBuilder()
- builder.RemoveObject( sobj )
- sg.updateObjBrowser(True)
+ name, ok = QInputDialog.getText( "Object name", "Enter object name:", QLineEdit.Normal, sobj.GetName() )
+ name = str( name.stripWhiteSpace() )
+ if not ok or not name: return
+ attr = builder.FindOrCreateAttribute( sobj, "AttributeName" )
+ attr.SetValue( name )
+ sg.updateObjBrowser( True )
+ pass
+ pass
pass
-# ----------------------- #
+###
+# Commands dictionary
+###
dict_command = {
- 941 : ShowHELLO,
- 942 : CreateObject,
- 951 : DeleteAll,
- 952 : ShowMe,
- 953 : Delete,
+ GUIcontext.HELLO_ID : ShowHELLO,
+ GUIcontext.CREATE_OBJECT_ID : CreateObject,
+ GUIcontext.DELETE_ALL_ID : DeleteAll,
+ GUIcontext.SHOW_ME_ID : ShowMe,
+ GUIcontext.DELETE_ME_ID : Delete,
+ GUIcontext.RENAME_ME_ID : Rename,
}
