PRM_Item Class Reference

#include <PRM_Item.h>

Inheritance diagram for PRM_Item:

Public Member Functions
	PRM_Item ()
	PRM_Item (const char *token, const char *label=NULL, const char *iconname=NULL)
virtual	~PRM_Item ()
const char *	getIcon () const
void	setIcon (const char *s)
Public Member Functions inherited from PRM_Name
	PRM_Name ()
	Default PRM_Name constructor is a sentinel value. More...
	PRM_Name (const char *thetoken, const char *thelabel=nullptr, int theflags=0)
	PRM_Name (PRM_NameCopy, const UT_StringHolder &thetoken, const UT_StringHolder &thelabel, int theflags=0)
	Constructor for doing deep copies of the strings. More...
bool	isSentinel () const
	Check if this is a sentinel. More...
void	setAsSentinel ()
	Set to a sentinel value. More...
void	setAsSeparator ()
	Set to a separator value. More...
const char *	getToken () const
const char *	getLabel () const
int	getExpressionFlag () const
unsigned	getHash () const
	operator const UT_StringRef & () const
	Use this for the common use of passing the token to a function. More...
const UT_StringRef &	getTokenRef () const
	Use this for hash tables, might be the sentinel value. More...
const UT_StringRef &	getLabelRef () const
	Get label UT_StringRef &, might be the sentinel value. More...
void	harden ()
	Do a deep copy of its internal references. More...
void	setToken (const char *s)
	Sets the token, doing a deep copy. More...
void	setLabel (const char *s)
	Sets the label, doing a deep copy. More...
void	setTokenAndLabel (const char *token, const char *label)
	Sets the token and label, doing deep copies. More...
void	setTokenAndLabelRef (const UT_StringRef &token, const UT_StringRef &label)
	Sets the token and label, doing shallow copies. More...
void	instance (const int *instance, int num)
void	instance (const UT_IntArray &instance_num)
bool	isValidChoice () const
	Returns if this a valid menu choice. More...
int64	getMemoryUsage (bool inclusive) const

Additional Inherited Members
Public Types inherited from PRM_Name
enum	PRM_NameCopy { COPY }
Static Public Member Functions inherited from PRM_Name
static void	instanceToken (UT_String &token, const int *instance, int num)
static void	instanceToken (UT_String &token, const UT_IntArray &instance_num)
static void	instanceToken (UT_WorkBuffer &result, const UT_StringRef &token, const int *instance, int num)
static void	instanceToken (UT_WorkBuffer &result, const UT_StringRef &token, const UT_IntArray &instance_num)
Static Public Attributes inherited from PRM_Name
static const char *const	mySeparator

Detailed Description

Definition at line 17 of file PRM_Item.h.

Constructor & Destructor Documentation

PRM_Item::PRM_Item

(

)

NOTE: Need an explicit default constructor to work around internal compiler error in Visual Studio 2015 Update 3. See: https://connect.microsoft.com/VisualStudio/feedback/details/2869531

PRM_Item::PRM_Item	(	const char *	token,
		const char *	label = NULL,
		const char *	iconname = NULL
	)

virtual PRM_Item::~PRM_Item ( )

virtual

Member Function Documentation

const char* PRM_Item::getIcon ( ) const

inline

Definition at line 30 of file PRM_Item.h.

void PRM_Item::setIcon ( const char *  s )

inline

Definition at line 31 of file PRM_Item.h.

---

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

• PRM/PRM_Item.h