gfCDiaryGui Class Reference

#include <gfCDiaryGui.h>

Inheritance diagram for gfCDiaryGui:

Static Public Attributes
static const fsCUniqueId	mTypeId

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

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 }
Public Member Functions inherited from gfICatalogueGui
	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 ()
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)
Protected Attributes inherited from gfICatalogueGui
fsS32	mScrollPos
fsS32	mMaxNumButtons
gfCCatalogueCatalogue *	mCatalogue
const gfICatalogueEntry *	mCurrentCategory
fsStr	mItemButtonFileName
fsStr	mCatalogueFileName
Protected Attributes inherited from fsIMessageListener
fsS32	mPriority
Static Protected Attributes inherited from gfICatalogueGui
static const fsStr	mButtonNameTemplate = "itemButton"

Constructor & Destructor Documentation

gfCDiaryGui()

gfCDiaryGui::gfCDiaryGui ( fsCEntity * pParent )

protected

~gfCDiaryGui()

gfCDiaryGui::~gfCDiaryGui ( )

protectedvirtual

Member Function Documentation

buttonsRefresh()

void gfCDiaryGui::buttonsRefresh ( )

overrideprotectedvirtual

Reimplemented from gfICatalogueGui.

catalogueLoadDo()

void gfCDiaryGui::catalogueLoadDo ( )

overrideprotectedvirtual

Reimplemented from gfICatalogueGui.

create()

fsIComponent * gfCDiaryGui::create ( fsCEntity * pParent )

staticprotected

initialiseFromVariableTableDo()

void gfCDiaryGui::initialiseFromVariableTableDo ( const fsCVariableTable & pVars )

overrideprotectedvirtual

Reimplemented from fsIGuiComponent.

itemInfoSetDo()

void gfCDiaryGui::itemInfoSetDo ( fsS32 pEntIndex, fsS32 pChildIndex ) const

overrideprotectedvirtual

Reimplemented from gfICatalogueGui.

listenersDeregisterDo()

void gfCDiaryGui::listenersDeregisterDo ( )

overrideprotectedvirtual

Implements fsIMessageListener.

listenersRegisterDo()

void gfCDiaryGui::listenersRegisterDo ( )

overrideprotectedvirtual

Implements fsIMessageListener.

messageProcessDo()

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

overrideprotectedvirtual

Implements fsIMessageListener.

onButtonClicked()

fsBool gfCDiaryGui::onButtonClicked ( fsCButtonComponent * pButtonComp )

protectedvirtual

Reimplemented from fsIGuiComponent.

onIconSelection()

void gfCDiaryGui::onIconSelection ( fsS32 pIconIndex )

overrideprotectedvirtual

Reimplemented from gfICatalogueGui.

onScrollSelection()

void gfCDiaryGui::onScrollSelection ( fsS32 pDirection )

overrideprotectedvirtual

Reimplemented from gfICatalogueGui.

renderDo()

void gfCDiaryGui::renderDo ( )

overrideprotectedvirtual

Reimplemented from fsIComponent.

Friends And Related Symbol Documentation

fsCComponentFactory

friend class fsCComponentFactory

friend

Member Data Documentation

mTypeId

const fsCUniqueId gfCDiaryGui::mTypeId

static

---

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

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