My Project
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Attributes | Private Member Functions | List of all members
OutputGenerator Class Referenceabstract

#include <outputgen.h>

Inheritance diagram for OutputGenerator:
BaseOutputDocInterface CodeOutputInterface HtmlGenerator LatexGenerator ManGenerator RTFGenerator

Public Types

enum  OutputType {
  Html, Latex, Man, RTF,
  XML, DEF, Perl
}
 
- Public Types inherited from BaseOutputDocInterface
enum  ParamListTypes { Param, RetVal, Exception }
 
enum  SectionTypes { EnumValues, Examples }
 

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 ()
 
bool isEnabled () const
 
void pushGeneratorState ()
 
void popGeneratorState ()
 
virtual void writeDoc (DocNode *, Definition *ctx, MemberDef *md)=0
 
virtual void startFile (const char *name, const char *manName, const char *title)=0
 
virtual void writeSearchInfo ()=0
 
virtual void writeFooter (const char *navPath)=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 startIndexListItem ()=0
 
virtual void endIndexListItem ()=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 (int)=0
 
virtual void endGroupHeader (int)=0
 
virtual void startMemberSections ()=0
 
virtual void endMemberSections ()=0
 
virtual void startHeaderSection ()=0
 
virtual void endHeaderSection ()=0
 
virtual void startMemberHeader (const char *anchor)=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 startInlineHeader ()=0
 
virtual void endInlineHeader ()=0
 
virtual void startAnonTypeScope (int)=0
 
virtual void endAnonTypeScope (int)=0
 
virtual void startMemberItem (const char *, int, const char *)=0
 
virtual void endMemberItem ()=0
 
virtual void startMemberTemplateParams ()=0
 
virtual void endMemberTemplateParams (const char *, const char *)=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 *, int, int, bool)=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 (const char *anchor, const char *inheritId)=0
 
virtual void endMemberDescription ()=0
 
virtual void startMemberDeclaration ()=0
 
virtual void endMemberDeclaration (const char *anchor, const char *inheritId)=0
 
virtual void writeInheritedSectionTitle (const char *id, const char *ref, const char *file, const char *anchor, const char *title, const char *name)=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 writeSplitBar (const char *)=0
 
virtual void writeNavigationPath (const char *)=0
 
virtual void writeLogo ()=0
 
virtual void writeQuickLinks (bool compact, HighlightedItem hli, const char *file)=0
 
virtual void writeSummaryLink (const char *file, const char *anchor, const char *title, bool first)=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 *key)=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 exceptionEntry (const char *, bool)=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
 
virtual void startMemberDocSimple (bool)=0
 
virtual void endMemberDocSimple (bool)=0
 
virtual void startInlineMemberType ()=0
 
virtual void endInlineMemberType ()=0
 
virtual void startInlineMemberName ()=0
 
virtual void endInlineMemberName ()=0
 
virtual void startInlineMemberDoc ()=0
 
virtual void endInlineMemberDoc ()=0
 
virtual void startLabels ()=0
 
virtual void writeLabel (const char *, bool)=0
 
virtual void endLabels ()=0
 
- Public Member Functions inherited from BaseOutputDocInterface
virtual ~BaseOutputDocInterface ()
 
virtual bool parseText (const QCString &s)
 
virtual void startItemList ()=0
 
virtual void startItemListItem ()=0
 
virtual void endItemListItem ()=0
 
virtual void endItemList ()=0
 
virtual void docify (const char *s)=0
 
virtual void writeChar (char c)=0
 
virtual void writeString (const char *text)=0
 
virtual void startParagraph ()=0
 
virtual void endParagraph ()=0
 
virtual void writeObjectLink (const char *ref, const char *file, const char *anchor, const char *name)=0
 
virtual void startHtmlLink (const char *url)=0
 
virtual void endHtmlLink ()=0
 
virtual void startBold ()=0
 
virtual void endBold ()=0
 
virtual void startTypewriter ()=0
 
virtual void endTypewriter ()=0
 
virtual void startEmphasis ()=0
 
virtual void endEmphasis ()=0
 
virtual void startCodeFragment ()=0
 
virtual void endCodeFragment ()=0
 
virtual void writeRuler ()=0
 
virtual void startDescription ()=0
 
virtual void endDescription ()=0
 
virtual void startDescItem ()=0
 
virtual void startDescForItem ()=0
 
virtual void endDescForItem ()=0
 
virtual void endDescItem ()=0
 
virtual void startCenter ()=0
 
virtual void endCenter ()=0
 
virtual void startSmall ()=0
 
virtual void endSmall ()=0
 
virtual void startSimpleSect (SectionTypes t, const char *file, const char *anchor, const char *title)=0
 
virtual void endSimpleSect ()=0
 
virtual void startParamList (ParamListTypes t, const char *title)=0
 
virtual void endParamList ()=0
 
virtual void startTitle ()=0
 
virtual void endTitle ()=0
 
virtual void writeAnchor (const char *fileName, const char *name)=0
 
virtual void startSection (const char *, const char *, SectionInfo::SectionType)=0
 
virtual void endSection (const char *, SectionInfo::SectionType)=0
 
