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

#include <UN_PortType.h>

Public Member Functions

const UT_StringHoldername () const
 Returns the name of the port type. More...
 
 UN_PortType (const UT_StringRef &port_type_name)
 Constructor and destructor. More...
 
 ~UN_PortType ()
 Constructor and destructor. More...
 
void setColorName (const UT_StringRef &color_name)
 
const UT_StringHoldercolorName () const
 

Detailed Description

The port type is a characteristics of a port that dertermines compatibility and connectivity with other ports based on their types.

Definition at line 26 of file UN_PortType.h.

Constructor & Destructor Documentation

UN_PortType::UN_PortType ( const UT_StringRef port_type_name)

Constructor and destructor.

UN_PortType::~UN_PortType ( )

Constructor and destructor.

Member Function Documentation

const UT_StringHolder& UN_PortType::colorName ( ) const
inline

The name of a color for this type of ports in the graph editor. The actual color is configurable via color schemes (eg, UILight.hcs), so the name adheres to the UIgetMiscColor() conventions.

Definition at line 44 of file UN_PortType.h.

const UT_StringHolder& UN_PortType::name ( void  ) const
inline

Returns the name of the port type.

Definition at line 36 of file UN_PortType.h.

void UN_PortType::setColorName ( const UT_StringRef color_name)
inline

The name of a color for this type of ports in the graph editor. The actual color is configurable via color schemes (eg, UILight.hcs), so the name adheres to the UIgetMiscColor() conventions.

Definition at line 42 of file UN_PortType.h.


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