HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UN_NodeTypeRegistry Class Reference

#include <UN_NodeTypeRegistry.h>

+ Inheritance diagram for UN_NodeTypeRegistry:

Public Types

using Base = UN_TypeRegistry< UN_NodeType >
 
using NodeTypeHandle = UT_UniquePtr< UN_NodeType >
 
- Public Types inherited from UN_TypeRegistry< UN_NodeType >
using TypeHandle = UT_UniquePtr< UN_NodeType >
 Defining a handle to express ownership management. More...
 
using TypeRange = UT_IteratorRange< TypeIterator >
 Returns an iterator range over the registered types. More...
 

Public Member Functions

void setNodeTypeNameSafeChars (const UT_StringRef &safe_chars)
 A set of additional characters that are legal in node type names. More...
 
bool isValidTypeName (const UT_StringRef &node_type_name) const
 Returns true if the given node type name is valid in this category. More...
 
bool addType (UN_NodeTypeHandle node_type)
 Adds the given type to the reigstry. More...
 
bool removeType (const UT_StringRef &node_type_name)
 Removes the given type from the reigstry. More...
 
const UN_NodeTypefindType (const UT_StringRef &type_name) const
 Returns a type by the given name, or null if not found. More...
 
const UT_StringArraytypeNamesFromSignature (const UT_StringRef &signature_name) const
 Returns the list of node type names that provide the given signature. More...
 
UT_NotifierImpl< const
UNI_NodeTypeEvent & > & 
getEventNotifier ()
 
 UN_NodeTypeRegistry (UNI_Category &category)
 Constructor and destructor. More...
 
- Public Member Functions inherited from UN_TypeRegistry< UN_NodeType >
const UT_StringArraytypeNames () const
 Returns the list of the type names in this registry. More...
 
TypeRange typeRange () const
 
const UN_NodeTypefindType (const UT_StringRef &type_name) const
 Returns a type by the given name, or null if not found. More...
 
 UN_TypeRegistry ()=default
 Constructor and destructor. More...
 
 ~UN_TypeRegistry ()=default
 Constructor and destructor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from UN_TypeRegistry< UN_NodeType >
bool addType (TypeHandle type_handle)
 
bool removeType (const UT_StringRef &node_type_name)
 

Detailed Description

A registry that maintains the set of node types.

Definition at line 25 of file UN_NodeTypeRegistry.h.

Member Typedef Documentation

Constructor & Destructor Documentation

UN_NodeTypeRegistry::UN_NodeTypeRegistry ( UNI_Category category)

Constructor and destructor.

Member Function Documentation

bool UN_NodeTypeRegistry::addType ( UN_NodeTypeHandle  node_type)

Adds the given type to the reigstry.

const UN_NodeType* UN_NodeTypeRegistry::findType ( const UT_StringRef type_name) const

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

UT_NotifierImpl<const UNI_NodeTypeEvent &>& UN_NodeTypeRegistry::getEventNotifier ( )
inline

Returns an object for notifying interested parties about changes to the registry (eg, adding a new or removing old node type).

Definition at line 63 of file UN_NodeTypeRegistry.h.

bool UN_NodeTypeRegistry::isValidTypeName ( const UT_StringRef node_type_name) const
inline

Returns true if the given node type name is valid in this category.

Definition at line 42 of file UN_NodeTypeRegistry.h.

bool UN_NodeTypeRegistry::removeType ( const UT_StringRef node_type_name)

Removes the given type from the reigstry.

void UN_NodeTypeRegistry::setNodeTypeNameSafeChars ( const UT_StringRef safe_chars)
inline

A set of additional characters that are legal in node type names.

Definition at line 36 of file UN_NodeTypeRegistry.h.

const UT_StringArray& UN_NodeTypeRegistry::typeNamesFromSignature ( const UT_StringRef signature_name) const

Returns the list of node type names that provide the given signature.


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