fsCRollOverGui Class Reference

#include <fsCRollOverGui.h>

Inheritance diagram for fsCRollOverGui:

Classes
struct	fsSRollOver

Public Member Functions
void	candidatesDeregister ()
void	candidatesRegister (std::vector< fsSRollOver > &pCandidates)
void	candidateRegister (const fsSRollOver &pCandidate)
void	candidateDeRegister (fsCEntity *pEnt)
void	listenersRegisterDo () override
void	listenersDeregisterDo () override
fsBool	messageProcessDo (const fsCUniqueId &pMessageType, const fsIMessageDispatcher::sMessageParameters &pParam) override
Public Member Functions inherited from fsIGuiComponent
template<typename TComponent>
TComponent *	siblingEntityComponentGet () const
template<typename TComponent>
TComponent *	siblingEntityFamilyComponentGet () const
void	listenerComponentsRegister (fsCEntity *const pRoot) const
void	listenerComponentsDeRegister (fsCEntity *const pRoot) const
virtual fsBool	onButtonClicked (fsCButtonComponent *pButtonComp)
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
static const fsCUniqueId	mDeactivateMsg

Protected Member Functions
void	initialiseFromVariableTableDo (const fsCVariableTable &pVars) override
	fsCRollOverGui (fsCEntity *pParent)
virtual	~fsCRollOverGui ()
void	posSet (const fsPoint &pMousePos, fsCEntity *pEnt)
void	textSet (const fsSRollOver &pRollOver)
fsBool	newTarget (const fsSRollOver &pRollOver) const
virtual void	rollOverCandidatesCheck (const fsPoint &pPos)
Protected Member Functions inherited from fsIMessageListenerGuiComponent
	fsIMessageListenerGuiComponent (fsCEntity *pParent, fsS32 pPriority)
	fsIMessageListenerGuiComponent (fsCEntity *pParent)
virtual	~fsIMessageListenerGuiComponent ()
Protected Member Functions inherited from fsIGuiComponent
void	layoutFileProcess ()
void	initialiseFromVariableTableDo (const fsCVariableTable &pVars) override
	fsIGuiComponent (fsCEntity *pParent)
virtual	~fsIGuiComponent ()
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
std::vector< fsSRollOver >	mRollOvers
Protected Attributes inherited from fsIMessageListener
fsS32	mPriority

Friends
class	fsCComponentFactory

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 fsIGuiComponent
static void	flush ()
static fsCEntity *	guiCreateFromCommands (fsStr &pCommands, fsCEntity *pParent=nullptr, fsBool pModal=true, fsBool pNewGrammarMode=false)
static fsCEntity *	guiCreateFromFile (const fsCResourceName &pGuiLayoutFileName, fsCEntity *pParent=nullptr, fsBool pModal=true)
static fsCGuiParseTree	parseToTree (fsStr &pCommands, fsBool pNewGrammarMode=false)
static fsCEntity *	constructFromTree (const fsCGuiParseTree &pTree, fsCEntity *pParent=nullptr, fsBool pModal=true)
static fsBool	newGrammarFileNameResolve (const fsStr &pLegacyFileName, fsStr &pOutResolvedFileName)
static fsIGuiComponent *	guiParentGetFromComponent (const fsIComponent *pComponent)
static fsBool	entityHasGuiComponentGet (const fsINode *pNode)
Static Public Member Functions inherited from fsIMessageListener
static fsBool	lessThan (const fsIMessageListener *pLHS, const fsIMessageListener *pRHS)

Constructor & Destructor Documentation

fsCRollOverGui()

fsCRollOverGui::fsCRollOverGui ( fsCEntity * pParent )

protected

~fsCRollOverGui()

fsCRollOverGui::~fsCRollOverGui ( )

protectedvirtual

Member Function Documentation

candidateDeRegister()

void fsCRollOverGui::candidateDeRegister

(

fsCEntity *

pEnt

)

candidateRegister()

void fsCRollOverGui::candidateRegister

(

const fsSRollOver &

pCandidate

)

candidatesDeregister()

void fsCRollOverGui::candidatesDeregister

(

)

candidatesRegister()

void fsCRollOverGui::candidatesRegister

(

std::vector< fsSRollOver > &

pCandidates

)

create()

fsIComponent * fsCRollOverGui::create ( fsCEntity * pParent )

staticprotected

initialiseFromVariableTableDo()

void fsCRollOverGui::initialiseFromVariableTableDo ( const fsCVariableTable & pVars )

overrideprotectedvirtual

Reimplemented from fsIComponent.

listenersDeregisterDo()

void fsCRollOverGui::listenersDeregisterDo ( )

overridevirtual

Implements fsIMessageListener.

listenersRegisterDo()

void fsCRollOverGui::listenersRegisterDo ( )

overridevirtual

Implements fsIMessageListener.

messageProcessDo()

fsBool fsCRollOverGui::messageProcessDo ( const fsCUniqueId & pMessageType, const fsIMessageDispatcher::sMessageParameters & pParam )

overridevirtual

Implements fsIMessageListener.

newTarget()

fsBool fsCRollOverGui::newTarget ( const fsSRollOver & pRollOver ) const

protected

posSet()

void fsCRollOverGui::posSet ( const fsPoint & pMousePos, fsCEntity * pEnt )

protected

rollOverCandidatesCheck()

void fsCRollOverGui::rollOverCandidatesCheck ( const fsPoint & pPos )

protectedvirtual

textSet()

void fsCRollOverGui::textSet ( const fsSRollOver & pRollOver )

protected

Friends And Related Symbol Documentation

fsCComponentFactory

friend class fsCComponentFactory

friend

Member Data Documentation

mDeactivateMsg

const fsCUniqueId fsCRollOverGui::mDeactivateMsg

static

mRollOvers

std::vector<fsSRollOver> fsCRollOverGui::mRollOvers

protected

mTypeId

const fsCUniqueId fsCRollOverGui::mTypeId

static

---

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

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