IPropertySettings.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidKernel/DllConfig.h"
#include <string>
#include <vector>
 
namespace Mantid {
namespace Kernel {
//----------------------------------------------------------------------
// Forward Declaration
//----------------------------------------------------------------------
class IPropertyManager;
class Property;
 
class MANTID_KERNEL_DLL IPropertySettings {
public:
  IPropertySettings() = default;
 
  virtual ~IPropertySettings() = default;
 
  virtual bool isEnabled(const IPropertyManager *algo) const {
    UNUSED_ARG(algo);
    return true;
  }
 
  virtual bool isVisible(const IPropertyManager *algo) const {
    UNUSED_ARG(algo);
    return true;
  }
 
  virtual bool isConditionChanged(const IPropertyManager *algo, const std::string &changedPropName = "") const {
    UNUSED_ARG(algo);
    UNUSED_ARG(changedPropName);
    return false;
  }
 
  virtual bool applyChanges(const IPropertyManager *algo, const std::string &currentPropName) {
    UNUSED_ARG(algo);
    UNUSED_ARG(currentPropName);
    return false;
  }
 
  virtual std::vector<std::string> dependsOn(const std::string & /* unused */) const {
    return std::vector<std::string>();
  }
 
  //--------------------------------------------------------------------------------------------
  virtual IPropertySettings *clone() const = 0;
 
protected:
  // non-copyable directly
  IPropertySettings(const IPropertySettings &) = default;
};
 
} // namespace Kernel
} // namespace Mantid