Save entries by default in the Form Dialog

eqt/ui/FormDialog.py

@@ -23,6 +23,7 @@ def __init__(self, parent=None, title=None):
             self.setWindowTitle(title)
         # add button box to the UI
         self.formWidget.uiElements['verticalLayout'].addWidget(bb)
+        bb.button(QtWidgets.QDialogButtonBox.Ok).clicked.connect(self._onOk)
         bb.button(QtWidgets.QDialogButtonBox.Cancel).clicked.connect(self._onCancel)
 
     @property
@@ -35,14 +36,27 @@ def Cancel(self):
         '''returns a reference to the Dialog Cancel button to connect its signals'''
         return self.buttonBox.button(QtWidgets.QDialogButtonBox.Cancel)
 
+    def _onOk(self):
+        '''saves the widget states and calls `onOk`'''
+        self.saveAllWidgetStates()
+        self.onOk()
+        self.close()
+
     def _onCancel(self):
-        '''calls onCancel and closes the FormDialog'''
+        '''calls `onCancel`, restores the previously saved states if existing and
+          closes the FormDialog'''
         self.onCancel()
+        self.restoreAllSavedWidgetStates()
         self.close()
 
+    def onOk(self):
+        '''Called when the dialog's "Ok" button is clicked.
+        Can be redefined to add additional functionality on "Ok"'''
+        pass
+
     def onCancel(self):
         '''Called when the dialog's "Cancel" button is clicked.
-          Can be redefined to add additional functionality on "Cancel"'''
+        Can be redefined to add additional functionality on "Cancel"'''
         pass
 
     @property

eqt/ui/UIFormWidget.py

@@ -109,6 +109,10 @@ def addSeparator(self, name):
     def _addWidget(self, name, qwidget, qlabel=None):
         formLayout = self.uiElements['groupBoxFormLayout']
 
+        # create the default values
+        if not hasattr(self, 'widget_default'):
+            self.widget_default={}
+
         # Create the widgets:
 
         widgetno = self.num_widgets
@@ -117,6 +121,9 @@ def _addWidget(self, name, qwidget, qlabel=None):
         field = f'{name}_field'
         self.widgets[field] = qwidget
 
+        # add the default value of the qwidget
+        self.widget_default[field]=self.getWidgetState(qwidget)['value']
+
         if qlabel is not None:
             # add the label
             label = f'{name}_label'
@@ -125,19 +132,27 @@ def _addWidget(self, name, qwidget, qlabel=None):
                 qlabel = QtWidgets.QLabel(self.uiElements['groupBox'])
                 qlabel.setText(txt)
             formLayout.setWidget(widgetno, QtWidgets.QFormLayout.LabelRole, qlabel)
-
+            
             # save a reference to label widgets in the dictionary
             self.widgets[label] = qlabel
 
             field_form_role = QtWidgets.QFormLayout.FieldRole
 
+            # add the default value of the qlabel
+            self.widget_default[label]=self.getWidgetState(qlabel,label)['value']
+
         else:
             # In the case we don't have a qlabel, set a spanning widget:
             field_form_role = QtWidgets.QFormLayout.SpanningRole
 
         formLayout.setWidget(widgetno, field_form_role, qwidget)
         self.num_widgets += 1
 
+    def applyWidgetValuesToState(self):
+        self.saveAllWidgetStates()
+        for state_key in self.widget_default.keys():
+            self.widget_states[state_key]['value']=self.widget_default[state_key]
+
     def getAllWidgetStates(self):
         '''
         Returns
