HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HOM_Tool Class Referenceabstract

#include <HOM_Tool.h>

+ Inheritance diagram for HOM_Tool:

Public Member Functions

 HOM_Tool ()
 
 HOM_Tool (const HOM_Tool &shelftool)
 
virtual ~HOM_Tool ()
 
virtual int __hash__ ()=0
 
virtual std::string script ()=0
 
virtual void setScript (const char *script)=0
 
virtual HOM_EnumValuelanguage ()=0
 
virtual void setLanguage (HOM_EnumValue &language)=0
 
virtual std::string icon ()=0
 
virtual void setIcon (const char *icon)=0
 
virtual std::string help ()=0
 
virtual void setHelp (const char *help)=0
 
virtual std::string helpURL ()=0
 
virtual void setHelpURL (const char *help_url)=0
 
virtual std::vector
< HOM_NodeTypeCategory * > 
toolMenuCategories (HOM_EnumValue &pane_type)=0
 
virtual void setToolMenuCategories (HOM_EnumValue &pane_type, const std::vector< HOM_NodeTypeCategory * > &categories)=0
 
virtual std::string toolMenuOpType (HOM_EnumValue &pane_type)=0
 
virtual void setToolMenuOpType (HOM_EnumValue &pane_type, const char *op_type)=0
 
virtual std::vector< std::stringtoolMenuLocations ()=0
 
virtual void setToolLocations (const std::vector< std::string > &locations)=0
 
virtual std::vector< std::stringkeywords ()=0
 
virtual void setKeywords (const std::vector< std::string > &keywords)=0
 
virtual void setData (const char *script=NULL, HOM_EnumValue &language=HOM_scriptLanguage::Python, const char *icon=NULL, const char *help=NULL, const char *help_url=NULL, const std::vector< HOM_NodeTypeCategory * > &network_categories=std::vector< HOM_NodeTypeCategory * >(), const std::vector< HOM_NodeTypeCategory * > &viewer_categories=std::vector< HOM_NodeTypeCategory * >(), const std::vector< HOM_NodeTypeCategory * > &cop_viewer_categories=std::vector< HOM_NodeTypeCategory * >(), const char *network_op_type=NULL, const char *viewer_op_type=NULL, const std::vector< std::string > &locations=std::vector< std::string >(), const std::vector< std::string > &keywords=std::vector< std::string >())=0
 
virtual void destroy ()=0
 
- Public Member Functions inherited from HOM_ShelfElement
 HOM_ShelfElement ()
 
 HOM_ShelfElement (const HOM_ShelfElement &element)
 
virtual ~HOM_ShelfElement ()
 
virtual std::string __repr__ ()=0
 
virtual bool operator== (HOM_PtrOrNull< HOM_ShelfElement > element)=0
 
virtual bool operator!= (HOM_PtrOrNull< HOM_ShelfElement > element)=0
 
virtual std::string filePath ()=0
 
virtual void setFilePath (const char *file_path)=0
 
virtual std::string name ()=0
 
virtual void setName (const char *name)=0
 
virtual std::string label ()=0
 
virtual void setLabel (const char *label)=0
 
virtual bool isReadOnly ()=0
 
virtual void setReadOnly (bool on)=0
 

Detailed Description

Definition at line 20 of file HOM_Tool.h.

Constructor & Destructor Documentation

HOM_Tool::HOM_Tool ( )
inline

Definition at line 23 of file HOM_Tool.h.

HOM_Tool::HOM_Tool ( const HOM_Tool shelftool)
inline

Definition at line 25 of file HOM_Tool.h.

virtual HOM_Tool::~HOM_Tool ( )
inlinevirtual

Definition at line 28 of file HOM_Tool.h.

Member Function Documentation

virtual int HOM_Tool::__hash__ ( )
pure virtual
virtual void HOM_Tool::destroy ( )
pure virtual
virtual std::string HOM_Tool::help ( )
pure virtual
virtual std::string HOM_Tool::helpURL ( )
pure virtual
virtual std::string HOM_Tool::icon ( )
pure virtual
virtual std::vector<std::string> HOM_Tool::keywords ( )
pure virtual
virtual HOM_EnumValue& HOM_Tool::language ( )
pure virtual
virtual std::string HOM_Tool::script ( )
pure virtual
virtual void HOM_Tool::setData ( const char *  script = NULL,
HOM_EnumValue language = HOM_scriptLanguage::Python,
const char *  icon = NULL,
const char *  help = NULL,
const char *  help_url = NULL,
const std::vector< HOM_NodeTypeCategory * > &  network_categories = std::vector< HOM_NodeTypeCategory * >(),
const std::vector< HOM_NodeTypeCategory * > &  viewer_categories = std::vector< HOM_NodeTypeCategory * >(),
const std::vector< HOM_NodeTypeCategory * > &  cop_viewer_categories = std::vector< HOM_NodeTypeCategory * >(),
const char *  network_op_type = NULL,
const char *  viewer_op_type = NULL,
const std::vector< std::string > &  locations = std::vector< std::string >(),
const std::vector< std::string > &  keywords = std::vector< std::string >() 
)
pure virtual
virtual void HOM_Tool::setHelp ( const char *  help)
pure virtual
virtual void HOM_Tool::setHelpURL ( const char *  help_url)
pure virtual
virtual void HOM_Tool::setIcon ( const char *  icon)
pure virtual
virtual void HOM_Tool::setKeywords ( const std::vector< std::string > &  keywords)
pure virtual
virtual void HOM_Tool::setLanguage ( HOM_EnumValue language)
pure virtual
virtual void HOM_Tool::setScript ( const char *  script)
pure virtual
virtual void HOM_Tool::setToolLocations ( const std::vector< std::string > &  locations)
pure virtual
virtual void HOM_Tool::setToolMenuCategories ( HOM_EnumValue pane_type,
const std::vector< HOM_NodeTypeCategory * > &  categories 
)
pure virtual
virtual void HOM_Tool::setToolMenuOpType ( HOM_EnumValue pane_type,
const char *  op_type 
)
pure virtual
virtual std::vector<HOM_NodeTypeCategory *> HOM_Tool::toolMenuCategories ( HOM_EnumValue pane_type)
pure virtual
virtual std::vector<std::string> HOM_Tool::toolMenuLocations ( )
pure virtual
virtual std::string HOM_Tool::toolMenuOpType ( HOM_EnumValue pane_type)
pure virtual

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