PRM_ScriptParm Class Reference

#include <PRM_ScriptParm.h>

List of all members.

Public Types
enum	{   PRM_SPARM_REQUIRED = 0x001, PRM_SPARM_DIRECTION = 0x002, PRM_SPARM_COLOR = 0x004, PRM_SPARM_OBJECT = 0x008,   PRM_SPARM_RENDERER = 0x010, PRM_SPARM_ANIMSTRING = 0x020, PRM_SPARM_OBJECTLIST = 0x040, PRM_SPARM_EMBED = 0x080,   PRM_SPARM_LOGARITHMIC = 0x100, PRM_SPARM_ALLFLAGS = 0x1FF }
Public Member Functions
	PRM_ScriptParm ()
virtual	~PRM_ScriptParm ()
int	parse (DS_Stream &is)
int	parseGroup (DS_Stream &is, PRM_ScriptPage *page, const char *grouptype)
bool	parseMultiParm (DS_Stream &is, PRM_MultiType multitype, PRM_ScriptPage *page)
int	parseGroupAttribute (DS_Stream &is)
void	appendScriptParms (UT_PtrArray< PRM_ScriptParm * > &parms)
void	setFlag (unsigned flag)
void	clearFlag (unsigned flag)
unsigned	getFlag (unsigned bit) const
PRM_ScriptGroup *	getGroup () const
PRM_Name &	getName ()
const PRM_Name &	getName () const
const PRM_Type &	getType () const
PRM_TypeExtended	getTypeExtended () const
PRM_MultiType	getMultiType () const
const PRM_Default *	getDefaults () const
PRM_Default *	getDefaults ()
PRM_Range *	getRange () const
int	getSize () const
PRM_ChoiceList *	getMenu () const
const UT_String &	getOption () const
const UT_String &	getHelpText () const
PRM_DisableList &	getDisableList ()
PRM_Template *	getMultiTemplate ()
bool	getBaseParm () const
PRM_SpareData *	getSpareData (bool create=false)
void	enforceOptions ()
	Some parameter dialogs require options for every parameter.
int	computeTemplateSize ()
void	fillTemplate (PRM_Template *array, int &idx, PRM_ScriptImports *&imports, int nest_level)
Static Public Member Functions
static const char *	protectString (const char *s, int handlenull=0)
	Inserts double backslashes to protect verbatim strings in script files.
static void	protectStrcat (UT_WorkBuffer &dest, const char *s, int handlenull=0)
Protected Member Functions
virtual PRM_ScriptGroup *	newGroup (bool asmultiparm=false)
virtual PRM_ScriptPage *	newPage ()
virtual int	handleUnknown (DS_Stream &is, UT_String &token)
virtual PRM_Callback	getScriptParmCallback () const
virtual bool	wantsParametersAnimatable () const
int	buildMultiParmTemplate (PRM_ScriptImports *&imports, int nest_level)
int	parseMenu (DS_Stream &is)
int	parseAttribute (DS_Stream &is)
int	parseDefaults (DS_Stream &is, int isstring)
int	parseRange (DS_Stream &is)
int	parseDisableInfo (DS_Stream &is)
void	clearMenu ()
void	clearDefaults ()
Protected Attributes
PRM_ScriptGroup *	myGroup
PRM_ChoiceList *	myMenu
PRM_Name *	myMenuNames
PRM_Template *	myMultiTemplate
int	myMenuType
PRM_Name	myName
PRM_Type	myType
PRM_TypeExtended	myTypeExtended
PRM_MultiType	myMultiType
int	myVectorSize
UT_RefArray< PRM_Default >	myDefaults
UT_StringArray	myDefaultStrings
PRM_Range *	myRange
PRM_SpareData *	mySpareData
PRM_DisableList	myDisableList
unsigned	myFlag
UT_String	myHelpText
int	myToolboxLevel
bool	myBaseParm
UT_String	myOption
Static Protected Attributes
static const char *	theTokens []
static int	theNumParms []

---

Detailed Description

Definition at line 84 of file PRM_ScriptParm.h.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

PRM_SPARM_REQUIRED
PRM_SPARM_DIRECTION
PRM_SPARM_COLOR
PRM_SPARM_OBJECT
PRM_SPARM_RENDERER
PRM_SPARM_ANIMSTRING
PRM_SPARM_OBJECTLIST
PRM_SPARM_EMBED
PRM_SPARM_LOGARITHMIC
PRM_SPARM_ALLFLAGS

Definition at line 89 of file PRM_ScriptParm.h.

---

Constructor & Destructor Documentation

PRM_ScriptParm::PRM_ScriptParm

(

)

virtual PRM_ScriptParm::~PRM_ScriptParm

(

)

[virtual]

---

Member Function Documentation

void PRM_ScriptParm::appendScriptParms

(

UT_PtrArray< PRM_ScriptParm * > &

parms

)

int PRM_ScriptParm::buildMultiParmTemplate	(	PRM_ScriptImports *&	imports,
		int	nest_level
	)			[protected]

void PRM_ScriptParm::clearDefaults

(

)

[protected]

void PRM_ScriptParm::clearFlag

(

unsigned

flag

)

[inline]

Definition at line 115 of file PRM_ScriptParm.h.

void PRM_ScriptParm::clearMenu

(

)

[protected]

int PRM_ScriptParm::computeTemplateSize

(

)

void PRM_ScriptParm::enforceOptions

(

)

Some parameter dialogs require options for every parameter.

void PRM_ScriptParm::fillTemplate	(	PRM_Template *	array,
		int &	idx,
		PRM_ScriptImports *&	imports,
		int	nest_level
	)

bool PRM_ScriptParm::getBaseParm

(

)

const [inline]

Definition at line 137 of file PRM_ScriptParm.h.

PRM_Default* PRM_ScriptParm::getDefaults

(

)

[inline]

Definition at line 127 of file PRM_ScriptParm.h.

const PRM_Default* PRM_ScriptParm::getDefaults

(

)

const [inline]

Definition at line 124 of file PRM_ScriptParm.h.

PRM_DisableList& PRM_ScriptParm::getDisableList

(

)

[inline]

Definition at line 135 of file PRM_ScriptParm.h.

unsigned PRM_ScriptParm::getFlag

(

unsigned

bit

)

const [inline]

Definition at line 116 of file PRM_ScriptParm.h.

PRM_ScriptGroup* PRM_ScriptParm::getGroup

(

)

const [inline]

Definition at line 118 of file PRM_ScriptParm.h.

const UT_String& PRM_ScriptParm::getHelpText

(

)

const [inline]

Definition at line 134 of file PRM_ScriptParm.h.

PRM_ChoiceList* PRM_ScriptParm::getMenu

(

)

const [inline]

Definition at line 132 of file PRM_ScriptParm.h.

PRM_Template* PRM_ScriptParm::getMultiTemplate

(

)

PRM_MultiType PRM_ScriptParm::getMultiType

(

)

const [inline]

Definition at line 123 of file PRM_ScriptParm.h.

const PRM_Name& PRM_ScriptParm::getName

(

void

)

const [inline]

Definition at line 120 of file PRM_ScriptParm.h.

PRM_Name& PRM_ScriptParm::getName

(

void

)

[inline]

Definition at line 119 of file PRM_ScriptParm.h.

const UT_String& PRM_ScriptParm::getOption

(

)

const [inline]

Definition at line 133 of file PRM_ScriptParm.h.

PRM_Range* PRM_ScriptParm::getRange

(

)

const [inline]

Definition at line 130 of file PRM_ScriptParm.h.

virtual PRM_Callback PRM_ScriptParm::getScriptParmCallback

(

)

const [protected, virtual]

int PRM_ScriptParm::getSize

(

void

)

const [inline]

Definition at line 131 of file PRM_ScriptParm.h.

PRM_SpareData* PRM_ScriptParm::getSpareData

(

bool

create = false

)

const PRM_Type& PRM_ScriptParm::getType

(

void

)

const [inline]

Definition at line 121 of file PRM_ScriptParm.h.

PRM_TypeExtended PRM_ScriptParm::getTypeExtended

(

)

const [inline]

Definition at line 122 of file PRM_ScriptParm.h.

virtual int PRM_ScriptParm::handleUnknown	(	DS_Stream &	is,
		UT_String &	token
	)			[protected, virtual]

virtual PRM_ScriptGroup* PRM_ScriptParm::newGroup

(

bool

asmultiparm = false

)

[protected, virtual]

virtual PRM_ScriptPage* PRM_ScriptParm::newPage

(

)

[protected, virtual]

int PRM_ScriptParm::parse

(

DS_Stream &

is

)

int PRM_ScriptParm::parseAttribute

(

DS_Stream &

is

)

[protected]

int PRM_ScriptParm::parseDefaults	(	DS_Stream &	is,
		int	isstring
	)			[protected]

int PRM_ScriptParm::parseDisableInfo

(

DS_Stream &

is

)

[protected]

int PRM_ScriptParm::parseGroup	(	DS_Stream &	is,
		PRM_ScriptPage *	page,
		const char *	grouptype
	)

int PRM_ScriptParm::parseGroupAttribute

(

DS_Stream &

is

)

int PRM_ScriptParm::parseMenu

(

DS_Stream &

is

)

[protected]

bool PRM_ScriptParm::parseMultiParm	(	DS_Stream &	is,
		PRM_MultiType	multitype,
		PRM_ScriptPage *	page
	)

int PRM_ScriptParm::parseRange

(

DS_Stream &

is

)

[protected]

static void PRM_ScriptParm::protectStrcat	(	UT_WorkBuffer &	dest,
		const char *	s,
		int	handlenull = 0
	)			[static]

static const char* PRM_ScriptParm::protectString	(	const char *	s,
		int	handlenull = 0
	)			[static]

Inserts double backslashes to protect verbatim strings in script files.

void PRM_ScriptParm::setFlag

(

unsigned

flag

)

[inline]

Definition at line 114 of file PRM_ScriptParm.h.

virtual bool PRM_ScriptParm::wantsParametersAnimatable

(

)

const [protected, virtual]

---

Member Data Documentation

bool PRM_ScriptParm::myBaseParm [protected]

Definition at line 190 of file PRM_ScriptParm.h.

UT_RefArray<PRM_Default> PRM_ScriptParm::myDefaults [protected]

Definition at line 182 of file PRM_ScriptParm.h.

UT_StringArray PRM_ScriptParm::myDefaultStrings [protected]

Definition at line 183 of file PRM_ScriptParm.h.

PRM_DisableList PRM_ScriptParm::myDisableList [protected]

Definition at line 186 of file PRM_ScriptParm.h.

unsigned PRM_ScriptParm::myFlag [protected]

Definition at line 187 of file PRM_ScriptParm.h.

PRM_ScriptGroup* PRM_ScriptParm::myGroup [protected]

Definition at line 172 of file PRM_ScriptParm.h.

UT_String PRM_ScriptParm::myHelpText [protected]

Definition at line 188 of file PRM_ScriptParm.h.

PRM_ChoiceList* PRM_ScriptParm::myMenu [protected]

Definition at line 173 of file PRM_ScriptParm.h.

PRM_Name* PRM_ScriptParm::myMenuNames [protected]

Definition at line 174 of file PRM_ScriptParm.h.

int PRM_ScriptParm::myMenuType [protected]

Definition at line 176 of file PRM_ScriptParm.h.

PRM_Template* PRM_ScriptParm::myMultiTemplate [protected]

Definition at line 175 of file PRM_ScriptParm.h.

PRM_MultiType PRM_ScriptParm::myMultiType [protected]

Definition at line 180 of file PRM_ScriptParm.h.

PRM_Name PRM_ScriptParm::myName [protected]

Definition at line 177 of file PRM_ScriptParm.h.

UT_String PRM_ScriptParm::myOption [protected]

Definition at line 193 of file PRM_ScriptParm.h.

PRM_Range* PRM_ScriptParm::myRange [protected]

Definition at line 184 of file PRM_ScriptParm.h.

PRM_SpareData* PRM_ScriptParm::mySpareData [protected]

Definition at line 185 of file PRM_ScriptParm.h.

int PRM_ScriptParm::myToolboxLevel [protected]

Definition at line 189 of file PRM_ScriptParm.h.

PRM_Type PRM_ScriptParm::myType [protected]

Definition at line 178 of file PRM_ScriptParm.h.

PRM_TypeExtended PRM_ScriptParm::myTypeExtended [protected]

Definition at line 179 of file PRM_ScriptParm.h.

int PRM_ScriptParm::myVectorSize [protected]

Definition at line 181 of file PRM_ScriptParm.h.

int PRM_ScriptParm::theNumParms[] [static, protected]

Definition at line 196 of file PRM_ScriptParm.h.

const char* PRM_ScriptParm::theTokens[] [static, protected]

Definition at line 195 of file PRM_ScriptParm.h.

---

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

• PRM/PRM_ScriptParm.h