mitkIPreferences.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkIPreferences_h
#define mitkIPreferences_h
 
#include <mitkMessage.h>
 
#include <MitkCoreExports.h>
 
#include <cstddef>
#include <string>
#include <vector>
 
namespace mitk
{
  class MITKCORE_EXPORT IPreferences
  {
  public:
    class MITKCORE_EXPORT ChangeEvent
    {
    public:
      ChangeEvent(IPreferences* source, const std::string& property, const std::string& oldValue, const std::string& newValue);
 
      IPreferences* GetSource() const;
      std::string GetProperty() const;
      std::string GetOldValue() const;
      std::string GetNewValue() const;
 
    private:
      IPreferences* m_Source;
      std::string m_Property;
      std::string m_OldValue;
      std::string m_NewValue;
    };
 
    virtual ~IPreferences();
 
    virtual std::string Get(const std::string& key, const std::string& def) const = 0;
 
    virtual void Put(const std::string& key, const std::string& value) = 0;
 
    virtual int GetInt(const std::string& key, int def) const = 0;
 
    virtual void PutInt(const std::string& key, int value) = 0;
 
    virtual bool GetBool(const std::string& key, bool def) const = 0;
 
    virtual void PutBool(const std::string& key, bool value) = 0;
 
    virtual float GetFloat(const std::string& key, float def) const = 0;
 
    virtual void PutFloat(const std::string& key, float value) = 0;
 
    virtual double GetDouble(const std::string& key, double def) const = 0;
 
    virtual void PutDouble(const std::string& key, double value) = 0;
 
    virtual std::vector<std::byte> GetByteArray(const std::string& key, const std::byte* def, size_t size) const = 0;
 
    virtual void PutByteArray(const std::string& key, const std::byte* array, size_t size) = 0;
 
    virtual void Override(const std::string& key, const std::string& value) = 0;
 
    virtual void OverrideInt(const std::string& key, int value) = 0;
 
    virtual void OverrideBool(const std::string& key, bool value) = 0;
 
    virtual void OverrideFloat(const std::string& key, float value) = 0;
 
    virtual void OverrideDouble(const std::string& key, double value) = 0;
 
    virtual void OverrideByteArray(const std::string& key, const std::byte* array, size_t size) = 0;
 
    virtual bool IsOverridden(const std::string& key) const = 0;
 
    virtual void RemoveOverride(const std::string& key) = 0;
 
    virtual void ClearOverrides() = 0;
 
    virtual void Flush() = 0;
 
    virtual bool Remove(const std::string& key, bool forceRemoval = false) = 0;
 
    virtual void Clear(bool includeOverrides = false) = 0;
 
    virtual std::vector<std::string> Keys(bool includeOverrides = false) const = 0;
 
    virtual std::string Name() const = 0;
 
    virtual std::string AbsolutePath() const = 0;
 
    virtual std::vector<std::string> ChildrenNames() const = 0;
 
    virtual IPreferences* Parent() = 0;
 
    virtual const IPreferences* Parent() const = 0;
 
    virtual IPreferences* Root() = 0;
 
    virtual const IPreferences* Root() const = 0;
 
    virtual IPreferences* Node(const std::string& path) = 0;
 
    virtual void RemoveNode() = 0;
 
    Message1<const IPreferences*> OnChanged; 
    Message1<const ChangeEvent&> OnPropertyChanged; 
  };
 
  MITKCORE_EXPORT void ApplyPreferencesOverrides(const std::string& xmlContent, IPreferences* prefs);
 
  MITKCORE_EXPORT void ApplyPreferencesPatches(const std::string& xmlContent, IPreferences* prefs);
 
}
 
#endif