Medical Imaging Interaction Toolkit  2024.06.99-b3904305
Medical Imaging Interaction Toolkit
berry::IViewRegistry Struct Referenceabstract

#include <berryIViewRegistry.h>

Public Member Functions

virtual IViewDescriptor::Pointer Find (const QString &id) const =0
virtual QList< IViewCategory::PointerGetCategories ()=0
virtual QList< IViewDescriptor::PointerGetViews () const =0
virtual QMultiMap< QString, IViewDescriptor::PointerGetViewsByCategory () const =0
 Get views as multi map with categories as keys. More...
virtual QList< IStickyViewDescriptor::PointerGetStickyViews () const =0
virtual ~IViewRegistry ()

Detailed Description

The view registry maintains a list of views explicitly registered against the view extension point.

The description of a given view is kept in a IViewDescriptor.

This interface is not intended to be implemented by clients.

See also

Definition at line 40 of file berryIViewRegistry.h.

Constructor & Destructor Documentation

◆ ~IViewRegistry()

virtual berry::IViewRegistry::~IViewRegistry ( )

Member Function Documentation

◆ Find()

virtual IViewDescriptor::Pointer berry::IViewRegistry::Find ( const QString &  id) const
pure virtual

Return a view descriptor with the given extension id. If no view exists with the id return null. Will also return null if the view descriptor exists, but is filtered by an expression-based activity.

idthe id to search for
the descriptor or null

◆ GetCategories()

virtual QList<IViewCategory::Pointer> berry::IViewRegistry::GetCategories ( )
pure virtual

Returns an array of view categories.

the categories.

◆ GetStickyViews()

virtual QList<IStickyViewDescriptor::Pointer> berry::IViewRegistry::GetStickyViews ( ) const
pure virtual

Return a list of sticky views defined in the registry.

the sticky views. Never null.

◆ GetViews()

virtual QList<IViewDescriptor::Pointer> berry::IViewRegistry::GetViews ( ) const
pure virtual

Return a list of views defined in the registry.

the views.

◆ GetViewsByCategory()

virtual QMultiMap<QString, IViewDescriptor::Pointer> berry::IViewRegistry::GetViewsByCategory ( ) const
pure virtual

Get views as multi map with categories as keys.

Exclude views without category and categories that contain a literal '.', e.g. "org.blueberry.ui" or "org.mitk.views.general", as they typically do not have a corresponding tool bar.

the views by category as described above.

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