GUIFactory.h

/*
* Copyright (C) TES Electronic Solutions GmbH,
* All Rights Reserved.
* Contact: info@guiliani.de
*
* This file is part of the Guiliani HMI framework
* for the development of graphical user interfaces on embedded systems.
*/
 
#ifndef GUIFACTORY__H_
#define GUIFACTORY__H_
 
#include "GUIBehaviourResource.h"
#include "GUICommandResource.h"
#include "GUIControlResource.h"
#include "GUILayouterResource.h"
#include "GUITextTypeResource.h"
#include "GUIAnimationTypeResource.h"
#include "RefCounted.h"
#include "SharedPtr.h"
 
class CGUIObject;
typedef CGUIObject* (*ControlCreateCallback)();
 
class CGUILayouter;
typedef CGUILayouter* (*LayouterCreateCallback)();
 
class CGUIBehaviourDecorator;
typedef CGUIBehaviourDecorator* (*BehaviourCreateCallback)();
 
class CGUICommand;
typedef CGUICommand* (*CommandCreateCallback)();
 
class CGUIText;
typedef CGUIText* (*TextCreateCallback)();
 
#ifdef GUILIANI_ANIMATION_ACTIVE
class CGUIAnimation;
typedef CGUIAnimation* (*AnimationCreateCallback)();
#endif
 
class CGUIFactory;
typedef NSmartPtr::SharedPtr<CGUIFactory> CGUIFactorySmartPtr;
 
struct ControlDescriptor
{
    ControlDescriptor(
        eC_Int iID,
        const char* rkClassName,
        ControlCreateCallback pkCreate) :
        m_iID(iID),
        m_kClassName(rkClassName),
        m_pkCreate(pkCreate)
    {}
 
    ControlDescriptor() :
        m_iID(DUMMY_CONTROL),
        m_kClassName(""),
        m_pkCreate(NULL)
    {}
 
    eC_Int m_iID;
 
    const char* m_kClassName;
 
    ControlCreateCallback m_pkCreate;
};
typedef eC_TArray<ControlDescriptor> ControlVector;
 
struct BehaviourDescriptor
{
    BehaviourDescriptor(
        eC_Int iID,
        const char* rkClassName,
        BehaviourCreateCallback pkCreate) :
        m_iID(iID),
        m_kClassName(rkClassName),
        m_pkCreate(pkCreate)
    {}
 
    BehaviourDescriptor() :
        m_iID(DUMMY_BEHAVIOUR),
        m_kClassName(""),
        m_pkCreate(NULL)
    {}
 
    eC_Int m_iID;
 
    const char* m_kClassName;
 
    BehaviourCreateCallback m_pkCreate;
};
typedef eC_TArray<BehaviourDescriptor> BehaviourVector;
 
struct CommandDescriptor
{
    CommandDescriptor(
        eC_Int iID,
        const char* rkClassName,
        CommandCreateCallback pkCreate) :
        m_iID(iID),
        m_kClassName(rkClassName),
        m_pkCreate(pkCreate)
    {}
 
    CommandDescriptor() :
        m_iID(DUMMY_COMMAND),
        m_kClassName(""),
        m_pkCreate(NULL)
    {}
 
    eC_Int m_iID;
 
    const char* m_kClassName;
 
    CommandCreateCallback m_pkCreate;
};
typedef eC_TArray<CommandDescriptor> CommandVector;
 
struct LayouterDescriptor
{
    LayouterDescriptor(
        eC_Int iID,
        const char* rkClassName,
        LayouterCreateCallback pkCreate) :
        m_iID(iID),
        m_kClassName(rkClassName),
        m_pkCreate(pkCreate)
    {}
 
    LayouterDescriptor() :
        m_iID(DUMMY_LAYOUTER),
        m_kClassName(""),
        m_pkCreate(NULL)
    {}
 
    eC_Int m_iID;
 
    const char* m_kClassName;
 
    LayouterCreateCallback m_pkCreate;
};
typedef eC_TArray<LayouterDescriptor> LayouterVector;
 
