fsCButtonComponent Class Reference

#include <fsCButtonComponent.h>

Inheritance diagram for fsCButtonComponent:

Classes
struct	sButtonEventMsgParam

Public Member Functions
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)
Public Member Functions inherited from fsIGestureHandlingComponent
fsBool	hitTest (const fsPoint &pPos) const
Public Member Functions inherited from fsIMessageListenerComponent
	fsIMessageListenerComponent (fsCEntity *pParent)
	fsIMessageListenerComponent (fsCEntity *pParent, fsS32 pPriority)
virtual	~fsIMessageListenerComponent ()
Public Member Functions inherited from fsIComponent
template<typename TInterface>
std::vector< fsCEntity * >	appSceneEntitiesWithComponentOfFamilyType () const
template<typename TInterface>
fsCEntity *	appSceneFirstEntityWithComponentOfFamilyType () const
fsCEntity *	appSceneEntityNamed (const fsStr &pName) const
void	reset ()
void	update (fsS32 pDeltaMs)
void	render ()
void	matrixApply ()
void	postLoad ()
void	deserialise ()
void	serialise ()
void	initialiseFromVariableTable (const fsCVariableTable &pVars)
void	initialise ()
void	finalise ()
fsCEntity *	parentGet () const
fsCEntity *	grandparentGet () const
Public Member Functions inherited from fsIMessageListener
void	listenersRegister ()
void	listenersDeregister ()
void	prioritySet (fsS32 pPriority)
fsBool	messageProcess (const fsCUniqueId &pMessageType, const fsIMessageDispatcher::sMessageParameters &pParam)
void	inputSteal ()

Static Public Attributes
static const fsCUniqueId	mTypeId

Protected Member Functions
void	defaultSpriteSet ()
fsBool	acceptingInputGet () const override
fsBool	highlightSetDo () override
void	onTap (const fsPoint &pTapPos) override
void	initialiseFromVariableTableDo (const fsCVariableTable &pVars) override
	fsCButtonComponent (fsCEntity *pParent)
virtual	~fsCButtonComponent ()
Protected Member Functions inherited from fsIGestureHandlingComponent
virtual void	stolenInputDo ()
void	gestureTypesSet (fsBool pHandleTaps, fsBool pHandleDragEvent, fsBool pHandlePinchEvents)
fsBool	messageProcessDo (const fsCUniqueId &pMessageType, const fsIMessageDispatcher::sMessageParameters &pParam) override
void	listenersRegisterDo () override
void	listenersDeregisterDo () override
void	gestureReset ()
	fsIGestureHandlingComponent (fsCEntity *pParent, fsBool pHandleTaps, fsBool pHandleDragEvent, fsBool pHandlePinchEvents)
virtual	~fsIGestureHandlingComponent ()
Protected Member Functions inherited from fsIComponent
virtual void	resetDo ()
virtual void	updateDo (fsS32 pDeltaMs)
virtual void	renderDo ()
virtual void	matrixApplyDo ()
virtual void	postLoadDo ()
virtual void	deserialiseDo ()
virtual void	serialiseDo ()
virtual void	initialiseDo ()
virtual void	finaliseDo ()
virtual	~fsIComponent ()
	fsIComponent (fsCEntity *pParent)
Protected Member Functions inherited from fsIMessageListener
virtual void	inputStealDo ()
	fsIMessageListener (fsS32 pPriority)
virtual	~fsIMessageListener ()

Static Protected Member Functions
static fsIComponent *	create (fsCEntity *pParent)

Protected Attributes
fsPoint	mSize
std::shared_ptr< fsCBrush >	mBrush
std::shared_ptr< fsCBrush >	mOverBrush
fsCUniqueId	mActionId
sButtonEventMsgParam	mActionParam
Protected Attributes inherited from fsIGestureHandlingComponent
std::vector< sGesturePoint >	mGesturePoints
fsS32	mGestureState
fsS32	mNumPointsDown
fsBool	mHighlighted
Protected Attributes inherited from fsIMessageListener
fsS32	mPriority

Friends
class	fsCComponentFactory
class	gfIAutoTestLevelUserInputComponent

