HOM/HOM_StringParmTemplate.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * COMMENTS:
 */

#ifndef __HOM_StringParmTemplate_h__
#define __HOM_StringParmTemplate_h__

#include "HOM_API.h"
#include "HOM_ParmTemplate.h"

SWIGOUT(%feature("notabstract") HOM_StringParmTemplate;)
SWIGOUT(%rename(StringParmTemplate) HOM_StringParmTemplate;)

class HOM_API HOM_StringParmTemplate : virtual public HOM_ParmTemplate
{
public:
#ifdef SWIG
#ifdef SWIGPYTHON
    %feature("autodoc",
        "__init__(self, name, label, num_components, default_value=(),"
        " naming_scheme=hou.parmNamingScheme.XYZW, disable_when=None,"
        " is_hidden=False, join_with_next=False, help=None, tags={})") 
        HOM_StringParmTemplate;
#endif
%extend {
    %kwargs HOM_StringParmTemplate;
    HOM_StringParmTemplate(
            const char *name,
            const char *label,
            int num_components,
            const std::vector<std::string> &default_value =
                std::vector<std::string>(),
            HOM_EnumValue &naming_scheme = HOM_parmNamingScheme::Base1,
            HOM_EnumValue &string_type = HOM_stringParmType::Regular,
            const char *disable_when = NULL,
            bool is_hidden = false,
            bool join_with_next = false,
            const char *help = NULL,
            const std::map<std::string, std::string> &tags =
                HOM_StdMapStringString())
        throw(HOM_OperationFailed, HOM_TypeError, HOM_Error)
    {
        return HOM().newStringParmTemplate(
            name, label, num_components, default_value,
            naming_scheme, string_type, disable_when, is_hidden,
            join_with_next, help, tags);
    }
};
#else
    HOM_StringParmTemplate()
    { HOM_CONSTRUCT_OBJECT(this) }

    HOM_StringParmTemplate(const HOM_StringParmTemplate &parm_template)
    : HOM_ParmTemplate(parm_template)
    { HOM_CONSTRUCT_OBJECT(this) }
#endif

    virtual ~HOM_StringParmTemplate()
    { HOM_DESTRUCT_OBJECT(this) }

    // Let swig think we're overriding __repr__ for this class so it doesn't
    // provide its own __repr__.
    SWIGOUT(virtual std::string __repr__() throw(HOM_Error);)

    SWIGPYTHONOUT(%feature("autodoc",
        "stringType(self) -> hou.stringParmType enum value") stringType;)
    virtual HOM_EnumValue &stringType() throw(HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "defaultValue(self) -> tuple of strings") defaultValue;)
    virtual std::vector<std::string> defaultValue() = 0;
};

#endif

---