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

Class that defines a struct vop type. More...

#include <VOP_CompositeTypeDefinition.h>

+ Inheritance diagram for VOP_StructTypeDefinition:

Public Member Functions

 VOP_StructTypeDefinition ()
 Standard overrides from the base class. More...
 
virtual ~VOP_StructTypeDefinition ()
 Standard overrides from the base class. More...
 
- Public Member Functions inherited from VOP_CompositeTypeDefinition
 VOP_CompositeTypeDefinition ()
 Constructor and destructor. More...
 
virtual ~VOP_CompositeTypeDefinition ()
 
virtual void getTypeDefinitionSourceCode (UT_String &code, const VOP_Language *language) const
 
virtual bool load (const UT_JSONValue &json)
 Saves to or loades from a JSON value. More...
 
virtual bool save (UT_JSONValue &json) const
 Saves to or loades from a JSON value. More...
 
int getMemberVarCount () const
 
const VOP_MemberVarInfogetMemberVarInfo (int index) const
 
const VOP_MemberVarInfofindMemberVarInfo (const char *member_name, bool check_old_names=false) const
 
int findMemberVarInfoIndex (const char *member_name, bool check_old_names=false) const
 
void appendMemberVarInfo (const VOP_MemberVarInfo &info)
 
int getMethodCount () const
 Getters and setter for member methods. More...
 
const VOP_MemberMethodInfogetMethodInfo (int index) const
 Getters and setter for member methods. More...
 
const VOP_MemberMethodInfofindMethodInfo (const char *method_name) const
 Getters and setter for member methods. More...
 
void appendMethodInfo (const VOP_MemberMethodInfo &info)
 Getters and setter for member methods. More...
 
void setIsAdHoc (bool flag)
 True if the type is ad-hoc (eg, defined by a Struct VOP node). More...
 
bool isAdHoc () const
 True if the type is ad-hoc (eg, defined by a Struct VOP node). More...
 
void setExplicitDefinitionCode (const char *code)
 
const char * getExplicitDefinitionCode () const
 
- Public Member Functions inherited from VOP_TypeDefinition
 VOP_TypeDefinition ()
 Constructor and destructor. More...
 
virtual ~VOP_TypeDefinition ()
 
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_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...
 
static const UT_StringHolder METATYPE_VALUE
 Override the meta-type string for structs. More...
 
virtual UT_StringHolder getMetaType () const
 Override the meta-type string for structs. More...
 
virtual UT_StringHolder getCodeTypeKeyword () const
 Override the meta-type string for structs. More...
 

Additional Inherited Members

- Static Public Attributes inherited from VOP_TypeDefinition
static const UT_StringHolder METATYPE_KEY
 
- Protected Member Functions inherited from VOP_CompositeTypeDefinition
void generateTypeDefinition (UT_String &code, const char *meta_type_keyword, const VOP_Language *language) const
 Generates a type definition for the source code from the member info. More...
 
virtual bool isEqual (const VOP_TypeDefinition &other) const
 Standard overrides from the base class. More...
 

Detailed Description

Class that defines a struct vop type.

Definition at line 189 of file VOP_CompositeTypeDefinition.h.

Constructor & Destructor Documentation

VOP_StructTypeDefinition::VOP_StructTypeDefinition ( )

Standard overrides from the base class.

virtual VOP_StructTypeDefinition::~VOP_StructTypeDefinition ( )
virtual

Standard overrides from the base class.

Member Function Documentation

virtual UT_StringHolder VOP_StructTypeDefinition::getCodeTypeKeyword ( ) const
virtual

Override the meta-type string for structs.

Implements VOP_CompositeTypeDefinition.

virtual UT_StringHolder VOP_StructTypeDefinition::getMetaType ( ) const
virtual

Override the meta-type string for structs.

Implements VOP_TypeDefinition.

Member Data Documentation

const UT_StringHolder VOP_StructTypeDefinition::METATYPE_VALUE
static

Override the meta-type string for structs.

Definition at line 198 of file VOP_CompositeTypeDefinition.h.


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