HOM/HOM_GalleryEntry.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_GalleryEntry_h__
#define __HOM_GalleryEntry_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Module.h"
#include "HOM_Errors.h"

class HOM_Node;

SWIGOUT(%rename(GalleryEntry) HOM_GalleryEntry;)

class HOM_API HOM_GalleryEntry
{
public:
    HOM_GalleryEntry()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_GalleryEntry(const HOM_GalleryEntry &)
    { HOM_CONSTRUCT_OBJECT(this) }
    virtual ~HOM_GalleryEntry()
    { HOM_DESTRUCT_OBJECT(this) }

    virtual std::string __repr__()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual bool canApplyToNode(HOM_Node &node)
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void applyToNode(HOM_Node &node)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual bool canCreateChildNode(HOM_Node &parent)
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    SWIGOUT(%newobject createChildNode;)
    virtual HOM_Node *createChildNode(HOM_Node &parent)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual void setEqual(HOM_GalleryEntry &entry)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual std::string name()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setName(const char *name)
        throw(HOM_OperationFailed, HOM_PermissionError,
              HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual std::string label()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setLabel(const char *label)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual std::string description()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setDescription(const char *description)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual std::string helpURL()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setHelpURL(const char *helpurl)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual std::string requiredHDAFile()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setRequiredHDAFile(const char *hda_file)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual std::string icon()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setIcon(const char *icon)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual bool allowIconRegeneration()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setAllowIconRegeneration(bool flag)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGOUT(%newobject bestNodeType;)
    SWIGPYTHONOUT(%feature("autodoc",
        "bestNodeType(self) -> NodeType or None") bestNodeType;)
    virtual HOM_NodeType *bestNodeType()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "nodeTypeNames(self) -> tuple of strings") nodeTypeNames;)
    virtual std::vector<std::string> nodeTypeNames()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setNodeTypeNames(const std::vector<std::string> &nodetypes)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "categories(self) -> tuple of strings") categories;)
    virtual std::vector<std::string> categories()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setCategories(const std::vector<std::string> &categories)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "keywords(self) -> tuple of strings") keywords;)
    virtual std::vector<std::string> keywords()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setKeywords(const std::vector<std::string> &keywords)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual HOM_NodeTypeCategory &nodeTypeCategory()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setNodeTypeCategory(HOM_NodeTypeCategory &category)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual std::string script()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setScript(const char *script)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setScriptFromNode(HOM_Node *node)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setContentsFromNode(HOM_Node *node)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;
};

#endif

---