pfGUIPopUpMenu Class Reference

#include <pfGUIPopUpMenu.h>

Inheritance diagram for pfGUIPopUpMenu:

Classes
struct	pfMenuItem

Public Types
enum	Alignment { kAlignUpLeft, kAlignUpRight, kAlignDownLeft, kAlignDownRight }
enum	MenuFlags { kStayOpenAfterClick = kDerivedFlagsStart, kModalOutsideMenus, kOpenSubMenusOnHover, kScaleWithResolution }
Public Types inherited from pfGUIDialogMod
enum	Flags { kModal, kDerivedFlagsStart }

Public Member Functions
	pfGUIPopUpMenu ()
virtual	~pfGUIPopUpMenu ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
size_t	getNumItems () const
pfMenuItem &	getItem (size_t idx)
void	addItem (const plString &name, pfGUICtrlProcWriteableObject *handler, plKey subMenu=plKey(), float yoffs=0.0f)
void	delItem (size_t idx)
void	moveItem (size_t from, size_t to)
void	clearItems ()
unsigned short	getMargin () const
plKey	getSkin () const
plKey	getOriginContext () const
plKey	getOriginAnchor () const
Alignment	getAlignment () const
void	setMargin (unsigned short margin)
void	setSkin (plKey skin)
void	setOriginContext (plKey context)
void	setOriginAnchor (plKey anchor)
void	setAlignment (Alignment align)
Public Member Functions inherited from pfGUIDialogMod
	pfGUIDialogMod ()
const std::vector< plKey > &	getControls () const
std::vector< plKey > &	getControls ()
void	addControl (plKey ctrl)
void	delControl (size_t idx)
void	clearControls ()
unsigned int	getTagID () const
unsigned int	getVersion () const
plKey	getRenderMod () const
plString	getName () const
plKey	getProcReceiver () const
plKey	getSceneNode () const
void	setTagID (unsigned int id)
void	setVersion (unsigned int version)
void	setRenderMod (plKey mod)
void	setName (const char *name)
void	setProcReceiver (plKey receiver)
void	setSceneNode (plKey node)
const pfGUIColorScheme &	getColorScheme () const
pfGUIColorScheme &	getColorScheme ()
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
unsigned short	fMargin
std::vector< pfMenuItem >	fMenuItems
plKey	fSkin
plKey	fOriginContext
plKey	fOriginAnchor
Alignment	fAlignment
Protected Attributes inherited from pfGUIDialogMod
unsigned int	fTagID
unsigned int	fVersion
plKey	fRenderMod
char	fName [128]
std::vector< plKey >	fControls
pfGUIColorScheme	fColorScheme
plKey	fProcReceiver
plKey	fSceneNode
Protected Attributes inherited from plSingleModifier
hsBitVector	fFlags
plKey	fTarget

Member Enumeration Documentation

enum pfGUIPopUpMenu::Alignment

Enumerator:

kAlignUpLeft
kAlignUpRight
kAlignDownLeft
kAlignDownRight

enum pfGUIPopUpMenu::MenuFlags

Enumerator:

kStayOpenAfterClick
kModalOutsideMenus
kOpenSubMenusOnHover
kScaleWithResolution

Constructor & Destructor Documentation

pfGUIPopUpMenu::pfGUIPopUpMenu

(

)

virtual pfGUIPopUpMenu::~pfGUIPopUpMenu ( )

virtual

Member Function Documentation

void pfGUIPopUpMenu::addItem	(	const plString &	name,
		pfGUICtrlProcWriteableObject *	handler,
		plKey	subMenu = plKey(),
		float	yoffs = 0.0f
	)

void pfGUIPopUpMenu::clearItems

(

)

void pfGUIPopUpMenu::delItem

(

size_t

idx

)

Alignment pfGUIPopUpMenu::getAlignment

(

)

const

pfMenuItem& pfGUIPopUpMenu::getItem

(

size_t

idx

)

unsigned short pfGUIPopUpMenu::getMargin

(

)

const

size_t pfGUIPopUpMenu::getNumItems

(

)

const

plKey pfGUIPopUpMenu::getOriginAnchor

(

)

const

plKey pfGUIPopUpMenu::getOriginContext

(

)

const

plKey pfGUIPopUpMenu::getSkin

(

)

const

virtual void pfGUIPopUpMenu::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 pfGUIDialogMod.

virtual void pfGUIPopUpMenu::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 pfGUIDialogMod.

void pfGUIPopUpMenu::moveItem	(	size_t	from,
		size_t	to
	)

virtual void pfGUIPopUpMenu::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 pfGUIDialogMod.

void pfGUIPopUpMenu::setAlignment

(

Alignment

align

)

void pfGUIPopUpMenu::setMargin

(

unsigned short

margin

)

void pfGUIPopUpMenu::setOriginAnchor

(

plKey

anchor

)

void pfGUIPopUpMenu::setOriginContext

(

plKey

context

)

void pfGUIPopUpMenu::setSkin

(

plKey

skin

)

virtual void pfGUIPopUpMenu::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 pfGUIDialogMod.

Member Data Documentation

Alignment pfGUIPopUpMenu::fAlignment

protected

unsigned short pfGUIPopUpMenu::fMargin

protected

std::vector<pfMenuItem> pfGUIPopUpMenu::fMenuItems

protected

plKey pfGUIPopUpMenu::fOriginAnchor

protected

plKey pfGUIPopUpMenu::fOriginContext

protected

plKey pfGUIPopUpMenu::fSkin

protected

---

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

• core/PRP/GUI/pfGUIPopUpMenu.h