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

#include <plAGApplicator.h>

Inheritance diagram for plSoundVolumeApplicator:
plAGApplicator plCreatable

Public Member Functions

 plSoundVolumeApplicator ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
unsigned int getIndex () const
void setIndex (unsigned int index)
- Public Member Functions inherited from plAGApplicator
 plAGApplicator ()
virtual ~plAGApplicator ()
plAGChannelgetChannel () const
void setChannel (plAGChannel *)
bool isEnabled () const
plString getChannelName () const
void setEnabled (bool enabled)
void setChannelName (const plString &channelName)
- Public Member Functions inherited from plCreatable
 plCreatable ()
virtual ~plCreatable ()
virtual short ClassIndex () const =0
short ClassIndex (PlasmaVer ver) const
virtual const char * ClassName () const
virtual bool ClassInstance (short) const
virtual bool isStub () const
virtual void prcWrite (pfPrcHelper *prc)
virtual void prcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Member Functions

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

Protected Attributes

unsigned int fIndex
- Protected Attributes inherited from plAGApplicator
plAGChannelfChannel
bool fEnabled
plString fChannelName

Constructor & Destructor Documentation

plSoundVolumeApplicator::plSoundVolumeApplicator ( )

Member Function Documentation

unsigned int plSoundVolumeApplicator::getIndex ( ) const
virtual void plSoundVolumeApplicator::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 plAGApplicator.

virtual void plSoundVolumeApplicator::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 plAGApplicator.

virtual void plSoundVolumeApplicator::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 plAGApplicator.

void plSoundVolumeApplicator::setIndex ( unsigned int  index)
virtual void plSoundVolumeApplicator::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 plAGApplicator.

Member Data Documentation

unsigned int plSoundVolumeApplicator::fIndex
protected

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