#include <UN_NodeType.h>

Public Member Functions
const UT_StringHolder &	name () const
	Returns the name of the node type. More...

const UT_StringHolder &	label () const
	Returns the label of the node type. More...

bool	isSubnet () const
	Returns true if the node type is a subnet containing children nodes. More...

bool	addSignature (UN_NodeSignatureHandle signature_handle)

const UT_StringArray &	signatureNames () const
	Returns the list of the signature names for this node type. More...

const UN_NodeSignature *	findSignature (const UT_StringRef &signature_name) const
	Returns a node signature by the given name, or null if not found. More...


	UN_NodeType (const UT_StringRef &node_type_name, const UT_StringRef &node_type_label=UT_StringRef())
	Constructor and destructor. More...

	~UN_NodeType ()
	Constructor and destructor. More...


void	setToolSubmenus (const UT_StringArray &submenus)

const UT_StringArray &	toolSubmenus () const


void	setChildCategoryNames (const UT_StringArray &names)
	The node type categories allowed inside this node type. More...

const UT_StringArray &	childCategoryNames () const
	The node type categories allowed inside this node type. More...

Detailed Description

The node type defines certain aspects of the node, that are common with some other nodes (of the same type), like, inputs and their types, standard parameters for such nodes, their function name, etc.

Definition at line 28 of file UN_NodeType.h.

Constructor & Destructor Documentation

UN_NodeType::UN_NodeType	(	const UT_StringRef &	node_type_name,
		const UT_StringRef &	node_type_label = `UT_StringRef()`
	)

Constructor and destructor.

UN_NodeType::~UN_NodeType ( )

Constructor and destructor.

Member Function Documentation

bool UN_NodeType::addSignature ( UN_NodeSignatureHandle signature_handle )

Adds the given signature to the set of signatures for this node type. Returns true if successful, or false if a signature by this name already exists and could not be added.

const UT_StringArray& UN_NodeType::childCategoryNames ( ) const

inline

The node type categories allowed inside this node type.

Definition at line 57 of file UN_NodeType.h.

const UN_NodeSignature* UN_NodeType::findSignature ( const UT_StringRef & signature_name ) const

inline

Returns a node signature by the given name, or null if not found.

Definition at line 76 of file UN_NodeType.h.

bool UN_NodeType::isSubnet ( ) const

inline

Returns true if the node type is a subnet containing children nodes.

Definition at line 62 of file UN_NodeType.h.

const UT_StringHolder& UN_NodeType::label ( ) const

inline

Returns the label of the node type.

Definition at line 43 of file UN_NodeType.h.

const UT_StringHolder& UN_NodeType::name ( void ) const

inline

Returns the name of the node type.

Definition at line 39 of file UN_NodeType.h.

void UN_NodeType::setChildCategoryNames ( const UT_StringArray & names )

inline

The node type categories allowed inside this node type.

Definition at line 55 of file UN_NodeType.h.

void UN_NodeType::setToolSubmenus ( const UT_StringArray & submenus )

inline

The submenus in the Tab menu where to place the default shelf tool for creating a node of this node type.

Definition at line 48 of file UN_NodeType.h.

const UT_StringArray& UN_NodeType::signatureNames ( ) const

inline

Returns the list of the signature names for this node type.

Definition at line 72 of file UN_NodeType.h.

const UT_StringArray& UN_NodeType::toolSubmenus ( ) const

inline

The submenus in the Tab menu where to place the default shelf tool for creating a node of this node type.

Definition at line 50 of file UN_NodeType.h.

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

UN/UN_NodeType.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation