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

#include <pfGUIButtonMod.h>

Inheritance diagram for pfGUIButtonMod:
pfGUIControlMod plSingleModifier plModifier plSynchedObject hsKeyedObject plCreatable pfGUIMenuItem

Public Types

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

Public Member Functions

 pfGUIButtonMod ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
const std::vector< plKey > & getAnimationKeys () const
std::vector< plKey > & getAnimationKeys ()
void addAnimationKey (plKey key)
void delAnimationKey (size_t idx)
void clearAnimationKeys ()
const std::vector< plKey > & getMouseOverKeys () const
std::vector< plKey > & getMouseOverKeys ()
void addMouseOverKey (plKey key)
void delMouseOverKey (size_t idx)
void clearMouseOverKeys ()
const plStringgetAnimationName () const
const plStringgetMouseOverAnimName () const
plKey getDraggable () const
int getNotifyType () const
void setAnimationName (const plString &name)
void setMouseOverAnimName (const plString &name)
void setDraggable (plKey draggable)
void setNotifyType (int type)
- 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< plKeyfAnimationKeys
std::vector< plKeyfMouseOverAnimKeys
plString fAnimName
plString fMouseOverAnimName
plKey fDraggable
int fNotifyType
int fEoaUnknown1
int fEoaUnknown2
- 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

Member Enumeration Documentation

Enumerator:
kNotifyOnUp 
kNotifyOnDown 
kNotifyOnUpAndDown 

Constructor & Destructor Documentation

pfGUIButtonMod::pfGUIButtonMod ( )

Member Function Documentation

void pfGUIButtonMod::addAnimationKey ( plKey  key)
void pfGUIButtonMod::addMouseOverKey ( plKey  key)
void pfGUIButtonMod::clearAnimationKeys ( )
void pfGUIButtonMod::clearMouseOverKeys ( )
void pfGUIButtonMod::delAnimationKey ( size_t  idx)
void pfGUIButtonMod::delMouseOverKey ( size_t  idx)
const std::vector<plKey>& pfGUIButtonMod::getAnimationKeys ( ) const
std::vector<plKey>& pfGUIButtonMod::getAnimationKeys ( )
const plString& pfGUIButtonMod::getAnimationName ( ) const
plKey pfGUIButtonMod::getDraggable ( ) const
const plString& pfGUIButtonMod::getMouseOverAnimName ( ) const
const std::vector<plKey>& pfGUIButtonMod::getMouseOverKeys ( ) const
std::vector<plKey>& pfGUIButtonMod::getMouseOverKeys ( )
int pfGUIButtonMod::getNotifyType ( ) const
virtual void pfGUIButtonMod::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 pfGUIButtonMod::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 pfGUIButtonMod::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 pfGUIButtonMod::setAnimationName ( const plString name)
void pfGUIButtonMod::setDraggable ( plKey  draggable)
void pfGUIButtonMod::setMouseOverAnimName ( const plString name)
void pfGUIButtonMod::setNotifyType ( int  type)
virtual void pfGUIButtonMod::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> pfGUIButtonMod::fAnimationKeys
protected
plString pfGUIButtonMod::fAnimName
protected
plKey pfGUIButtonMod::fDraggable
protected
int pfGUIButtonMod::fEoaUnknown1
protected
int pfGUIButtonMod::fEoaUnknown2
protected
std::vector<plKey> pfGUIButtonMod::fMouseOverAnimKeys
protected
plString pfGUIButtonMod::fMouseOverAnimName
protected
int pfGUIButtonMod::fNotifyType
protected

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