mitk::IPropertyDescriptions Class Reference

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 regular 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()

virtual mitk::IPropertyDescriptions::~IPropertyDescriptions ( )

virtual

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]	propertyName	Name of the property.
[in]	description	Description of the property.
[in]	className	Optional data node class name to which this description is restricted.
[in]	overwrite	Overwrite already existing description.

Returns

True if description was added successfully.

Implemented in mitk::PropertyDescriptions.

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 regular expression.

Parameters

[in]	propertyRegEx	String of the regular expression specifying all relevant property names.
[in]	description	Description of the property.
[in]	className	Optional data node class name to which this description is restricted.
[in]	overwrite	Overwrite already existing description.

Returns

True if description was added successfully.

Implemented in mitk::PropertyDescriptions.

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]	propertyName	Name of the property.
[in]	className	Optional data node class name to which the returned description is restricted.
[in]	allowNameRegEx	Indicates 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]	propertyName	Name of the property.
[in]	className	Optional data node class name to which this description is restricted.
[in]	allowNameRegEx	Indicates 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]

className

Optional 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]	propertyName	Name of the property.
[in]	className	Optional data node class name to which this description is restricted.

Implemented in mitk::PropertyDescriptions.

---

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

• mitkIPropertyDescriptions.h