HDK: HOM/HOM_ParmTemplate.h Source File

00001 /*
00002  * PROPRIETARY INFORMATION.  This software is proprietary to
00003  * Side Effects Software Inc., and is not to be reproduced,
00004  * transmitted, or disclosed in any way without written permission.
00005  *
00006  * Produced by:
00007  *      Side Effects Software Inc
00008  *      123 Front Street West, Suite 1401
00009  *      Toronto, Ontario
00010  *      Canada   M5J 2M2
00011  *      416-504-9876
00012  *
00013  * COMMENTS:
00014  */
00015 
00016 #ifndef __HOM_ParmTemplate_h__
00017 #define __HOM_ParmTemplate_h__
00018 
00019 #include "HOM_API.h"
00020 #include "HOM_Defines.h"
00021 #include "HOM_Errors.h"
00022 #include "HOM_EnumValue.h"
00023 #include "HOM_Module.h"
00024 #include <string>
00025 
00026 SWIGOUT(%rename(ParmTemplate) HOM_ParmTemplate;)
00027 
00028 class HOM_API HOM_ParmTemplate
00029 {
00030 public:
00031     HOM_ParmTemplate()
00032     { HOM_CONSTRUCT_OBJECT(this) }
00033     HOM_ParmTemplate(const HOM_ParmTemplate &parm_template)
00034     { HOM_CONSTRUCT_OBJECT(this) }
00035     virtual ~HOM_ParmTemplate()
00036     { HOM_DESTRUCT_OBJECT(this) }
00037 
00038     virtual bool operator==(HOM_ParmTemplate &parm_template)
00039         throw(HOM_Error) = 0;
00040     virtual bool operator!=(HOM_ParmTemplate &parm_template)
00041         throw(HOM_Error) = 0;
00042 
00043     virtual int __hash__() throw(HOM_Error) = 0;
00044     virtual std::string __repr__() throw(HOM_Error) = 0;
00045 
00046     SWIGOUT(%newobject clone;)
00047     virtual HOM_ParmTemplate *clone() throw(HOM_Error) = 0;
00048 
00049     virtual std::string name() throw(HOM_Error) = 0;
00050     virtual void setName(const char *name)
00051         throw(HOM_OperationFailed, HOM_Error) = 0;
00052 
00053     virtual std::string label() throw(HOM_Error) = 0;
00054     virtual void setLabel(const char *label) throw(HOM_Error) = 0;
00055 
00056     virtual std::string help() throw(HOM_Error) = 0;
00057     virtual void setHelp(const char *help) throw(HOM_Error) = 0;
00058 
00059     SWIGPYTHONOUT(%feature("autodoc",
00060         "type(self) -> hou.parmTemplateType enum value") type;)
00061     virtual HOM_EnumValue &type() throw(HOM_Error) = 0;
00062 
00063     SWIGPYTHONOUT(%feature("autodoc",
00064         "dataType(self) -> hou.parmData enum value") dataType;)
00065     virtual HOM_EnumValue &dataType() throw(HOM_Error) = 0;
00066 
00067     SWIGPYTHONOUT(%feature("autodoc",
00068         "look(self) -> hou.parmLook enum value") look;)
00069     virtual HOM_EnumValue &look() throw(HOM_Error) = 0;
00070 
00071     SWIGPYTHONOUT(%feature("autodoc",
00072         "namingScheme(self) -> hou.parmNamingScheme enum value") namingScheme;)
00073     virtual HOM_EnumValue &namingScheme() throw(HOM_Error) = 0;
00074 
00075     virtual int numComponents() throw(HOM_Error) = 0;
00076 
00077     virtual std::string disableWhen() throw(HOM_Error) = 0;
00078     virtual void setDisableWhen(const char *disable_when) throw(HOM_Error) = 0;
00079 
00080     virtual bool isHidden() throw(HOM_Error) = 0;
00081     virtual void hide(bool on) throw(HOM_Error) = 0;
00082 
00083     virtual bool joinWithNext() throw(HOM_Error) = 0;
00084     virtual void setJoinWithNext(bool on) throw(HOM_Error) = 0;
00085 
00086     SWIGPYTHONOUT(%feature("autodoc",
00087         "tags(self) -> dict of string to string") tags;)
00088     virtual std::map<std::string, std::string>  tags() = 0;
00089 
00090     virtual void setTags(const std::map<std::string, std::string> &tags)
00091         throw(HOM_Error) = 0;
00092 
00093     SWIGOUT(%kwargs asCode;)
00094     virtual std::string asCode(const char *function_name=NULL)
00095         throw(HOM_TypeError, HOM_Error) = 0;
00096 };
00097 
00098 #endif