Medical Imaging Interaction Toolkit  2021.10.99-cbc78432
Medical Imaging Interaction Toolkit
berry::IProduct Struct Referenceabstract

#include <berryIProduct.h>

Inheritance diagram for berry::IProduct:
Collaboration diagram for berry::IProduct:

Public Types

typedef IProduct Self
 
typedef berry::SmartPointer< SelfPointer
 
typedef berry::SmartPointer< const SelfConstPointer
 
typedef berry::WeakPointer< SelfWeakPtr
 
typedef berry::WeakPointer< const SelfConstWeakPtr
 
- Public Types inherited from berry::Object
typedef Object Self
 
typedef berry::SmartPointer< SelfPointer
 
typedef berry::SmartPointer< const SelfConstPointer
 
typedef berry::WeakPointer< SelfWeakPtr
 
typedef berry::WeakPointer< const SelfConstWeakPtr
 

Public Member Functions

 ~IProduct () override
 
virtual QString GetApplication () const =0
 
virtual QString GetName () const =0
 
virtual QString GetDescription () const =0
 
virtual QString GetId () const =0
 
virtual QString GetProperty (const QString &key) const =0
 
virtual QSharedPointer< ctkPlugin > GetDefiningPlugin () const =0
 
- Public Member Functions inherited from berry::Object
virtual QString GetClassName () const
 
virtual Reflection::TypeInfo GetTypeInfo () const
 
virtual QList< Reflection::TypeInfoGetSuperclasses () const
 
virtual void Delete ()
 
QDebug Print (QDebug os, Indent Indent=0) const
 
virtual QString ToString () const
 
virtual uint HashCode () const
 
virtual bool operator< (const Object *) const
 
void Register () const
 
void UnRegister (bool del=true) const
 
int GetReferenceCount () const
 
void SetReferenceCount (int)
 
void AddDestroyListener (const MessageAbstractDelegate<> &delegate) const
 
void RemoveDestroyListener (const MessageAbstractDelegate<> &delegate) const
 
virtual bool operator== (const Object *) const
 

Static Public Member Functions

static const char * GetStaticClassName ()
 
- Static Public Member Functions inherited from berry::Object
static const char * GetStaticClassName ()
 
static Reflection::TypeInfo GetStaticTypeInfo ()
 
static QList< Reflection::TypeInfoGetStaticSuperclasses ()
 

Additional Inherited Members

- Protected Member Functions inherited from berry::Object
 Object ()
 
virtual ~Object ()
 
virtual QDebug PrintSelf (QDebug os, Indent indent) const
 
virtual QDebug PrintHeader (QDebug os, Indent indent) const
 
virtual QDebug PrintTrailer (QDebug os, Indent indent) const
 
- Protected Attributes inherited from berry::Object
QAtomicInt m_ReferenceCount
 
QMutex m_ReferenceCountLock
 

Detailed Description

Products are the BlueBerry unit of branding. From the runtime point of view they have a name, id and description and identify the BlueBerry application to run.

Since the bulk of the branding related information is specific to the UI, products also carry an arbitrary set of properties. The valid set of key-value pairs and their interpretation defined by the UI of the target environment. For example, in the standard BlueBerry UI, IProductConstants the properties of interest to the UI. Other clients may specify additional properties.

Products can be defined directly using extensions to the org.blueberry.core.runtime.products extension point or by using facilities provided by IProductProvider implementations.

See also
IProductProvider

Definition at line 42 of file berryIProduct.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 44 of file berryIProduct.h.

◆ ConstWeakPtr

Definition at line 44 of file berryIProduct.h.

◆ Pointer

Definition at line 44 of file berryIProduct.h.

◆ Self

Definition at line 44 of file berryIProduct.h.

◆ WeakPtr

Definition at line 44 of file berryIProduct.h.

Constructor & Destructor Documentation

◆ ~IProduct()

berry::IProduct::~IProduct ( )
override

Member Function Documentation

◆ GetApplication()

virtual QString berry::IProduct::GetApplication ( ) const
pure virtual

Returns the application associated with this product. This information is used to guide the runtime as to what application extension to create and execute.

Returns
this product's application or null if none

◆ GetDefiningPlugin()

virtual QSharedPointer<ctkPlugin> berry::IProduct::GetDefiningPlugin ( ) const
pure virtual

Returns the plug-in which is responsible for the definition of this product. Typically this is used as a base for searching for images and other files that are needed in presenting the product.

Returns
the plug-in which defines this product or null if none

◆ GetDescription()

virtual QString berry::IProduct::GetDescription ( ) const
pure virtual

Returns the text description of this product

Returns
the description of this product or null if none

◆ GetId()

virtual QString berry::IProduct::GetId ( ) const
pure virtual

Returns the unique product id of this product.

Returns
the id of this product

◆ GetName()

virtual QString berry::IProduct::GetName ( ) const
pure virtual

Returns the name of this product. The name is typically used in the title bar of UI windows.

Returns
the name of this product or null if none

◆ GetProperty()

virtual QString berry::IProduct::GetProperty ( const QString &  key) const
pure virtual

Returns the property of this product with the given key. null is returned if there is no such key/value pair.

Parameters
keythe name of the property to return
Returns
the value associated with the given key or null if none

◆ GetStaticClassName()

static const char* berry::IProduct::GetStaticClassName ( )
inlinestatic

Definition at line 44 of file berryIProduct.h.


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