class CCL::ComponentFactory

Overview

Light-weight factory for internal component classes. More…

#include <componentfactory.h>

class ComponentFactory:
    public CCL::Object,
    public CCL::Singleton
{
public:
    // typedefs

    typedef Component*  (*CreateFunc)(
        StringID name,
        Component *owner,
        Object *arg
        );

    typedef void  (*ExtendFunc)(Component *component);

    // classes

    class ComponentClass;
    class FunctionExtender;
    class NullConstructor;

    // methods

    void registerComponentClass (StringID name, CreateFunc createFunc);
    void registerComponentClass (CreateFunc createFunc);
    bool unregisterComponentClass (StringID name);
    void hideComponentClass (StringID name);
    bool isHiddenClass (StringID name) const;
    bool isClassRegistered (StringID name) const;

    Component* createComponent (
        StringID name,
        Component* owner = nullptr,
        Object* arg = nullptr
    );

    template  <class T>
    T* createComponent (
        StringID name,
        Component* owner = nullptr,
        Object* arg = nullptr
    );

    void addExtender (IComponentExtender* extender, bool owns = false);
    void addExtendFunction (ExtendFunc extendFunc);
    void removeExtender (IComponentExtender* extender);
    void extendComponent (Component* component);
};

Inherited Members

public:
    // typedefs

    typedef CStringRef MemberID;

    // methods

    virtual tresult CCL_API queryInterface (UIDRef iid, void** ptr) = 0;
    virtual unsigned int CCL_API retain () = 0;
    virtual unsigned int CCL_API release () = 0;
    Unknown& operator = (const Unknown&);
    unsigned int getRetainCount () const;
    virtual Object*CCL_API revealObject (const void* moduleAddress) = 0;
    virtual void CCL_API addObserver (IObserver* observer) = 0;
    virtual void CCL_API removeObserver (IObserver* observer) = 0;
    virtual void CCL_API signal (MessageRef msg) = 0;
    virtual void CCL_API deferSignal (IMessage* msg) = 0;
    static ISubject void addObserver (IUnknown* unknown, IObserver* observer);
    static void removeObserver (IUnknown* unknown, IObserver* observer);
    virtual void CCL_API notify (ISubject* subject, MessageRef msg) = 0;

    static IObserver void notify (
        IUnknown* unknown,
        ISubject* subject,
        MessageRef msg
    );

    virtual const ITypeInfo&CCL_API getTypeInfo () const = 0;
    virtual tbool CCL_API getProperty (Variant& var, MemberID propertyId) const = 0;
    virtual tbool CCL_API setProperty (MemberID propertyId, const Variant& var) = 0;
    virtual tbool CCL_API getPropertyNames (IPropertyCollector& collector) const = 0;
    virtual tbool CCL_API invokeMethod (Variant& returnValue, MessageRef msg) = 0;
    DECLARE_BASE_CLASS (Object);
    virtual void CCL_API removeObserver (IObserver* observer);
    virtual void CCL_API signal (MessageRef msg);
    virtual void CCL_API deferSignal (IMessage* msg);
    virtual void deferChanged ();
    virtual void CCL_API notify (ISubject* subject, MessageRef msg);
    virtual bool equals (const Object& obj) const;
    virtual int compare (const Object& obj) const;
    virtual bool load (const Storage& storage);
    virtual bool save (const Storage& storage) const;
    virtual bool save (const OutputStorage& storage) const;
    virtual bool toString (String& string, int flags = 0) const;
    virtual int getHashCode (int size) const;
    IUnknown* asUnknown ();
    static void addGarbageCollected (Object* obj, bool globalScope = true);
    static void deferDestruction (Object* obj);
    static const void* getModuleAddress ();
    static T& instance ();
    static T* peekInstance ();
    static Object* __createSingleton ();

Detailed Documentation

Light-weight factory for internal component classes.

Typedefs

typedef Component*  (*CreateFunc)(
    StringID name,
    Component *owner,
    Object *arg
    )

Component creation function.

typedef void  (*ExtendFunc)(Component *component)

Component extension function.

Methods

void registerComponentClass (StringID name, CreateFunc createFunc)

Register component class.

void registerComponentClass (CreateFunc createFunc)

Register component class (w/o name).

bool unregisterComponentClass (StringID name)

Unregister component class.

void hideComponentClass (StringID name)

Hide component class, i.e.

register with null constructor.

bool isClassRegistered (StringID name) const

Check if class is registered.

Component* createComponent (
    StringID name,
    Component* owner = nullptr,
    Object* arg = nullptr
)

Create component instance.

template  <class T>
T* createComponent (
    StringID name,
    Component* owner = nullptr,
    Object* arg = nullptr
)

Create component instance (template).

void addExtender (IComponentExtender* extender, bool owns = false)

Add component extender.

void addExtendFunction (ExtendFunc extendFunc)

Add component extension function.

void removeExtender (IComponentExtender* extender)

Remove component extender.

void extendComponent (Component* component)

Extend component.