pfGUIControlMod Class Reference

#include <pfGUIControlMod.h>

Inheritance diagram for pfGUIControlMod:

Public Types
enum	{   kWantsInterest, kInheritProcFromDlg, kIntangible, kXparentBgnd,   kScaleTextWithResolution, kTakesSpecialKeys, kHasProxy, kBetterHitTesting,   kDerivedFlagsStart = 0x20 }

Public Member Functions
	pfGUIControlMod ()
virtual	~pfGUIControlMod ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
const std::vector< int > &	getSoundIndices () const
std::vector< int > &	getSoundIndices ()
void	setSoundIndices (const std::vector< int > &indices)
void	clearSoundIndices ()
unsigned int	getTagID () const
bool	isVisible () const
pfGUICtrlProcWriteableObject *	getHandler () const
plKey	getDynTextMap () const
plKey	getDynTextLayer () const
pfGUIColorScheme *	getColorScheme () const
plKey	getProxy () const
plKey	getSkin () const
void	setTagID (unsigned int id)
void	setVisible (bool visible)
void	setDynTextMap (plKey map)
void	setDynTextLayer (plKey layer)
void	setProxy (plKey proxy)
void	setSkin (plKey skin)
void	setHandler (pfGUICtrlProcWriteableObject *handler)
void	setColorScheme (pfGUIColorScheme *scheme)
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
bool	fVisible
pfGUICtrlProcWriteableObject *	fHandler
plKey	fDynTextMap
plKey	fDynTextLayer
pfGUIColorScheme *	fColorScheme
std::vector< int >	fSoundIndices
plKey	fProxy
plKey	fSkin
Protected Attributes inherited from plSingleModifier
hsBitVector	fFlags
plKey	fTarget

Member Enumeration Documentation

anonymous enum

Enumerator:

kWantsInterest
kInheritProcFromDlg
kIntangible
kXparentBgnd
kScaleTextWithResolution
kTakesSpecialKeys
kHasProxy
kBetterHitTesting
kDerivedFlagsStart

Constructor & Destructor Documentation

pfGUIControlMod::pfGUIControlMod

(

)

virtual pfGUIControlMod::~pfGUIControlMod ( )

virtual

Member Function Documentation

void pfGUIControlMod::clearSoundIndices

(

)

pfGUIColorScheme* pfGUIControlMod::getColorScheme

(

)

const

plKey pfGUIControlMod::getDynTextLayer

(

)

const

plKey pfGUIControlMod::getDynTextMap

(

)

const

pfGUICtrlProcWriteableObject* pfGUIControlMod::getHandler

(

)

const

plKey pfGUIControlMod::getProxy

(

)

const

plKey pfGUIControlMod::getSkin

(

)

const

const std::vector<int>& pfGUIControlMod::getSoundIndices

(

)

const

std::vector<int>& pfGUIControlMod::getSoundIndices

(

)

unsigned int pfGUIControlMod::getTagID

(

)

const

virtual void pfGUIControlMod::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 pfGUIListBoxMod, pfGUIKnobCtrl, pfGUIProgressCtrl, pfGUIButtonMod, pfGUIRadioGroupCtrl, pfGUITextBoxMod, pfGUICheckBoxCtrl, pfGUIValueCtrl, pfGUIDynDisplayCtrl, pfGUIMultiLineEditCtrl, and pfGUIUpDownPairMod.

virtual void pfGUIControlMod::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 pfGUIListBoxMod, pfGUIKnobCtrl, pfGUIProgressCtrl, pfGUIButtonMod, pfGUIRadioGroupCtrl, pfGUITextBoxMod, pfGUICheckBoxCtrl, pfGUIValueCtrl, pfGUIDynDisplayCtrl, pfGUIMultiLineEditCtrl, and pfGUIUpDownPairMod.

bool pfGUIControlMod::isVisible

(

)

const

virtual void pfGUIControlMod::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 pfGUIListBoxMod, pfGUIKnobCtrl, pfGUIProgressCtrl, pfGUIButtonMod, pfGUIRadioGroupCtrl, pfGUITextBoxMod, pfGUICheckBoxCtrl, pfGUIValueCtrl, pfGUIDynDisplayCtrl, pfGUIMultiLineEditCtrl, and pfGUIUpDownPairMod.

void pfGUIControlMod::setColorScheme

(

pfGUIColorScheme *

scheme

)

void pfGUIControlMod::setDynTextLayer

(

plKey

layer

)

void pfGUIControlMod::setDynTextMap

(

plKey

map

)

void pfGUIControlMod::setHandler

(

pfGUICtrlProcWriteableObject *

handler

)

void pfGUIControlMod::setProxy

(

plKey

proxy

)

void pfGUIControlMod::setSkin

(

plKey

skin

)

void pfGUIControlMod::setSoundIndices

(

const std::vector< int > &

indices

)

void pfGUIControlMod::setTagID

(

unsigned int

id

)

void pfGUIControlMod::setVisible

(

bool

visible

)

virtual void pfGUIControlMod::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 pfGUIListBoxMod, pfGUIKnobCtrl, pfGUIProgressCtrl, pfGUIButtonMod, pfGUIRadioGroupCtrl, pfGUITextBoxMod, pfGUICheckBoxCtrl, pfGUIValueCtrl, pfGUIDynDisplayCtrl, pfGUIMultiLineEditCtrl, and pfGUIUpDownPairMod.

Member Data Documentation

pfGUIColorScheme* pfGUIControlMod::fColorScheme

protected

plKey pfGUIControlMod::fDynTextLayer

protected

plKey pfGUIControlMod::fDynTextMap

protected

pfGUICtrlProcWriteableObject* pfGUIControlMod::fHandler

protected

plKey pfGUIControlMod::fProxy

protected

plKey pfGUIControlMod::fSkin

protected

std::vector<int> pfGUIControlMod::fSoundIndices

protected

unsigned int pfGUIControlMod::fTagID

protected

bool pfGUIControlMod::fVisible

protected

---

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

• core/PRP/GUI/pfGUIControlMod.h