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

#include <pfGUITextBoxMod.h>

Inheritance diagram for pfGUITextBoxMod:
pfGUIControlMod plSingleModifier plModifier plSynchedObject hsKeyedObject plCreatable

Public Types

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

Public Member Functions

 pfGUITextBoxMod ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
plString getText () const
plString getLocalizationPath () const
void setText (const plString &text)
void setLocalizationPath (const plString &path)
- 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

plString fText
plString fLocalizationPath
- 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

Enumerator:
kCenterJustify 
kRightJustify 

Constructor & Destructor Documentation

pfGUITextBoxMod::pfGUITextBoxMod ( )

Member Function Documentation

plString pfGUITextBoxMod::getLocalizationPath ( ) const
plString pfGUITextBoxMod::getText ( ) const
virtual void pfGUITextBoxMod::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 pfGUITextBoxMod::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 pfGUITextBoxMod::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 pfGUITextBoxMod::setLocalizationPath ( const plString &  path)
void pfGUITextBoxMod::setText ( const plString &  text)
virtual void pfGUITextBoxMod::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

plString pfGUITextBoxMod::fLocalizationPath
protected
plString pfGUITextBoxMod::fText
protected

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