Carousel
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Pages
Public Member Functions | List of all members
IComponentProvider Class Referenceabstract

This is the expected provider definition for the boot loading sequence. More...

#include <IComponentProvider.h>

Inherits QObject.

Inherited by ComponentProvider, CompositeComponentProvider, and IDirectoryComponentProvider.

Public Member Functions

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)
 
QObjectchild (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< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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 QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () 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)
 
QThreadthread () 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
 
QObjectsender () 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

This is the expected provider definition for the boot loading sequence.

The IComponentProvider defines the contract that CarouselBootloader uses for adding registered and/or discovered components to the IComponentManager.

At your application you can override BootloaderBase::createComponentProvider() method to instantiate your own component provider (e.g. DirectoryComponentProvider, that can discovering components in the file system).

You also might to override BootloaderBase::configureComponentProvider() to add compile-time-known components statically in code using registerComponent() method.

Member Function Documentation

virtual QList<IComponent *> IComponentProvider::components ( ) const
pure virtual

Gets the all components registered at the provider.

Implemented in DirectoryComponentProvider, CompositeComponentProvider, and ComponentProvider.

virtual bool IComponentProvider::initialize ( )
pure virtual

Initializes the provider, which may load and validate the components. Returns true, if initialization was succesful; otherwise, returns false.

Implemented in DirectoryComponentProvider, CompositeComponentProvider, and ComponentProvider.

virtual bool IComponentProvider::isInitialized ( ) const
pure virtual

Returns true, if provider alreadyinitialzied; otherwise, returns false.

Implemented in DirectoryComponentProvider, CompositeComponentProvider, and ComponentProvider.

virtual void IComponentProvider::registerComponent ( IComponent component)
pure virtual

Registers the specified component at the provider. Usually, you can register the same components or components with same names using existing providers, but when components will be pushed to the IComponentManager from the providers - the last one doesn't allow duplicating components. Null pointers will be skipped.

Implemented in DirectoryComponentProvider, CompositeComponentProvider, and ComponentProvider.