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

#include <DT_Plugin.h>

+ Inheritance diagram for DT_ParmDefString:

Public Types

enum  StringType { ST_ANY, ST_IDENTIFIER, ST_PATH }
- Public Types inherited from DT_ParmDef
enum  Type {

Public Member Functions

DT_ParmDefStringsetStringType (StringType type)
StringType stringType () const
DT_ParmDefStringsetHasMenu ()
bool hasMenu () 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...
bool operator== (const DT_ParmDef &other) const override
- 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_ParmDefStringcreate (int id, const UT_StringHolder &name)
static const DT_ParmDefStringget (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 505 of file DT_Plugin.h.

Member Enumeration Documentation


Definition at line 509 of file DT_Plugin.h.

Member Function Documentation

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

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

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

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

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

Automatically cast the base class definition to this type.

Definition at line 519 of file DT_Plugin.h.

bool DT_ParmDefString::hasMenu ( ) const
bool DT_ParmDefString::operator== ( const DT_ParmDef other) const

Implements DT_ParmDef.

DT_ParmDefString* DT_ParmDefString::setHasMenu ( )
DT_ParmDefString* DT_ParmDefString::setStringType ( StringType  type)
StringType DT_ParmDefString::stringType ( ) const

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