virtual void lineBreak (const char *style)=0
 
virtual void addIndexItem (const char *s1, const char *s2)=0
 
virtual void writeNonBreakableSpace (int)=0
 
virtual void startDescTable (const char *title)=0
 
virtual void endDescTable ()=0
 
virtual void startDescTableRow ()=0
 
virtual void endDescTableRow ()=0
 
virtual void startDescTableTitle ()=0
 
virtual void endDescTableTitle ()=0
 
virtual void startDescTableData ()=0
 
virtual void endDescTableData ()=0
 
virtual void startTextLink (const char *file, const char *anchor)=0
 
virtual void endTextLink ()=0
 
virtual void startPageRef ()=0
 
virtual void endPageRef (const char *, const char *)=0
 
virtual void startSubsection ()=0
 
virtual void endSubsection ()=0
 
virtual void startSubsubsection ()=0
 
virtual void endSubsubsection ()=0
 
- Public Member Functions inherited from CodeOutputInterface
virtual ~CodeOutputInterface ()
 
virtual void codify (const char *s)=0
 
virtual void writeCodeLink (const char *ref, const char *file, const char *anchor, const char *name, const char *tooltip)=0
 
virtual void writeLineNumber (const char *ref, const char *file, const char *anchor, int lineNumber)=0
 
virtual void writeTooltip (const char *id, const DocLinkInfo &docInfo, const char *decl, const char *desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)=0
 
virtual void startCodeLine (bool hasLineNumbers)=0
 
virtual void endCodeLine ()=0
 
virtual void startFontClass (const char *clsName)=0
 
virtual void endFontClass ()=0
 
virtual void writeCodeAnchor (const char *name)=0
 
virtual void setCurrentDoc (Definition *context, const char *anchor, bool isSourceFile)=0
 
virtual void addWord (const char *word, bool hiPriority)=0
 

Protected Attributes

FTextStream t
 
QFile * file
 
QCString fileName
 
QCString dir
 
bool active
 
QStack< bool > * genStack
 

Private Member Functions

 OutputGenerator (const OutputGenerator &o)
 
OutputGeneratoroperator= (const OutputGenerator &o)
 

Detailed Description

Abstract output generator.

Subclass this class to add support for a new output format

Definition at line 322 of file outputgen.h.

Member Enumeration Documentation

Enumerator
Html 
Latex 
Man 
RTF 
XML 
DEF 
Perl 

Definition at line 325 of file outputgen.h.

{ Html, Latex, Man, RTF, XML, DEF, Perl };

Constructor & Destructor Documentation

OutputGenerator::OutputGenerator ( )

Definition at line 26 of file outputgen.cpp.

References active, file, and genStack.

{
//printf("OutputGenerator::OutputGenerator()\n");
file=0;
active=TRUE;
genStack = new QStack<bool>;
genStack->setAutoDelete(TRUE);
}
OutputGenerator::~OutputGenerator ( )
virtual

Definition at line 35 of file outputgen.cpp.

References file, and genStack.

{
//printf("OutputGenerator::~OutputGenerator()\n");
delete file;
delete genStack;
}
OutputGenerator::OutputGenerator ( const OutputGenerator o)
private

Member Function Documentation

