#include <PRM_ScriptParm.h>
|
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_OBSOLETE = 0x200,
PRM_SPARM_EXPERIMENTAL = 0x400,
PRM_SPARM_ALLFLAGS = 0x7FF
} |
|
|
| PRM_ScriptParm () |
|
virtual | ~PRM_ScriptParm () |
|
int | parse (DS_Stream &is, int multiparm_depth) |
|
int | parseGroup (DS_Stream &is, PRM_ScriptPage *page, const char *grouptype, int multiparm_depth) |
|
bool | parseMultiParm (DS_Stream &is, PRM_MultiType multitype, PRM_ScriptPage *page, int multiparm_depth) |
|
int | parseGroupAttribute (DS_Stream &is) |
|
int | parseRange (DS_Stream &is) |
|
void | appendScriptParms (UT_ValArray< 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_ConditionalGroup & | getConditionalGroup () |
|
PRM_Template * | getMultiTemplate () |
|
bool | getBaseParm () const |
|
PRM_SpareData * | getSpareData (bool create=false) |
|
bool | hasObsoleteGroup () const |
|
PRM_ScriptParm * | createObsoleteGroupParm () |
|
bool | clearJoinNext () |
|
void | enforceOptions () |
| Some parameter dialogs require options for every parameter. More...
|
|
int | computeTemplateSize () |
|
void | fillTemplate (PRM_Template *array, int &idx, PRM_ScriptImports *&imports, int nest_level) |
|
Definition at line 87 of file PRM_ScriptParm.h.
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_OBSOLETE |
|
PRM_SPARM_EXPERIMENTAL |
|
PRM_SPARM_ALLFLAGS |
|
Definition at line 92 of file PRM_ScriptParm.h.
PRM_ScriptParm::PRM_ScriptParm |
( |
| ) |
|
virtual PRM_ScriptParm::~PRM_ScriptParm |
( |
| ) |
|
|
virtual |
void PRM_ScriptParm::clearDefaults |
( |
| ) |
|
|
protected |
void PRM_ScriptParm::clearFlag |
( |
unsigned |
flag | ) |
|
|
inline |
bool PRM_ScriptParm::clearJoinNext |
( |
| ) |
|
Clear any type or extended type settings related to joining. Returns true if any settings were changed.
void PRM_ScriptParm::clearMenu |
( |
| ) |
|
|
protected |
int PRM_ScriptParm::computeTemplateSize |
( |
| ) |
|
void PRM_ScriptParm::enforceOptions |
( |
| ) |
|
Some parameter dialogs require options for every parameter.
bool PRM_ScriptParm::getBaseParm |
( |
| ) |
const |
|
inline |
const PRM_Default* PRM_ScriptParm::getDefaults |
( |
| ) |
const |
|
inline |
unsigned PRM_ScriptParm::getFlag |
( |
unsigned |
bit | ) |
const |
|
inline |
const UT_String& PRM_ScriptParm::getHelpText |
( |
| ) |
const |
|
inline |
const PRM_Name& PRM_ScriptParm::getName |
( |
| ) |
const |
|
inline |
const UT_String& PRM_ScriptParm::getOption |
( |
| ) |
const |
|
inline |
PRM_Range* PRM_ScriptParm::getRange |
( |
| ) |
const |
|
inline |
virtual PRM_Callback PRM_ScriptParm::getScriptParmCallback |
( |
| ) |
const |
|
protectedvirtual |
int PRM_ScriptParm::getSize |
( |
| ) |
const |
|
inline |
PRM_SpareData* PRM_ScriptParm::getSpareData |
( |
bool |
create = false | ) |
|
const PRM_Type& PRM_ScriptParm::getType |
( |
| ) |
const |
|
inline |
bool PRM_ScriptParm::hasObsoleteGroup |
( |
| ) |
const |
|
inline |
virtual PRM_ScriptGroup* PRM_ScriptParm::newGroup |
( |
bool |
asmultiparm = false | ) |
|
|
protectedvirtual |
static void PRM_ScriptParm::protectStrcat |
( |
UT_WorkBuffer & |
dest, |
|
|
const char * |
s, |
|
|
int |
handlenull = 0 |
|
) |
| |
|
static |
static void PRM_ScriptParm::protectStrcat |
( |
UT_WorkBuffer & |
dest, |
|
|
const char * |
s, |
|
|
int |
handlenull, |
|
|
bool |
wrap_in_quotes |
|
) |
| |
|
static |
static const char* PRM_ScriptParm::protectString |
( |
const char * |
s, |
|
|
int |
handlenull = 0 |
|
) |
| |
|
static |
Inserts double backslashes to protect verbatim strings in script files. If wrap_in_quotes
is set to true, then protectString() and protectStrcat() will wrap the string in double quotes when necessary (i.e. string contains whitespace or a double quote).
static const char* PRM_ScriptParm::protectString |
( |
const char * |
s, |
|
|
int |
handlenull, |
|
|
bool |
wrap_in_quotes |
|
) |
| |
|
static |
void PRM_ScriptParm::setFlag |
( |
unsigned |
flag | ) |
|
|
inline |
virtual bool PRM_ScriptParm::wantsParametersAnimatable |
( |
| ) |
const |
|
protectedvirtual |
bool PRM_ScriptParm::myBaseParm |
|
protected |
unsigned PRM_ScriptParm::myFlag |
|
protected |
int PRM_ScriptParm::myMenuType |
|
protected |
int PRM_ScriptParm::myToolboxLevel |
|
protected |
int PRM_ScriptParm::myVectorSize |
|
protected |
int PRM_ScriptParm::theNumParms[] |
|
staticprotected |
const char* PRM_ScriptParm::theTokens[] |
|
staticprotected |
The documentation for this class was generated from the following file: