#include <pfGUIProgressCtrl.h>
Public Types | |
| enum | ProgressFlags { kReverseValues = kDerivedFlagsStart, kLeftRightOrientation, kMapToScreenRange, kTriggerOnlyOnMouseUp, kMapToAnimationRange } |
Public Member Functions | |
| pfGUIProgressCtrl () | |
| 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 plString & | getAnimName () const |
| void | setAnimName (const plString &name) |
 Public Member Functions inherited from pfGUIValueCtrl | |
| pfGUIValueCtrl () | |
| float | getMin () const |
| float | getMax () const |
| float | getStep () const |
| void | setMin (float min) |
| void | setMax (float max) |
| void | setStep (float step) |
| void | setRange (float min, float max) |
| 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 |
| 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 | |
| std::vector< plKey > | fAnimationKeys |
| plString | fAnimName |
| Protected Attributes inherited from pfGUIValueCtrl | |
| float | fMin |
| float | fMax |
| float | fStep |
| Protected Attributes inherited from pfGUIControlMod | |
| 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
Constructor & Destructor Documentation
| pfGUIProgressCtrl::pfGUIProgressCtrl | ( | ) |
Member Function Documentation
| void pfGUIProgressCtrl::addAnimKey | ( | plKey | key | ) |
| void pfGUIProgressCtrl::clearAnimKeys | ( | ) |
| void pfGUIProgressCtrl::delAnimKey | ( | size_t | idx | ) |
| const std::vector<plKey>& pfGUIProgressCtrl::getAnimKeys | ( | ) | const |
| std::vector<plKey>& pfGUIProgressCtrl::getAnimKeys | ( | ) |
| const plString& pfGUIProgressCtrl::getAnimName | ( | ) | const |
|
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 pfGUIValueCtrl.
|
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 pfGUIValueCtrl.
|
virtual |
Reads this creatable directly from the stream. If any keys are read, they will be added to the plResManager automatically.
Reimplemented from pfGUIValueCtrl.
| void pfGUIProgressCtrl::setAnimName | ( | const plString & | name | ) |
|
virtual |
Writes this creatable directly to the stream. The plResManager is used to manage any key references written by this creatable.
Reimplemented from pfGUIValueCtrl.
Member Data Documentation
|
protected |
|
protected |
The documentation for this class was generated from the following file:
- core/PRP/GUI/pfGUIProgressCtrl.h
