Adds slider view widget (#161)

Author: abuts

rascal2/ui/view.py

@@ -8,7 +8,7 @@
 from rascal2.dialogs.settings_dialog import SettingsDialog
 from rascal2.dialogs.startup_dialog import PROJECT_FILES, LoadDialog, LoadR1Dialog, NewProjectDialog, StartupDialog
 from rascal2.settings import MDIGeometries, Settings, get_global_settings
-from rascal2.widgets import ControlsWidget, PlotWidget, TerminalWidget
+from rascal2.widgets import ControlsWidget, PlotWidget, SlidersViewWidget, TerminalWidget
 from rascal2.widgets.project import ProjectWidget
 from rascal2.widgets.startup import StartUpWidget
 
@@ -22,6 +22,11 @@ class MainWindowView(QtWidgets.QMainWindow):
 
     def __init__(self):
         super().__init__()
+        # Public interface
+        self.disabled_elements = []
+        self.show_sliders = False  # no one displays sliders initially except got from configuration
+        #  (not implemented yet)
+
         self.setWindowTitle(MAIN_WINDOW_TITLE)
 
         window_icon = QtGui.QIcon(path_for("logo.png"))
@@ -38,14 +43,21 @@ def __init__(self):
         self.plot_widget = PlotWidget(self)
         self.terminal_widget = TerminalWidget()
         self.controls_widget = ControlsWidget(self)
+        self.sliders_view_widget = SlidersViewWidget(self)
         self.project_widget = ProjectWidget(self)
 
-        self.disabled_elements = []
+        ## protected interface and public properties construction
+
+        # define menu controlling switch between table and slider views
+        self._sliders_menu_control_text = {
+            "ShowSliders": "&Show Sliders",  # if state is show sliders, click will show them
+            "HideSliders": "&Hide Sliders",
+        }  # if state is show table, click will show sliders
 
         self.create_actions()
 
-        self.main_menu = self.menuBar()
-        self.add_submenus(self.main_menu)
+        main_menu = self.menuBar()
+        self.add_submenus(main_menu)
 
         self.create_toolbar()
         self.create_status_bar()
@@ -166,6 +178,20 @@ def create_actions(self):
         open_help_action.triggered.connect(self.open_docs)
         self.open_help_action = open_help_action
 
+        # done this way expecting the value "show_sliders" being stored
+        # in configuration in a future + "show_sliders" is public for this reason
+        if self.show_sliders:
+            # if show_sliders state is True, action will be hide
+            show_or_hide_slider_action = QtGui.QAction(self._sliders_menu_control_text["HideSliders"], self)
+        else:
+            # if display_sliders state is False, action will be show
+            show_or_hide_slider_action = QtGui.QAction(self._sliders_menu_control_text["ShowSliders"], self)
+        show_or_hide_slider_action.setStatusTip("Show or Hide Sliders")
+        show_or_hide_slider_action.triggered.connect(lambda: self.show_or_hide_sliders(None))
+        self._show_or_hide_slider_action = show_or_hide_slider_action
+        self._show_or_hide_slider_action.setEnabled(False)
+        self.disabled_elements.append(self._show_or_hide_slider_action)
+
         open_about_action = QtGui.QAction("&About", self)
         open_about_action.setStatusTip("Report RAT version&info")
         open_about_action.triggered.connect(self.open_about_info)
@@ -242,6 +268,8 @@ def add_submenus(self, main_menu: QtWidgets.QMenuBar):
 
         tools_menu = main_menu.addMenu("&Tools")
         tools_menu.setObjectName("&Tools")
+        tools_menu.addAction(self._show_or_hide_slider_action)
+        tools_menu.addSeparator()
         tools_menu.addAction(self.clear_terminal_action)
         tools_menu.addSeparator()
         tools_menu.addAction(self.setup_matlab_action)
@@ -251,6 +279,32 @@ def add_submenus(self, main_menu: QtWidgets.QMenuBar):
         help_menu.addAction(self.open_about_action)
         help_menu.addAction(self.open_help_action)
 
+    def show_or_hide_sliders(self, do_show_sliders=None):
+        """Depending on current state, show or hide sliders for
+        table properties within Project class view.
+
+        Parameters:
+        -----------
+
+        do_show_sliders: bool,default None
+            if provided, sets self.show_sliders logical variable into the requested state
+            (True/False), forcing sliders widget to appear/disappear. if None, applies not to current state.
+        """
+        if do_show_sliders is None:
+            self.show_sliders = not self.show_sliders
+        else:
+            self.show_sliders = do_show_sliders
+
+        if self.show_sliders:
+            self._show_or_hide_slider_action.setText(self._sliders_menu_control_text["HideSliders"])
+            self.sliders_view_widget.show()
+            self.project_widget.setWindowTitle("Sliders View")
+            self.project_widget.stacked_widget.setCurrentIndex(2)
+        else:
+            self._show_or_hide_slider_action.setText(self._sliders_menu_control_text["ShowSliders"])
+            self.sliders_view_widget.hide()
+            self.project_widget.show_project_view()
+
     def open_about_info(self):
         """Opens about menu containing information about RASCAL gui"""
         self.about_dialog.update_rascal_info(self)
@@ -311,7 +365,9 @@ def setup_mdi(self):
         self.setCentralWidget(self.mdi)
 
     def setup_mdi_widgets(self):
-        """Performs setup of MDI widgets that relies on the Project existing."""
+        """
+        Performs initialization of MDI widgets that rely on the Project being defined.
+        """
         self.controls_widget.setup_controls()
         self.project_widget.show_project_view()
         self.plot_widget.clear()
@@ -333,7 +389,6 @@ def reset_mdi_layout(self):
                     window.showMinimized()
                 else:
                     window.showNormal()
-
                 window.setGeometry(x, y, width, height)
 
     def save_mdi_layout(self):

rascal2/widgets/__init__.py

@@ -1,6 +1,7 @@
 from rascal2.widgets.controls import ControlsWidget
 from rascal2.widgets.inputs import AdaptiveDoubleSpinBox, MultiSelectComboBox, MultiSelectList, get_validated_input
 from rascal2.widgets.plot import PlotWidget
+from rascal2.widgets.sliders_view import SlidersViewWidget
 from rascal2.widgets.terminal import TerminalWidget
 
 __all__ = [
@@ -11,4 +12,5 @@
     "MultiSelectList",
     "PlotWidget",
     "TerminalWidget",
+    "SlidersViewWidget",
 ]

rascal2/widgets/project/project.py

@@ -72,22 +72,27 @@ def __init__(self, parent):
         self.stacked_widget = QtWidgets.QStackedWidget()
         self.stacked_widget.addWidget(project_view)
         self.stacked_widget.addWidget(project_edit)
+        self.stacked_widget.addWidget(self.parent.sliders_view_widget)
 
         layout = QtWidgets.QVBoxLayout()
         layout.setContentsMargins(0, 0, 0, 0)
         layout.addWidget(self.stacked_widget)
         self.setLayout(layout)
 
-    def create_project_view(self) -> None:
+    def create_project_view(self) -> QtWidgets.QWidget:
         """Creates the project (non-edit) view"""
         project_widget = QtWidgets.QWidget()
         main_layout = QtWidgets.QVBoxLayout()
         main_layout.setSpacing(20)
 
+        show_sliders_button = QtWidgets.QPushButton("Show sliders", self, objectName="ShowSliders")
+        show_sliders_button.clicked.connect(lambda: self.parent.show_or_hide_sliders(True))
+
         self.edit_project_button = QtWidgets.QPushButton("Edit Project", self, icon=QtGui.QIcon(path_for("edit.png")))
         self.edit_project_button.clicked.connect(self.show_edit_view)
         button_layout = QtWidgets.QHBoxLayout()
         button_layout.setAlignment(QtCore.Qt.AlignmentFlag.AlignRight)
+        button_layout.addWidget(show_sliders_button)
         button_layout.addWidget(self.edit_project_button)
 
         main_layout.addLayout(button_layout)
@@ -142,7 +147,7 @@ def create_project_view(self) -> None:
 
         return project_widget
 
-    def create_edit_view(self) -> None:
+    def create_edit_view(self) -> QtWidgets.QWidget:
         """Creates the project edit view"""
 
         edit_project_widget = QtWidgets.QWidget()
@@ -360,6 +365,8 @@ def show_project_view(self) -> None:
 
     def show_edit_view(self) -> None:
         """Show edit view"""
+
+        # will be updated according to edit changes
         self.update_project_view(0)
         self.setWindowTitle("Edit Project")
         self.parent.controls_widget.run_button.setEnabled(False)
@@ -540,6 +547,7 @@ def __init__(self, fields: list[str], parent, edit_mode: bool = False):
                 self.tables[field] = DataWidget(field, self)
             else:
                 self.tables[field] = ProjectFieldWidget(field, self)
+            self.tables[field].setObjectName(field)
             layout.addWidget(self.tables[field])
 
         scroll_area = QtWidgets.QScrollArea()

rascal2/widgets/project/tables.py

@@ -75,7 +75,27 @@ def data(self, index, role=QtCore.Qt.ItemDataRole.DisplayRole):
         elif role == QtCore.Qt.ItemDataRole.CheckStateRole and self.index_header(index) == "fit":
             return QtCore.Qt.CheckState.Checked if data else QtCore.Qt.CheckState.Unchecked
 
-    def setData(self, index, value, role=QtCore.Qt.ItemDataRole.EditRole) -> bool:
+    def setData(
+        self, index: QtCore.QModelIndex, value, role=QtCore.Qt.ItemDataRole.EditRole, recalculate_proj=True
+    ) -> bool:
+        """Implement abstract setData method of QAbstractTableModel.
+
+        Parameters
+        ----------
+        index: QtCore.QModelIndex
+            QModelIndex representing the row and column indices of edited cell wrt. the edited table
+        value:
+            new value of appropriate cell of the table.
+        role: QtCore.Qt.ItemDataRole
+            not sure what it is but apparently controls table behaviour amd needs to be Edit.
+            it nof Edit, method does nothing.
+        recalculate_proj: bool,default True
+            Additional control for RAT project recalculation. Set it to False when modifying
+            a bunch of properties in a loop changing it to True for the last value to recalculate
+            project and update all table's dependent widgets.
+            IMPORTANT: ensure last value differs from the existing one for this property as project
+                       will be not recalculated otherwise.
+        """
         if role == QtCore.Qt.ItemDataRole.EditRole or role == QtCore.Qt.ItemDataRole.CheckStateRole:
             row = index.row()
             param = self.index_header(index)
@@ -93,7 +113,7 @@ def setData(self, index, value, role=QtCore.Qt.ItemDataRole.EditRole) -> bool:
                     return False
                 if not self.edit_mode:
                     # recalculate plots if value was changed
-                    recalculate = self.index_header(index) == "value"
+                    recalculate = self.index_header(index) == "value" and recalculate_proj
                     self.parent.update_project(recalculate)
                 self.dataChanged.emit(index, index)
                 return True
@@ -175,6 +195,7 @@ def __init__(self, field: str, parent):
         self.parent = parent
         self.project_widget = parent.parent
         self.table = QtWidgets.QTableView(parent)
+
         self.table.horizontalHeader().setCascadingSectionResizes(True)
         self.table.setMinimumHeight(100)
 
@@ -231,7 +252,7 @@ def resize_columns(self):
 
         header.setStretchLastSection(True)
 
-    def update_model(self, classlist):
+    def update_model(self, classlist: ratapi.classlist.ClassList):
         """Update the table model to synchronise with the project field."""
         self.model = self.classlist_model(classlist, self)
 
@@ -248,10 +269,18 @@ def update_model(self, classlist):
     def set_item_delegates(self):
         """Set item delegates and open persistent editors for the table."""
         for i, header in enumerate(self.model.headers):
-            self.table.setItemDelegateForColumn(
-                i + self.model.col_offset,
-                delegates.ValidatedInputDelegate(self.model.item_type.model_fields[header], self.table),
-            )
+            delegate = delegates.ValidatedInputDelegate(self.model.item_type.model_fields[header], self.table)
+            self.table.setItemDelegateForColumn(i + self.model.col_offset, delegate)
+
+    def get_item_delegates(self, fields_list: list):
+        """Return list of delegates attached to the fields
+        with the names provided as input
+        """
+        dlgts = []
+        for i, header in enumerate(self.model.headers):
+            if header in fields_list:
+                dlgts.append(self.table.itemDelegateForColumn(i + self.model.col_offset))
+        return dlgts
 
     def append_item(self):
         """Append an item to the model if the model exists."""
@@ -354,13 +383,14 @@ class ParameterFieldWidget(ProjectFieldWidget):
     def set_item_delegates(self):
         for i, header in enumerate(self.model.headers):
             if header in ["min", "value", "max"]:
-                self.table.setItemDelegateForColumn(i + 1, delegates.ValueSpinBoxDelegate(header, self.table))
+                delegate = delegates.ValueSpinBoxDelegate(header, self.table)
+                self.table.setItemDelegateForColumn(i + 1, delegate)
             else:
                 self.table.setItemDelegateForColumn(
                     i + 1, delegates.ValidatedInputDelegate(self.model.item_type.model_fields[header], self.table)
                 )
 
-    def update_model(self, classlist):
+    def update_model(self, classlist: ratapi.classlist.ClassList):
         super().update_model(classlist)
         header = self.table.horizontalHeader()
         header.setSectionResizeMode(