CmdLineOptions Class Reference

List of all members.

Public Member Functions

 CmdLineOptions (int argc, char *argv[])
const string & getSingleOutFilename ()
const string & getSingleInFilename () const
const string & getOutDirectory ()
const string getStyleOutFilename () const
const string & getStyleInFilename () const
const string & getEncoding () const
int getNumberSpaces () const
bool printVersion () const
bool printHelp () const
bool printDebugInfo () const
bool includeStyleDef () const
bool printLineNumbers () const
string getStyleName () const
int helpLanguage () const
bool enableBatchMode () const
bool fragmentOutput () const
string getOutFileSuffix () const
bool attachLineAnchors () const
bool showThemes () const
bool showLangdefs () const
bool outDirGiven () const
bool formattingEnabled ()
bool dataDirGiven () const
bool additionalDataDirGiven () const
bool printIndexFile () const
bool replaceQuotes () const
bool disableBabelShorthands () const
const string & getDataDir () const
const string & getAdditionalDataDir () const
bool syntaxGiven () const
bool quietMode () const
bool fopCompatible () const
bool printProgress () const
bool fillLineNrZeroes () const
const string getHelpLang () const
const string & getLanguage () const
highlight::WrapMode getWrappingStyle () const
const vector< string > & getInputFileNames () const
const string & getIndentScheme () const
const string & getPageSize () const
highlight::OutputType getOutputType () const
bool formatSupportsExtStyle ()
bool styleOutPathDefined () const
bool omitEncoding () const
bool forceOutput () const
bool orderedList () const
bool hasBaseFont () const
const string & getBaseFont () const
bool hasBaseFontSize () const
const string & getBaseFontSize () const
int getNumberWidth ()
int getNumberStart ()

Detailed Description

Command line options


Constructor & Destructor Documentation

CmdLineOptions::CmdLineOptions ( int  argc,
char *  argv[] 
)

Constructor

Parameters:
argc Argument count
argv Argument strings


Member Function Documentation

const string & CmdLineOptions::getSingleOutFilename (  ) 

Returns:
Single output file name

const string & CmdLineOptions::getSingleInFilename (  )  const

Returns:
Single input file name

const string & CmdLineOptions::getOutDirectory (  ) 

Returns:
Output directory

const string CmdLineOptions::getStyleOutFilename (  )  const

Returns:
Style output file name

const string & CmdLineOptions::getStyleInFilename (  )  const

Returns:
Style input file name

const string & CmdLineOptions::getEncoding (  )  const

Returns:
Char set

int CmdLineOptions::getNumberSpaces (  )  const

Returns:
Number of spaces to replace a tab

bool CmdLineOptions::printVersion (  )  const

Returns:
True if version information should be printed

bool CmdLineOptions::printHelp (  )  const

Returns:
True if help information should be printed

bool CmdLineOptions::printDebugInfo (  )  const

Returns:
True if debug information should be printed

bool CmdLineOptions::includeStyleDef (  )  const

Returns:
True if Style definition should be included in output

bool CmdLineOptions::printLineNumbers (  )  const

Returns:
True if line numbers should be printed

string CmdLineOptions::getStyleName (  )  const

Returns:
colour theme name

int CmdLineOptions::helpLanguage (  )  const

gibt true zurck, falls deutsche Hilfe ausgegeben werden soll

bool CmdLineOptions::enableBatchMode (  )  const

Returns:
True if batch mode is active

bool CmdLineOptions::fragmentOutput (  )  const

Returns:
True if output shluld be fragmented

string CmdLineOptions::getOutFileSuffix (  )  const

Returns:
output file suffix

bool CmdLineOptions::attachLineAnchors (  )  const

Returns:
True if anchors should be attached to line numbers

bool CmdLineOptions::showThemes (  )  const

Returns:
True if list of installed themes should be printed

bool CmdLineOptions::showLangdefs (  )  const

Returns:
True if list of installed language definitions should be printed

bool CmdLineOptions::outDirGiven (  )  const

Returns:
True if loutput directory is given

bool CmdLineOptions::formattingEnabled (  ) 

Returns:
True if refomatting is enabled

bool CmdLineOptions::dataDirGiven (  )  const

Returns:
True if a new data directory is given

bool CmdLineOptions::additionalDataDirGiven (  )  const

Returns:
True if an additional data directory is given

bool CmdLineOptions::printIndexFile (  )  const

Returns:
True if index file should be printed

bool CmdLineOptions::replaceQuotes (  )  const

Returns:
True if quotes should be replaced by /dq in LaTeX

bool CmdLineOptions::disableBabelShorthands (  )  const

Returns:
True if shorthands of LaTeX Babel package should be disabled

const string & CmdLineOptions::getDataDir (  )  const

Returns:
Data directory

const string & CmdLineOptions::getAdditionalDataDir (  )  const

Returns:
Additional data directory

bool CmdLineOptions::syntaxGiven (  )  const

Returns:
True if language syntax is given

bool CmdLineOptions::quietMode (  )  const

Returns:
True if quiet mode is active

bool CmdLineOptions::fopCompatible (  )  const

Returns:
True if XSL-FO output should be FOP compatible

bool CmdLineOptions::printProgress (  )  const

Returns:
True if progress bar should be printed in batch mode

bool CmdLineOptions::fillLineNrZeroes (  )  const

Returns:
True if line numbers are filled with leading zeroes

const string CmdLineOptions::getHelpLang (  )  const

Returns:
name of help message file

const string & CmdLineOptions::getLanguage (  )  const

Returns:
programming language

highlight::WrapMode CmdLineOptions::getWrappingStyle (  )  const

Returns:
Wrapping style

const vector< string > & CmdLineOptions::getInputFileNames (  )  const

Returns:
List of input file names

const string & CmdLineOptions::getIndentScheme (  )  const

Returns:
Name of indentation scheme file

const string & CmdLineOptions::getPageSize (  )  const

Returns:
RTF page size

highlight::OutputType CmdLineOptions::getOutputType (  )  const

Returns:
Output file format

bool CmdLineOptions::formatSupportsExtStyle (  ) 

Returns:
True if chosen output format supports referenced style files

bool CmdLineOptions::styleOutPathDefined (  )  const [inline]

Returns:
True if style output path was defined by user

bool CmdLineOptions::omitEncoding (  )  const

Returns:
True if encoding specification should be omitted in output

bool CmdLineOptions::forceOutput (  )  const

Returns:
True if output should be generated if languege type is unknown

bool CmdLineOptions::orderedList (  )  const

Returns:
True if line numbers should be replaced by ordered list (HTML)

bool CmdLineOptions::hasBaseFont (  )  const

Returns:
True if a base font has been given

const string & CmdLineOptions::getBaseFont (  )  const

Returns:
The given base font, empty string by default

bool CmdLineOptions::hasBaseFontSize (  )  const

Returns:
True if a base font size has been given

const string & CmdLineOptions::getBaseFontSize (  )  const

Returns:
The given base font size, empty string by default

int CmdLineOptions::getNumberWidth (  ) 

Returns:
line number width

int CmdLineOptions::getNumberStart (  ) 

Returns:
Line number start count


The documentation for this class was generated from the following files:
Generated on Fri Apr 27 13:12:36 2007 for Highlight Code Converter by  doxygen 1.5.2