PRM_Parm.h File Reference

#include "PRM_API.h"
#include "PRM_ChanState.h"
#include "PRM_Default.h"
#include "PRM_KeySetType.h"
#include "PRM_ParmOwner.h"
#include "PRM_Template.h"
#include "PRM_Type.h"
#include <CH/CH_Types.h>
#include <DEP/DEP_MicroNode.h>
#include <UT/UT_IntArray.h>
#include <UT/UT_SharedPtr.h>
#include <UT/UT_SmallObject.h>
#include <UT/UT_StringHolder.h>
#include <SYS/SYS_Types.h>
#include <iosfwd>

Include dependency graph for PRM_Parm.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	PRM_DataItem
class	PRM_DataFactory
class	PRM_UndoData
class	PRM_Parm

Typedefs
typedef UT_SharedPtr< const PRM_DataItem >	PRM_DataItemHandle
typedef UT_SharedPtr < PRM_UndoData >	PRM_UndoDataHandle
typedef UT_Array< std::pair < UT_StringHolder, PRM_UndoDataHandle > >	PRM_UndoDataList

Enumerations
enum	PRM_AddKeyType { PRM_AK_MARK_PENDING, PRM_AK_SET_KEY, PRM_AK_FORCE_KEY }
enum	PRM_OverrideType { PRM_OVERRIDDEN, PRM_LAYERED }

Functions
PRM_API size_t	format (char *buffer, size_t buffer_size, const PRM_Parm &v)

Typedef Documentation

typedef UT_SharedPtr<const PRM_DataItem> PRM_DataItemHandle

Definition at line 97 of file PRM_Parm.h.

typedef UT_SharedPtr<PRM_UndoData> PRM_UndoDataHandle

Definition at line 128 of file PRM_Parm.h.

typedef UT_Array<std::pair<UT_StringHolder, PRM_UndoDataHandle> > PRM_UndoDataList

Definition at line 129 of file PRM_Parm.h.

Enumeration Type Documentation

enum PRM_AddKeyType

An enumeration specifying how, if wanted, keys are set when values are set.

Enumerator
PRM_AK_MARK_PENDING	Keys are not immediately added for the value being but marked as pending.
PRM_AK_SET_KEY	Keys are added if the current value differs from the value being set.
PRM_AK_FORCE_KEY	Keys are added even if the current value matches the value being set.

Definition at line 58 of file PRM_Parm.h.

enum PRM_OverrideType

Enumerator
PRM_OVERRIDDEN
PRM_LAYERED

Definition at line 69 of file PRM_Parm.h.

Function Documentation

PRM_API size_t format	(	char *	buffer,
		size_t	buffer_size,
		const PRM_Parm &	v
	)