added tooltip support

git-svn-id: http://sextante.googlecode.com/svn/trunk/soft/bindings/qgis-plugin@138 881b9c09-3ef8-f3c2-ec3d-21d735c97f4d
qgis · Apr 21, 2012 · 3fd0697 · 3fd0697
1 parent db7d7f6
commit 3fd0697
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 1 deletion.
diff --git a/src/sextante/core/GeoAlgorithm.py b/src/sextante/core/GeoAlgorithm.py
@@ -69,6 +69,13 @@ def getCustomModelerParametersDialog(self, modelAlg):
         it should be returned here, ready to be executed'''
         return None
 
+    def getParameterDescriptions(self):
+        '''Returns a dict with param names as keys and detailed descriptions of each param
+        as value. These descriptions are used as tool tips in the parameters dialog.
+        If a description does not exist, the parameter's human-readable name is used'''
+        descs = {}
+        return descs
+
     def checkBeforeOpeningParametersDialog(self):
         '''If there is any check to perform before the parameters dialog is opened,
         it should be done here. This method returns an error message string if there

diff --git a/src/sextante/grass/GrassAlgorithm.py b/src/sextante/grass/GrassAlgorithm.py
@@ -41,10 +41,31 @@ def getIcon(self):
     def helpFile(self):
         folder = GrassUtils.grassHelpPath()
         if str(folder).strip() != "":
-            helpfile = str(folder) + os.sep + self.name + ".html"
+            helpfile = str(folder) + os.sep + self.grassName + ".html"
             return helpfile
         return None
 
+    def getParameterDescriptions(self):
+        descs = {}
+        helpfile = self.helpFile()
+        if helpfile:
+            try:
+                infile = open(helpfile)
+                lines = infile.readlines()
+                for i in range(len(lines)):
+                    if lines[i].startswith("<DT><b>"):
+                        for param in self. parameters:
+                            searchLine = "<b>" + param.name + "</b>"
+                            if searchLine in lines[i]:
+                                i+=1
+                                descs[param.name] = lines[i][4:-6]
+                                break
+
+                infile.close()
+            except Exception:
+                pass
+        return descs
+
     def defineCharacteristicsFromFile(self):
         lines = open(self.descriptionFile)
         line = lines.readline().strip("\n").strip()

diff --git a/src/sextante/gui/ParametersPanel.py b/src/sextante/gui/ParametersPanel.py
@@ -40,6 +40,7 @@ def __init__(self, alg, paramDialog):
         self.initGUI()
 
     def initGUI(self):
+        tooltips = self.alg.getParameterDescriptions()
         tableLike = SextanteConfig.getSetting(SextanteConfig.TABLE_LIKE_PARAM_PANEL)
         if tableLike:
             self.tableWidget = QtGui.QTableWidget()
@@ -83,6 +84,12 @@ def initGUI(self):
                     QtCore.QObject.connect(button, QtCore.SIGNAL("toggled(bool)"), self.buttonToggled)
                     widget = QtGui.QWidget()
                     widget.setLayout(layout)
+                if param.name in tooltips.keys():
+                    tooltip = tooltips[param.name]
+                else:
+                    tooltip = param.description
+                label.setToolTip(tooltip)
+                widget.setToolTip(tooltip)
                 self.verticalLayout.addWidget(label)
                 self.verticalLayout.addWidget(widget)