Add custom tile layout and adjust plot padding

Author: StephenNneji

pyproject.toml

@@ -51,17 +51,23 @@ extend-ignore-names = ['allKeys',
                        'closeEvent',
                        'columnCount',
                        'createEditor',
+                       'expandingDirections',
                        'eventFilter',
+                       'hasHeightForWidth',
                        'headerData',
+                       'heightForWidth',
                        'isClean',
+                       'itemAt',
                        'mergeWith',
+                       'minimumSize',
                        'mouseDoubleClickEvent',
                        'paintEvent',
                        'resizeEvent',
                        'rowCount',
                        'setClean',
                        'setData',
                        'setEditorData',
+                       'setGeometry',
                        'setModel',
                        'setModelData',
                        'setText',
@@ -70,6 +76,7 @@ extend-ignore-names = ['allKeys',
                        'sizeHint',
                        'stepBy',
                        'supportedDropActions',
+                       'takeAt',
                        'textFromValue',
                        'timerEvent',
                        'valueFromText',]

rascal2/ui/view.py

@@ -47,7 +47,7 @@ def __init__(self):
         self.create_toolbar()
         self.create_status_bar()
 
-        self.setMinimumSize(1024, 800)
+        self.setMinimumSize(1360, 800)
         self.setAttribute(QtCore.Qt.WidgetAttribute.WA_DeleteOnClose)
 
         self.settings = Settings()
@@ -182,7 +182,7 @@ def create_actions(self):
         self.tile_windows_action = QtGui.QAction("Tile Windows", self)
         self.tile_windows_action.setStatusTip("Arrange windows in the default grid.")
         self.tile_windows_action.setIcon(QtGui.QIcon(path_for("tile.png")))
-        self.tile_windows_action.triggered.connect(self.mdi.tileSubWindows)
+        self.tile_windows_action.triggered.connect(self.custom_tile_layout)
         self.tile_windows_action.setEnabled(False)
         self.disabled_elements.append(self.tile_windows_action)
 
@@ -338,7 +338,7 @@ def reset_mdi_layout(self):
         if mdi_defaults is None:
             for window in self.mdi.subWindowList():
                 window.showNormal()
-            self.mdi.tileSubWindows()
+            self.custom_tile_layout()
         else:
             for window in self.mdi.subWindowList():
                 # get corresponding MDIGeometries entry for the widget
@@ -364,6 +364,24 @@ def save_mdi_layout(self):
         global_setting.setValue("window_geometry", self.saveGeometry())
         global_setting.sync()
 
+    def custom_tile_layout(self):
+        """Tile the MDI windows using user recommended sizes."""
+        # The percentages are estimated from provided screenshot in
+        # https://github.com/RascalSoftware/RasCAL-2/issues/188
+        rect = self.centralWidget().contentsRect()
+        plot_width = round(0.6 * rect.width())
+        plot_height = round(0.65 * rect.height())
+        project_width = rect.width() - plot_width
+        project_height = round(0.5 * rect.height())
+
+        plot_geom = (0, 0, plot_width, plot_height)
+        project_geom = (plot_width, 0, project_width, project_height)
+        terminal_geom = (0, plot_height, plot_width, rect.height() - plot_height)
+        controls_geom = (plot_width, project_height, project_width, rect.height() - project_height)
+        geoms = [controls_geom, terminal_geom, project_geom, plot_geom]  # windows in reverse order of creation
+        for geom, windows in zip(geoms, self.mdi.subWindowList(), strict=False):
+            windows.setGeometry(*geom)
+
     def enable_elements(self):
         """Enable the elements that are disabled on startup."""
         for element in self.disabled_elements:

rascal2/widgets/controls.py

@@ -76,9 +76,9 @@ def __init__(self, parent):
 
         widget_layout = QtWidgets.QHBoxLayout()
         widget_layout.addStretch(1)
-        widget_layout.addLayout(procedure_box, 4)
+        widget_layout.addLayout(procedure_box, 8)
         widget_layout.addSpacing(20)
-        widget_layout.addWidget(self.fit_settings, 4)
+        widget_layout.addWidget(self.fit_settings, 12)
         widget_layout.addStretch(1)
         self.setLayout(widget_layout)
 

rascal2/widgets/plot.py

@@ -215,7 +215,7 @@ def __init__(self, parent):
             sub_layout.addWidget(slider)
             sub_layout.addStretch(1)
             plot_toolbar.addLayout(sub_layout)
-            plot_toolbar.addSpacing(15)
+            plot_toolbar.addSpacing(5)
 
         sidebar = QtWidgets.QHBoxLayout()
         sidebar.addWidget(self.plot_controls)
@@ -237,6 +237,7 @@ def __init__(self, parent):
         scroll_area.setWidgetResizable(True)
 
         central_layout = QtWidgets.QVBoxLayout()
+        central_layout.setSpacing(0)
         central_layout.setContentsMargins(0, 0, 0, 0)
         self.interaction_layout = self.make_interaction_layout()
         if self.interaction_layout is not None:
@@ -399,6 +400,7 @@ def make_figure(self) -> matplotlib.figure.Figure:
         self.resize_timer = 0
         figure = matplotlib.figure.Figure()
         figure.subplots(1, 2)
+        figure.set_tight_layout(True)
 
         return figure
 
@@ -465,7 +467,6 @@ def plot_event(self, data: ratapi.events.PlotEventData | None = None):
         show_legend = self.show_legend.isChecked() if self.current_plot_data.contrastNames else False
         self.figure.clear()
         self.update_figure_size()
-        self.figure.tight_layout()
         ratapi.plotting.plot_ref_sld_helper(
             self.current_plot_data,
             self.figure,

rascal2/widgets/project/project.py

@@ -21,6 +21,7 @@
     ProjectFieldWidget,
     ResolutionsFieldWidget,
 )
+from rascal2.widgets.utils import FlowLayout
 
 
 class ProjectWidget(QtWidgets.QWidget):
@@ -77,16 +78,43 @@ def __init__(self, parent):
         layout.addWidget(self.stacked_widget)
         self.setLayout(layout)
 
+    @staticmethod
+    def make_labelled_widget(label_text, form_widget):
+        """Create widget containing a label and the given widget.
+
+        Parameters
+        ----------
+        label_text: str
+            The label text for the form widget.
+        form_widget
+            The widget to add.
+
+        Returns
+        -------
+            label_form_widget:
+                A widget with label and the given widget.
+        """
+        layout = QtWidgets.QHBoxLayout()
+        layout.setSpacing(0)
+        layout.setContentsMargins(2, 5, 2, 5)
+        layout.addWidget(QtWidgets.QLabel(f"{label_text}: ", objectName="BoldLabel"))
+        layout.addWidget(form_widget)
+
+        widget = QtWidgets.QWidget()
+        widget.setLayout(layout)
+        widget.setSizePolicy(QtWidgets.QSizePolicy.Policy.Minimum, QtWidgets.QSizePolicy.Policy.Fixed)
+        return widget
+
     def create_project_view(self) -> QtWidgets.QWidget:
         """Create 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)
+        show_sliders_button = QtWidgets.QPushButton("Show sliders")
         show_sliders_button.clicked.connect(self.parent.toggle_sliders)
 
-        self.edit_project_button = QtWidgets.QPushButton("Edit Project", self, icon=QtGui.QIcon(path_for("edit.png")))
+        self.edit_project_button = QtWidgets.QPushButton("Edit Project", 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)
@@ -95,42 +123,27 @@ def create_project_view(self) -> QtWidgets.QWidget:
 
         main_layout.addLayout(button_layout)
 
-        settings_layout = QtWidgets.QHBoxLayout()
-        settings_layout.setAlignment(QtCore.Qt.AlignmentFlag.AlignHCenter)
+        settings_layout = FlowLayout(spacing=2)
+        settings_layout.setAlignment(QtCore.Qt.AlignmentFlag.AlignRight)
 
-        absorption_label = QtWidgets.QLabel("Absorption:", self, objectName="BoldLabel")
         self.absorption_checkbox = QtWidgets.QCheckBox()
         self.absorption_checkbox.setDisabled(True)
+        settings_layout.addWidget(self.make_labelled_widget("Absorption", self.absorption_checkbox))
 
-        settings_layout.addWidget(absorption_label)
-        settings_layout.addWidget(self.absorption_checkbox)
-
-        self.calculation_label = QtWidgets.QLabel("Calculation:", self, objectName="BoldLabel")
-
-        self.calculation_type = QtWidgets.QLineEdit(self)
+        self.calculation_type = QtWidgets.QLineEdit()
         self.calculation_type.setAlignment(QtCore.Qt.AlignmentFlag.AlignCenter)
         self.calculation_type.setReadOnly(True)
+        settings_layout.addWidget(self.make_labelled_widget("Calculation", self.calculation_type))
 
-        settings_layout.addWidget(self.calculation_label)
-        settings_layout.addWidget(self.calculation_type)
-
-        self.model_type_label = QtWidgets.QLabel("Model Type:", self, objectName="BoldLabel")
-
-        self.model_type = QtWidgets.QLineEdit(self)
+        self.model_type = QtWidgets.QLineEdit()
         self.model_type.setAlignment(QtCore.Qt.AlignmentFlag.AlignCenter)
         self.model_type.setReadOnly(True)
+        settings_layout.addWidget(self.make_labelled_widget("Model Type", self.model_type))
 
-        settings_layout.addWidget(self.model_type_label)
-        settings_layout.addWidget(self.model_type)
-
-        self.geometry_label = QtWidgets.QLabel("Geometry:", self, objectName="BoldLabel")
-
-        self.geometry_type = QtWidgets.QLineEdit(self)
+        self.geometry_type = QtWidgets.QLineEdit()
         self.geometry_type.setAlignment(QtCore.Qt.AlignmentFlag.AlignCenter)
         self.geometry_type.setReadOnly(True)
-
-        settings_layout.addWidget(self.geometry_label)
-        settings_layout.addWidget(self.geometry_type)
+        settings_layout.addWidget(self.make_labelled_widget("Geometry", self.geometry_type))
 
         main_layout.addLayout(settings_layout)
 
@@ -152,11 +165,11 @@ def create_edit_view(self) -> QtWidgets.QWidget:
         main_layout.setSpacing(20)
 
         self.save_project_button = QtWidgets.QPushButton(
-            "Accept Changes", self, icon=QtGui.QIcon(path_for("save-project.png"))
+            "Accept Changes", icon=QtGui.QIcon(path_for("save-project.png"))
         )
         self.save_project_button.clicked.connect(self.save_changes)
 
-        self.cancel_button = QtWidgets.QPushButton("Cancel", self, icon=QtGui.QIcon(path_for("cancel-dark.png")))
+        self.cancel_button = QtWidgets.QPushButton("Cancel", icon=QtGui.QIcon(path_for("cancel-dark.png")))
         self.cancel_button.clicked.connect(self.show_project_view)
 
         buttons_layout = QtWidgets.QHBoxLayout()
@@ -165,47 +178,24 @@ def create_edit_view(self) -> QtWidgets.QWidget:
         buttons_layout.addWidget(self.cancel_button)
         main_layout.addLayout(buttons_layout)
 
-        settings_layout = QtWidgets.QHBoxLayout()
+        settings_layout = FlowLayout(spacing=2)
         settings_layout.setAlignment(QtCore.Qt.AlignmentFlag.AlignHCenter)
 
-        absorption_label = QtWidgets.QLabel("Absorption:", self, objectName="BoldLabel")
         self.edit_absorption_checkbox = QtWidgets.QCheckBox()
+        settings_layout.addWidget(self.make_labelled_widget("Absorption", self.edit_absorption_checkbox))
 
-        settings_layout.addWidget(absorption_label)
-        settings_layout.addWidget(self.edit_absorption_checkbox)
-
-        self.edit_calculation_label = QtWidgets.QLabel("Calculation:", self, objectName="BoldLabel")
-
-        self.calculation_combobox = QtWidgets.QComboBox(self)
-        self.calculation_combobox.setSizePolicy(
-            QtWidgets.QSizePolicy.Policy.MinimumExpanding, QtWidgets.QSizePolicy.Policy.Fixed
-        )
+        self.calculation_combobox = QtWidgets.QComboBox()
         self.calculation_combobox.addItems([calc for calc in Calculations])
+        settings_layout.addWidget(self.make_labelled_widget("Calculation", self.calculation_combobox))
 
-        settings_layout.addWidget(self.edit_calculation_label)
-        settings_layout.addWidget(self.calculation_combobox)
-
-        self.edit_model_type_label = QtWidgets.QLabel("Model Type:", self, objectName="BoldLabel")
-
-        self.model_combobox = QtWidgets.QComboBox(self)
-        self.model_combobox.setSizePolicy(
-            QtWidgets.QSizePolicy.Policy.MinimumExpanding, QtWidgets.QSizePolicy.Policy.Fixed
-        )
+        self.model_combobox = QtWidgets.QComboBox()
         self.model_combobox.addItems([model for model in LayerModels])
+        settings_layout.addWidget(self.make_labelled_widget("Model Type", self.model_combobox))
 
-        settings_layout.addWidget(self.edit_model_type_label)
-        settings_layout.addWidget(self.model_combobox)
-
-        self.edit_geometry_label = QtWidgets.QLabel("Geometry:", self, objectName="BoldLabel")
-
-        self.geometry_combobox = QtWidgets.QComboBox(self)
-        self.geometry_combobox.setSizePolicy(
-            QtWidgets.QSizePolicy.Policy.MinimumExpanding, QtWidgets.QSizePolicy.Policy.Fixed
-        )
+        self.geometry_combobox = QtWidgets.QComboBox()
         self.geometry_combobox.addItems([geo for geo in Geometries])
+        settings_layout.addWidget(self.make_labelled_widget("Geometry", self.geometry_combobox))
 
-        settings_layout.addWidget(self.edit_geometry_label)
-        settings_layout.addWidget(self.geometry_combobox)
         main_layout.addLayout(settings_layout)
 
         self.edit_absorption_checkbox.checkStateChanged.connect(

rascal2/widgets/utils.py

@@ -0,0 +1,90 @@
+from PyQt6 import QtCore, QtWidgets
+
+
+class FlowLayout(QtWidgets.QLayout):
+    """A layout that rearranges contents when resized.
+
+    Adapted from PyQt port of QFlowLayout example https://doc.qt.io/qt-6/qtwidgets-layouts-flowlayout-example.html
+    """
+
+    def __init__(self, parent=None, margin=0, spacing=5):
+        super().__init__(parent)
+
+        if parent is not None:
+            self.setContentsMargins(margin, margin, margin, margin)
+
+        self.setSpacing(spacing)
+        self.margin = margin
+
+        self.item_list = []
+
+    def __del__(self):
+        item = self.takeAt(0)
+        while item:
+            item = self.takeAt(0)
+
+    def addItem(self, item):
+        self.item_list.append(item)
+
+    def count(self):
+        return len(self.item_list)
+
+    def itemAt(self, index):
+        if 0 <= index < len(self.item_list):
+            return self.item_list[index]
+
+        return None
+
+    def takeAt(self, index):
+        if 0 <= index < len(self.item_list):
+            return self.item_list.pop(index)
+
+        return None
+
+    def expandingDirections(self):
+        return QtCore.Qt.Orientation.Horizontal
+
+    def hasHeightForWidth(self):
+        return True
+
+    def heightForWidth(self, width):
+        height = self.do_layout(QtCore.QRect(0, 0, width, 0), True)
+        return height
+
+    def setGeometry(self, rect):
+        super().setGeometry(rect)
+        self.do_layout(rect, False)
+
+    def sizeHint(self):
+        return self.minimumSize()
+
+    def minimumSize(self):
+        size = QtCore.QSize()
+
+        for item in self.item_list:
+            size = size.expandedTo(item.minimumSize())
+
+        size += QtCore.QSize(2 * self.margin, 2 * self.margin)
+        return size
+
+    def do_layout(self, rect, test_only):
+        x = rect.x()
+        y = rect.y()
+        space_x = space_y = self.spacing()
+        line_height = 0
+
+        for item in self.item_list:
+            next_x = x + item.sizeHint().width() + space_x
+            if next_x - space_x > rect.right() and line_height > 0:
+                x = rect.x()
+                y = y + line_height + space_y
+                next_x = x + item.sizeHint().width() + space_x
+                line_height = 0
+
+            if not test_only:
+                item.setGeometry(QtCore.QRect(QtCore.QPoint(x, y), item.sizeHint()))
+
+            x = next_x
+            line_height = max(line_height, item.sizeHint().height())
+
+        return y + line_height - rect.y()