pfGUIDialogMod Class Reference

#include <pfGUIDialogMod.h>

Inheritance diagram for pfGUIDialogMod:

Public Types
enum	Flags { kModal, kDerivedFlagsStart }

Public Member Functions
	pfGUIDialogMod ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
const std::vector< plKey > &	getControls () const
std::vector< plKey > &	getControls ()
void	addControl (plKey ctrl)
void	delControl (size_t idx)
void	clearControls ()
unsigned int	getTagID () const
unsigned int	getVersion () const
plKey	getRenderMod () const
plString	getName () const
plKey	getProcReceiver () const
plKey	getSceneNode () const
void	setTagID (unsigned int id)
void	setVersion (unsigned int version)
void	setRenderMod (plKey mod)
void	setName (const char *name)
void	setProcReceiver (plKey receiver)
void	setSceneNode (plKey node)
const pfGUIColorScheme &	getColorScheme () const
pfGUIColorScheme &	getColorScheme ()
Public Member Functions inherited from plSingleModifier
bool	getFlag (size_t flag) const
void	setFlag (size_t flag, bool value)
virtual size_t	getTargetsCount () const
virtual plKey	getTarget (size_t) const
virtual void	addTarget (plKey target)
virtual void	removeTarget (plKey)

Protected Member Functions
virtual void	IPrcWrite (pfPrcHelper *prc)
virtual void	IPrcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Attributes
unsigned int	fTagID
unsigned int	fVersion
plKey	fRenderMod
char	fName [128]
std::vector< plKey >	fControls
pfGUIColorScheme	fColorScheme
plKey	fProcReceiver
plKey	fSceneNode
Protected Attributes inherited from plSingleModifier
hsBitVector	fFlags
plKey	fTarget

Member Enumeration Documentation

enum pfGUIDialogMod::Flags

Enumerator:

kModal
kDerivedFlagsStart

Constructor & Destructor Documentation

pfGUIDialogMod::pfGUIDialogMod

(

)

Member Function Documentation

void pfGUIDialogMod::addControl

(

plKey

ctrl

)

void pfGUIDialogMod::clearControls

(

)

void pfGUIDialogMod::delControl

(

size_t

idx

)

const pfGUIColorScheme& pfGUIDialogMod::getColorScheme

(

)

const

pfGUIColorScheme& pfGUIDialogMod::getColorScheme

(

)

const std::vector<plKey>& pfGUIDialogMod::getControls

(

)

const

std::vector<plKey>& pfGUIDialogMod::getControls

(

)

plString pfGUIDialogMod::getName

(

)

const

plKey pfGUIDialogMod::getProcReceiver

(

)

const

plKey pfGUIDialogMod::getRenderMod

(

)

const

plKey pfGUIDialogMod::getSceneNode

(

)

const

unsigned int pfGUIDialogMod::getTagID

(

)

const

unsigned int pfGUIDialogMod::getVersion

(

)

const

virtual void pfGUIDialogMod::IPrcParse ( const pfPrcTag *  tag, plResManager *  mgr  )

protectedvirtual

This must be overloaded by subclasses to parse PRC data specific to the class from the PRC document. It is called once for each tag that is a child to the Creatable tag itself, so subclasses should check for each supported tag and handle it accordingly if it matches. If the tag is not recognized, it should be passed along to the parent class.

Reimplemented from plSingleModifier.

Reimplemented in pfGUIPopUpMenu.

virtual void pfGUIDialogMod::IPrcWrite ( pfPrcHelper *  prc )

protectedvirtual

This must be overloaded by subclasses to write PRC data specific to the class to the PRC document. Do not write the top-level creatable tag, that is handled by prcWrite().

Reimplemented from plSingleModifier.

Reimplemented in pfGUIPopUpMenu.

virtual void pfGUIDialogMod::read ( hsStream *  , plResManager *    )

virtual

Reads this creatable directly from the stream. If any keys are read, they will be added to the plResManager automatically.

Reimplemented from plSingleModifier.

Reimplemented in pfGUIPopUpMenu.

void pfGUIDialogMod::setName

(

const char *

name

)

void pfGUIDialogMod::setProcReceiver

(

plKey

receiver

)

void pfGUIDialogMod::setRenderMod

(

plKey

mod

)

void pfGUIDialogMod::setSceneNode

(

plKey

node

)

void pfGUIDialogMod::setTagID

(

unsigned int

id

)

void pfGUIDialogMod::setVersion

(

unsigned int

version

)

virtual void pfGUIDialogMod::write ( hsStream *  , plResManager *    )

virtual

Writes this creatable directly to the stream. The plResManager is used to manage any key references written by this creatable.

Reimplemented from plSingleModifier.

Reimplemented in pfGUIPopUpMenu.

Member Data Documentation

pfGUIColorScheme pfGUIDialogMod::fColorScheme

protected

std::vector<plKey> pfGUIDialogMod::fControls

protected

char pfGUIDialogMod::fName[128]

protected

plKey pfGUIDialogMod::fProcReceiver

protected

plKey pfGUIDialogMod::fRenderMod

protected

plKey pfGUIDialogMod::fSceneNode

protected

unsigned int pfGUIDialogMod::fTagID

protected

unsigned int pfGUIDialogMod::fVersion

protected

---

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

• core/PRP/GUI/pfGUIDialogMod.h