CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
Public Member Functions | Static Public Attributes | List of all members
ctkMetaTypeProvider Struct Referenceabstract

#include <Libs/PluginFramework/service/metatype/ctkMetaTypeProvider.h>

Inheritance diagram for ctkMetaTypeProvider:
Inheritance graph
[legend]

Public Member Functions

virtual QList< QLocale > getLocales () const =0
 
virtual ctkObjectClassDefinitionPtr getObjectClassDefinition (const QString &id, const QLocale &locale=QLocale())=0
 
virtual ~ctkMetaTypeProvider ()
 

Static Public Attributes

static const QString METATYPE_FACTORY_PID
 
static const QString METATYPE_PID
 

Detailed Description

Provides access to metatypes. This interface can be implemented on a Managed Service or Managed Service Factory as well as registered as a service. When registered as a service, it must be registered with a METATYPE_FACTORY_PID or METATYPE_PID service property (or both). Any PID mentioned in either of these factories must be a valid argument to the getObjectClassDefinition(const QString&, const QLocale&) method.

Definition at line 41 of file ctkMetaTypeProvider.h.

Constructor & Destructor Documentation

◆ ~ctkMetaTypeProvider()

virtual ctkMetaTypeProvider::~ctkMetaTypeProvider ( )
inlinevirtual

Definition at line 58 of file ctkMetaTypeProvider.h.

Member Function Documentation

◆ getLocales()

virtual QList<QLocale> ctkMetaTypeProvider::getLocales ( ) const
pure virtual

Return a list of available locales.

Returns
A list of QLocale objects.

◆ getObjectClassDefinition()

virtual ctkObjectClassDefinitionPtr ctkMetaTypeProvider::getObjectClassDefinition ( const QString &  id,
const QLocale &  locale = QLocale() 
)
pure virtual

Returns an object class definition for the specified id localized to the specified locale. If no locale is specified, the default locale is used, according to the default constructor of QLocale.

Parameters
idThe ID of the requested object class. This can be a pid or factory pid returned by getPids or getFactoryPids.
localeThe locale of the definition
Returns
A ctkObjectClassDefinition object.

Member Data Documentation

◆ METATYPE_FACTORY_PID

const QString ctkMetaTypeProvider::METATYPE_FACTORY_PID
static

Service property to signal that this service has ctkObjectClassDefinition objects for the given factory PIDs. The type of this service property is QString.

Definition at line 56 of file ctkMetaTypeProvider.h.

◆ METATYPE_PID

const QString ctkMetaTypeProvider::METATYPE_PID
static

Service property to signal that this service has ctkObjectClassDefinition objects for the given PIDs. The type of this service property is QString.

Definition at line 49 of file ctkMetaTypeProvider.h.


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