virtual void OutputGenerator::disable ( )
pure virtual
virtual void OutputGenerator::disableIf ( OutputType  o)
pure virtual
virtual void OutputGenerator::disableIfNot ( OutputType  o)
pure virtual
virtual void OutputGenerator::enable ( )
pure virtual
virtual void OutputGenerator::enableIf ( OutputType  o)
pure virtual
virtual void OutputGenerator::endAnonTypeScope ( int  )
pure virtual
virtual void OutputGenerator::endCallGraph ( const DotCallGraph g)
pure virtual
virtual void OutputGenerator::endClassDiagram ( const ClassDiagram ,
const char *  ,
const char *   
)
pure virtual
virtual void OutputGenerator::endConstraintDocs ( )
pure virtual
virtual void OutputGenerator::endConstraintList ( )
pure virtual
virtual void OutputGenerator::endConstraintParam ( )
pure virtual
virtual void OutputGenerator::endConstraintType ( )
pure virtual
virtual void OutputGenerator::endContents ( )
pure virtual
virtual void OutputGenerator::endDirDepGraph ( const DotDirDeps g)
pure virtual
virtual void OutputGenerator::endDotGraph ( const DotClassGraph g)
pure virtual
virtual void OutputGenerator::endDoxyAnchor ( const char *  fileName,
const char *  anchor 
)
pure virtual
virtual void OutputGenerator::endFile ( )
pure virtual
virtual void OutputGenerator::endGroupCollaboration ( const DotGroupCollaboration g)
pure virtual
virtual void OutputGenerator::endGroupHeader ( int  )
pure virtual
virtual void OutputGenerator::endHeaderSection ( )
pure virtual
virtual void OutputGenerator::endInclDepGraph ( const DotInclDepGraph g)
pure virtual
virtual void OutputGenerator::endIndent ( )
pure virtual
virtual void OutputGenerator::endIndexItem ( const char *  ref,
const char *  file 
)
pure virtual
virtual void OutputGenerator::endIndexKey ( )
pure virtual
virtual void OutputGenerator::endIndexList ( )
pure virtual
virtual void OutputGenerator::endIndexListItem ( )
pure virtual
virtual void OutputGenerator::endIndexSection ( IndexSections  )
pure virtual
virtual void OutputGenerator::endIndexValue ( const char *  ,
bool   
)
pure virtual
virtual void OutputGenerator::endInlineHeader ( )
pure virtual
virtual void OutputGenerator::endInlineMemberDoc ( )
pure virtual
virtual void OutputGenerator::endInlineMemberName ( )
pure virtual
virtual void OutputGenerator::endInlineMemberType ( )
pure virtual
virtual void OutputGenerator::endLabels ( )
pure virtual
virtual void OutputGenerator::endMemberDeclaration ( const char *  anchor,
const char *  inheritId 
)
pure virtual
virtual void OutputGenerator::endMemberDescription ( )
pure virtual
virtual void OutputGenerator::endMemberDoc ( bool  )
pure virtual
virtual void OutputGenerator::endMemberDocList ( )
pure virtual
virtual void OutputGenerator::endMemberDocName ( )
pure virtual
virtual void OutputGenerator::endMemberDocPrefixItem ( )
pure virtual
virtual void OutputGenerator::endMemberDocSimple ( bool  )
pure virtual
virtual void OutputGenerator::endMemberGroup ( bool  )
pure virtual
virtual void OutputGenerator::endMemberGroupDocs ( )
pure virtual
virtual void OutputGenerator::endMemberGroupHeader ( )
pure virtual
virtual void OutputGenerator::endMemberHeader ( )
pure virtual
virtual void OutputGenerator::endMemberItem ( )
pure virtual
virtual void OutputGenerator::endMemberList ( )
pure virtual
virtual void OutputGenerator::endMemberSections ( )
pure virtual
virtual void OutputGenerator::endMemberSubtitle ( )
pure virtual
virtual void OutputGenerator::endMemberTemplateParams ( const char *  ,
const char *   
)
pure virtual
virtual void OutputGenerator::endParameterList ( )
pure virtual
virtual void OutputGenerator::endParameterName ( bool  ,
bool  ,
bool   
)
pure virtual
virtual void OutputGenerator::endParameterType ( )
pure virtual
void OutputGenerator::endPlainFile ( )
virtual void OutputGenerator::endProjectNumber ( )
pure virtual
virtual void OutputGenerator::endQuickIndices ( )
pure virtual
virtual void OutputGenerator::endTextBlock ( bool  )
pure virtual
virtual void OutputGenerator::endTitleHead ( const char *  fileName,
const char *  name 
)
pure virtual
virtual void OutputGenerator::exceptionEntry ( const char *  ,
bool   
)
pure virtual
virtual OutputGenerator* OutputGenerator::get ( OutputType  o)
pure virtual
virtual void OutputGenerator::insertMemberAlign ( bool  )
pure virtual
virtual bool OutputGenerator::isEnabled ( OutputType  o)
pure virtual
bool OutputGenerator::isEnabled ( ) const
inline

Definition at line 343 of file outputgen.h.

References active.

Referenced by pushGeneratorState().

{ return active; }
virtual void OutputGenerator::lastIndexPage ( )
pure virtual
OutputGenerator& OutputGenerator::operator= ( const OutputGenerator o)
private
void OutputGenerator::popGeneratorState ( )

Definition at line 69 of file outputgen.cpp.

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

Referenced by OutputList::popGeneratorState().

{
//printf("%p:popGeneratorState(%d) enabled=%d\n",this,genStack->count(),isEnabled());
bool *lb = genStack->pop();
ASSERT(lb!=0);
if (lb==0) return; // for some robustness against superfluous \endhtmlonly commands.
if (*lb) enable(); else disable();
delete lb;
}
void OutputGenerator::pushGeneratorState ( )

Definition at line 63 of file outputgen.cpp.

References genStack, and isEnabled().

Referenced by OutputList::pushGeneratorState().

