mitk::IPropertyExtensions Class Reference

Interface of property extensions service. More...

#include <mitkIPropertyExtensions.h>

Inheritance diagram for mitk::IPropertyExtensions:

Public Member Functions
virtual	~IPropertyExtensions ()
virtual bool	AddExtension (const std::string &propertyName, PropertyExtension::Pointer extension, const std::string &className="", bool overwrite=false)=0
	Add an extension to a specific property. More...
virtual PropertyExtension::Pointer	GetExtension (const std::string &propertyName, const std::string &className="")=0
	Get the extension of a specific property. More...
virtual bool	HasExtension (const std::string &propertyName, const std::string &className="")=0
	Check if a specific property has an extension. More...
virtual void	RemoveAllExtensions (const std::string &className="")=0
	Remove all property extensions. More...
virtual void	RemoveExtension (const std::string &propertyName, const std::string &className="")=0
	Remove extension of a specific property. More...

Detailed Description

Interface of property extensions service.

This service allows you to manage extensions for properties. An extension is a class that derives from mitk::PropertyExtension. Use extensions to attach useful metadata to your properties, e.g. the allowed range of values. Note that you have to extend the property view if you want it to respect your custom metadata.

Definition at line 32 of file mitkIPropertyExtensions.h.

Constructor & Destructor Documentation

~IPropertyExtensions()

virtual mitk::IPropertyExtensions::~IPropertyExtensions ( )

virtual

Member Function Documentation

AddExtension()

virtual bool mitk::IPropertyExtensions::AddExtension ( const std::string &  propertyName, PropertyExtension::Pointer  extension, const std::string &  className = "", bool  overwrite = false  )

pure virtual

Add an extension to a specific property.

Parameters

[in]	propertyName	Name of the property.
[in]	extension	Property extension.
[in]	className	Optional data node class name to which the property extension is restricted.
[in]	overwrite	Overwrite already existing property extension.

Returns

True if extension was added successfully.

Implemented in mitk::PropertyExtensions.

GetExtension()

virtual PropertyExtension::Pointer mitk::IPropertyExtensions::GetExtension ( const std::string &  propertyName, const std::string &  className = ""  )

pure virtual

Get the extension of a specific property.

Parameters

[in]	propertyName	Name of the property.
[in]	className	Optional data node class name to which the returned property extension is restricted.

Returns

Property extension or null pointer if no extension was found.

Implemented in mitk::PropertyExtensions.

HasExtension()

virtual bool mitk::IPropertyExtensions::HasExtension ( const std::string &  propertyName, const std::string &  className = ""  )

pure virtual

Check if a specific property has an extension.

Parameters

[in]	propertyName	Name of the property.
[in]	className	Optional data node class name to which the property extension is restricted.

Returns

True if the property has an extension, false otherwise.

Implemented in mitk::PropertyExtensions.

RemoveAllExtensions()

virtual void mitk::IPropertyExtensions::RemoveAllExtensions ( const std::string &  className = "" )

pure virtual

Remove all property extensions.

Parameters

[in]

className

Optional data node class name to which the property extension is restricted.

Implemented in mitk::PropertyExtensions.

RemoveExtension()

virtual void mitk::IPropertyExtensions::RemoveExtension ( const std::string &  propertyName, const std::string &  className = ""  )

pure virtual

Remove extension of a specific property.

Parameters

[in]	propertyName	Name of the property.
[in]	className	Optional data node class name to which the property extension is restricted.

Implemented in mitk::PropertyExtensions.

---

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

• mitkIPropertyExtensions.h