HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PI_OldParms Class Reference

#include <PI_OldParms.h>

Public Member Functions

 PI_OldParms ()
 
 PI_OldParms (const PI_OldParms &other)
 
 ~PI_OldParms ()
 
void clear ()
 Remove all parameters. More...
 
void preserveOldParms (PI_EditScriptedParms *eso)
 
int addOldParm (const char *name, const char *chan, int subidx)
 Add parameter to set. More...
 
void renameOldParm (const char *oldname, const char *newname)
 
void deleteOldParm (const char *newname)
 
void renameOldParmChannel (const char *newname, const char *oldchan, const char *newchan)
 
void deleteOldParmChannel (const char *newname, const char *newchan)
 
void undeleteOldParm (const char *oldname)
 
void resolveOldParmLinks (int node_id, PI_EditScriptedParms *eos, UT_StringArray &errs, UT_StringArray &parmdelwarnings)
 
bool hasOldParm (const char *oldname) const
 Return true if we have a parameter registered with the specified name. More...
 
bool hasDeletedOldParm (const char *oldname) const
 
void getDeletedParms (UT_StringArray &deleted_parms) const
 Pass back a list of parameters that have been deleted. More...
 
void getRenamedParms (UT_StringArray &old_parms, UT_StringArray &new_parms) const
 
const char * getOriginalName (const char *parm_name) const
 
const char * getNewName (const char *old_parm_name) const
 

Static Public Member Functions

static int getParameterDeletionBehavior ()
 
static void setParameterDeletionBehavior (int behavior)
 

Detailed Description

Definition at line 66 of file PI_OldParms.h.

Constructor & Destructor Documentation

PI_OldParms::PI_OldParms ( )
PI_OldParms::PI_OldParms ( const PI_OldParms other)
PI_OldParms::~PI_OldParms ( )

Member Function Documentation

int PI_OldParms::addOldParm ( const char *  name,
const char *  chan,
int  subidx 
)

Add parameter to set.

void PI_OldParms::clear ( )

Remove all parameters.

void PI_OldParms::deleteOldParm ( const char *  newname)
void PI_OldParms::deleteOldParmChannel ( const char *  newname,
const char *  newchan 
)
void PI_OldParms::getDeletedParms ( UT_StringArray deleted_parms) const

Pass back a list of parameters that have been deleted.

const char* PI_OldParms::getNewName ( const char *  old_parm_name) const

Return the new name of the parameter after it was renamed. Return old_parm_name if no such parameter exists with that name or if the parameter was never renamed.

const char* PI_OldParms::getOriginalName ( const char *  parm_name) const

Return the original name of the parameter before it was renamed. Return parm_name if no such parameter exists with that name or if the parameter was never renamed.

static int PI_OldParms::getParameterDeletionBehavior ( )
static
void PI_OldParms::getRenamedParms ( UT_StringArray old_parms,
UT_StringArray new_parms 
) const

Pass back lists of parameters that have been renamed. old_parms contains the old parameter names. new_parms contains the new parameter names. The size of old_parms and new_parms is the same with old_parm(i) => new_parm(i) representing the parameter name change.

bool PI_OldParms::hasDeletedOldParm ( const char *  oldname) const
bool PI_OldParms::hasOldParm ( const char *  oldname) const

Return true if we have a parameter registered with the specified name.

void PI_OldParms::preserveOldParms ( PI_EditScriptedParms eso)
void PI_OldParms::renameOldParm ( const char *  oldname,
const char *  newname 
)
void PI_OldParms::renameOldParmChannel ( const char *  newname,
const char *  oldchan,
const char *  newchan 
)
void PI_OldParms::resolveOldParmLinks ( int  node_id,
PI_EditScriptedParms eos,
UT_StringArray errs,
UT_StringArray parmdelwarnings 
)
static void PI_OldParms::setParameterDeletionBehavior ( int  behavior)
static
void PI_OldParms::undeleteOldParm ( const char *  oldname)

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