pfGUISkin Class Reference

#include <pfGUISkin.h>

Inheritance diagram for pfGUISkin:

Classes
struct	pfSRect

Public Types
enum	Elements {   kUpLeftCorner, kTopSpan, kUpRightCorner, kRightSpan,   kLowerRightCorner, kBottomSpan, kLowerLeftCorner, kLeftSpan,   kMiddleFill, kSelectedFill, kSubMenuArrow, kSelectedSubMenuArrow,   kTreeButtonClosed, kTreeButtonOpen, kNumElements }

Public Member Functions
	pfGUISkin ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
const pfSRect &	getElement (size_t which) const
pfSRect &	getElement (size_t which)
plKey	getTexture () const
unsigned short	getItemMargin () const
unsigned short	getBorderMargin () const
void	setTexture (plKey tex)
void	setItemMargin (unsigned short margin)
void	setBorderMargin (unsigned short margin)
Public Member Functions inherited from hsKeyedObject
void	init (const plString &name)
plKey	getKey () const
void	setKey (plKey key)
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
plKey	fTexture
pfSRect	fElements [kNumElements]
unsigned short	fItemMargin
unsigned short	fBorderMargin

Member Enumeration Documentation

enum pfGUISkin::Elements

Enumerator:

kUpLeftCorner
kTopSpan
kUpRightCorner
kRightSpan
kLowerRightCorner
kBottomSpan
kLowerLeftCorner
kLeftSpan
kMiddleFill
kSelectedFill
kSubMenuArrow
kSelectedSubMenuArrow
kTreeButtonClosed
kTreeButtonOpen
kNumElements

Constructor & Destructor Documentation

pfGUISkin::pfGUISkin

(

)

Member Function Documentation

unsigned short pfGUISkin::getBorderMargin

(

)

const

const pfSRect& pfGUISkin::getElement

(

size_t

which

)

const

pfSRect& pfGUISkin::getElement

(

size_t

which

)

unsigned short pfGUISkin::getItemMargin

(

)

const

plKey pfGUISkin::getTexture

(

)

const

virtual void pfGUISkin::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 hsKeyedObject.

virtual void pfGUISkin::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 hsKeyedObject.

virtual void pfGUISkin::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 hsKeyedObject.

void pfGUISkin::setBorderMargin

(

unsigned short

margin

)

void pfGUISkin::setItemMargin

(

unsigned short

margin

)

void pfGUISkin::setTexture

(

plKey

tex

)

virtual void pfGUISkin::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 hsKeyedObject.

Member Data Documentation

unsigned short pfGUISkin::fBorderMargin

protected

pfSRect pfGUISkin::fElements[kNumElements]

protected

unsigned short pfGUISkin::fItemMargin

protected

plKey pfGUISkin::fTexture

protected

---

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

• core/PRP/GUI/pfGUISkin.h