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

#include <pfGUICheckBoxCtrl.h>

Inheritance diagram for pfGUICheckBoxCtrl:
pfGUIControlMod plSingleModifier plModifier plSynchedObject hsKeyedObject plCreatable

Public Member Functions

 pfGUICheckBoxCtrl ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
const std::vector< plKey > & getAnimKeys () const
std::vector< plKey > & getAnimKeys ()
void addAnimKey (plKey key)
void delAnimKey (size_t idx)
void clearAnimKeys ()
const plStringgetAnimName () const
bool isChecked () const
void setAnimName (const plString &name)
void setChecked (bool checked)
- 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< plKeyfAnimKeys
plString fAnimName
bool fChecked
- 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
}

Constructor & Destructor Documentation

pfGUICheckBoxCtrl::pfGUICheckBoxCtrl ( )

Member Function Documentation

void pfGUICheckBoxCtrl::addAnimKey ( plKey  key)
void pfGUICheckBoxCtrl::clearAnimKeys ( )
void pfGUICheckBoxCtrl::delAnimKey ( size_t  idx)
const std::vector<plKey>& pfGUICheckBoxCtrl::getAnimKeys ( ) const
std::vector<plKey>& pfGUICheckBoxCtrl::getAnimKeys ( )
const plString& pfGUICheckBoxCtrl::getAnimName ( ) const
virtual void pfGUICheckBoxCtrl::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 pfGUICheckBoxCtrl::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.

bool pfGUICheckBoxCtrl::isChecked ( ) const
virtual void pfGUICheckBoxCtrl::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.

void pfGUICheckBoxCtrl::setAnimName ( const plString name)
void pfGUICheckBoxCtrl::setChecked ( bool  checked)
virtual void pfGUICheckBoxCtrl::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> pfGUICheckBoxCtrl::fAnimKeys
protected
plString pfGUICheckBoxCtrl::fAnimName
protected
bool pfGUICheckBoxCtrl::fChecked
protected

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