UN_GraphConfig Class Reference

#include <UN_GraphConfig.h>

Public Member Functions
void	setForceValidUniqueGraphItemNames (bool flag)
bool	shouldForceValidGraphItemNames () const
void	setForceValidGraphItemNames (bool flag)
const UT_StringHolder &	graphItemNameSafeChars () const
	A set of additional characters that are legal in node names. More...
void	setGraphItemNameSafeChars (const UT_StringRef &safe_chars)
	A set of additional characters that are legal in node names. More...
bool	shouldForceUniqueGraphItemNames () const
void	setForceUniqueGraphItemNames (bool flag)
bool	usesRegistryNodeTypes () const
void	useRegistryNodeTypes (bool flag)
bool	shouldForceValidPortNames () const
	A flag that ensures all the ports have an alphanumeric name. More...
void	setForceValidPortNames (bool flag)
	A flag that ensures all the ports have an alphanumeric name. More...
bool	shouldForceValidPortTypeNames () const
void	setForceValidPortTypeNames (bool flag)

Detailed Description

The graph configuration class. It contains info about specific aspects of a graph, eg, whether nodes require alphanumeric and/or unique names.

Definition at line 23 of file UN_GraphConfig.h.

Member Function Documentation

const UT_StringHolder& UN_GraphConfig::graphItemNameSafeChars ( ) const

inline

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

Definition at line 46 of file UN_GraphConfig.h.

void UN_GraphConfig::setForceUniqueGraphItemNames ( bool  flag )

inline

A flag that ensures all the nodes have names that are unique among their siblings within a subnet.

Definition at line 57 of file UN_GraphConfig.h.

void UN_GraphConfig::setForceValidGraphItemNames ( bool  flag )

inline

A flag that ensures all graph items (nodes, sticky notes, etc) have an alphanumeric name.

Definition at line 41 of file UN_GraphConfig.h.

void UN_GraphConfig::setForceValidPortNames ( bool  flag )

inline

A flag that ensures all the ports have an alphanumeric name.

Definition at line 73 of file UN_GraphConfig.h.

void UN_GraphConfig::setForceValidPortTypeNames ( bool  flag )

inline

A flag that ensures an alphanumeric node type names. This is useful for future-proofing namespacing, versioning, etc.

Definition at line 81 of file UN_GraphConfig.h.

void UN_GraphConfig::setForceValidUniqueGraphItemNames ( bool  flag )

inline

Set the flag to ensure the graph item names (such as node or sticky note names) are both alphanumeric and also unique among their siblings in the subnet. These two options are usually set in tandem, for pattern matching in scripts and for identifying nodes using paths.

Definition at line 31 of file UN_GraphConfig.h.

void UN_GraphConfig::setGraphItemNameSafeChars ( const UT_StringRef &  safe_chars )

inline

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

Definition at line 48 of file UN_GraphConfig.h.

bool UN_GraphConfig::shouldForceUniqueGraphItemNames ( ) const

inline

A flag that ensures all the nodes have names that are unique among their siblings within a subnet.

Definition at line 55 of file UN_GraphConfig.h.

bool UN_GraphConfig::shouldForceValidGraphItemNames ( ) const

inline

A flag that ensures all graph items (nodes, sticky notes, etc) have an alphanumeric name.

Definition at line 39 of file UN_GraphConfig.h.

bool UN_GraphConfig::shouldForceValidPortNames ( ) const

inline

A flag that ensures all the ports have an alphanumeric name.

Definition at line 71 of file UN_GraphConfig.h.

bool UN_GraphConfig::shouldForceValidPortTypeNames ( ) const

inline

A flag that ensures an alphanumeric node type names. This is useful for future-proofing namespacing, versioning, etc.

Definition at line 79 of file UN_GraphConfig.h.

void UN_GraphConfig::useRegistryNodeTypes ( bool  flag )

inline

A flag that indicates whether the graph should use the node types registered with the UN manager. Setting this flag to true validates the node type name when creating a new node.

Definition at line 66 of file UN_GraphConfig.h.

bool UN_GraphConfig::usesRegistryNodeTypes ( ) const

inline

A flag that indicates whether the graph should use the node types registered with the UN manager. Setting this flag to true validates the node type name when creating a new node.

Definition at line 64 of file UN_GraphConfig.h.

---

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

• UN/UN_GraphConfig.h