mitk::IDataStorageInspectorProvider Struct Reference

The common interface for all DataStorage inspector providers. More...

#include <mitkIDataStorageInspectorProvider.h>

Inheritance diagram for mitk::IDataStorageInspectorProvider:

Public Types
using	InspectorIDType = std::string

Public Member Functions
virtual	~IDataStorageInspectorProvider ()
virtual QmitkAbstractDataStorageInspector *	CreateInspector () const =0
	returns an inspector instance represented by the provider. More...
virtual InspectorIDType	GetInspectorID () const =0
virtual std::string	GetInspectorDisplayName () const =0
virtual std::string	GetInspectorDescription () const =0
virtual QIcon	GetInspectorIcon () const =0

Static Public Member Functions
static std::string	PROP_INSPECTOR_ID ()
	Service property name for the inspector ID. More...

Detailed Description

The common interface for all DataStorage inspector providers.

Implementations of this interface must be registered as a service to make themselves available via the service registry.

It is recommended to derive new implementations from QmitkDataStorageInspectorProviderBase which provide correct service registration semantics.

See also

QmitkDataStorageInspectorProviderBase

Definition at line 39 of file mitkIDataStorageInspectorProvider.h.

Member Typedef Documentation

InspectorIDType

using mitk::IDataStorageInspectorProvider::InspectorIDType = std::string

Definition at line 48 of file mitkIDataStorageInspectorProvider.h.

Constructor & Destructor Documentation

~IDataStorageInspectorProvider()

virtual mitk::IDataStorageInspectorProvider::~IDataStorageInspectorProvider ( )

virtual

Member Function Documentation

CreateInspector()

virtual QmitkAbstractDataStorageInspector* mitk::IDataStorageInspectorProvider::CreateInspector ( ) const

pure virtual

returns an inspector instance represented by the provider.

Implemented in QmitkDataStorageInspectorProviderBase< TInspector >.

GetInspectorDescription()

virtual std::string mitk::IDataStorageInspectorProvider::GetInspectorDescription ( ) const

pure virtual

Returns a description of the inspector type provided.

Implemented in QmitkDataStorageInspectorProviderBase< TInspector >.

GetInspectorDisplayName()

virtual std::string mitk::IDataStorageInspectorProvider::GetInspectorDisplayName ( ) const

pure virtual

Return the display name (e.g. used in the UI) for the inspector type provided.

Implemented in QmitkDataStorageInspectorProviderBase< TInspector >.

GetInspectorIcon()

virtual QIcon mitk::IDataStorageInspectorProvider::GetInspectorIcon ( ) const

pure virtual

Returns the svg data of the icon of the inspector. Empty array indicates that no icon is defined.

Remarks

It is passed as svg file content and not as icon directly to allow later styling

Implemented in QmitkDataStorageInspectorProviderBase< TInspector >.

GetInspectorID()

virtual InspectorIDType mitk::IDataStorageInspectorProvider::GetInspectorID ( ) const

pure virtual

Return the uniqe ID for the inspector type provided.

Implemented in QmitkDataStorageInspectorProviderBase< TInspector >.

PROP_INSPECTOR_ID()

static std::string mitk::IDataStorageInspectorProvider::PROP_INSPECTOR_ID ( )

static

Service property name for the inspector ID.

The property value must be of type std::string.

Returns

The property name.

---

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

• mitkIDataStorageInspectorProvider.h