struct TextTypeDescriptor
{
    TextTypeDescriptor(
        eC_Int iID,
        const char* rkClassName,
        TextCreateCallback pkCreate) :
        m_iID(iID),
        m_kClassName(rkClassName),
        m_pkCreate(pkCreate)
    {}
 
    TextTypeDescriptor() :
        m_iID(DUMMY_LAYOUTER),
        m_kClassName(""),
        m_pkCreate(NULL)
    {}
 
    eC_Int m_iID;
 
    const char* m_kClassName;
 
    TextCreateCallback m_pkCreate;
};
typedef eC_TArray<TextTypeDescriptor> TextTypeVector;
 
#ifdef GUILIANI_ANIMATION_ACTIVE
struct AnimationDescriptor
{
    AnimationDescriptor(
        eC_Int iID,
        const char* rkClassName,
        AnimationCreateCallback pkCreate) :
        m_iID(iID),
        m_kClassName(rkClassName),
        m_pkCreate(pkCreate)
    {}
 
    AnimationDescriptor() :
        m_iID(DUMMY_LAYOUTER),
        m_kClassName(""),
        m_pkCreate(NULL)
    {}
 
    eC_Int m_iID;
 
    const char* m_kClassName;
 
    AnimationCreateCallback m_pkCreate;
};
typedef eC_TArray<AnimationDescriptor> AnimationVector;
#endif
 
 
class CGUIFactory : public NSmartPtr::RefCounted
{
public:
    void Clear();
 
    eC_Bool RegisterControl(ControlDescriptor desc);
 
    void UnregisterControl(const eC_Int& iID);
 
    void GetControls(ControlVector& rkControls);
 
    eC_Bool RegisterBehaviour(BehaviourDescriptor desc);
 
    void UnregisterBehaviour(const eC_Int& iID);
 
    void GetBehaviours(BehaviourVector& rkBehaviours);
 
    eC_Bool RegisterCommand(CommandDescriptor desc);
 
    void UnregisterCommand(const eC_Int& iID);
 
    void GetCommands(CommandVector& rkCommands);
 
    eC_Bool RegisterLayouter(LayouterDescriptor desc);
 
    void UnregisterLayouter(const eC_Int& iID);
 
    void GetLayouters(LayouterVector& rkLayouters);
 
    eC_Bool RegisterText(TextTypeDescriptor desc);
 
    void UnregisterText(const eC_Int& iID);
 
    void GetTextTypes(TextTypeVector& rkTextTypes);
 
#ifdef GUILIANI_ANIMATION_ACTIVE
    eC_Bool RegisterAnimation(AnimationDescriptor desc);
 
    void UnregisterAnimation(const eC_Int& iID);
 
    void GetAnimations(AnimationVector& rkAnimations);
#endif
 
protected:
    friend class CGUIFactoryManager; 
 
    virtual ~CGUIFactory();
 
    virtual CGUIObject* CreateControl(const ControlClassID_t& eControlID) { return NULL; }
 
    virtual CGUILayouter* CreateLayouter(const LayouterClassID_t& eLayouterID) { return NULL; }
 
    virtual CGUIBehaviourDecorator* CreateBehaviour(const BehaviourClassID_t& eBehaviourID) { return NULL; }
 
    virtual CGUICommand* CreateCommand(const CommandClassID_t& eCommandID) { return NULL; }
 
    virtual CGUIText* CreateText(const TextTypeID_t& eTextType) { return NULL; }
 
#ifdef GUILIANI_ANIMATION_ACTIVE
    virtual CGUIAnimation* CreateAnimation(const AnimationType_t& eAnimation) { return NULL; }
#endif
 
protected:
    // controls
    ControlVector m_kControlVector; 
 
    // behaviours
    BehaviourVector m_kBehaviourVector; 
 
    // commands
    CommandVector m_kCommandVector; 
 
    // layouters
    LayouterVector m_kLayouterVector; 
 
    // texts
    TextTypeVector m_kTextTypeVector; 
 
#ifdef GUILIANI_ANIMATION_ACTIVE
    // animations
    AnimationVector m_kAnimationVector; 
#endif
};
 
#endif