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

Parameters for OP_Node::getInfoText()/OP_Node::getNodeSpecificInfoText() More...

#include <OP_NodeInfoParms.h>

Public Member Functions

 OP_NodeInfoParms ()
 
 ~OP_NodeInfoParms ()
 
void clearText ()
 Clear the text. More...
 
UT_WorkBuffergetText ()
 The text buffer in which to write the information. More...
 
void append (const char *string)
 Append a string to the text buffer. More...
 
int appendSprintf (const char *format,...) SYS_PRINTF_CHECK_ATTRIBUTE(2
 
int void appendSeparator ()
 Append a section separator. More...
 
void appendNotCooked (const char *node_type="Node")
 Append "not cooked". More...
 
void replaceSeparators (char dash='_')
 
void setVerbose (bool v)
 
bool getVerbose () const
 
void setForceCook (bool v)
 
bool getForceCook () const
 
void setSeparatorLength (int v)
 
int getSeparatorLength () const
 

Static Public Member Functions

static const char * getSeparatorToken ()
 

Detailed Description

Parameters for OP_Node::getInfoText()/OP_Node::getNodeSpecificInfoText()

Examples:
SOP/SOP_PrimVOP.C, and SOP/SOP_PrimVOP.h.

Definition at line 18 of file OP_NodeInfoParms.h.

Constructor & Destructor Documentation

OP_NodeInfoParms::OP_NodeInfoParms ( )
inlineexplicit

Definition at line 21 of file OP_NodeInfoParms.h.

OP_NodeInfoParms::~OP_NodeInfoParms ( )
inline

Definition at line 27 of file OP_NodeInfoParms.h.

Member Function Documentation

void OP_NodeInfoParms::append ( const char *  string)
inline

Append a string to the text buffer.

Examples:
SOP/SOP_PrimVOP.C.

Definition at line 39 of file OP_NodeInfoParms.h.

void OP_NodeInfoParms::appendNotCooked ( const char *  node_type = "Node")

Append "not cooked".

int void OP_NodeInfoParms::appendSeparator ( )

Append a section separator.

Examples:
SOP/SOP_PrimVOP.C.
int OP_NodeInfoParms::appendSprintf ( const char *  format,
  ... 
)

Append text to the buffer. If you have a single string to append, to avoid printf errors in the string text, please use:

append("%s", string);
void OP_NodeInfoParms::clearText ( )
inline

Clear the text.

Definition at line 31 of file OP_NodeInfoParms.h.

bool OP_NodeInfoParms::getForceCook ( ) const
inline

Force cook

Definition at line 71 of file OP_NodeInfoParms.h.

int OP_NodeInfoParms::getSeparatorLength ( ) const
inline

Separator length

Definition at line 79 of file OP_NodeInfoParms.h.

static const char* OP_NodeInfoParms::getSeparatorToken ( )
static

Return the separator string token (which is replaced in replaceSeparators()).

UT_WorkBuffer& OP_NodeInfoParms::getText ( )
inline

The text buffer in which to write the information.

Definition at line 35 of file OP_NodeInfoParms.h.

bool OP_NodeInfoParms::getVerbose ( ) const
inline

Verbose info

Definition at line 63 of file OP_NodeInfoParms.h.

void OP_NodeInfoParms::replaceSeparators ( char  dash = '_')

Make a separator line (prefixed and suffixed with newlines). The separator will be a line of '-' which matches the line length of the longest line in the text (or getSeparatorLength() if the lines are too long).

void OP_NodeInfoParms::setForceCook ( bool  v)
inline

Force cook

Definition at line 69 of file OP_NodeInfoParms.h.

void OP_NodeInfoParms::setSeparatorLength ( int  v)
inline

Separator length

Definition at line 77 of file OP_NodeInfoParms.h.

void OP_NodeInfoParms::setVerbose ( bool  v)
inline

Verbose info

Definition at line 61 of file OP_NodeInfoParms.h.


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