Merge release-next into main

mantidproject · May 10, 2024 · f2b8b49 · f2b8b49
2 parents b7676f5 + 2d38088
commit f2b8b49
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 4 deletions.
diff --git a/Framework/Kernel/inc/MantidKernel/Property.h b/Framework/Kernel/inc/MantidKernel/Property.h
@@ -196,6 +196,9 @@ class MANTID_KERNEL_DLL Property {
   bool autoTrim() const;
   void setAutoTrim(const bool &setting);
 
+  bool disableReplaceWSButton() const;
+  void setDisableReplaceWSButton(const bool &disable);
+
 protected:
   /// Constructor
   Property(std::string name, const std::type_info &type, const unsigned int &direction = Direction::Input);
@@ -232,6 +235,9 @@ class MANTID_KERNEL_DLL Property {
   /// Flag to determine if string inputs to the property should be automatically
   /// trimmed of whitespace
   bool m_autotrim;
+
+  /// Flag to disable the generation of the "Replace Workspace" button on the OutputWorkspace property
+  bool m_disableReplaceWSButton;
 };
 
 /// Compares this to another property for equality

diff --git a/Framework/Kernel/src/Property.cpp b/Framework/Kernel/src/Property.cpp
@@ -28,7 +28,7 @@ namespace Kernel {
  */
 Property::Property(std::string name, const std::type_info &type, const unsigned int &direction)
     : m_name(std::move(name)), m_documentation(""), m_typeinfo(&type), m_direction(direction), m_units(""), m_group(""),
-      m_remember(true), m_autotrim(true) {
+      m_remember(true), m_autotrim(true), m_disableReplaceWSButton(false) {
   if (m_name.empty()) {
     throw std::invalid_argument("An empty property name is not permitted");
   }
@@ -43,7 +43,7 @@ Property::Property(std::string name, const std::type_info &type, const unsigned
 Property::Property(const Property &right)
     : m_name(right.m_name), m_documentation(right.m_documentation), m_typeinfo(right.m_typeinfo),
       m_direction(right.m_direction), m_units(right.m_units), m_group(right.m_group), m_remember(right.m_remember),
-      m_autotrim(right.m_autotrim) {
+      m_autotrim(right.m_autotrim), m_disableReplaceWSButton(right.m_disableReplaceWSButton) {
   if (m_name.empty()) {
     throw std::invalid_argument("An empty property name is not permitted");
   }
@@ -342,6 +342,18 @@ bool Property::autoTrim() const { return m_autotrim; }
  * @param setting The new setting value
  */
 void Property::setAutoTrim(const bool &setting) { m_autotrim = setting; }
+
+/**
+ * Returns if the property is set to disable the creation of the "Replace Workspace" button
+ * @returns True/False
+ */
+bool Property::disableReplaceWSButton() const { return m_disableReplaceWSButton; }
+
+/**
+ * Sets the property to disable the creation of the "Replace Workspace" button
+ * @param disable The option to disable or not
+ */
+void Property::setDisableReplaceWSButton(const bool &disable) { m_disableReplaceWSButton = disable; }
 } // namespace Kernel
 
 } // namespace Mantid
diff --git a/Framework/Kernel/test/PropertyTest.h b/Framework/Kernel/test/PropertyTest.h
@@ -99,6 +99,15 @@ class PropertyTest : public CxxTest::TestSuite {
     TS_ASSERT(p3->remember());
   }
 
+  void testDisableReplaceWSButton() {
+    auto p = std::make_unique<PropertyHelper>();
+    TS_ASSERT(!p->disableReplaceWSButton());
+    p->setDisableReplaceWSButton(true);
+    TS_ASSERT(p->disableReplaceWSButton());
+    p->setDisableReplaceWSButton(false);
+    TS_ASSERT(!p->disableReplaceWSButton());
+  }
+
 private:
   std::unique_ptr<Property> p;
 };
diff --git a/Framework/PythonInterface/mantid/kernel/src/Exports/Property.cpp b/Framework/PythonInterface/mantid/kernel/src/Exports/Property.cpp
@@ -175,5 +175,7 @@ void export_Property() {
       .add_static_property("EMPTY_LONG", emptyLong)
 
       .def("setAutoTrim", &Property::setAutoTrim, (arg("setting")), "Setting automatic trimming of whitespaces.")
-      .def("getAutoTrim", &Property::autoTrim, "Gets the setting of automatic trimming of whitespaces.");
+      .def("getAutoTrim", &Property::autoTrim, "Gets the setting of automatic trimming of whitespaces.")
+      .def("setDisableReplaceWSButton", &Property::setDisableReplaceWSButton, (arg("disable")),
+           "Disable the creation of the Replace Workspace button.");
 }
diff --git a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/WANDPowderReduction.py b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/WANDPowderReduction.py
@@ -169,6 +169,7 @@ def PyInit(self):
             WorkspaceProperty("OutputWorkspace", "", direction=Direction.Output),
             doc="Output Workspace",
         )
+        self.getProperty("OutputWorkspace").setDisableReplaceWSButton(True)
 
         self.declareProperty(
             "Sum",

diff --git a/docs/source/release/v6.10.0/Diffraction/Powder/Bugfixes/37314.rst b/docs/source/release/v6.10.0/Diffraction/Powder/Bugfixes/37314.rst
@@ -0,0 +1 @@
+- Remove the confusing "Replace input workspace" button in the :ref:`WANDPowderReduction <algm-WANDPowderReduction>` algorithm
diff --git a/qt/widgets/common/src/AlgorithmPropertiesWidget.cpp b/qt/widgets/common/src/AlgorithmPropertiesWidget.cpp
@@ -255,7 +255,7 @@ void AlgorithmPropertiesWidget::initLayout() {
 
       // Only show the "Replace Workspace" button if the algorithm has an input
       // workspace.
-      if (hasInputWS)
+      if (hasInputWS && !prop->disableReplaceWSButton())
         widget->addReplaceWSButton();
 
       ++row;