#include <UNI_Node.h>

Inheritance diagram for UNI_ConstNode:

Public Member Functions
bool	isRootNode () const
	Returns true if this is the graph root node. More...

bool	isSubnet () const
	Returns true if this node is a subnet (can contain other nodes). More...

bool	isEditableSubnet () const
	Returns true if this subnet's contents can be modified. More...

bool	isEditable () const
	Returns true if this is the graph root node. More...

UT_StringHolder	name () const
	Returns the name of the node. More...

UT_StringHolder	path () const
	Return the full path from the root of the graph to this node. More...

UT_StringHolder	categoryName () const
	Returns the category name of the node. More...

UT_StringHolder	typeName () const
	Returns the type name of the node. More...

UT_StringHolder	signatureName () const
	Returns the name of the current signature of this node. More...

UT_Vector2D	position () const
	Returns the node position in the graph editor. More...

UT_Color	color () const
	Returns the color tint of the node in the graph editor. More...

UT_StringHolder	iconName () const
	Returns the icon name for the given node. More...

UT_StringHolder	comment () const
	Returns the comment for the node. More...

UT_StringArray	tags () const
	Returns the tags (a set of keywords) assigned to the node. More...

UT_StringHolder	parmDialogScript () const
	Returns a dialog script describing this node's parms. More...

UNI_ParmValue	parmValue (const UT_StringRef &parm_name) const
	Get the value of a parm on this node. More...

UNI_NodeID	parent () const

UNI_NodeID	findNode (const UT_StringRef &path) const

UNI_NodeIDList	childNodes () const
	Returns array of ids of all direct children of this node. More...

UNI_StickyNoteIDList	childStickyNotes () const
	Returns all sticky notes contained by this node. More...

UNI_StickyNoteID	findStickyNote (const UT_StringRef &path) const
	Find a sticky note using a path specified relative to this node. More...

UNI_PortIDList	inputPorts () const
	Input ports of a node. More...

UNI_PortIDList	outputPorts () const
	Output ports of a node. More...

bool	hasDynamicPorts (UNI_NodeID node_id) const
	Does this node have dynamic input or output ports (not subports). More...

UT_Vector2D	containerConnectPosition (UNI_ContainerConnectType contype) const

UT_Color	containerConnectColor (UNI_ContainerConnectType contype) const

bool	copyItems (const UNI_NodeIDList &node_ids, const UNI_StickyNoteIDList &note_ids, std::ostream &os) const
	Copy items contained by this node. More...

Public Member Functions inherited from UNI_ConstItem< UNI_NodeID >
	UNI_ConstItem ()=default
	Constructor. More...

	UNI_ConstItem (const UNI_ConstGraphHandle &graph_handle, UNI_NodeIDid)

	UNI_ConstItem (UNI_ConstGraphHandle &&graph_handle, UNI_NodeIDid)
	Constructor with r-value for the intrusive graph pointer. More...

const UNI_Graph *	graph () const
	Returns the graph inside which the node lives. More...

UNI_NodeID	id () const
	Returns the ID of the node in the graph. More...

bool	isValid () const

	operator bool () const

Additional Inherited Members
Protected Member Functions inherited from UNI_ConstItem< UNI_NodeID >
const UNI_ConstGraphHandle &	graphHandle () const
	Returns the underlying graph handle. More...

Detailed Description

Definition at line 19 of file UNI_Node.h.

Member Function Documentation

UT_StringHolder UNI_ConstNode::categoryName ( ) const

inline

Returns the category name of the node.

Definition at line 45 of file UNI_Node.h.

UNI_NodeIDList UNI_ConstNode::childNodes ( ) const

inline

Returns array of ids of all direct children of this node.

Definition at line 88 of file UNI_Node.h.

UNI_StickyNoteIDList UNI_ConstNode::childStickyNotes ( ) const

inline

Returns all sticky notes contained by this node.

Definition at line 92 of file UNI_Node.h.

UT_Color UNI_ConstNode::color ( ) const

inline

Returns the color tint of the node in the graph editor.

Definition at line 57 of file UNI_Node.h.

UT_StringHolder UNI_ConstNode::comment ( ) const

inline

