fsCButtonComponent.h

Go to the documentation of this file.

/********************************************************************
*
*       Created:        17/3/2014   11:05
*
*       File:           fsCButtonComponent.h
*
*       Author:         Mick Waites
*       
*       Purpose:        Control component for a GUI button entity.
*
*********************************************************************/
 
#ifndef fsCButtonComponenthdr
#define fsCButtonComponenthdr
 
#include <fsCore/src/fsCUniqueId.h>
 
#include "../../fsIGestureHandlingComponent.h"
 
struct fsPoint;
class fsCResourceName;
class fsIFont;
class fsCBrush;
 
class fsCButtonComponent : public fsIGestureHandlingComponent
{
        friend class fsCComponentFactory;
        friend class gfIAutoTestLevelUserInputComponent;
 
public:
 
        struct sButtonEventMsgParam : public fsIMessageDispatcher::sMessageParameters
        {
                fsStr mStr;
                fsCButtonComponent* mParent;
        };
 
        void brushesReplace(const fsCResourceName& pImageFileName, const fsCResourceName& pDownImageFileName,
                            const fsPoint& pSize);
 
        void actionSet(const fsCUniqueId& pActionId, const fsStr& pParamStr);
 
        fsCEntity* buttonGuiEntityCreate(const fsStr& pEntityName, const fsCResourceName& pImageFileName,
                                         const fsCResourceName& pDownImageFileName);
        fsCEntity* textButtonGuiEntityCreate(const fsStr& pEntityName, const fsCResourceName& pImageFileName,
                                             const fsCResourceName& pDownImageFileName, const fsStr& pText, fsIFont* pFont);
 
        static const fsCUniqueId mTypeId;
 
protected:
 
        void defaultSpriteSet();
 
        fsBool acceptingInputGet() const override;
        fsBool highlightSetDo() override;
 
        void onTap(const fsPoint& pTapPos) override;
 
        static fsIComponent* create(fsCEntity* pParent);
 
        void initialiseFromVariableTableDo(const fsCVariableTable& pVars) override;
 
        fsCButtonComponent(fsCEntity* pParent);
        virtual ~fsCButtonComponent();
 
        fsPoint mSize;
        std::shared_ptr<fsCBrush> mBrush;
        std::shared_ptr<fsCBrush> mOverBrush;
 
        fsCUniqueId mActionId;
        sButtonEventMsgParam mActionParam;
 
private:
 
        static const fsCUniqueId mActionUnsetId;
 
        void spriteInitialise(const fsCVariableTable& pVars);
        void actionInitialise(const fsCVariableTable& pVars);
        void textCreateIfWanted(const fsCVariableTable& pVars) const;
 
        void actionPerform();
};
 
#endif