@@ -299,10 +314,11 @@ def restoreAllSavedWidgetStates(self):
         Restore all widgets in the form to the state saved by `saveAllWidgetStates()`.
         If `saveAllWidgetStates()` method was not previously invoked, do nothing.
         '''
-        if hasattr(self, 'widget_states'):
-            self.applyWidgetStates(self.widget_states)
-
+        if not hasattr(self, 'widget_states'):
+            self.applyWidgetValuesToState()
+        self.applyWidgetStates(self.widget_states)
 
+
 class FormWidget(QtWidgets.QWidget, UIFormWidget):
     def __init__(self, parent=None):
         # dockWidgetContents = QtWidgets.QWidget()

examples/dialog_example_3_save_default.py

@@ -0,0 +1,51 @@
+import sys
+
+from PySide2 import QtWidgets
+
+from eqt.ui import FormDialog
+
+import utilitiesForExamples as utex
+
+
+class MainUI(QtWidgets.QMainWindow):
+    def __init__(self, parent=None):
+        QtWidgets.QMainWindow.__init__(self, parent)
+
+        pb = QtWidgets.QPushButton(self)
+        pb.setText("Open Dialog with form layout")
+        pb.clicked.connect(lambda: self.executeDialog())
+
+        layout = QtWidgets.QHBoxLayout()
+        layout.addWidget(pb)
+        widg = QtWidgets.QWidget()
+        widg.setLayout(layout)
+
+        self.setCentralWidget(widg)
+        self.dialog = FormDialog(parent=self, title='Example')
+        self.openFormDialog()
+
+        self.show()
+
+    def openFormDialog(self):
+        utex.addWidgetsToExample(self.dialog)
+        # redefine the onOk and onCancel functions
+        self.dialog.onOk = self.accepted
+        self.dialog.onCancel = self.rejected
+
+    def accepted(self):
+        print("States saved")
+
+    def rejected(self):
+        print("States rejected")
+
+    # open dialog function when the parent button is clicked
+    def executeDialog(self):
+        self.dialog.open()
+
+
+if __name__ == "__main__":
+    app = QtWidgets.QApplication(sys.argv)
+
+    window = MainUI()
+
+    sys.exit(app.exec_())

examples/utilitiesForExamples.py

@@ -0,0 +1,26 @@
+from PySide2 import QtWidgets
+from eqt.ui.UISliderWidget import UISliderWidget
+
+def addWidgetsToExample(form):
+    '''
+    Adds a spanning widget and every type of widget to a form
+    '''
+    # add a spanning widget
+    form.addSpanningWidget(QtWidgets.QLabel("Input Values: "), 'input_title')
+    # add all widgets
+    form.addWidget(QtWidgets.QLabel('Label'), 'Label: ', 'label')
+    form.addWidget(QtWidgets.QCheckBox('check me'), 'CheckBox: ', 'checkBox')
+    combobox_list = ['choice 1', 'choice 2']
+    form.addWidget(QtWidgets.QComboBox(), 'ComboBox: ', 'comboBox')
+    form.getWidget('comboBox').addItems(combobox_list)
+    form.addWidget(QtWidgets.QDoubleSpinBox(), 'DoubleSpinBox: ', 'doubleSpinBox')
+    form.addWidget(QtWidgets.QSpinBox(), 'SpinBox: ', 'spinBox')
+    form.addWidget(QtWidgets.QSlider(), 'Slider: ', 'slider')
+    form.addWidget(UISliderWidget(QtWidgets.QLabel()), 'UISlider: ', 'uiSliderWidget')
+    form.addWidget(QtWidgets.QRadioButton('select me'), 'RadioButton: ', 'radioButton')
+    form.addWidget(QtWidgets.QTextEdit('write text here'), 'TextEdit: ', 'textEdit')
+    form.addWidget(QtWidgets.QPlainTextEdit('write text here'), 'PlainTextEdit: ',
+                            'plainTextEdit')
+    form.addWidget(QtWidgets.QLineEdit('write text here'), 'LineEdit: ', 'lineEdit')
+    form.addWidget(QtWidgets.QPushButton('Click me'), 'Button: ', 'button')
+

test/test__formUI_status_test.py

@@ -3,6 +3,8 @@
 from unittest import mock
 
 from PySide2 import QtWidgets
+from PySide2.QtCore import Qt
+from PySide2.QtTest import QTest
 
 from eqt.ui.FormDialog import FormDialog
 from eqt.ui.UIFormWidget import FormDockWidget, FormWidget
@@ -13,9 +15,29 @@
 
 class FormsCommonTests(metaclass=abc.ABCMeta):
     """Common tests for all Form types"""
+
     @abc.abstractmethod
     def setUp(self):
         raise NotImplementedError
+
+    @property                 
+    def exampleState(self): 
+        # define two states for every widget
+        state=[
+            {
+            'label_value': 'Test label state 0', 'checkbox_value': False, 'combobox_value': 0,
+            'doubleSpinBox_value': 10.0, 'spinBox_value': 10, 'slider_value': 10,
+            'uislider_value': 10, 'radio_value': False, 'textEdit_value': 'test edit 0',
+            'plainTextEdit_value': 'test plain 0', 'lineEdit_value': 'test line 0',
+            'pushButton_value': False},
+            {
+            'label_value': 'Test label state 1', 'checkbox_value': True, 'combobox_value': 1,
+            'doubleSpinBox_value': 1.0, 'spinBox_value': 1, 'slider_value': 1, 'uislider_value': 1,
+            'radio_value': True, 'textEdit_value': 'test edit 1',
+            'plainTextEdit_value': 'test plain 1', 'lineEdit_value': 'test line 1',
+            'pushButton_value': True}
+            ]    
+        return state
 
     def add_every_widget(self):
         """Generate every widget and add it to `self.form`"""
@@ -39,6 +61,44 @@ def add_two_widgets(self):
         form.addWidget(QtWidgets.QLabel('test label'), 'Label: ', 'label')
         form.addWidget(QtWidgets.QCheckBox('test checkbox'), 'CheckBox: ', 'checkBox')
 
+    def set_state(self, ii):
+        """
+        Applies the values saved in `self.exampleState` at position `ii` to the widgets in the form.
+
+        Parameters
+        ----------------
+        ii: int
+        """
+        state=self.exampleState
+        # set the states
+        # QLabel
+        self.form.getWidget('label').setText(state[ii]['label_value'])
+        # QCheckBox
+        self.form.getWidget('checkBox').setChecked(state[ii]['checkbox_value'])
+        # QComboBox
+        combobox_list = ['test', 'test2']
+        self.form.getWidget('comboBox').addItems(combobox_list)
+        self.form.getWidget('comboBox').setCurrentIndex(state[ii]['combobox_value'])
+        # QDoubleSpinBox
+        self.form.getWidget('doubleSpinBox').setValue(state[ii]['doubleSpinBox_value'])
+        # QSpinBox
+        self.form.getWidget('spinBox').setValue(state[ii]['spinBox_value'])
+        # QSlider
+        self.form.getWidget('slider').setValue(state[ii]['slider_value'])
+        # UISlider
+        self.form.getWidget('uiSliderWidget').setValue(state[ii]['uislider_value'])
+        # QRadioButton
+        self.form.getWidget('radioButton').setChecked(state[ii]['radio_value'])
+        # QTextEdit
+        self.form.getWidget('textEdit').setText(state[ii]['textEdit_value'])
+        # QPlainTextEdit
+        self.form.getWidget('plainTextEdit').setPlainText(state[ii]['plainTextEdit_value'])
+        # QLineEdit
+        self.form.getWidget('lineEdit').setText(state[ii]['lineEdit_value'])
+        # QPushButton
+        self.form.getWidget('button').setCheckable(True)
+        self.form.getWidget('button').setChecked(state[ii]['pushButton_value'])
+
     def test_getWidgetState_returns_visibility(self):
         """
         Check that the visibility of the widget is saved to the state
@@ -296,6 +356,43 @@ def setUp(self):
         self.simple_form = FormDialog()
         self.add_two_widgets()
 
+    def click_Ok(self):
+        QTest.mouseClick(self.form.Ok, Qt.LeftButton)
+
+    def click_Cancel(self):
+        QTest.mouseClick(self.form.Cancel, Qt.LeftButton)
+
+    def test_save_states_default(self):
+        # test both states are working
+        # state1
+        self.set_state(1)
+        states1 = self.form.getAllWidgetStates()
+        self.assertEqual(states1, self.form.getAllWidgetStates())
+        # state0
+        self.set_state(0)
+        states0 = self.form.getAllWidgetStates()
+        self.assertNotEqual(states1, self.form.getAllWidgetStates())
+        self.assertEqual(states0, self.form.getAllWidgetStates())
+        # check state 0 and 1 are not saved when Cancel is pressed
+        self.click_Cancel()
+        self.assertNotEqual(states0, self.form.getAllWidgetStates())
+        self.assertNotEqual(states1, self.form.getAllWidgetStates())
+        # save state 0
+        self.set_state(0)
+        self.assertEqual(states0, self.form.getAllWidgetStates())
+        self.click_Ok()
+        self.assertEqual(states0, self.form.getAllWidgetStates())
+        # save state 1
+        self.set_state(1)
+        self.assertEqual(states1, self.form.getAllWidgetStates())
+        self.click_Ok()
+        self.assertEqual(states1, self.form.getAllWidgetStates())
+        # change to state 0 without saving
+        self.set_state(0)
+        self.assertEqual(states0, self.form.getAllWidgetStates())
+        self.click_Cancel()
+        self.assertEqual(states1, self.form.getAllWidgetStates())
+
     def test_getWidgetState_returns_QLabel_value(self):
         """Check that the value of the QLabel is saved to the state"""
         initial_label_value = 'Label: '