implement tooltip in client defined as description field in yaml files

Author: luigicalori

rcm/client/gui/new_display_dialog.py

@@ -135,6 +135,7 @@ def recursive_init_ui(self, d, parent_widget, parent_layout, path="", var=""):
             values = d.get('values', None)
             label = d.get('label', None)
             widget_type = d.get('type', None)
+            description = d.get('description', None)
 
             if values:
                 gui_widget = create_hor_composite_widget(parent_widget,
@@ -143,7 +144,8 @@ def recursive_init_ui(self, d, parent_widget, parent_layout, path="", var=""):
                                                          widget_type,
                                                          values,
                                                          path,
-                                                         var)
+                                                         var,
+                                                         description )
                 gui_widget.parent = self
                 gui_widget.update()
                 parent_widget.widgets.append(gui_widget)
@@ -207,7 +209,8 @@ def create_hor_composite_widget(parent_widget,
                                 widget_type=None,
                                 parameters=None,
                                 path='',
-                                var=''):
+                                var='',
+                                description=''):
     """
     Create a horizontal composite widget to be added in the main vertical layout
     The composite widget is made of a qlabel + an interactive gui widget
@@ -228,7 +231,7 @@ def create_hor_composite_widget(parent_widget,
             label_widget = QLabel("%s:" % label)
             hor_layout.addWidget(label_widget)
 
-        qvar_widget = widget_factory(widget_type)(parameters, path, var, parent_widget)
+        qvar_widget = widget_factory(widget_type)(parameters, path, var, parent_widget, description)
 
         hor_layout.addWidget(qvar_widget)
         main_widget.setLayout(hor_layout)
@@ -263,7 +266,7 @@ def widget_factory(widget_type):
 
     # nested class
     class ComboBox(QComboBox):
-        def __init__(self, values=None, path='', var='', parent_widget=None):
+        def __init__(self, values=None, path='', var='', parent_widget=None, description=None):
             QComboBox.__init__(self)
             self.parent_widget = parent_widget
             self.var = var
@@ -272,7 +275,15 @@ def __init__(self, values=None, path='', var='', parent_widget=None):
             self.path = path
             self.currentIndexChanged.connect(lambda: self.combo_box_change(self.choices))
             self.addItems(values)
+            count = 0
+            for v in values:
+                choice_description = values[v].get('description','')
+                if choice_description:
+                    self.setItemData(count, choice_description, Qt.ToolTipRole)
+                count += 1
             self.setCurrentIndex(0)
+            if description:
+                self.setToolTip(description)
 
         def update(self):
             self.currentIndexChanged.emit(0)
@@ -301,7 +312,7 @@ def combo_box_change(self, values):
                                 hide_childs(self.parent.containers[new_key])
 
     class Divider(QFrame):
-        def __init__(self, values=None, path='', var='', parent_widget=None):
+        def __init__(self, values=None, path='', var='', parent_widget=None, description=None):
             QFrame.__init__(self)
             self.setFrameShape(QFrame.HLine)
             self.setFrameShadow(QFrame.Sunken)
@@ -312,7 +323,7 @@ def update(self):
             return
 
     class Slider(QWidget):
-        def __init__(self, values=None, path='', var='', parent_widget=None):
+        def __init__(self, values=None, path='', var='', parent_widget=None, description=None):
             QWidget.__init__(self)
             self.parent = None
             self.var = var
@@ -329,6 +340,11 @@ def __init__(self, values=None, path='', var='', parent_widget=None):
             self.slider.setFixedWidth(100)
             self.slider.setMinimum(values.get('min'))
             self.slider.setMaximum(values.get('max'))
+            if 'description' in values:
+                self.slider.setToolTip(values['description'])
+            else:
+                if description:
+                    self.slider.setToolTip(description)
 
             self.slider_edit.textChanged.connect(self.slider_edit_change)
             self.slider.valueChanged.connect(self.slider_change)

rcm/server/etc/defaults/schema_00_top.yaml

@@ -23,6 +23,8 @@ schema:
       SCHEDULER:
         label : 'Scheduler'
         type : 'combobox'
+        description : "Select the scheduler for starting the service"
+
 
 
       DIVIDER:
@@ -33,6 +35,8 @@ schema:
       SERVICE :
         label : 'Service Type'
         type: 'combobox'
+        description : "Select the service type to start"
+
         substitutions :
           COMMAND.SETUP: ""
           COMMAND.COMMAND_LINE: ""

rcm/server/etc/defaults/schema_02_service.yaml

@@ -17,7 +17,7 @@ schema:
           COMMAND :
             label : 'Command'
             type : 'combobox'
-
+            description : "Select the specific command to start the service"
             substitutions :
   #            COMMAND: "vncserver @{WM_FLAGS} $vnc_foreground -geometry @{DISPLAY} -rfbauth $RCM_JOBLOG.pwd  @{WM_COMMAND "
               COMMAND_LINE: ""
@@ -28,6 +28,7 @@ schema:
               WM :
                 label : 'Window Manager'
                 type : 'combobox'
+                description : "Select the window manager"
                 substitutions :
                   WM_COMMAND: ""
                   WM_FLAGS: ""
@@ -36,12 +37,14 @@ schema:
                   XSIZE :
                     label : 'X size'
                     type : 'slider'
+                    description : "Horizontal dimension of VNC Display window"
                     values :
                       min : 300
                       max : 3000
                   YSIZE :
                     label : 'Y size'
                     type : 'slider'
+                    description : "Vertical dimension of VNC Display window"
                     values :
                       min : 300
                       max : 3000

rcm/server/lib/jobscript_builder.py

@@ -260,9 +260,13 @@ def get_gui_options(self):
             options[child.NAME] = child.get_gui_options()
 
         if options:
-            return {'children': options}
+            result = {'children': options}
         else:
-            return options
+            result = options
+        if 'description' in self.defaults:
+            result['description'] = self.defaults['description']
+        return result
+
 
 
 class ManagerChoiceNode(ChoiceNode):

rcm/server/test/etc/test_hierarchical/base_scheduler/slurm.yaml

@@ -2,7 +2,7 @@ defaults:
   TOP:
     SCHEDULER :
       Slurm :
-
+        description : "Start service using Slurm batch scheduler"
         substitutions :
           # WARNING: on regex, \ must be escaped
           JOBID_REGEX: "Submitted batch job (\\d*)"

rcm/server/test/etc/test_hierarchical/base_scheduler/ssh.yaml

@@ -2,7 +2,7 @@ defaults:
   TOP:
     SCHEDULER :
       SSH :
-
+        description : "Start service using a process on the login node"
         substitutions :
           # WARNING: on regex, \ and " must be escaped
           JOBID_REGEX: "process id: (\\d*)"

rcm/server/test/etc/test_hierarchical/base_service/turbovnc.yaml

@@ -2,8 +2,10 @@ defaults:
   TOP:
     SERVICE :
       VNC :
+        description : "Start service of type VNC "
         COMMAND :
           TurboVNC :
+            description : "Select TurboVNC as VNC server "
             substitutions :
               SETUP: "module load rcm"
               LOGFILE: "@{RCM_SESSION_FOLDER}/vnclog"
@@ -17,9 +19,11 @@ defaults:
 
             WM :
               Fluxbox :
+                description : "Start Fluxbox as Window manager for the VNC session (lightest choice)"
                 substitutions :
                   WM_COMMAND: "-xstartup ${RCM_HOME}/bin/config/xstartup.fluxbox"
                 XSIZE:
+                  description : "Screen hor size "
                   min : 400
                 YSIZE:
                   min : 400

rcm/server/test/etc/test_hierarchical/other/other_service_type.yaml

@@ -2,9 +2,11 @@ defaults:
   TOP:
     SERVICE :
       Other :
+        description : "Placeholder for other type of sarvice"
         COMMAND :
           FakeService :
             otherstuff :
+            description : " this is a dummy service example"
             substitutions :
               SETUP: "# fake module load "
               LOGFILE: "@{RCM_SESSION_FOLDER}/fakelog"

rcm/server/test/etc/test_hierarchical/other/other_vnc.yaml

@@ -4,6 +4,7 @@ defaults:
       VNC :
         COMMAND :
           OtherVNC :
+            description : "Placeholder for Other VNC server"
             substitutions :
               COMMAND_LINE: "other_vncserver "
             DISPLAY :

rcm/server/test/etc/test_hierarchical/other/other_wm.yaml

@@ -6,9 +6,11 @@ defaults:
           TurboVNC :
             WM :
               KDE :
+                description : "Start KDE as Window manager for the VNC session (heavvier choice)"
                 substitutions :
                   WM_COMMAND: "-xstartup ${RCM_HOME}/bin/config/xstartup.kde"
               GnomeGL :
+                description : "Start Gnome as Window manager for the VNC session, needs OpenGL (VirtualGL support)"
                 substitutions :
                   WM_COMMAND: "-xstartup ${RCM_HOME}/bin/config/xstartup.gnomegl"
                   WM_FLAGS: " -3dwm "