src/daSalome/daGUI/daGuiImpl/adaoGuiHelper.py

   1 # -*- coding: utf-8 -*-
   2 #  Copyright (C) 2010 EDF R&D
   3 #
   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.
   8 #
   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.
  13 #
  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
  17 #
  18 #  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  19 #
  20
  21 __author__="aribes/gboulant"
  22
  23 import salome
  24 # Get SALOME PyQt interface
  25 import SalomePyQt
  26 __sgPyQt = SalomePyQt.SalomePyQt()
  27
  28 import adaoModuleHelper
  29 from PyQt4 import QtGui,QtCore
  30
  31 def waitCursor():
  32     QtGui.QApplication.setOverrideCursor(QtGui.QCursor(QtCore.Qt.WaitCursor))
  33
  34 def restoreCursor():
  35     QtGui.QApplication.restoreOverrideCursor()
  36
  37 def gui_warning(parent, msg="An error occurs" ):
  38     """
  39     This function displays a message dialog box displaying the specified message.
  40     """
  41     QtGui.QMessageBox.warning( parent, "Alerte", msg)
  42
  43 def getActiveStudyId():
  44     """
  45     This function returns the id of the active study. The concept of active study
  46     makes sens only in the GUI context.
  47     """
  48     return salome.sg.getActiveStudyId()
  49
  50 def refreshObjectBrowser():
  51     """
  52     Refresh the graphical representation of the SALOME study, in case where the
  53     GUI is working.
  54     """
  55     if salome.sg is not None:
  56         salome.sg.updateObjBrowser(0)
  57
  58 def selectItem(salomeStudyItem):
  59   if salome.sg is not None:
  60     salome.sg.ClearIObjects()
  61     salome.sg.AddIObject(salomeStudyItem)
  62
  63 def getSelectedItem(salomeStudyId=-100):
  64     """
  65     Get the current selection. If more than one item are selected, the
  66     only first is considered. The object is return (not the id).
  67     The item can be of any type, no control is done in this function.
  68     """
  69     if salome.sg is None:
  70         raise Exception("GuiHelper.getSelectedItem can't be used without the GUI context")
  71
  72     if salomeStudyId != -100:
  73       studyEditor = salome.kernel.studyedit.getStudyEditor(salomeStudyId)
  74     studyEditor = salome.kernel.studyedit.getStudyEditor()
  75     item = None
  76     listEntries=salome.sg.getAllSelected()
  77     if len(listEntries) >= 1:
  78         entry = listEntries[0]
  79         item = studyEditor.study.FindObjectID( entry )
  80     return item
  81
  82 def getAllSelected(salomeStudyId):
  83     """
  84     Returns all selected items in the specified study.
  85     """
  86     if salome.sg is None:
  87         raise OmaException("getSelectedItem can't be used without the GUI context", OmaException.TYPES.DEVEL)
  88
  89     study = adaoModuleHelper.getStudyManager().GetStudyByID( salomeStudyId )
  90     selcount = salome.sg.SelectedCount()
  91     seltypes = {}
  92     for i in range( selcount ):
  93         __incObjToMap( seltypes, adaoModuleHelper.getObjectID( study, salome.sg.getSelected( i ) ) )
  94         pass
  95     return selcount, seltypes
  96
  97 def __incObjToMap( m, id ):
  98     """
  99     Increment object counter in the specified map.
 100     Not to be used outside this module.
 101     """
 102     if id not in m: m[id] = 0
 103     m[id] += 1
 104     pass
 105
 106 def getDesktop():
 107     """
 108     Returns the active Desktop. Usefull to set the relative position of a dialog box
 109     """
 110     return __sgPyQt.getDesktop()
 111
 112 def warning(msg):
 113     """
 114     This function displays a message dialog box displaying the specified message.
 115     """
 116     gui_warning(getDesktop(),msg)