gfICatalogueGui Class Reference

#include <gfICatalogueGui.h>

Inheritance diagram for gfICatalogueGui:

Public Member Functions
	gfICatalogueGui (fsCEntity *pParent)
virtual	~gfICatalogueGui ()
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
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 ()

Protected Member Functions
void	pageScrollToContainingItem (fsS32 pItemIndex)
void	itemInfoSet (fsS32 pEntIndex, fsS32 pChildIndex) const
virtual void	onIconSelection (fsS32 pIconIndex)
virtual void	onScrollSelection (fsS32 pDirection)
virtual void	buttonsRefresh ()
virtual void	catalogueLoadDo ()
virtual void	itemSelect (const gfICatalogueEntry *shopItem)
virtual void	itemInfoSetDo (fsS32 pEntIndex, fsS32 pChildIndex) const
fsBool	onButtonClicked (fsCButtonComponent *pButtonComp) override
void	listenersRegisterDo () override
void	listenersDeregisterDo () override
fsBool	messageProcessDo (const fsCUniqueId &pMessageType, const fsIMessageDispatcher::sMessageParameters &pParam) override
void	initialiseFromVariableTableDo (const fsCVariableTable &pVars) override
Protected Member Functions inherited from fsIMessageListenerGuiComponent
	fsIMessageListenerGuiComponent (fsCEntity *pParent, fsS32 pPriority)
	fsIMessageListenerGuiComponent (fsCEntity *pParent)
virtual	~fsIMessageListenerGuiComponent ()
Protected Member Functions inherited from fsIGuiComponent
void	layoutFileProcess ()
	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 fsS32	buttonIndexGet (fsStr pButtonName)
static fsStr	buttonNameGet (fsS32 pIndex)
static fsStr	infoStrGet (const fsStr &pKey)

Protected Attributes
fsS32	mScrollPos
fsS32	mMaxNumButtons
gfCCatalogueCatalogue *	mCatalogue
const gfICatalogueEntry *	mCurrentCategory
fsStr	mItemButtonFileName
fsStr	mCatalogueFileName
Protected Attributes inherited from fsIMessageListener
fsS32	mPriority

Static Protected Attributes
static const fsStr	mButtonNameTemplate = "itemButton"

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

gfICatalogueGui()

gfICatalogueGui::gfICatalogueGui

(

fsCEntity *

pParent

)

~gfICatalogueGui()

gfICatalogueGui::~gfICatalogueGui ( )

virtual

Member Function Documentation

buttonIndexGet()

fsS32 gfICatalogueGui::buttonIndexGet ( fsStr pButtonName )

staticprotected

buttonNameGet()

fsStr gfICatalogueGui::buttonNameGet ( fsS32 pIndex )

staticprotected

buttonsRefresh()

void gfICatalogueGui::buttonsRefresh ( )

protectedvirtual

Reimplemented in gfCDiaryGui, and gfCParkCatalogueGui.

catalogueLoadDo()

virtual void gfICatalogueGui::catalogueLoadDo ( )

inlineprotectedvirtual

Reimplemented in gfCDiaryGui, gfCInGameShopGui, gfCMiniGameGui, gfCMoreGamesGui, gfCParkCatalogueGui, gfCTuneGui, and gfCWallpaperGui.

infoStrGet()

fsStr gfICatalogueGui::infoStrGet ( const fsStr & pKey )

staticprotected

initialiseFromVariableTableDo()

void gfICatalogueGui::initialiseFromVariableTableDo ( const fsCVariableTable & pVars )

overrideprotectedvirtual

Reimplemented from fsIGuiComponent.

itemInfoSet()

void gfICatalogueGui::itemInfoSet ( fsS32 pEntIndex, fsS32 pChildIndex ) const

protected

itemInfoSetDo()

virtual void gfICatalogueGui::itemInfoSetDo ( fsS32 pEntIndex, fsS32 pChildIndex ) const

inlineprotectedvirtual

Reimplemented in gfCDiaryGui, gfCInGameShopGui, gfCMiniGameGui, gfCMoreGamesGui, gfCParkCatalogueGui, gfCTuneGui, and gfCWallpaperGui.

itemSelect()

void gfICatalogueGui::itemSelect ( const gfICatalogueEntry * shopItem )

protectedvirtual

Reimplemented in gfCInGameShopGui, gfCParkCatalogueGui, and gfCWallpaperGui.

listenersDeregisterDo()

void gfICatalogueGui::listenersDeregisterDo ( )

overrideprotectedvirtual

Implements fsIMessageListener.

listenersRegisterDo()

void gfICatalogueGui::listenersRegisterDo ( )

overrideprotectedvirtual

Implements fsIMessageListener.

messageProcessDo()

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

overrideprotectedvirtual

Implements fsIMessageListener.

onButtonClicked()

fsBool gfICatalogueGui::onButtonClicked ( fsCButtonComponent * pButtonComp )

overrideprotectedvirtual

Reimplemented from fsIGuiComponent.

onIconSelection()

void gfICatalogueGui::onIconSelection ( fsS32 pIconIndex )

protectedvirtual

Reimplemented in gfCDiaryGui.

onScrollSelection()

void gfICatalogueGui::onScrollSelection ( fsS32 pDirection )

protectedvirtual

Reimplemented in gfCDiaryGui, and gfCParkCatalogueGui.

pageScrollToContainingItem()

void gfICatalogueGui::pageScrollToContainingItem ( fsS32 pItemIndex )

protected

Member Data Documentation

mButtonNameTemplate

const fsStr gfICatalogueGui::mButtonNameTemplate = "itemButton"

staticprotected

mCatalogue

gfCCatalogueCatalogue* gfICatalogueGui::mCatalogue

protected

mCatalogueFileName

fsStr gfICatalogueGui::mCatalogueFileName

protected

mCurrentCategory

const gfICatalogueEntry* gfICatalogueGui::mCurrentCategory

protected

mItemButtonFileName

fsStr gfICatalogueGui::mItemButtonFileName

protected

mMaxNumButtons

fsS32 gfICatalogueGui::mMaxNumButtons

protected

mScrollPos

fsS32 gfICatalogueGui::mScrollPos

protected

---

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

• /home/runner/work/fission/fission/gameModules/gfCatalogue/src/gfICatalogueGui.h
• /home/runner/work/fission/fission/gameModules/gfCatalogue/src/gfICatalogueGui.cpp