Medical Imaging Interaction Toolkit  2018.4.99-08619e4f
Medical Imaging Interaction Toolkit
mitk::IPropertyDescriptions Class Referenceabstract

Interface of property descriptions service. More...

#include <mitkIPropertyDescriptions.h>

Inheritance diagram for mitk::IPropertyDescriptions:

Public Member Functions

virtual ~IPropertyDescriptions ()
 
virtual bool AddDescription (const std::string &propertyName, const std::string &description, const std::string &className="", bool overwrite=false)=0
 Add a description for a specific property. More...
 
virtual bool AddDescriptionRegEx (const std::string &propertyRegEx, const std::string &description, const std::string &className="", bool overwrite=false)=0
 Add a description for all properties matching the property regulary expression. More...
 
virtual std::string GetDescription (const std::string &propertyName, const std::string &className="", bool allowNameRegEx=true) const =0
 Get the description for a specific property. More...
 
virtual bool HasDescription (const std::string &propertyName, const std::string &className="", bool allowNameRegEx=true) const =0
 Check if a specific property has a description. More...
 
virtual void RemoveAllDescriptions (const std::string &className="")=0
 Remove all descriptions. More...
 
virtual void RemoveDescription (const std::string &propertyName, const std::string &className="")=0
 Remove description of specific property. More...
 

Detailed Description

Interface of property descriptions service.

This service allows you to manage descriptions for properties. The property view displays descriptions of selected properties (in rich text format) at its bottom.

Definition at line 29 of file mitkIPropertyDescriptions.h.

Constructor & Destructor Documentation

◆ ~IPropertyDescriptions()

mitk::IPropertyDescriptions::~IPropertyDescriptions ( )
virtual

Definition at line 15 of file mitkIPropertyDescriptions.cpp.

Member Function Documentation

◆ AddDescription()

virtual bool mitk::IPropertyDescriptions::AddDescription ( const std::string &  propertyName,
const std::string &  description,
const std::string &  className = "",
bool  overwrite = false 
)
pure virtual

Add a description for a specific property.

Parameters
[in]propertyNameName of the property.
[in]descriptionDescription of the property.
[in]classNameOptional data node class name to which this description is restricted.
[in]overwriteOverwrite already existing description.
Returns
True if description was added successfully.

Implemented in mitk::PropertyDescriptions.

Referenced by mitk::SurfaceVtkMapper3D::SetDefaultProperties().

◆ AddDescriptionRegEx()

virtual bool mitk::IPropertyDescriptions::AddDescriptionRegEx ( const std::string &  propertyRegEx,
const std::string &  description,
const std::string &  className = "",
bool  overwrite = false 
)
pure virtual

Add a description for all properties matching the property regulary expression.

Parameters
[in]propertyRegExString of the regular expression specifing all relevant property names.
[in]descriptionDescription of the property.
[in]classNameOptional data node class name to which this description is restricted.
[in]overwriteOverwrite already existing description.
Returns
True if description was added successfully.

Implemented in mitk::PropertyDescriptions.

Referenced by mitk::DICOMTagsOfInterestService::AddTagOfInterest().

◆ GetDescription()

virtual std::string mitk::IPropertyDescriptions::GetDescription ( const std::string &  propertyName,
const std::string &  className = "",
bool  allowNameRegEx = true 
) const
pure virtual

Get the description for a specific property.

Parameters
[in]propertyNameName of the property.
[in]classNameOptional data node class name to which the returned description is restricted.
[in]allowNameRegExIndicates of also regular expressions should be regarded.
Returns
Property description or empty string if no description is available.

Implemented in mitk::PropertyDescriptions.

◆ HasDescription()

virtual bool mitk::IPropertyDescriptions::HasDescription ( const std::string &  propertyName,
const std::string &  className = "",
bool  allowNameRegEx = true 
) const
pure virtual

Check if a specific property has a description.

Parameters
[in]propertyNameName of the property.
[in]classNameOptional data node class name to which this description is restricted.
[in]allowNameRegExIndicates of also regular expressions should be regarded.
Returns
True if the property has a description, false otherwise.

Implemented in mitk::PropertyDescriptions.

◆ RemoveAllDescriptions()

virtual void mitk::IPropertyDescriptions::RemoveAllDescriptions ( const std::string &  className = "")
pure virtual

Remove all descriptions.

Parameters
[in]classNameOptional data node class name to which this description is restricted.

Implemented in mitk::PropertyDescriptions.

◆ RemoveDescription()

virtual void mitk::IPropertyDescriptions::RemoveDescription ( const std::string &  propertyName,
const std::string &  className = "" 
)
pure virtual

Remove description of specific property.

Parameters
[in]propertyNameName of the property.
[in]classNameOptional data node class name to which this description is restricted.

Implemented in mitk::PropertyDescriptions.

Referenced by mitk::DICOMTagsOfInterestService::RemoveAllTags(), and mitk::DICOMTagsOfInterestService::RemoveTag().


The documentation for this class was generated from the following files: