1 # -*- coding: utf-8 -*-
2 # Copyright (C) 2007-2017 EDF R&D
4 # This library is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU Lesser General Public
6 # License as published by the Free Software Foundation; either
7 # version 2.1 of the License.
9 # This library is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 # Lesser General Public License for more details.
14 # You should have received a copy of the GNU Lesser General Public
15 # License along with this library; if not, write to the Free Software
16 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 from __future__ import absolute_import
24 from __future__ import print_function
26 from builtins import str
27 from builtins import range
28 from builtins import object
31 import types,os,glob,imp,sys
32 from six.moves.reprlib import Repr
33 from copy import copy,deepcopy
35 # import du chargeur de composants
36 from .comploader import makeObjecttreeitem
37 from Ihm import CONNECTOR
38 from Extensions.i18n import tr
39 from Extensions.eficas_exception import EficasException
40 from six.moves import range
43 myrepr.maxstring = 100
46 class TreeItem(object):
48 """Abstract class representing tree items.
50 Methods should typically be overridden, otherwise a default action
54 # itemNode est une factory qui doit retourner un objet de la classe Node
55 # ou derive de cette classe.
56 # Le widget arbre utilisera cet objet comme noeud associe au tree item.
57 # Par defaut, utilise la classe Node de base
58 # La signature de la factory est la suivante :
59 # itemNode(treeOrNode,item,command,rmenu)
60 # ou treeOrNode est le noeud parent, item est l'item associe
61 # command est une fonction python appelee sur selection graphique
62 # du noeud et rmenu est une fonction python appelee sur click droit sur le noeud
66 """Constructor. Do whatever you need to do."""
69 """Return text string to display."""
71 def getLabelText(self):
72 """Return label text string to display in front of text (if any)."""
76 def _isExpandable(self):
77 """Do not override! Called by TreeNode."""
78 if self.expandable is None:
79 self.expandable = self.isExpandable()
80 return self.expandable
82 def isExpandable(self):
83 """Return whether there are subitems."""
86 def _getSubList(self):
87 """Do not override! Called by TreeNode."""
88 if not self.isExpandable():
90 sublist = self.getSubList()
96 """Return whether the item's text may be edited."""
98 def SetText(self, text):
99 """Change the item's text (if it is editable)."""
101 def getIconName(self):
102 """Return name of icon to be displayed normally."""
104 def getSelectedIconName(self):
105 """Return name of icon to be displayed when selected."""
107 def getSubList(self):
108 """Return list of items forming sublist."""
110 def onDoubleClick(self):
111 """Called on a double-click on the item."""
113 class Delegate(object):
114 def __init__(self, delegate=None):
115 self.object = delegate
118 def setDelegate(self, delegate):
120 self.object = delegate
122 def getDelegate(self):
125 def __getattr__(self, name):
126 attr = getattr(self.object, name) # May raise AttributeError
127 setattr(self, name, attr)
128 self.__cache[name] = attr
131 def resetcache(self):
132 for key in list(self.__cache.keys()):
135 except AttributeError:
139 def cachereport(self):
140 keys = list(self.__cache.keys())
145 class ObjectTreeItem(TreeItem,Delegate):
146 def __init__(self, appli, labeltext, object, setFunction=None):
147 self.labeltext = labeltext
149 # L'objet delegue est stocke dans l'attribut object
150 # L'objet associe a l'item est stocke dans l'attribut _object
151 # Il peut etre obtenu par appel a la methode getObject
152 # Attention : le delegue peut etre different de l'objet associe (MCLIST)
153 # Dans le cas d'une MCListe de longueur 1, l'objet associe est la MCListe
154 # et l'objet delegue est le MCFACT (object = _object.data[0])
155 Delegate.__init__(self,object)
156 # On cache l'objet initial (pour destruction eventuelle
158 self._object = object
159 self.setFunction = setFunction
170 def connect(self,channel,callable,args):
171 """ Connecte la fonction callable (avec arguments args) a l'item self sur le
174 #print self,channel,callable,args
175 CONNECTOR.Connect(self._object,channel,callable,args)
176 CONNECTOR.Connect(self.object, channel,callable,args)
180 Cree un item copie de self
182 object = self._object.copy()
183 appli = copy(self.appli)
184 labeltext = copy(self.labeltext)
185 fonction = deepcopy(self.setFunction)
186 item = makeObjecttreeitem(appli,labeltext,object,fonction)
190 if hasattr(self.object,'actif'):
191 return self.object.actif
195 def update(self,item):
197 Met a jour l'item courant a partir d'un autre item passe en argument
198 Ne fait rien par defaut
202 def getLabelText(self):
203 """ Retourne 3 valeurs :
204 - le texte a afficher dans le noeud representant l'item
205 - la fonte dans laquelle afficher ce texte
206 - la couleur du texte
208 # None --> fonte et couleur par defaut
209 return tr(self.labeltext),None,None
211 def getNature(self) :
213 Retourne la nature de l'item et de l'objet
215 return self.object.nature
218 """ retourne les regles de l'objet pointe par self """
219 return self.object.getRegles()
221 def getListeMcPresents(self):
222 """ Retourne la liste des mots-cles fils de l'objet pointe par self """
223 return self.object.listeMcPresents()
226 """ Retourne le nom de la valeur de l'objet pointe par self dans le cas
227 ou celle-ci est un objet (ASSD) """
228 return self.object.getVal()
230 def get_definition(self):
232 Retourne l'objet definition de l'objet pointe par self
234 return self.object.definition
236 def getListeMcOrdonnee(self,liste,dico):
237 """ retourne la liste ordonnee (suivant le catalogue) brute des mots-cles
238 d'une entite composee dont le chemin complet est donne sous forme
239 d'une liste du type :ETAPE + MCFACT ou MCBLOC + ...
240 il faut encore rearranger cette liste (certains mots-cles deja
241 presents ne doivent plus etre proposes, regles ...)"""
242 return self.object.getListeMcOrdonnee(liste,dico)
244 def getListeMcOrdonneeBrute(self,liste,dico):
246 retourne la liste ordonnee (suivant le catalogue) BRUTE des mots-cles
247 d'une entite composee dont le chemin complet est donne sous forme
248 d'une liste du type :ETAPE + MCFACT ou MCBLOC + ...
250 return self.object.getListeMcOrdonneeBrute(liste,dico)
252 def getGenealogie(self):
254 Retourne la liste des noms des ascendants (noms de MCSIMP,MCFACT,MCBLOC ou ETAPE)
255 de l'objet pointe par self
257 return self.object.getGenealogie()
259 def getIndexChild(self,nom_fils):
261 Retourne l'index dans la liste des fils de self du nouveau fils de nom nom_fils
262 Necessaire pour savoir a quelle position dans la liste des fils il faut ajouter
265 return self.object.getIndexChild(nom_fils)
267 def getIndexChild_old(self,nom_fils):
269 Retourne l'index dans la liste des fils de self du nouveau fils de nom nom_fils
270 Necessaire pour savoir a quelle position dans la liste des fils il faut ajouter
273 liste_noms_mc_ordonnee = self.getListeMcOrdonneeBrute(self.getGenealogie(),self.getJdc().cata_ordonne_dico)
274 liste_noms_mc_presents = self.object.listeMcPresents()
276 for nom in liste_noms_mc_ordonnee:
277 if nom in liste_noms_mc_presents or nom == nom_fils:
279 # l contient les anciens mots-cles + le nouveau dans l'ordre
280 return l.index(nom_fils)
282 def appendChild(self,name,pos=None):
284 Permet d'ajouter un item fils a self
289 index = len(self.listeMcPresents())
290 elif type(pos) == int :
291 # la position est fixee
293 #elif type(pos) == types.InstanceType:
294 elif type(pos) == object :
295 # pos est un item. Il faut inserer name apres pos
296 index = self.getIndex(pos) +1
297 #elif type(name) == types.InstanceType:
298 elif type(name) == object :
299 index = self.getIndexChild(name.nom)
301 index = self.getIndexChild(name)
302 return self.addobject(name,index)
304 def appendBrother(self,name,pos='after'):
306 Permet d'ajouter un frere a self
307 par defaut on l'ajoute apres self
309 index = self._object.parent.getIndex(self.getObject())
315 print((tr("%d n'est pas un index valide pour appendBrother", pos)))
317 return self.parent.addobject(name,index)
319 def getCopieObjet(self):
320 """ Retourne une copie de l'objet pointe par self """
321 return self.object.copy()
323 def getPosition(self):
324 """ Retourne la valeur de l'attribut position de l'objet pointe par self """
325 definition = self.get_definition()
327 return getattr(definition,'position')
328 except AttributeError:
332 """ Retourne le nom de l'objet pointe par self """
333 return self.object.nom
336 """ Retourne le jdc auquel appartient l'objet pointe par self """
337 return self.object.jdc
340 """ Retourne la valeur de l'objet pointe par self """
341 return self.object.valeur
344 """ Retourne le compte-rendu CR de self """
345 return self.object.report()
347 def getObjetCommentarise(self):
349 Cette methode retourne un objet commentarise
350 representatif de self.object
351 --> a surcharger par les differents items
353 raise EficasException("MESSAGE AU DEVELOPPEUR : il faut \
354 surcharger la methode getObjetCommentarise() \
355 pour la classe %s", self.__class__.__name__)
358 """ Retourne 1 si l'objet pointe par self est valide, 0 sinon"""
359 return self.object.isValid()
361 def isCopiable(self):
363 Retourne 1 si l'objet est copiable, 0 sinon
364 Par defaut retourne 0
368 def getMcPresents(self):
369 """ Retourne le dictionnaire des mots-cles presents de l'objet pointe par self """
370 return self.object.dictMcPresents()
372 def verifConditionRegles(self,l_mc_presents):
373 return self.object.verifConditionRegles(l_mc_presents)
376 """ Retourne le fr de l'objet pointe par self """
378 return self.object.getFr()
383 """ Retourne la cle de doc de l'objet pointe par self """
384 return self.object.getDocu()
386 def setValeur(self,new_valeur):
387 """ Remplace la valeur de l'objet pointe par self par new_valeur """
388 return self.object.setValeur(new_valeur)
391 return myrepr.repr(self.object)
393 def getIconName(self):
394 if not self.isExpandable():
397 def IsEditable(self):
398 return self.setFunction is not None
400 def SetText(self, text):
403 self.setFunction(value)
406 # Modif de ma part CCar : je ne comprend pas a quoi ca sert
407 # ca parait meme incorrect
409 # self.object = value
411 def isExpandable(self):
414 def getSubList(self):
415 keys = dir(self.object)
419 value = getattr(self.object, key)
420 except AttributeError:
422 item = makeObjecttreeitem(
426 lambda value, key=key, object=self.object:
427 setattr(object, key, value))
431 # a piori inutile PN 06 11 17
432 #def wait_fichier_init(self):
433 """ Retourne 1 si l'object pointe par self attend un fichier d'initialisation
434 (ex: macros POURSUITE et INCLUDE de Code_Aster), 0 SINON """
435 # return self.object.definition.fichier_ini
437 def makeObjecttreeitem(self,appli,labeltext, object, setFunction=None):
439 Cette methode, globale pour les objets de type item, permet de construire et de retourner un objet
440 de type item associe a l'object passe en argument.
442 return makeObjecttreeitem(appli,labeltext,object,setFunction)
445 # print "__del__",self
447 class AtomicObjectTreeItem(ObjectTreeItem):
448 def isExpandable(self):
451 class SequenceTreeItem(ObjectTreeItem):
452 def isExpandable(self):
453 return len(self._object) > 0
456 return len(self._object)
459 return list(range(len(self._object)))
461 def getIconName(self):
462 if self._object.isValid():
463 return "ast-green-los"
464 elif self._object.isOblig():
469 def ajoutPossible(self):
470 return self._object.ajoutPossible()
472 def getIndex(self,child):
473 """ Retourne le numero de child dans la liste des enfants de self """
474 return self._object.getIndex(child.getObject())
479 def addItem(self,obj,pos):
480 self._object.insert(pos,obj)
481 item = self.makeObjecttreeitem(self.appli, obj.nom + ":", obj)
484 def suppItem(self,item):
486 self._object.remove(item.getObject())
487 # la liste peut etre retournee vide !
488 message = "Mot-clef " + item.getObject().nom + " supprime"
489 self.appli.afficheInfos(message)
494 def getSubList(self):
495 isublist=iter(self.sublist)
496 liste=self._object.data
502 for item in isublist:
503 old_obj=item.getObject()
504 if old_obj in liste:break
507 if obj is old_obj:break
508 # nouvel objet : on cree un nouvel item
509 def setFunction(value, object=obj):
511 it = self.makeObjecttreeitem(self.appli, obj.nom + " : ", obj, setFunction)
512 self.sublist.append(it)
513 if old_obj is None and obj is None:break
514 if old_obj is obj: self.sublist.append(item)