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

#include <DT_Plugin.h>

+ Inheritance diagram for DT_ParmDefPath:

Public Types

enum  PathType {
  PT_OPERATOR, PT_OBJECT_PATH, PT_PARM, PT_FILE,
  PT_DIRECTORY
}
 
- Public Types inherited from DT_ParmDef
enum  Type {
  T_TOGGLE, T_INTEGER, T_FLOAT, T_COLOR,
  T_STRING, T_MENU, T_PATH, T_BUTTON,
  T_GROUPED
}
 
enum  OptionType { OT_OPTION_ONLY, OT_OPTION_AND_TOOLBAR, OT_TOOLBAR_ONLY }
 

Public Member Functions

DT_ParmDefPathsetPathType (PathType path_type)
 
PathType pathType () const
 
DT_ParmDefPathsetOpFilter (const UT_StringHolder &op_filter)
 
const char * opFilter () const
 
DT_ParmDefPathsetMultiSelection ()
 
bool multiSelection () const
 
void copyValue (const char *src, DT_Value &dst) const
 Copy a value from a concrete type to an opaque DT_Value object. More...
 
void copyValue (const DT_Value &src, UT_StringHolder &dst) const
 Copy a value from DT_Value opaque type to a concrete type. More...
 
virtual bool operator== (const DT_ParmDef &other) const
 
- Public Member Functions inherited from DT_ParmDef
virtual ~DT_ParmDef ()
 
int id () const
 
Type type () const
 
const char * typeName () const
 
DT_ParmDefsetName (const UT_StringHolder &name)
 Set a name for this parameter definition. More...
 
const UT_StringHoldername () const
 Returns the name of the parameter definition. More...
 
DT_ParmDefsetIcon (const UT_StringHolder &icon)
 Show an icon, instead of a headet text / label. More...
 
const UT_StringHoldericon () const
 
DT_ParmDefsetTooltip (const UT_StringHolder &str)
 
const UT_StringHoldertooltip () const
 
DT_ParmDefsetReadOnly ()
 
bool readOnly () const
 
DT_ParmDefsetOptionType (OptionType opt_type)
 
OptionType optionType () const
 
DT_ParmDefsetToolbarName (const UT_StringHolder &toolbar_name)
 
const UT_StringHoldertoolbarName () const
 
DT_ParmDefsetCanBeIndeterminate ()
 The parameter can be in an indeterminate state. Ignored for options. More...
 
bool canBeIndeterminate () const
 
virtual bool allowsMultiValueSet () const
 

Static Public Member Functions

static DT_ParmDefPathcreate (int id, const UT_StringHolder &name)
 
static const DT_ParmDefPathget (const DT_ParmDef &def)
 Automatically cast the base class definition to this type. More...
 
- Static Public Member Functions inherited from DT_ParmDef
static DT_ParmDefcreateFromTemplate (int id, const PRM_Template &tpl)
 
static bool getMenuItemsFromTemplate (const PRM_Template &tpl, PRM_Parm &parm, DT_MenuItemList &items)
 

Additional Inherited Members

- Protected Member Functions inherited from DT_ParmDef
 DT_ParmDef (int id, const UT_StringHolder &name, Type parm_type)
 
- Protected Member Functions inherited from UT_NonCopyableNS::UT_NonCopyable
 UT_NonCopyable ()=default
 
 ~UT_NonCopyable ()=default
 
 UT_NonCopyable (const UT_NonCopyable &)=delete
 
UT_NonCopyableoperator= (const UT_NonCopyable &)=delete
 
- Protected Attributes inherited from DT_ParmDef
int myId
 
UT_StringHolder myName
 
UT_StringHolder myIcon
 
Type myType
 
UT_StringHolder myTooltip
 
OptionType myOptionType
 
UT_StringHolder myToolbarName
 
bool myReadOnly
 
bool myCanBeIndeterminate
 

Detailed Description

Definition at line 617 of file DT_Plugin.h.

Member Enumeration Documentation

Enumerator
PT_OPERATOR 

Any scene operator.

PT_OBJECT_PATH 

Objects + virtual SOP paths.

PT_PARM 

Node parameter.

PT_FILE 

File browser.

PT_DIRECTORY 

Directory browser.

Definition at line 621 of file DT_Plugin.h.

Member Function Documentation

void DT_ParmDefPath::copyValue ( const char *  src,
DT_Value dst 
) const

Copy a value from a concrete type to an opaque DT_Value object.

void DT_ParmDefPath::copyValue ( const DT_Value src,
UT_StringHolder dst 
) const

Copy a value from DT_Value opaque type to a concrete type.

static DT_ParmDefPath* DT_ParmDefPath::create ( int  id,
const UT_StringHolder name 
)
static
static const DT_ParmDefPath& DT_ParmDefPath::get ( const DT_ParmDef def)
inlinestatic

Automatically cast the base class definition to this type.

Definition at line 633 of file DT_Plugin.h.

bool DT_ParmDefPath::multiSelection ( ) const
virtual bool DT_ParmDefPath::operator== ( const DT_ParmDef other) const
virtual

Implements DT_ParmDef.

const char* DT_ParmDefPath::opFilter ( ) const
PathType DT_ParmDefPath::pathType ( ) const
DT_ParmDefPath* DT_ParmDefPath::setMultiSelection ( )
DT_ParmDefPath* DT_ParmDefPath::setOpFilter ( const UT_StringHolder op_filter)
DT_ParmDefPath* DT_ParmDefPath::setPathType ( PathType  path_type)

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