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

The simplest form of a custom type implementation. More...

#include <VOP_TypeDefinition.h>

+ Inheritance diagram for VOP_CustomTypeDefinition:

Public Member Functions

 VOP_CustomTypeDefinition ()
 Constructor and destructor. More...
 
 ~VOP_CustomTypeDefinition () override
 
- Public Member Functions inherited from VOP_TypeDefinition
 VOP_TypeDefinition ()
 Constructor and destructor. More...
 
virtual ~VOP_TypeDefinition ()
 
virtual bool load (const UT_JSONValue &json)
 
virtual bool save (UT_JSONValue &json) const
 
virtual void getTypeDefinitionSourceCode (UT_String &code, const VOP_Language *language) const
 
const UT_StringHoldergetTypeName () const
 Sets and gets the type definition unique name identifier. More...
 
void setTypeName (const char *name)
 Sets and gets the type definition unique name identifier. More...
 
const UT_StringHoldergetName () const
 Sets and gets the type definition unique name identifier. More...
 
const UT_StringHoldergetTypeLabel () const
 Sets and gets the type definition unique name identifier. More...
 
void setTypeLabel (const char *label)
 Sets and gets the type definition unique name identifier. More...
 
const UT_ColorgetConnectorColor () const
 Methods for the color of the connector of this type. More...
 
void setSpecificConnectorColor (const UT_Color &clr)
 Methods for the color of the connector of this type. More...
 
void setDefaultConnectorColor ()
 Methods for the color of the connector of this type. More...
 
void setCodeTypeName (const char *code_type_name)
 Sets and gets the type name used in the generated code. More...
 
const UT_StringHoldergetCodeTypeName () const
 Sets and gets the type name used in the generated code. More...
 
const UT_StringHoldergetCodeTypeNameRaw () const
 Sets and gets the type name used in the generated code. More...
 
bool operator== (const VOP_TypeDefinition &other) const
 Standard comparison operators. More...
 
bool operator!= (const VOP_TypeDefinition &other) const
 Standard comparison operators. More...
 

Protected Member Functions

bool isEqual (const VOP_TypeDefinition &other) const override
 Standard overrides from the base class. More...
 
static const UT_StringHolder METATYPE_VALUE
 Saves to or loades from a JSON value associated with given key. More...
 
UT_StringHolder getMetaType () const override
 Saves to or loades from a JSON value associated with given key. More...
 

Additional Inherited Members

- Static Public Attributes inherited from VOP_TypeDefinition
static const UT_StringHolder METATYPE_KEY
 

Detailed Description

The simplest form of a custom type implementation.

Definition at line 123 of file VOP_TypeDefinition.h.

Constructor & Destructor Documentation

VOP_CustomTypeDefinition::VOP_CustomTypeDefinition ( )

Constructor and destructor.

VOP_CustomTypeDefinition::~VOP_CustomTypeDefinition ( )
override

Member Function Documentation

UT_StringHolder VOP_CustomTypeDefinition::getMetaType ( ) const
overridevirtual

Saves to or loades from a JSON value associated with given key.

Implements VOP_TypeDefinition.

bool VOP_CustomTypeDefinition::isEqual ( const VOP_TypeDefinition other) const
overrideprotectedvirtual

Standard overrides from the base class.

Implements VOP_TypeDefinition.

Member Data Documentation

const UT_StringHolder VOP_CustomTypeDefinition::METATYPE_VALUE
static

Saves to or loades from a JSON value associated with given key.

Definition at line 131 of file VOP_TypeDefinition.h.


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