mitkIPropertyDescriptions.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 mitkIPropertyDescriptions_h
#define mitkIPropertyDescriptions_h

#include <MitkCoreExports.h>
#include <mitkServiceInterface.h>
#include <string>

namespace mitk
{
  class MITKCORE_EXPORT IPropertyDescriptions
  {
  public:
    virtual ~IPropertyDescriptions();

    virtual bool AddDescription(const std::string &propertyName,
                                const std::string &description,
                                const std::string &className = "",
                                bool overwrite = false) = 0;

    virtual bool AddDescriptionRegEx(const std::string &propertyRegEx,
                                     const std::string &description,
                                     const std::string &className = "",
                                     bool overwrite = false) = 0;

    virtual std::string GetDescription(const std::string &propertyName,
                                       const std::string &className = "",
                                       bool allowNameRegEx = true) const = 0;

    virtual bool HasDescription(const std::string &propertyName,
                                const std::string &className = "",
                                bool allowNameRegEx = true) const = 0;

    virtual void RemoveAllDescriptions(const std::string &className = "") = 0;

    virtual void RemoveDescription(const std::string &propertyName, const std::string &className = "") = 0;
  };
}

MITK_DECLARE_SERVICE_INTERFACE(mitk::IPropertyDescriptions, "org.mitk.IPropertyDescriptions")

#endif