HOM/HOM_MenuParmTemplate.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_MenuParmTemplate_h__
#define __HOM_MenuParmTemplate_h__

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

SWIGOUT(%feature("notabstract") HOM_MenuParmTemplate;)
SWIGOUT(%rename(MenuParmTemplate) HOM_MenuParmTemplate;)

class HOM_API HOM_MenuParmTemplate : virtual public HOM_ParmTemplate
{
public:
#ifdef SWIG
#ifdef SWIGPYTHON
    %feature("autodoc",
        "__init__(self, name, label, menu_items, menu_labels=(),"
        " default_value=0, icon_names=(), item_generator_script='',"
        " disable_when=None, is_hidden=False, join_with_next=False,"
        " help=None, tags={})") 
        HOM_MenuParmTemplate;
#endif
%extend {
    %kwargs HOM_MenuParmTemplate;
    HOM_MenuParmTemplate(
            const char *name,
            const char *label,
            const std::vector<std::string> &menu_items,
            const std::vector<std::string> &menu_labels =
                std::vector<std::string>(),
            int default_value = 0,
            const std::vector<std::string> &icon_names =
                std::vector<std::string>(),
            const std::string &item_generator_script = "",
            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().newMenuParmTemplate(
            name, label, menu_items, menu_labels, default_value, icon_names,
            item_generator_script, disable_when, is_hidden, join_with_next,
            help, tags);
    }
};
#else
    HOM_MenuParmTemplate()
    { HOM_CONSTRUCT_OBJECT(this) }

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

    virtual ~HOM_MenuParmTemplate()
    { 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);)

    virtual int defaultValue() throw(HOM_Error) = 0;
    virtual std::string defaultValueAsString() throw(HOM_Error) = 0;

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

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

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

    virtual std::string itemGeneratorScript() throw(HOM_Error) = 0;

    // TODO: Add methods to modify this parm template.
};

#endif

---