OutputGenerator Class Reference

Abstract output generator. More...

#include <outputgen.h>

Inheritance diagram for OutputGenerator:

BaseOutputDocInterface CodeOutputInterface HtmlGenerator LatexGenerator ManGenerator RTFGenerator List of all members.

Public Types

enum  OutputType {
  Html, Latex, Man, RTF,
  XML, DEF, Perl
}

Public Member Functions

 OutputGenerator ()
virtual ~OutputGenerator ()
virtual void enable ()=0
virtual void disable ()=0
virtual void enableIf (OutputType o)=0
virtual void disableIf (OutputType o)=0
virtual void disableIfNot (OutputType o)=0
virtual bool isEnabled (OutputType o)=0
virtual OutputGeneratorget (OutputType o)=0
void startPlainFile (const char *name)
void endPlainFile ()
QCString getContents () const
bool isEnabled () const
void pushGeneratorState ()
void popGeneratorState ()
void setEncoding (const QCString &enc)
virtual void postProcess (QByteArray &)
virtual void printDoc (DocNode *, const char *langExt)=0
virtual void startFile (const char *name, const char *manName, const char *title)=0
virtual void writeFooter ()=0
virtual void endFile ()=0
virtual void startIndexSection (IndexSections)=0
virtual void endIndexSection (IndexSections)=0
virtual void writePageLink (const char *, bool)=0
virtual void startProjectNumber ()=0
virtual void endProjectNumber ()=0
virtual void writeStyleInfo (int part)=0
virtual void startTitleHead (const char *)=0
virtual void endTitleHead (const char *fileName, const char *name)=0
virtual void startIndexList ()=0
virtual void endIndexList ()=0
virtual void startIndexKey ()=0
virtual void endIndexKey ()=0
virtual void startIndexValue (bool)=0
virtual void endIndexValue (const char *, bool)=0
virtual void startIndexItem (const char *ref, const char *file)=0
virtual void endIndexItem (const char *ref, const char *file)=0
virtual void startGroupHeader ()=0
virtual void endGroupHeader ()=0
virtual void startMemberSections ()=0
virtual void endMemberSections ()=0
virtual void startMemberHeader ()=0
virtual void endMemberHeader ()=0
virtual void startMemberSubtitle ()=0
virtual void endMemberSubtitle ()=0
virtual void startMemberDocList ()=0
virtual void endMemberDocList ()=0
virtual void startMemberList ()=0
virtual void endMemberList ()=0
virtual void startAnonTypeScope (int)=0
virtual void endAnonTypeScope (int)=0
virtual void startMemberItem (int)=0
virtual void endMemberItem ()=0
virtual void startMemberTemplateParams ()=0
virtual void endMemberTemplateParams ()=0
virtual void startMemberGroupHeader (bool)=0
virtual void endMemberGroupHeader ()=0
virtual void startMemberGroupDocs ()=0
virtual void endMemberGroupDocs ()=0
virtual void startMemberGroup ()=0
virtual void endMemberGroup (bool)=0
virtual void insertMemberAlign (bool)=0
virtual void startMemberDoc (const char *, const char *, const char *, const char *)=0
virtual void endMemberDoc (bool)=0
virtual void startDoxyAnchor (const char *fName, const char *manName, const char *anchor, const char *name, const char *args)=0
virtual void endDoxyAnchor (const char *fileName, const char *anchor)=0
virtual void writeLatexSpacing ()=0
virtual void writeStartAnnoItem (const char *type, const char *file, const char *path, const char *name)=0
virtual void writeEndAnnoItem (const char *name)=0
virtual void startMemberDescription ()=0
virtual void endMemberDescription ()=0
virtual void startIndent ()=0
virtual void endIndent ()=0
virtual void writeSynopsis ()=0
virtual void startClassDiagram ()=0
virtual void endClassDiagram (const ClassDiagram &, const char *, const char *)=0
virtual void startDotGraph ()=0
virtual void endDotGraph (const DotClassGraph &g)=0
virtual void startInclDepGraph ()=0
virtual void endInclDepGraph (const DotInclDepGraph &g)=0
virtual void startGroupCollaboration ()=0
virtual void endGroupCollaboration (const DotGroupCollaboration &g)=0
virtual void startCallGraph ()=0
virtual void endCallGraph (const DotCallGraph &g)=0
virtual void startDirDepGraph ()=0
virtual void endDirDepGraph (const DotDirDeps &g)=0
virtual void writeGraphicalHierarchy (const DotGfxHierarchyTable &g)=0
virtual void startQuickIndices ()=0
virtual void endQuickIndices ()=0
virtual void writeQuickLinks (bool compact, HighlightedItem hli)=0
virtual void startContents ()=0
virtual void endContents ()=0
virtual void startTextBlock (bool)=0
virtual void endTextBlock (bool)=0
virtual void lastIndexPage ()=0
virtual void startMemberDocPrefixItem ()=0
virtual void endMemberDocPrefixItem ()=0
virtual void startMemberDocName (bool)=0
virtual void endMemberDocName ()=0
virtual void startParameterType (bool, const char *)=0
virtual void endParameterType ()=0
virtual void startParameterName (bool)=0
virtual void endParameterName (bool, bool, bool)=0
virtual void startParameterList (bool)=0
virtual void endParameterList ()=0
virtual void startConstraintList (const char *)=0
virtual void startConstraintParam ()=0
virtual void endConstraintParam ()=0
virtual void startConstraintType ()=0
virtual void endConstraintType ()=0
virtual void startConstraintDocs ()=0
virtual void endConstraintDocs ()=0
virtual void endConstraintList ()=0

