The IDirectoryComponentProvider uses to load custom components from the specified library path. More...

#include <IDirectoryComponentProvider.h>

Inherited by DirectoryComponentProvider.

Public Member Functions
virtual const QString &	extension () const =0

virtual QDir::Filters	filters () const =0

virtual QDirIterator::IteratorFlags	flags () const =0

virtual const QString &	path () const =0

virtual void	setExtension (const QString &definitionExtension)=0

virtual void	setFilters (QDir::Filters filters)=0

virtual void	setFlags (QDirIterator::IteratorFlags flags)=0

virtual void	setPath (const QString &path)=0

virtual QList< IComponent * >	update ()=0

Public Member Functions inherited from IComponentProvider
virtual QList< IComponent * >	components () const =0

virtual bool	initialize ()=0

virtual bool	isInitialized () const =0

virtual void	registerComponent (IComponent *component)=0

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

Detailed Description

The IDirectoryComponentProvider uses to load custom components from the specified library path.

IDirectoryComponentProvider does not instantiate components from the shared libraries, it uses FileComponentProvider instead.

To export your component in shared library you have to define it:

*   #include <carousel/componentsystem/BaseComponent.h>
*
*   class MyComponent : public BaseComponent
*   {
*       Q_OBJECT
*   public:
*       MyComponent(QObject *parent = nullptr);
*   protected:
*       bool onStartup(IServiceLocator *serviceLocator);
*   private:
*       IServiceLocator *m_serviceLocator;
*   };
* 

and to export it in MyComponent.cpp file using macros EXPORT_COMPONENT:

*   #include "MyComponent.h"
*   #include <carousel/componentsystem/ComponentExport.h>
*
*   MyComponent::MyComponent(QObject *parent)
*      : BaseComponent("MyComponent", parent)
*      , m_serviceLocator(nullptr)
*   {
*   }
*
*   bool MyComponent::onStartup(IServiceLocator *serviceLocator)
*   {
*       m_serviceLocator = serviceLocator;
*       return (m_serviceLocator != nullptr);
*   }
*
*   EXPORT_COMPONENT(MyComponent)
*
* 

You also should provide definition for the component:

*   <component name="MyComponent">
*       <productName>My super product</productName>
*       <description>Ultra feature</description>
*       <location>./MyComponent</location>
*       <parents>
*           <parentComponent name="ComponentA"/>
*           <parentComponent name="ComponentC"/>
*           <parentComponent name="ComponentB"/>
*       </parents>
*   </component>
* 

XmlDefinitionParser will be used to read this meta-information, by which ProxyComponent should load the real component.

Then you should override BootloaderBase::createComponentProvider() to return IDirectoryComponentProvider pointer or BootloaderBase::configureComponentProvider() to specify path for the library:

*   IComponentProvider *MyBootloader::createComponentProvider()
*   {
*       return new DirectoryComponentProvider("plugins/");
*   }
*   void MyBootloader::configureComponentProvider()
*   {
*       static_cast<IDirectoryComponentProvider *>(m_componentProvider)->setPath("plugins/");
*   }
* 

During boot loading sequence IDirectoryComponentProvider will find all component definitions in the plugins/ directory and instantiate proxy components for them, which creates real components by demand.

Note: it does not take ownership neither for proxy components that will be discovered in libraries nor for components registered by registerComponent().