{
genStack->push(new bool(isEnabled()));
//printf("%p:pushGeneratorState(%d) enabled=%d\n",this,genStack->count(),isEnabled());
}
virtual void OutputGenerator::startAnonTypeScope ( int  )
pure virtual
virtual void OutputGenerator::startCallGraph ( )
pure virtual
virtual void OutputGenerator::startClassDiagram ( )
pure virtual
virtual void OutputGenerator::startConstraintDocs ( )
pure virtual
virtual void OutputGenerator::startConstraintList ( const char *  )
pure virtual
virtual void OutputGenerator::startConstraintParam ( )
pure virtual
virtual void OutputGenerator::startConstraintType ( )
pure virtual
virtual void OutputGenerator::startContents ( )
pure virtual
virtual void OutputGenerator::startDirDepGraph ( )
pure virtual
virtual void OutputGenerator::startDotGraph ( )
pure virtual
virtual void OutputGenerator::startDoxyAnchor ( const char *  fName,
const char *  manName,
const char *  anchor,
const char *  name,
const char *  args 
)
pure virtual
virtual void OutputGenerator::startFile ( const char *  name,
const char *  manName,
const char *  title 
)
pure virtual
virtual void OutputGenerator::startGroupCollaboration ( )
pure virtual
virtual void OutputGenerator::startGroupHeader ( int  )
pure virtual
virtual void OutputGenerator::startHeaderSection ( )
pure virtual
virtual void OutputGenerator::startInclDepGraph ( )
pure virtual
virtual void OutputGenerator::startIndent ( )
pure virtual
virtual void OutputGenerator::startIndexItem ( const char *  ref,
const char *  file 
)
pure virtual
virtual void OutputGenerator::startIndexKey ( )
pure virtual
virtual void OutputGenerator::startIndexList ( )
pure virtual
virtual void OutputGenerator::startIndexListItem ( )
pure virtual
virtual void OutputGenerator::startIndexSection ( IndexSections  )
pure virtual
virtual void OutputGenerator::startIndexValue ( bool  )
pure virtual
virtual void OutputGenerator::startInlineHeader ( )
pure virtual
virtual void OutputGenerator::startInlineMemberDoc ( )
pure virtual
virtual void OutputGenerator::startInlineMemberName ( )
pure virtual
virtual void OutputGenerator::startInlineMemberType ( )
pure virtual
virtual void OutputGenerator::startLabels ( )
pure virtual
virtual void OutputGenerator::startMemberDeclaration ( )
pure virtual
virtual void OutputGenerator::startMemberDescription ( const char *  anchor,
const char *  inheritId 
)
pure virtual
virtual void OutputGenerator::startMemberDoc ( const char *  ,
const char *  ,
const char *  ,
const char *  ,
int  ,
int  ,
bool   
)
pure virtual
virtual void OutputGenerator::startMemberDocList ( )
pure virtual
virtual void OutputGenerator::startMemberDocName ( bool  )
pure virtual
virtual void OutputGenerator::startMemberDocPrefixItem ( )
pure virtual
virtual void OutputGenerator::startMemberDocSimple ( bool  )
pure virtual
virtual void OutputGenerator::startMemberGroup ( )
pure virtual
virtual void OutputGenerator::startMemberGroupDocs ( )
pure virtual
virtual void OutputGenerator::startMemberGroupHeader ( bool  )
pure virtual
virtual void OutputGenerator::startMemberHeader ( const char *  anchor)
pure virtual
virtual void OutputGenerator::startMemberItem ( const char *  ,
int  ,
const char *   
)
pure virtual
virtual void OutputGenerator::startMemberList ( )
pure virtual
virtual void OutputGenerator::startMemberSections ( )
pure virtual
virtual void OutputGenerator::startMemberSubtitle ( )
pure virtual
virtual void OutputGenerator::startMemberTemplateParams ( )
pure virtual
virtual void OutputGenerator::startParameterList ( bool  )
pure virtual
virtual void OutputGenerator::startParameterName ( bool  )
pure virtual
virtual void OutputGenerator::startParameterType ( bool  ,
const char *  key 
)
pure virtual
void OutputGenerator::startPlainFile ( const char *  name)

Definition at line 42 of file outputgen.cpp.

References dir, err(), file, fileName, FTextStream::setDevice(), and t.

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

{
//printf("startPlainFile(%s)\n",name);
fileName=dir+"/"+name;
file = new QFile(fileName);
if (!file->open(IO_WriteOnly))
{
err("Could not open file %s for writing\n",fileName.data());
exit(1);
}
}
virtual void OutputGenerator::startProjectNumber ( )
pure virtual
virtual void OutputGenerator::startQuickIndices ( )
pure virtual
virtual void OutputGenerator::startTextBlock ( bool  )
pure virtual
virtual void OutputGenerator::startTitleHead ( const char *  )
pure virtual
virtual void OutputGenerator::writeDoc ( DocNode ,
Definition ctx,
MemberDef md 
)
pure virtual
virtual void OutputGenerator::writeEndAnnoItem ( const char *  name)
pure virtual
virtual void OutputGenerator::writeFooter ( const char *  navPath)
pure virtual
virtual void OutputGenerator::writeGraphicalHierarchy ( const DotGfxHierarchyTable g)
pure virtual
virtual void OutputGenerator::writeInheritedSectionTitle ( const char *  id,
const char *  ref,
const char *  file,
const char *  anchor,
const char *  title,
const char *  name 
)
pure virtual
virtual void OutputGenerator::writeLabel ( const char *  ,
bool   
)
pure virtual
virtual void OutputGenerator::writeLatexSpacing ( )
pure virtual
virtual void OutputGenerator::writeLogo ( )
pure virtual
virtual void OutputGenerator::writeNavigationPath ( const char *  )
pure virtual
virtual void OutputGenerator::writePageLink ( const char *  ,
bool   
)
pure virtual
virtual void OutputGenerator::writeQuickLinks ( bool  compact,
HighlightedItem  hli,
const char *  file 
)
pure virtual
virtual void OutputGenerator::writeSearchInfo ( )
pure virtual
virtual void OutputGenerator::writeSplitBar ( const char *  )
pure virtual
virtual void OutputGenerator::writeStartAnnoItem ( const char *  type,
const char *  file,
const char *  path,
const char *  name 
)
pure virtual
virtual void OutputGenerator::writeStyleInfo ( int  part)
pure virtual
virtual void OutputGenerator::writeSummaryLink ( const char *  file,
const char *  anchor,
const char *  title,
bool  first 
)
pure virtual
virtual void OutputGenerator::writeSynopsis ( )
pure virtual