Protected Attributes

QTextStream fs
QByteArray a
QBuffer b
QTextStream t
QFile * file
QCString dir
bool active
QStack< bool > * genStack
QString encoding

Detailed Description

Abstract output generator.

Subclass this class to add support for a new output format

Definition at line 262 of file outputgen.h.


Member Enumeration Documentation

enum OutputGenerator::OutputType

Enumerator:
Html 
Latex 
Man 
RTF 
XML 
DEF 
Perl 

Definition at line 265 of file outputgen.h.


Constructor & Destructor Documentation

OutputGenerator::OutputGenerator (  ) 

Definition at line 25 of file outputgen.cpp.

References a, active, b, file, genStack, and t.

OutputGenerator::~OutputGenerator (  )  [virtual]

Definition at line 38 of file outputgen.cpp.

References file, and genStack.


Member Function Documentation

virtual void OutputGenerator::enable (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::enableAll(), and popGeneratorState().

virtual void OutputGenerator::disable (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::disableAll(), and popGeneratorState().

virtual void OutputGenerator::enableIf ( OutputType  o  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::enable().

virtual void OutputGenerator::disableIf ( OutputType  o  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::disable().

virtual void OutputGenerator::disableIfNot ( OutputType  o  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::disableAllBut().

virtual bool OutputGenerator::isEnabled ( OutputType  o  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endPlainFile(), OutputList::isEnabled(), OutputList::parseDoc(), OutputList::parseText(), and OutputList::startPlainFile().

virtual OutputGenerator* OutputGenerator::get ( OutputType  o  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

void OutputGenerator::startPlainFile ( const char *  name  ) 

Definition at line 45 of file outputgen.cpp.

References dir, err(), file, fs, and QCString.

Referenced by ManGenerator::startFile(), LatexGenerator::startFile(), HtmlGenerator::startFile(), OutputList::startPlainFile(), LatexGenerator::writeStyleInfo(), and HtmlGenerator::writeStyleInfo().

void OutputGenerator::endPlainFile (  ) 

Definition at line 63 of file outputgen.cpp.

References a, b, encoding, file, fs, portable_iconv(), portable_iconv_close(), portable_iconv_open(), postProcess(), and t.

Referenced by ManGenerator::endFile(), LatexGenerator::endFile(), HtmlGenerator::endFile(), OutputList::endPlainFile(), LatexGenerator::writeStyleInfo(), and HtmlGenerator::writeStyleInfo().

QCString OutputGenerator::getContents (  )  const

Definition at line 102 of file outputgen.cpp.

References a, and QCString.

bool OutputGenerator::isEnabled (  )  const [inline]

Definition at line 283 of file outputgen.h.

References active.

Referenced by pushGeneratorState().

void OutputGenerator::pushGeneratorState (  ) 

Definition at line 111 of file outputgen.cpp.

References genStack, and isEnabled().

Referenced by OutputList::pushGeneratorState().

void OutputGenerator::popGeneratorState (  ) 

Definition at line 116 of file outputgen.cpp.

References disable(), enable(), and genStack.

Referenced by OutputList::popGeneratorState().

void OutputGenerator::setEncoding ( const QCString &  enc  )  [inline]

Definition at line 286 of file outputgen.h.

References encoding.

Referenced by LatexGenerator::startFile().

virtual void OutputGenerator::postProcess ( QByteArray &   )  [inline, virtual]

Reimplemented in RTFGenerator.

Definition at line 287 of file outputgen.h.

Referenced by endPlainFile().

virtual void OutputGenerator::printDoc ( DocNode ,
const char *  langExt 
) [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::parseDoc(), and OutputList::parseText().

virtual void OutputGenerator::startFile ( const char *  name,
const char *  manName,
const char *  title 
) [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startFile().

virtual void OutputGenerator::writeFooter (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::writeFooter().

virtual void OutputGenerator::endFile (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endFile().

virtual void OutputGenerator::startIndexSection ( IndexSections   )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startIndexSection().

virtual void OutputGenerator::endIndexSection ( IndexSections   )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endIndexSection().

virtual void OutputGenerator::writePageLink ( const char *  ,
bool   
) [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::writePageLink().

virtual void OutputGenerator::startProjectNumber (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startProjectNumber().

virtual void OutputGenerator::endProjectNumber (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endProjectNumber().

virtual void OutputGenerator::writeStyleInfo ( int  part  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::writeStyleInfo().

virtual void OutputGenerator::startTitleHead ( const char *   )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startTitleHead().

virtual void OutputGenerator::endTitleHead ( const char *  fileName,
const char *  name 
) [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endTitleHead().

virtual void OutputGenerator::startIndexList (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startIndexList().

virtual void OutputGenerator::endIndexList (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endIndexList().

virtual void OutputGenerator::startIndexKey (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startIndexKey().

virtual void OutputGenerator::endIndexKey (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endIndexKey().

virtual void OutputGenerator::startIndexValue ( bool   )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startIndexValue().

virtual void OutputGenerator::endIndexValue ( const char *  ,
bool   
) [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endIndexValue().

virtual void OutputGenerator::startIndexItem ( const char *  ref,
const char *  file 
) [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startIndexItem().

virtual void OutputGenerator::endIndexItem ( const char *  ref,
const char *  file 
) [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endIndexItem().

virtual void OutputGenerator::startGroupHeader (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startGroupHeader().

virtual void OutputGenerator::endGroupHeader (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endGroupHeader().

virtual void OutputGenerator::startMemberSections (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startMemberSections().

virtual void OutputGenerator::endMemberSections (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endMemberSections().

virtual void OutputGenerator::startMemberHeader (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startMemberHeader().

virtual void OutputGenerator::endMemberHeader (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endMemberHeader().

virtual void OutputGenerator::startMemberSubtitle (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startMemberSubtitle().

virtual void OutputGenerator::endMemberSubtitle (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endMemberSubtitle().

virtual void OutputGenerator::startMemberDocList (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startMemberDocList().

virtual void OutputGenerator::endMemberDocList (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endMemberDocList().

virtual void OutputGenerator::startMemberList (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startMemberList().

virtual void OutputGenerator::endMemberList (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endMemberList().

virtual void OutputGenerator::startAnonTypeScope ( int   )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startAnonTypeScope().

virtual void OutputGenerator::endAnonTypeScope ( int   )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endAnonTypeScope().

virtual void OutputGenerator::startMemberItem ( int   )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startMemberItem().

virtual void OutputGenerator::endMemberItem (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endMemberItem().

virtual void OutputGenerator::startMemberTemplateParams (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startMemberTemplateParams().

virtual void OutputGenerator::endMemberTemplateParams (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endMemberTemplateParams().

virtual void OutputGenerator::startMemberGroupHeader ( bool   )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startMemberGroupHeader().

virtual void OutputGenerator::endMemberGroupHeader (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endMemberGroupHeader().

virtual void OutputGenerator::startMemberGroupDocs (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startMemberGroupDocs().

virtual void OutputGenerator::endMemberGroupDocs (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endMemberGroupDocs().

virtual void OutputGenerator::startMemberGroup (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startMemberGroup().

virtual void OutputGenerator::endMemberGroup ( bool   )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endMemberGroup().

virtual void OutputGenerator::insertMemberAlign ( bool   )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::insertMemberAlign().

virtual void OutputGenerator::startMemberDoc ( const char *  ,
const char *  ,
const char *  ,
const char *   
) [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startMemberDoc().

virtual void OutputGenerator::endMemberDoc ( bool   )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endMemberDoc().

virtual void OutputGenerator::startDoxyAnchor ( const char *  fName,
const char *  manName,
const char *  anchor,
const char *  name,
const char *  args 
) [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startDoxyAnchor().

virtual void OutputGenerator::endDoxyAnchor ( const char *  fileName,
const char *  anchor 
) [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endDoxyAnchor().

virtual void OutputGenerator::writeLatexSpacing (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::writeLatexSpacing().

virtual void OutputGenerator::writeStartAnnoItem ( const char *  type,
const char *  file,
const char *  path,
const char *  name 
) [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::writeStartAnnoItem().

virtual void OutputGenerator::writeEndAnnoItem ( const char *  name  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::writeEndAnnoItem().

virtual void OutputGenerator::startMemberDescription (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startMemberDescription().

virtual void OutputGenerator::endMemberDescription (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endMemberDescription().

virtual void OutputGenerator::startIndent (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startIndent().

virtual void OutputGenerator::endIndent (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endIndent().

virtual void OutputGenerator::writeSynopsis (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::writeSynopsis().

virtual void OutputGenerator::startClassDiagram (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startClassDiagram().

virtual void OutputGenerator::endClassDiagram ( const ClassDiagram ,
const char *  ,
const char *   
) [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endClassDiagram().

virtual void OutputGenerator::startDotGraph (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startDotGraph().

virtual void OutputGenerator::endDotGraph ( const DotClassGraph g  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endDotGraph().

virtual void OutputGenerator::startInclDepGraph (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startInclDepGraph().

virtual void OutputGenerator::endInclDepGraph ( const DotInclDepGraph g  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endInclDepGraph().

virtual void OutputGenerator::startGroupCollaboration (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startGroupCollaboration().

virtual void OutputGenerator::endGroupCollaboration ( const DotGroupCollaboration g  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endGroupCollaboration().

virtual void OutputGenerator::startCallGraph (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startCallGraph().

virtual void OutputGenerator::endCallGraph ( const DotCallGraph g  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endCallGraph().

virtual void OutputGenerator::startDirDepGraph (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startDirDepGraph().

virtual void OutputGenerator::endDirDepGraph ( const DotDirDeps g  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endDirDepGraph().

virtual void OutputGenerator::writeGraphicalHierarchy ( const DotGfxHierarchyTable g  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::writeGraphicalHierarchy().

virtual void OutputGenerator::startQuickIndices (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startQuickIndices().

virtual void OutputGenerator::endQuickIndices (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endQuickIndices().

virtual void OutputGenerator::writeQuickLinks ( bool  compact,
HighlightedItem  hli 
) [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::writeQuickLinks().

virtual void OutputGenerator::startContents (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startContents().

virtual void OutputGenerator::endContents (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endContents().

virtual void OutputGenerator::startTextBlock ( bool   )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startTextBlock().

virtual void OutputGenerator::endTextBlock ( bool   )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endTextBlock().

virtual void OutputGenerator::lastIndexPage (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::lastIndexPage().

virtual void OutputGenerator::startMemberDocPrefixItem (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startMemberDocPrefixItem().

virtual void OutputGenerator::endMemberDocPrefixItem (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endMemberDocPrefixItem().

virtual void OutputGenerator::startMemberDocName ( bool   )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startMemberDocName().

virtual void OutputGenerator::endMemberDocName (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endMemberDocName().

virtual void OutputGenerator::startParameterType ( bool  ,
const char *   
) [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startParameterType().

virtual void OutputGenerator::endParameterType (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endParameterType().

virtual void OutputGenerator::startParameterName ( bool   )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startParameterName().

virtual void OutputGenerator::endParameterName ( bool  ,
bool  ,
bool   
) [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endParameterName().

virtual void OutputGenerator::startParameterList ( bool   )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startParameterList().

virtual void OutputGenerator::endParameterList (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endParameterList().

virtual void OutputGenerator::startConstraintList ( const char *   )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startConstraintList().

virtual void OutputGenerator::startConstraintParam (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startConstraintParam().

virtual void OutputGenerator::endConstraintParam (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endConstraintParam().

virtual void OutputGenerator::startConstraintType (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startConstraintType().

virtual void OutputGenerator::endConstraintType (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endConstraintType().

virtual void OutputGenerator::startConstraintDocs (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::startConstraintDocs().

virtual void OutputGenerator::endConstraintDocs (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endConstraintDocs().

virtual void OutputGenerator::endConstraintList (  )  [pure virtual]

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Referenced by OutputList::endConstraintList().


Member Data Documentation

QTextStream OutputGenerator::fs [protected]

Definition at line 397 of file outputgen.h.

Referenced by endPlainFile(), and startPlainFile().

QByteArray OutputGenerator::a [protected]

Definition at line 398 of file outputgen.h.

Referenced by endPlainFile(), getContents(), and OutputGenerator().

QBuffer OutputGenerator::b [protected]

Definition at line 399 of file outputgen.h.

Referenced by endPlainFile(), and OutputGenerator().

QTextStream OutputGenerator::t [protected]

Definition at line 400 of file outputgen.h.

Referenced by RTFGenerator::addIndexItem(), RTFGenerator::codify(), ManGenerator::codify(), RTFGenerator::docify(), ManGenerator::docify(), RTFGenerator::endBold(), ManGenerator::endBold(), LatexGenerator::endBold(), HtmlGenerator::endBold(), RTFGenerator::endCenter(), LatexGenerator::endCenter(), HtmlGenerator::endCenter(), RTFGenerator::endClassDiagram(), RTFGenerator::endCodeFragment(), ManGenerator::endCodeFragment(), LatexGenerator::endCodeFragment(), HtmlGenerator::endCodeFragment(), ManGenerator::endConstraintDocs(), ManGenerator::endConstraintParam(), RTFGenerator::endDescItem(), ManGenerator::endDescItem(), HtmlGenerator::endDescItem(), LatexGenerator::endDescList(), HtmlGenerator::endDescList(), RTFGenerator::endDescription(), HtmlGenerator::endDescription(), RTFGenerator::endDescTable(), LatexGenerator::endDescTable(), HtmlGenerator::endDescTable(), RTFGenerator::endDescTableData(), HtmlGenerator::endDescTableData(), RTFGenerator::endDescTableTitle(), LatexGenerator::endDescTableTitle(), HtmlGenerator::endDescTableTitle(), RTFGenerator::endDoxyAnchor(), RTFGenerator::endEmphasis(), ManGenerator::endEmphasis(), LatexGenerator::endEmphasis(), HtmlGenerator::endEmphasis(), ManGenerator::endFile(), HtmlGenerator::endFontClass(), RTFGenerator::endGroupHeader(), ManGenerator::endGroupHeader(), RTFGenerator::endHtmlLink(), RTFGenerator::endIndent(), RTFGenerator::endIndexItem(), RTFGenerator::endIndexKey(), RTFGenerator::endIndexList(), LatexGenerator::endIndexList(), RTFGenerator::endIndexValue(), RTFGenerator::endItemList(), LatexGenerator::endItemList(), HtmlGenerator::endItemList(), RTFGenerator::endMemberDescription(), ManGenerator::endMemberDescription(), RTFGenerator::endMemberDoc(), ManGenerator::endMemberDoc(), ManGenerator::endMemberGroup(), ManGenerator::endMemberGroupDocs(), ManGenerator::endMemberGroupHeader(), ManGenerator::endMemberHeader(), RTFGenerator::endMemberItem(), ManGenerator::endMemberItem(), RTFGenerator::endMemberList(), ManGenerator::endMemberList(), RTFGenerator::endMemberSubtitle(), RTFGenerator::endPageRef(), RTFGenerator::endParagraph(), endPlainFile(), RTFGenerator::endSection(), ManGenerator::endSection(), RTFGenerator::endSmall(), LatexGenerator::endSmall(), HtmlGenerator::endSmall(), RTFGenerator::endSubsection(), ManGenerator::endSubsection(), LatexGenerator::endSubsection(), HtmlGenerator::endSubsection(), RTFGenerator::endSubsubsection(), ManGenerator::endSubsubsection(), LatexGenerator::endSubsubsection(), HtmlGenerator::endSubsubsection(), RTFGenerator::endTextBlock(), RTFGenerator::endTextLink(), ManGenerator::endTitle(), LatexGenerator::endTitle(), HtmlGenerator::endTitle(), RTFGenerator::endTitleHead(), ManGenerator::endTitleHead(), RTFGenerator::endTypewriter(), ManGenerator::endTypewriter(), LatexGenerator::endTypewriter(), HtmlGenerator::endTypewriter(), LatexGenerator::init(), RTFGenerator::lastIndexPage(), RTFGenerator::lineBreak(), ManGenerator::lineBreak(), LatexGenerator::lineBreak(), HtmlGenerator::lineBreak(), RTFGenerator::newParagraph(), ManGenerator::newParagraph(), OutputGenerator(), ManGenerator::printDoc(), RTFGenerator::startBold(), ManGenerator::startBold(), LatexGenerator::startBold(), HtmlGenerator::startBold(), RTFGenerator::startCenter(), LatexGenerator::startCenter(), HtmlGenerator::startCenter(), RTFGenerator::startClassDiagram(), HtmlGenerator::startCodeAnchor(), RTFGenerator::startCodeFragment(), ManGenerator::startCodeFragment(), LatexGenerator::startCodeFragment(), HtmlGenerator::startCodeFragment(), ManGenerator::startConstraintList(), RTFGenerator::startDescItem(), ManGenerator::startDescItem(), HtmlGenerator::startDescItem(), RTFGenerator::startDescList(), ManGenerator::startDescList(), LatexGenerator::startDescList(), HtmlGenerator::startDescList(), RTFGenerator::startDescription(), HtmlGenerator::startDescription(), RTFGenerator::startDescTable(), LatexGenerator::startDescTable(), HtmlGenerator::startDescTable(), RTFGenerator::startDescTableData(), ManGenerator::startDescTableData(), HtmlGenerator::startDescTableData(), RTFGenerator::startDescTableTitle(), LatexGenerator::startDescTableTitle(), HtmlGenerator::startDescTableTitle(), RTFGenerator::startDoxyAnchor(), RTFGenerator::startEmphasis(), ManGenerator::startEmphasis(), LatexGenerator::startEmphasis(), HtmlGenerator::startEmphasis(), HtmlGenerator::startFontClass(), RTFGenerator::startGroupHeader(), ManGenerator::startGroupHeader(), RTFGenerator::startHtmlLink(), RTFGenerator::startIndent(), RTFGenerator::startIndexItem(), RTFGenerator::startIndexKey(), RTFGenerator::startIndexList(), LatexGenerator::startIndexList(), RTFGenerator::startIndexValue(), RTFGenerator::startItemList(), LatexGenerator::startItemList(), HtmlGenerator::startItemList(), RTFGenerator::startMemberDescription(), ManGenerator::startMemberDescription(), RTFGenerator::startMemberDoc(), ManGenerator::startMemberDoc(), ManGenerator::startMemberGroup(), ManGenerator::startMemberGroupHeader(), ManGenerator::startMemberHeader(), RTFGenerator::startMemberItem(), ManGenerator::startMemberItem(), RTFGenerator::startMemberList(), ManGenerator::startMemberList(), RTFGenerator::startMemberSubtitle(), RTFGenerator::startPageRef(), RTFGenerator::startParagraph(), ManGenerator::startParagraph(), ManGenerator::startParamList(), RTFGenerator::startSection(), ManGenerator::startSimpleSect(), RTFGenerator::startSmall(), LatexGenerator::startSmall(), HtmlGenerator::startSmall(), RTFGenerator::startSubsection(), ManGenerator::startSubsection(), LatexGenerator::startSubsection(), HtmlGenerator::startSubsection(), RTFGenerator::startSubsubsection(), ManGenerator::startSubsubsection(), LatexGenerator::startSubsubsection(), HtmlGenerator::startSubsubsection(), RTFGenerator::startTextBlock(), RTFGenerator::startTextLink(), RTFGenerator::startTitle(), ManGenerator::startTitle(), HtmlGenerator::startTitle(), RTFGenerator::startTitleHead(), RTFGenerator::startTypewriter(), ManGenerator::startTypewriter(), LatexGenerator::startTypewriter(), HtmlGenerator::startTypewriter(), RTFGenerator::writeAnchor(), HtmlGenerator::writeAnchor(), ManGenerator::writeChar(), HtmlGenerator::writeCodeAnchor(), RTFGenerator::writeCodeLink(), RTFGenerator::writeDescItem(), ManGenerator::writeDescItem(), LatexGenerator::writeDescItem(), HtmlGenerator::writeDescItem(), RTFGenerator::writeEndAnnoItem(), ManGenerator::writeEndAnnoItem(), HtmlGenerator::writeEndAnnoItem(), RTFGenerator::writeExtensionsFile(), HtmlGenerator::writeFooterFile(), LatexGenerator::writeHeaderFile(), HtmlGenerator::writeHeaderFile(), LatexGenerator::writeLatexSpacing(), RTFGenerator::writeLineNumber(), ManGenerator::writeLineNumber(), LatexGenerator::writeLineNumber(), RTFGenerator::writeListItem(), ManGenerator::writeListItem(), LatexGenerator::writeListItem(), HtmlGenerator::writeListItem(), RTFGenerator::writeNonBreakableSpace(), ManGenerator::writeNonBreakableSpace(), RTFGenerator::writeObjectLink(), RTFGenerator::writePageLink(), LatexGenerator::writeRuler(), HtmlGenerator::writeRuler(), HtmlGenerator::writeSearchPage(), RTFGenerator::writeStartAnnoItem(), RTFGenerator::writeString(), RTFGenerator::writeStyleSheetFile(), LatexGenerator::writeStyleSheetFile(), HtmlGenerator::writeStyleSheetFile(), and ManGenerator::writeSynopsis().

QFile* OutputGenerator::file [protected]

Definition at line 401 of file outputgen.h.

Referenced by endPlainFile(), LatexGenerator::init(), OutputGenerator(), startPlainFile(), and ~OutputGenerator().

QCString OutputGenerator::dir [protected]

Definition at line 402 of file outputgen.h.

Referenced by RTFGenerator::endClassDiagram(), LatexGenerator::endClassDiagram(), RTFGenerator::init(), LatexGenerator::init(), LatexGenerator::LatexGenerator(), ManGenerator::ManGenerator(), RTFGenerator::RTFGenerator(), ManGenerator::startDoxyAnchor(), and startPlainFile().

bool OutputGenerator::active [protected]

Definition at line 403 of file outputgen.h.

Referenced by RTFGenerator::disable(), ManGenerator::disable(), LatexGenerator::disable(), HtmlGenerator::disable(), RTFGenerator::disableIf(), ManGenerator::disableIf(), LatexGenerator::disableIf(), HtmlGenerator::disableIf(), RTFGenerator::disableIfNot(), ManGenerator::disableIfNot(), LatexGenerator::disableIfNot(), HtmlGenerator::disableIfNot(), RTFGenerator::enable(), ManGenerator::enable(), LatexGenerator::enable(), HtmlGenerator::enable(), RTFGenerator::enableIf(), ManGenerator::enableIf(), LatexGenerator::enableIf(), HtmlGenerator::enableIf(), RTFGenerator::isEnabled(), isEnabled(), ManGenerator::isEnabled(), LatexGenerator::isEnabled(), HtmlGenerator::isEnabled(), and OutputGenerator().

QStack<bool>* OutputGenerator::genStack [protected]

Definition at line 404 of file outputgen.h.

Referenced by RTFGenerator::enable(), ManGenerator::enable(), LatexGenerator::enable(), HtmlGenerator::enable(), OutputGenerator(), popGeneratorState(), pushGeneratorState(), and ~OutputGenerator().

QString OutputGenerator::encoding [protected]

Definition at line 405 of file outputgen.h.

Referenced by endPlainFile(), and setEncoding().


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



Generated on Mon Mar 31 10:59:02 2008 by  doxygen 1.5.1