Additional Inherited Members
Public Types inherited from fsIMessageListener
enum	{   ePRIORITY_NORMAL = 0 , ePRIORITY_DEBUG_WINDOW , ePRIORITY_SOFTWARE_CURSOR , ePRIORITY_TEXT_ENTRY ,   ePRIORITY_DEBUG_MODAL , ePRIORITY_DEBUG_MODAL_BUTTON }
Static Public Member Functions inherited from fsIMessageListener
static fsBool	lessThan (const fsIMessageListener *pLHS, const fsIMessageListener *pRHS)
Protected Types inherited from fsIGestureHandlingComponent
enum	{   eSTATE_NOT_IN_GESTURE = 0 , eSTATE_MOUSE_OVER , eSTATE_EVALUATING_GESTURE_TYPE , eSTATE_IN_TAP_GESTURE ,   eSTATE_IN_DRAG_GESTURE , eSTATE_IN_PINCH_GESTURE , eSTATE_WAITING_FOR_ALL_POINTS_TO_RELEASE }

Constructor & Destructor Documentation

fsCButtonComponent()

fsCButtonComponent::fsCButtonComponent ( fsCEntity * pParent )

protected

~fsCButtonComponent()

fsCButtonComponent::~fsCButtonComponent ( )

protectedvirtual

Member Function Documentation

acceptingInputGet()

fsBool fsCButtonComponent::acceptingInputGet ( ) const

overrideprotectedvirtual

Implements fsIGestureHandlingComponent.

actionSet()

void fsCButtonComponent::actionSet	(	const fsCUniqueId &	pActionId,
		const fsStr &	pParamStr )

brushesReplace()

void fsCButtonComponent::brushesReplace	(	const fsCResourceName &	pImageFileName,
		const fsCResourceName &	pDownImageFileName,
		const fsPoint &	pSize )

buttonGuiEntityCreate()

fsCEntity * fsCButtonComponent::buttonGuiEntityCreate	(	const fsStr &	pEntityName,
		const fsCResourceName &	pImageFileName,
		const fsCResourceName &	pDownImageFileName )

create()

fsIComponent * fsCButtonComponent::create ( fsCEntity * pParent )

staticprotected

defaultSpriteSet()

void fsCButtonComponent::defaultSpriteSet ( )

protected

highlightSetDo()

fsBool fsCButtonComponent::highlightSetDo ( )

overrideprotectedvirtual

Reimplemented from fsIGestureHandlingComponent.

Reimplemented in fsCCheatButtonComponent, and gfCCommodityButtonComponent.

initialiseFromVariableTableDo()

void fsCButtonComponent::initialiseFromVariableTableDo ( const fsCVariableTable & pVars )

overrideprotectedvirtual

Reimplemented from fsIComponent.

Reimplemented in fsCCheatButtonComponent, gfCAutoMinigameButtonComponent, and gfCCommodityButtonComponent.

onTap()

void fsCButtonComponent::onTap ( const fsPoint & pTapPos )

overrideprotectedvirtual

Reimplemented from fsIGestureHandlingComponent.

Reimplemented in gfCAutoMinigameButtonComponent, and gfCCommodityButtonComponent.

textButtonGuiEntityCreate()

fsCEntity * fsCButtonComponent::textButtonGuiEntityCreate	(	const fsStr &	pEntityName,
		const fsCResourceName &	pImageFileName,
		const fsCResourceName &	pDownImageFileName,
		const fsStr &	pText,
		fsIFont *	pFont )

Friends And Related Symbol Documentation

fsCComponentFactory

friend class fsCComponentFactory

friend

gfIAutoTestLevelUserInputComponent

friend class gfIAutoTestLevelUserInputComponent

friend

Member Data Documentation

mActionId

fsCUniqueId fsCButtonComponent::mActionId

protected

mActionParam

sButtonEventMsgParam fsCButtonComponent::mActionParam

protected

mBrush

std::shared_ptr<fsCBrush> fsCButtonComponent::mBrush

protected

mOverBrush

std::shared_ptr<fsCBrush> fsCButtonComponent::mOverBrush

protected

mSize

fsPoint fsCButtonComponent::mSize

protected

mTypeId

const fsCUniqueId fsCButtonComponent::mTypeId

static

---

The documentation for this class was generated from the following files:

• /home/runner/work/fission/fission/libs/fsAppCore/src/components/gui/elements/fsCButtonComponent.h
• /home/runner/work/fission/fission/libs/fsAppCore/src/components/gui/elements/fsCButtonComponent.cpp