Returns the comment for the node.

Definition at line 63 of file UNI_Node.h.

UT_Color UNI_ConstNode::containerConnectColor ( UNI_ContainerConnectType contype ) const

inline

The color of the UI gadget for connecting to inputs or outputs of the container node.

Definition at line 115 of file UNI_Node.h.

UT_Vector2D UNI_ConstNode::containerConnectPosition ( UNI_ContainerConnectType contype ) const

inline

The position of the UI gadget for connecting to inputs or outputs of the container node.

Definition at line 110 of file UNI_Node.h.

bool UNI_ConstNode::copyItems	(	const UNI_NodeIDList &	node_ids,
		const UNI_StickyNoteIDList &	note_ids,
		std::ostream &	os
	)		const

inline

Copy items contained by this node.

Definition at line 120 of file UNI_Node.h.

UNI_NodeID UNI_ConstNode::findNode ( const UT_StringRef & path ) const

inline

Returns the id of the node specified by the provided path, which may be absolute or relative to this node.

Definition at line 85 of file UNI_Node.h.

UNI_StickyNoteID UNI_ConstNode::findStickyNote ( const UT_StringRef & path ) const

inline

Find a sticky note using a path specified relative to this node.

Definition at line 95 of file UNI_Node.h.

bool UNI_ConstNode::hasDynamicPorts ( UNI_NodeID node_id ) const

inline

Does this node have dynamic input or output ports (not subports).

Definition at line 105 of file UNI_Node.h.

UT_StringHolder UNI_ConstNode::iconName ( ) const

inline

Returns the icon name for the given node.

Definition at line 60 of file UNI_Node.h.

UNI_PortIDList UNI_ConstNode::inputPorts ( ) const

inline

Input ports of a node.

Definition at line 99 of file UNI_Node.h.

bool UNI_ConstNode::isEditable ( ) const

inline

Returns true if this is the graph root node.

Definition at line 36 of file UNI_Node.h.

bool UNI_ConstNode::isEditableSubnet ( ) const

inline

Returns true if this subnet's contents can be modified.

Definition at line 33 of file UNI_Node.h.

bool UNI_ConstNode::isRootNode ( ) const

inline

Returns true if this is the graph root node.

Definition at line 26 of file UNI_Node.h.

bool UNI_ConstNode::isSubnet ( ) const

inline

Returns true if this node is a subnet (can contain other nodes).

Definition at line 30 of file UNI_Node.h.

UT_StringHolder UNI_ConstNode::name ( void ) const

inline

Returns the name of the node.

Definition at line 39 of file UNI_Node.h.

UNI_PortIDList UNI_ConstNode::outputPorts ( ) const

inline

Output ports of a node.

Definition at line 102 of file UNI_Node.h.

UNI_NodeID UNI_ConstNode::parent ( ) const

inline

Returns the id of our parent node. This may be the root node. The parent of the root node will be an invalid node.

Definition at line 77 of file UNI_Node.h.

UT_StringHolder UNI_ConstNode::parmDialogScript ( ) const

inline

Returns a dialog script describing this node's parms.

Definition at line 69 of file UNI_Node.h.

UNI_ParmValue UNI_ConstNode::parmValue ( const UT_StringRef & parm_name ) const

inline

Get the value of a parm on this node.

Definition at line 72 of file UNI_Node.h.

UT_StringHolder UNI_ConstNode::path ( ) const

inline

Return the full path from the root of the graph to this node.

Definition at line 42 of file UNI_Node.h.

UT_Vector2D UNI_ConstNode::position ( ) const

inline

Returns the node position in the graph editor.

Definition at line 54 of file UNI_Node.h.

UT_StringHolder UNI_ConstNode::signatureName ( ) const

inline

Returns the name of the current signature of this node.

Definition at line 51 of file UNI_Node.h.

UT_StringArray UNI_ConstNode::tags ( ) const

inline

Returns the tags (a set of keywords) assigned to the node.

Definition at line 66 of file UNI_Node.h.

UT_StringHolder UNI_ConstNode::typeName ( ) const

inline

Returns the type name of the node.

Definition at line 48 of file UNI_Node.h.

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

UNI/UNI_Node.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation