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

#include <DS_Creator.h>

Public Member Functions

 DS_Creator (DS_ParmReader &pr, const char *appName=DS_DEFNAME)
 
virtual ~DS_Creator ()
 
int openOutput (std::ostream &os)
 
int closeOutput ()
 
int prepareToWriteOutput ()
 
int writeOutput ()
 
void setParmDSOverride (const char *parm_ds)
 

Static Public Member Functions

static void setUseOldGrouping (bool useold)
 
static bool getUseOldGrouping ()
 
static const char * getIndent (int level)
 
static void dumpParm (const DS_ParmInfo *pi)
 

Static Public Attributes

static const char * theToolboxLabels []
 

Protected Member Functions

void writeUnboundSelectors (DS_SelectorList &selectors)
 
void writeReservedSelectors (DS_SelectorList &selectors)
 
void writeReservedHandles (DS_HandleList &handles)
 
void writeBoundHandles (DS_HandleList &handles)
 
void writeMetaInfo ()
 
void writeParms () const
 
virtual void writeContextSpecific ()
 
virtual int writeInfo ()
 
virtual void writeHeader (const char *appname, const char *script)
 
virtual void writeTrailer (const char *appname, const char *script)
 

Static Protected Member Functions

static void startGroup (std::ostream &os, int &id, const char *name)
 
static void printParm (std::ostream &os, const DS_ParmInfo *pi)
 
static void printHelp (std::ostream &os, const char *help)
 
static void printInfo (std::ostream &os, const char *info)
 

Protected Attributes

DS_ParmReadermyPR
 
UT_String myAppName
 
std::ostream * myOS
 
UT_String myParmDSOverride
 

Static Protected Attributes

static UT_StringArray theGroupStack
 
static bool theUseOldGrouping
 

Detailed Description

Definition at line 26 of file DS_Creator.h.

Constructor & Destructor Documentation

DS_Creator::DS_Creator ( DS_ParmReader pr,
const char *  appName = DS_DEFNAME 
)
virtual DS_Creator::~DS_Creator ( )
virtual

Member Function Documentation

int DS_Creator::closeOutput ( )
static void DS_Creator::dumpParm ( const DS_ParmInfo pi)
static
static const char* DS_Creator::getIndent ( int  level)
static

Returns an indentation string for the given indent level.

The string is kept in a static buffer, which has the advantage of automatically caching it, but you are thus meant to call getIndent pretty much every time you want to indent something

static bool DS_Creator::getUseOldGrouping ( )
static
int DS_Creator::openOutput ( std::ostream &  os)
int DS_Creator::prepareToWriteOutput ( )
static void DS_Creator::printHelp ( std::ostream &  os,
const char *  help 
)
staticprotected
static void DS_Creator::printInfo ( std::ostream &  os,
const char *  info 
)
staticprotected
static void DS_Creator::printParm ( std::ostream &  os,
const DS_ParmInfo pi 
)
staticprotected
void DS_Creator::setParmDSOverride ( const char *  parm_ds)
inline

Definition at line 39 of file DS_Creator.h.

static void DS_Creator::setUseOldGrouping ( bool  useold)
static
static void DS_Creator::startGroup ( std::ostream &  os,
int id,
const char *  name 
)
staticprotected
void DS_Creator::writeBoundHandles ( DS_HandleList handles)
protected
virtual void DS_Creator::writeContextSpecific ( )
protectedvirtual
virtual void DS_Creator::writeHeader ( const char *  appname,
const char *  script 
)
protectedvirtual
virtual int DS_Creator::writeInfo ( )
protectedvirtual
void DS_Creator::writeMetaInfo ( )
protected
int DS_Creator::writeOutput ( )
void DS_Creator::writeParms ( ) const
protected
void DS_Creator::writeReservedHandles ( DS_HandleList handles)
protected
void DS_Creator::writeReservedSelectors ( DS_SelectorList selectors)
protected
virtual void DS_Creator::writeTrailer ( const char *  appname,
const char *  script 
)
protectedvirtual
void DS_Creator::writeUnboundSelectors ( DS_SelectorList selectors)
protected

Member Data Documentation

UT_String DS_Creator::myAppName
protected

Definition at line 75 of file DS_Creator.h.

std::ostream* DS_Creator::myOS
protected

Definition at line 76 of file DS_Creator.h.

UT_String DS_Creator::myParmDSOverride
protected

Definition at line 77 of file DS_Creator.h.

DS_ParmReader& DS_Creator::myPR
protected

Definition at line 74 of file DS_Creator.h.

UT_StringArray DS_Creator::theGroupStack
staticprotected

Definition at line 79 of file DS_Creator.h.

const char* DS_Creator::theToolboxLabels[]
static

Definition at line 52 of file DS_Creator.h.

bool DS_Creator::theUseOldGrouping
staticprotected

Definition at line 80 of file DS_Creator.h.


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