Abstract output generator. More...
#include <outputgen.h>
Inheritance diagram for OutputGenerator:
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 | |
| 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 OutputGenerator * | get (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 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 (const char *classDef)=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 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 |
Detailed Description
Abstract output generator.
Subclass this class to add support for a new output format
The documentation for this class was generated from the following files:
- src/outputgen.h
- src/outputgen.cpp
