LeechCraft  %{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
IQuarkComponentProvider Class Referenceabstract

Interface for plugins providing quark components. More...

#include "iquarkcomponentprovider.h"

Public Member Functions

virtual ~IQuarkComponentProvider ()
 Virtual destructor. More...
 
virtual
LeechCraft::QuarkComponents_t 
GetComponents () const =0
 Returns the list of quarks provided by this plugin. More...
 

Detailed Description

Interface for plugins providing quark components.

Definition at line 142 of file iquarkcomponentprovider.h.

Constructor & Destructor Documentation

virtual IQuarkComponentProvider::~IQuarkComponentProvider ( )
inlinevirtual

Virtual destructor.

Definition at line 147 of file iquarkcomponentprovider.h.

Member Function Documentation

virtual LeechCraft::QuarkComponents_t IQuarkComponentProvider::GetComponents ( ) const
pure virtual

Returns the list of quarks provided by this plugin.

This function returns the list of smart pointers to quarks provided by this plugin. The caller will remove the pointers once he doesn't need them anymore. Thus, if the plugin doesn't retain the pointers, the corresponding QuarkComponent objects will be destroyed.

Dynamic context-independent context properties (QuarkComponent::DynamicProps_) should be the same objects for each result of each invocation. Context-dependent properties (those in QuarkComponent::ContextProps_) should be created on each invocation of this method.

Returns
The list of quark components provided by this plugin.

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