libHSPlasma
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
pfGUIDynDisplayCtrl Class Reference

#include <pfGUIDynDisplayCtrl.h>

Inheritance diagram for pfGUIDynDisplayCtrl:
pfGUIControlMod plSingleModifier plModifier plSynchedObject hsKeyedObject plCreatable

Public Member Functions

virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
const std::vector< plKey > & getTextMaps () const
std::vector< plKey > & getTextMaps ()
void addTextMap (plKey map)
void delTextMap (size_t idx)
void clearTextMaps ()
const std::vector< plKey > & getLayers () const
std::vector< plKey > & getLayers ()
void addLayer (plKey map)
void delLayer (size_t idx)
void clearLayers ()
const std::vector< plKey > & getMaterials () const
std::vector< plKey > & getMaterials ()
void addMaterial (plKey map)
void delMaterial (size_t idx)
void clearMaterials ()
- Public Member Functions inherited from pfGUIControlMod
 pfGUIControlMod ()
virtual ~pfGUIControlMod ()
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
pfGUICtrlProcWriteableObjectgetHandler () const
plKey getDynTextMap () const
plKey getDynTextLayer () const
pfGUIColorSchemegetColorScheme () 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

std::vector< plKeyfTextMaps
std::vector< plKeyfLayers
std::vector< plKeyfMaterials
- Protected Attributes inherited from pfGUIControlMod
unsigned int fTagID
bool fVisible
pfGUICtrlProcWriteableObjectfHandler
plKey fDynTextMap
plKey fDynTextLayer
pfGUIColorSchemefColorScheme
std::vector< int > fSoundIndices
plKey fProxy
plKey fSkin
- Protected Attributes inherited from plSingleModifier
hsBitVector fFlags
plKey fTarget

Additional Inherited Members

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

Member Function Documentation

void pfGUIDynDisplayCtrl::addLayer ( plKey  map)
void pfGUIDynDisplayCtrl::addMaterial ( plKey  map)
void pfGUIDynDisplayCtrl::addTextMap ( plKey  map)
void pfGUIDynDisplayCtrl::clearLayers ( )
void pfGUIDynDisplayCtrl::clearMaterials ( )
void pfGUIDynDisplayCtrl::clearTextMaps ( )
void pfGUIDynDisplayCtrl::delLayer ( size_t  idx)
void pfGUIDynDisplayCtrl::delMaterial ( size_t  idx)
void pfGUIDynDisplayCtrl::delTextMap ( size_t  idx)
const std::vector<plKey>& pfGUIDynDisplayCtrl::getLayers ( ) const
std::vector<plKey>& pfGUIDynDisplayCtrl::getLayers ( )
const std::vector<plKey>& pfGUIDynDisplayCtrl::getMaterials ( ) const
std::vector<plKey>& pfGUIDynDisplayCtrl::getMaterials ( )
const std::vector<plKey>& pfGUIDynDisplayCtrl::getTextMaps ( ) const
std::vector<plKey>& pfGUIDynDisplayCtrl::getTextMaps ( )
virtual void pfGUIDynDisplayCtrl::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 pfGUIControlMod.

virtual void pfGUIDynDisplayCtrl::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 pfGUIControlMod.

virtual void pfGUIDynDisplayCtrl::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 pfGUIControlMod.

virtual void pfGUIDynDisplayCtrl::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 pfGUIControlMod.

Member Data Documentation

std::vector<plKey> pfGUIDynDisplayCtrl::fLayers
protected
std::vector<plKey> pfGUIDynDisplayCtrl::fMaterials
protected
std::vector<plKey> pfGUIDynDisplayCtrl::fTextMaps
protected

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