#include <UN_UniCategory.h>

Inheritance diagram for UN_UniCategory:

Public Member Functions
void	setSubnetNodeTypeName (const UT_StringRef &name)
	Sets the node type name of the generic subnet. More...


	UN_UniCategory (const UT_StringRef &name, const UT_StringRef &label=UT_StringRef())
	Constructor and destructor. More...

	~UN_UniCategory () override
	Constructor and destructor. More...


const UN_NodeTypeRegistry &	nodeTypeRegistry () const
	Returns the node type registry for this category. More...

UN_NodeTypeRegistry &	nodeTypeRegistry ()
	Returns the node type registry for this category. More...


const UN_PortTypeRegistry &	portTypeRegistry () const
	Returns the node port type registry for this category. More...

UN_PortTypeRegistry &	portTypeRegistry ()
	Returns the node port type registry for this category. More...


const UN_ParmTypeRegistry &	parmTypeRegistry () const
	Returns the node parameter type registry for this category. More...

UN_ParmTypeRegistry &	parmTypeRegistry ()
	Returns the node parameter type registry for this category. More...


UT_StringArray	nodeTypeNames () const override
	Required overrides from the base class. More...

bool	isValidNodeType (const UT_StringRef &name) const override
	Required overrides from the base class. More...

bool	isHiddenNodeType (const UT_StringRef &name) const override
	Required overrides from the base class. More...

UT_StringHolder	nodeTypeLabel (const UT_StringRef &type_name) const override
	Required overrides from the base class. More...

UT_StringHolder	nodeTypeIcon (const UT_StringRef &type_name) const override
	Required overrides from the base class. More...

UT_Array< UNI_Signature >	nodeTypeSignatures (const UT_StringRef &type_name) const override
	Required overrides from the base class. More...

UT_StringArray	nodeTypeNamesInPrecedenceOrder (const UT_StringRef &type_name) const override
	Required overrides from the base class. More...

UT_StringHolder	subnetNodeTypeName () const override
	Required overrides from the base class. More...

UT_StringArray	childCategoryNames (const UT_StringRef &type_name) const override
	Required overrides from the base class. More...

bool	shouldGenerateToolForNodeType (const UT_StringRef &type_name) const override
	Required overrides from the base class. More...

ToolInfo	nodeTypeToolInfo (const UT_StringRef &type_name) const override
	Required overrides from the base class. More...

UT_NotifierImpl< const UNI_NodeTypeEvent & > &	getNodeTypeEventNotifier () override
	Required overrides from the base class. More...

Public Member Functions inherited from UNI_Category
const UT_StringHolder &	name () const

const UT_StringHolder &	label () const

	UNI_Category (const UT_StringRef &name, const UT_StringRef &label=UT_StringRef())
	Constructor and destructor. More...

virtual	~UNI_Category ()
	Constructor and destructor. More...

Detailed Description

The category of nodes, node types, and port types that work together.

It groups these concepts into one umbrella, isolating them from other incompatible nodes and types. It allows presenting available node types and determine connectability of node ports, avoiding type collisions, etc.

Definition at line 30 of file UN_UniCategory.h.

Constructor & Destructor Documentation

UN_UniCategory::UN_UniCategory	(	const UT_StringRef &	name,
		const UT_StringRef &	label = `UT_StringRef()`
	)

Constructor and destructor.

UN_UniCategory::~UN_UniCategory ( )

override

Constructor and destructor.

Member Function Documentation

UT_StringArray UN_UniCategory::childCategoryNames ( const UT_StringRef & type_name ) const

overridevirtual

Required overrides from the base class.

Implements UNI_Category.

UT_NotifierImpl<const UNI_NodeTypeEvent &>& UN_UniCategory::getNodeTypeEventNotifier ( )

overridevirtual

Required overrides from the base class.

Implements UNI_Category.

bool UN_UniCategory::isHiddenNodeType ( const UT_StringRef & name ) const

overridevirtual

Required overrides from the base class.

Implements UNI_Category.

bool UN_UniCategory::isValidNodeType ( const UT_StringRef & name ) const

overridevirtual

Required overrides from the base class.

Implements UNI_Category.

UT_StringHolder UN_UniCategory::nodeTypeIcon ( const UT_StringRef & type_name ) const

overridevirtual

Required overrides from the base class.

Implements UNI_Category.

UT_StringHolder UN_UniCategory::nodeTypeLabel ( const UT_StringRef & type_name ) const

overridevirtual

Required overrides from the base class.

Implements UNI_Category.

UT_StringArray UN_UniCategory::nodeTypeNames ( ) const

overridevirtual

Required overrides from the base class.

Implements UNI_Category.

UT_StringArray UN_UniCategory::nodeTypeNamesInPrecedenceOrder ( const UT_StringRef & type_name ) const

overridevirtual

Required overrides from the base class.

Implements UNI_Category.

const UN_NodeTypeRegistry& UN_UniCategory::nodeTypeRegistry ( ) const

inline

Returns the node type registry for this category.

Definition at line 42 of file UN_UniCategory.h.

UN_NodeTypeRegistry& UN_UniCategory::nodeTypeRegistry ( )

inline

Returns the node type registry for this category.

Definition at line 44 of file UN_UniCategory.h.

UT_Array<UNI_Signature> UN_UniCategory::nodeTypeSignatures ( const UT_StringRef & type_name ) const

overridevirtual

Required overrides from the base class.

Implements UNI_Category.

ToolInfo UN_UniCategory::nodeTypeToolInfo ( const UT_StringRef & type_name ) const

overridevirtual

Required overrides from the base class.

Implements UNI_Category.

const UN_ParmTypeRegistry& UN_UniCategory::parmTypeRegistry ( ) const

inline

Returns the node parameter type registry for this category.

Definition at line 56 of file UN_UniCategory.h.

UN_ParmTypeRegistry& UN_UniCategory::parmTypeRegistry ( )

inline

Returns the node parameter type registry for this category.

Definition at line 58 of file UN_UniCategory.h.

const UN_PortTypeRegistry& UN_UniCategory::portTypeRegistry ( ) const

inline

Returns the node port type registry for this category.

Definition at line 49 of file UN_UniCategory.h.

UN_PortTypeRegistry& UN_UniCategory::portTypeRegistry ( )

inline

Returns the node port type registry for this category.

Definition at line 51 of file UN_UniCategory.h.

void UN_UniCategory::setSubnetNodeTypeName ( const UT_StringRef & name )

inline

Sets the node type name of the generic subnet.

Definition at line 63 of file UN_UniCategory.h.

bool UN_UniCategory::shouldGenerateToolForNodeType ( const UT_StringRef & type_name ) const

overridevirtual

Required overrides from the base class.

Implements UNI_Category.

UT_StringHolder UN_UniCategory::subnetNodeTypeName ( ) const

overridevirtual

Required overrides from the base class.

Implements UNI_Category.

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

UN/UN_UniCategory.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation