NCBI C++ ToolKit
Public Types | Public Member Functions | List of all members
IExtensionRegistry Class Referenceabstract

Search Toolkit Book for IExtensionRegistry

IExtensionRegistry IExtensionRegistry is an interface representing a Registry where Extension Points and Extensions are registered. More...

#include <gui/utils/extension.hpp>

+ Inheritance diagram for IExtensionRegistry:

Public Types

typedef CIRef< IExtensionTExtRef
 
typedef vector< TExtRefTExtVec
 
typedef CIRef< IExtensionPointTExtPointRef
 
typedef vector< TExtPointRefTExtPointVec
 

Public Member Functions

virtual bool AddExtensionPoint (IExtensionPoint &ext_point)=0
 adds a new Extension Point, returns true if successful More...
 
virtual bool AddExtensionPoint (const string &ext_point_id, const string &ext_point_label)=0
 adds a new Extension Point, returns true if successful More...
 
virtual bool AddExtension (const string &ext_point_id, IExtension &extension)=0
 adds a new Extension to an Extension Point, if the Point does not exists creates a new one, returns true if successful More...
 
virtual TExtRef GetExtension (const string &extension_id)=0
 finds and returns a reference to an Extension with the specified Id, search is performed across all Points in the Registry returns null if there the Id is not found More...
 
virtual TExtRef GetExtension (const string &ext_point_id, const string &extension_id)=0
 finds and returns a reference to an Extension with the specified Id, search is performed only in the Extension Point with the given Id, returns null if there the Id is not found More...
 
virtual TExtPointRef GetExtensionPoint (const string &ext_point_id)=0
 returns a reference to an Extension Point with the given identifier, returns null if there the Id is not found More...
 
virtual bool GetExtensions (const string &ext_point_id, TExtVec &extensions)=0
 finds an Extension Point with the given Id and fills the given container with references to all Extensions registered in the Point. More...
 
virtual void GetExtensionPoints (TExtPointVec &ext_points)=0
 fills the given container with all Extension Points registered More...
 
virtual bool RemoveExtension (IExtension &extension)=0
 removes the given Extension from all Extension Points in the Registry returns false if the Extension is not registered More...
 
virtual bool RemoveExtension (const string &ext_id)=0
 removes the Extension with the given Id from all Extension Point in the Registry, returns false if the Extension Id is not found More...
 
virtual bool RemoveExtension (const string &ext_point_id, IExtension &extension)=0
 removes the given Extension from the Extension Point with the given id returns false if the Point or Extension is not found More...
 
virtual bool RemoveExtension (const string &ext_point_id, const string &ext_id)=0
 removes the Extension with the given Id from the Extension Point with the specified Id. More...
 
virtual bool RemoveExtensionPoint (IExtensionPoint &ext_point)=0
 removes the specified Extension Point from the Registry. More...
 
virtual ~IExtensionRegistry ()
 

Detailed Description

IExtensionRegistry IExtensionRegistry is an interface representing a Registry where Extension Points and Extensions are registered.

IExtensionRegistry provides a more convenient higher-level API for working with Points and Extensions.

Definition at line 121 of file extension.hpp.


The documentation for this class was generated from the following file:
Modified on Fri Sep 20 14:58:26 2024 by modify_doxy.py rev. 669887