Member Data Documentation

bool OutputGenerator::active
protected
QCString OutputGenerator::dir
protected
QFile* OutputGenerator::file
protected
QCString OutputGenerator::fileName
protected
QStack<bool>* OutputGenerator::genStack
protected
FTextStream OutputGenerator::t
protected

Definition at line 488 of file outputgen.h.

Referenced by RTFGenerator::addIndexItem(), LatexGenerator::addIndexItem(), RTFGenerator::beginRTFChapter(), RTFGenerator::beginRTFDocument(), RTFGenerator::beginRTFSection(), ManGenerator::codify(), RTFGenerator::codify(), ManGenerator::docify(), RTFGenerator::docify(), LatexGenerator::docify(), HtmlGenerator::docify(), LatexGenerator::endAnonTypeScope(), RTFGenerator::endBold(), ManGenerator::endBold(), LatexGenerator::endBold(), RTFGenerator::endCallGraph(), LatexGenerator::endCallGraph(), HtmlGenerator::endCallGraph(), RTFGenerator::endCenter(), LatexGenerator::endCenter(), RTFGenerator::endClassDiagram(), LatexGenerator::endClassDiagram(), HtmlGenerator::endClassDiagram(), RTFGenerator::endCodeFragment(), ManGenerator::endCodeFragment(), LatexGenerator::endCodeFragment(), RTFGenerator::endConstraintDocs(), ManGenerator::endConstraintDocs(), HtmlGenerator::endConstraintDocs(), RTFGenerator::endConstraintList(), LatexGenerator::endConstraintList(), HtmlGenerator::endConstraintList(), RTFGenerator::endConstraintParam(), ManGenerator::endConstraintParam(), HtmlGenerator::endConstraintParam(), RTFGenerator::endConstraintType(), LatexGenerator::endConstraintType(), HtmlGenerator::endConstraintType(), HtmlGenerator::endContents(), RTFGenerator::endDescForItem(), RTFGenerator::endDescItem(), ManGenerator::endDescItem(), LatexGenerator::endDescItem(), LatexGenerator::endDescList(), RTFGenerator::endDescription(), LatexGenerator::endDescription(), RTFGenerator::endDescTable(), LatexGenerator::endDescTable(), HtmlGenerator::endDescTable(), RTFGenerator::endDescTableData(), LatexGenerator::endDescTableData(), HtmlGenerator::endDescTableData(), HtmlGenerator::endDescTableRow(), RTFGenerator::endDescTableTitle(), HtmlGenerator::endDescTableTitle(), RTFGenerator::endDirDepGraph(), LatexGenerator::endDirDepGraph(), HtmlGenerator::endDirDepGraph(), RTFGenerator::endDotGraph(), LatexGenerator::endDotGraph(), HtmlGenerator::endDotGraph(), RTFGenerator::endDoxyAnchor(), RTFGenerator::endEmphasis(), ManGenerator::endEmphasis(), LatexGenerator::endEmphasis(), RTFGenerator::endFile(), ManGenerator::endFile(), LatexGenerator::endGroupCollaboration(), HtmlGenerator::endGroupCollaboration(), ManGenerator::endGroupHeader(), RTFGenerator::endGroupHeader(), LatexGenerator::endGroupHeader(), HtmlGenerator::endGroupHeader(), HtmlGenerator::endHeaderSection(), RTFGenerator::endHtmlLink(), LatexGenerator::endHtmlLink(), HtmlGenerator::endHtmlLink(), RTFGenerator::endInclDepGraph(), LatexGenerator::endInclDepGraph(), HtmlGenerator::endInclDepGraph(), RTFGenerator::endIndent(), HtmlGenerator::endIndent(), RTFGenerator::endIndexItem(), LatexGenerator::endIndexItem(), HtmlGenerator::endIndexItem(), RTFGenerator::endIndexKey(), HtmlGenerator::endIndexKey(), RTFGenerator::endIndexList(), LatexGenerator::endIndexList(), HtmlGenerator::endIndexList(), RTFGenerator::endIndexListItem(), HtmlGenerator::endIndexListItem(), RTFGenerator::endIndexSection(), LatexGenerator::endIndexSection(), RTFGenerator::endIndexValue(), LatexGenerator::endIndexValue(), HtmlGenerator::endIndexValue(), ManGenerator::endInlineHeader(), RTFGenerator::endInlineHeader(), LatexGenerator::endInlineHeader(), HtmlGenerator::endInlineHeader(), RTFGenerator::endInlineMemberDoc(), ManGenerator::endInlineMemberDoc(), LatexGenerator::endInlineMemberDoc(), HtmlGenerator::endInlineMemberDoc(), RTFGenerator::endInlineMemberName(), ManGenerator::endInlineMemberName(), LatexGenerator::endInlineMemberName(), HtmlGenerator::endInlineMemberName(), RTFGenerator::endInlineMemberType(), ManGenerator::endInlineMemberType(), LatexGenerator::endInlineMemberType(), HtmlGenerator::endInlineMemberType(), RTFGenerator::endItemList(), LatexGenerator::endItemList(), RTFGenerator::endItemListItem(), HtmlGenerator::endLabels(), HtmlGenerator::endMemberDeclaration(), RTFGenerator::endMemberDescription(), ManGenerator::endMemberDescription(), HtmlGenerator::endMemberDescription(), LatexGenerator::endMemberDescription(), RTFGenerator::endMemberDoc(), ManGenerator::endMemberDoc(), LatexGenerator::endMemberDoc(), HtmlGenerator::endMemberDoc(), HtmlGenerator::endMemberDocList(), HtmlGenerator::endMemberDocName(), LatexGenerator::endMemberDocPrefixItem(), HtmlGenerator::endMemberDocPrefixItem(), RTFGenerator::endMemberDocSimple(), ManGenerator::endMemberDocSimple(), LatexGenerator::endMemberDocSimple(), HtmlGenerator::endMemberDocSimple(), ManGenerator::endMemberGroup(), LatexGenerator::endMemberGroup(), RTFGenerator::endMemberGroup(), ManGenerator::endMemberGroupDocs(), LatexGenerator::endMemberGroupDocs(), HtmlGenerator::endMemberGroupDocs(), RTFGenerator::endMemberGroupDocs(), ManGenerator::endMemberGroupHeader(), LatexGenerator::endMemberGroupHeader(), HtmlGenerator::endMemberGroupHeader(), RTFGenerator::endMemberGroupHeader(), ManGenerator::endMemberHeader(), LatexGenerator::endMemberHeader(), HtmlGenerator::endMemberHeader(), ManGenerator::endMemberItem(), RTFGenerator::endMemberItem(), LatexGenerator::endMemberItem(), HtmlGenerator::endMemberItem(), ManGenerator::endMemberList(), RTFGenerator::endMemberList(), LatexGenerator::endMemberList(), HtmlGenerator::endMemberList(), HtmlGenerator::endMemberSections(), RTFGenerator::endMemberSubtitle(), HtmlGenerator::endMemberSubtitle(), LatexGenerator::endMemberTemplateParams(), HtmlGenerator::endMemberTemplateParams(), RTFGenerator::endPageRef(), LatexGenerator::endPageRef(), RTFGenerator::endParagraph(), LatexGenerator::endParagraph(), HtmlGenerator::endParagraph(), HtmlGenerator::endParameterList(), LatexGenerator::endParameterName(), HtmlGenerator::endParameterName(), RTFGenerator::endParameterType(), LatexGenerator::endParameterType(), HtmlGenerator::endParameterType(), RTFGenerator::endParamList(), LatexGenerator::endParamList(), HtmlGenerator::endParamList(), endPlainFile(), RTFGenerator::endProjectNumber(), HtmlGenerator::endProjectNumber(), HtmlGenerator::endQuickIndices(), RTFGenerator::endSection(), ManGenerator::endSection(), LatexGenerator::endSection(), HtmlGenerator::endSection(), RTFGenerator::endSimpleSect(), LatexGenerator::endSimpleSect(), HtmlGenerator::endSimpleSect(), RTFGenerator::endSmall(), LatexGenerator::endSmall(), RTFGenerator::endSubsection(), ManGenerator::endSubsection(), LatexGenerator::endSubsection(), RTFGenerator::endSubsubsection(), ManGenerator::endSubsubsection(), LatexGenerator::endSubsubsection(), RTFGenerator::endTextBlock(), RTFGenerator::endTextLink(), LatexGenerator::endTextLink(), HtmlGenerator::endTextLink(), ManGenerator::endTitle(), LatexGenerator::endTitle(), ManGenerator::endTitleHead(), RTFGenerator::endTitleHead(), LatexGenerator::endTitleHead(), HtmlGenerator::endTitleHead(), ManGenerator::endTypewriter(), RTFGenerator::endTypewriter(), LatexGenerator::endTypewriter(), RTFGenerator::exceptionEntry(), LatexGenerator::exceptionEntry(), HtmlGenerator::exceptionEntry(), HtmlGenerator::init(), HtmlGenerator::insertMemberAlign(), RTFGenerator::lastIndexPage(), RTFGenerator::lineBreak(), ManGenerator::lineBreak(), LatexGenerator::lineBreak(), HtmlGenerator::lineBreak(), ManGenerator::newParagraph(), RTFGenerator::newParagraph(), LatexGenerator::newParagraph(), RTFGenerator::rtfwriteRuler_doubleline(), RTFGenerator::rtfwriteRuler_emboss(), RTFGenerator::rtfwriteRuler_thick(), RTFGenerator::rtfwriteRuler_thin(), LatexGenerator::startAnonTypeScope(), RTFGenerator::startBold(), ManGenerator::startBold(), LatexGenerator::startBold(), RTFGenerator::startCallGraph(), HtmlGenerator::startCallGraph(), RTFGenerator::startCenter(), LatexGenerator::startCenter(), RTFGenerator::startClassDiagram(), HtmlGenerator::startClassDiagram(), RTFGenerator::startCodeFragment(), ManGenerator::startCodeFragment(), LatexGenerator::startCodeFragment(), RTFGenerator::startConstraintDocs(), HtmlGenerator::startConstraintDocs(), RTFGenerator::startConstraintList(), ManGenerator::startConstraintList(), LatexGenerator::startConstraintList(), HtmlGenerator::startConstraintList(), RTFGenerator::startConstraintParam(), LatexGenerator::startConstraintParam(), HtmlGenerator::startConstraintParam(), RTFGenerator::startConstraintType(), LatexGenerator::startConstraintType(), HtmlGenerator::startConstraintType(), HtmlGenerator::startContents(), RTFGenerator::startDescForItem(), ManGenerator::startDescForItem(), LatexGenerator::startDescForItem(), RTFGenerator::startDescItem(), ManGenerator::startDescItem(), LatexGenerator::startDescItem(), RTFGenerator::startDescList(), ManGenerator::startDescList(), LatexGenerator::startDescList(), RTFGenerator::startDescription(), LatexGenerator::startDescription(), RTFGenerator::startDescTable(), LatexGenerator::startDescTable(), HtmlGenerator::startDescTable(), RTFGenerator::startDescTableData(), ManGenerator::startDescTableData(), LatexGenerator::startDescTableData(), HtmlGenerator::startDescTableData(), LatexGenerator::startDescTableRow(), HtmlGenerator::startDescTableRow(), RTFGenerator::startDescTableTitle(), LatexGenerator::startDescTableTitle(), HtmlGenerator::startDescTableTitle(), RTFGenerator::startDirDepGraph(), HtmlGenerator::startDirDepGraph(), RTFGenerator::startDotGraph(), HtmlGenerator::startDotGraph(), RTFGenerator::startDoxyAnchor(), LatexGenerator::startDoxyAnchor(), HtmlGenerator::startDoxyAnchor(), RTFGenerator::startEmphasis(), ManGenerator::startEmphasis(), LatexGenerator::startEmphasis(), LatexGenerator::startFile(), HtmlGenerator::startFile(), HtmlGenerator::startGroupCollaboration(), RTFGenerator::startGroupHeader(), ManGenerator::startGroupHeader(), LatexGenerator::startGroupHeader(), HtmlGenerator::startGroupHeader(), HtmlGenerator::startHeaderSection(), RTFGenerator::startHtmlLink(), LatexGenerator::startHtmlLink(), HtmlGenerator::startHtmlLink(), RTFGenerator::startInclDepGraph(), HtmlGenerator::startInclDepGraph(), RTFGenerator::startIndent(), HtmlGenerator::startIndent(), RTFGenerator::startIndexItem(), LatexGenerator::startIndexItem(), HtmlGenerator::startIndexItem(), RTFGenerator::startIndexKey(), LatexGenerator::startIndexKey(), HtmlGenerator::startIndexKey(), RTFGenerator::startIndexList(), LatexGenerator::startIndexList(), HtmlGenerator::startIndexList(), RTFGenerator::startIndexListItem(), HtmlGenerator::startIndexListItem(), RTFGenerator::startIndexSection(), LatexGenerator::startIndexSection(), RTFGenerator::startIndexValue(), LatexGenerator::startIndexValue(), HtmlGenerator::startIndexValue(), ManGenerator::startInlineHeader(), RTFGenerator::startInlineHeader(), LatexGenerator::startInlineHeader(), HtmlGenerator::startInlineHeader(), RTFGenerator::startInlineMemberDoc(), HtmlGenerator::startInlineMemberDoc(), RTFGenerator::startInlineMemberName(), ManGenerator::startInlineMemberName(), HtmlGenerator::startInlineMemberName(), RTFGenerator::startInlineMemberType(), HtmlGenerator::startInlineMemberType(), RTFGenerator::startItemList(), LatexGenerator::startItemList(), RTFGenerator::startItemListItem(), ManGenerator::startItemListItem(), LatexGenerator::startItemListItem(), LatexGenerator::startLabels(), HtmlGenerator::startLabels(), RTFGenerator::startMemberDescription(), ManGenerator::startMemberDescription(), HtmlGenerator::startMemberDescription(), LatexGenerator::startMemberDescription(), RTFGenerator::startMemberDoc(), ManGenerator::startMemberDoc(), LatexGenerator::startMemberDoc(), HtmlGenerator::startMemberDoc(), HtmlGenerator::startMemberDocList(), HtmlGenerator::startMemberDocName(), HtmlGenerator::startMemberDocPrefixItem(), RTFGenerator::startMemberDocSimple(), ManGenerator::startMemberDocSimple(), LatexGenerator::startMemberDocSimple(), HtmlGenerator::startMemberDocSimple(), ManGenerator::startMemberGroup(), RTFGenerator::startMemberGroup(), LatexGenerator::startMemberGroupDocs(), HtmlGenerator::startMemberGroupDocs(), RTFGenerator::startMemberGroupDocs(), ManGenerator::startMemberGroupHeader(), LatexGenerator::startMemberGroupHeader(), HtmlGenerator::startMemberGroupHeader(), RTFGenerator::startMemberGroupHeader(), ManGenerator::startMemberHeader(), LatexGenerator::startMemberHeader(), HtmlGenerator::startMemberHeader(), RTFGenerator::startMemberItem(), ManGenerator::startMemberItem(), LatexGenerator::startMemberItem(), HtmlGenerator::startMemberItem(), ManGenerator::startMemberList(), RTFGenerator::startMemberList(), LatexGenerator::startMemberList(), HtmlGenerator::startMemberList(), HtmlGenerator::startMemberSections(), RTFGenerator::startMemberSubtitle(), HtmlGenerator::startMemberSubtitle(), LatexGenerator::startMemberTemplateParams(), RTFGenerator::startPageRef(), LatexGenerator::startPageRef(), ManGenerator::startParagraph(), RTFGenerator::startParagraph(), LatexGenerator::startParagraph(), HtmlGenerator::startParagraph(), LatexGenerator::startParameterList(), HtmlGenerator::startParameterList(), LatexGenerator::startParameterName(), HtmlGenerator::startParameterName(), RTFGenerator::startParameterType(), LatexGenerator::startParameterType(), HtmlGenerator::startParameterType(), RTFGenerator::startParamList(), ManGenerator::startParamList(), LatexGenerator::startParamList(), HtmlGenerator::startParamList(), startPlainFile(), RTFGenerator::startProjectNumber(), LatexGenerator::startProjectNumber(), HtmlGenerator::startProjectNumber(), RTFGenerator::startSection(), LatexGenerator::startSection(), HtmlGenerator::startSection(), RTFGenerator::startSimpleSect(), ManGenerator::startSimpleSect(), LatexGenerator::startSimpleSect(), HtmlGenerator::startSimpleSect(), RTFGenerator::startSmall(), LatexGenerator::startSmall(), RTFGenerator::startSubsection(), ManGenerator::startSubsection(), LatexGenerator::startSubsection(), RTFGenerator::startSubsubsection(), ManGenerator::startSubsubsection(), LatexGenerator::startSubsubsection(), RTFGenerator::startTextBlock(), RTFGenerator::startTextLink(), LatexGenerator::startTextLink(), HtmlGenerator::startTextLink(), RTFGenerator::startTitle(), ManGenerator::startTitle(), LatexGenerator::startTitle(), RTFGenerator::startTitleHead(), LatexGenerator::startTitleHead(), HtmlGenerator::startTitleHead(), ManGenerator::startTypewriter(), RTFGenerator::startTypewriter(), LatexGenerator::startTypewriter(), RTFGenerator::writeAnchor(), LatexGenerator::writeAnchor(), ManGenerator::writeChar(), RTFGenerator::writeCodeLink(), ManGenerator::writeDoc(), RTFGenerator::writeDoc(), LatexGenerator::writeDoc(), HtmlGenerator::writeDoc(), RTFGenerator::writeEndAnnoItem(), ManGenerator::writeEndAnnoItem(), LatexGenerator::writeEndAnnoItem(), RTFGenerator::writeExtensionsFile(), HtmlGenerator::writeExternalSearchPage(), HtmlGenerator::writeFooter(), LatexGenerator::writeFooterFile(), HtmlGenerator::writeFooterFile(), HtmlGenerator::writeGraphicalHierarchy(), LatexGenerator::writeHeaderFile(), HtmlGenerator::writeHeaderFile(), HtmlGenerator::writeInheritedSectionTitle(), RTFGenerator::writeLabel(), ManGenerator::writeLabel(), LatexGenerator::writeLabel(), HtmlGenerator::writeLabel(), LatexGenerator::writeLatexSpacing(), RTFGenerator::writeLineNumber(), ManGenerator::writeLineNumber(), HtmlGenerator::writeLogo(), HtmlGenerator::writeNavigationPath(), RTFGenerator::writeNonBreakableSpace(), ManGenerator::writeNonBreakableSpace(), LatexGenerator::writeNonBreakableSpace(), HtmlGenerator::writeNonBreakableSpace(), RTFGenerator::writeObjectLink(), LatexGenerator::writeObjectLink(), HtmlGenerator::writeObjectLink(), RTFGenerator::writePageLink(), LatexGenerator::writePageLink(), HtmlGenerator::writeQuickLinks(), RTFGenerator::writeRTFReference(), LatexGenerator::writeRuler(), HtmlGenerator::writeSearchData(), HtmlGenerator::writeSearchInfo(), HtmlGenerator::writeSearchPage(), HtmlGenerator::writeSplitBar(), RTFGenerator::writeStartAnnoItem(), LatexGenerator::writeStartAnnoItem(), HtmlGenerator::writeStartAnnoItem(), RTFGenerator::writeString(), LatexGenerator::writeString(), HtmlGenerator::writeString(), LatexGenerator::writeStyleInfo(), HtmlGenerator::writeStyleInfo(), RTFGenerator::writeStyleSheetFile(), LatexGenerator::writeStyleSheetFile(), HtmlGenerator::writeStyleSheetFile(), HtmlGenerator::writeSummaryLink(), and ManGenerator::writeSynopsis().


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