doxygen
Public Member Functions | List of all members
OutputList Class Reference

Class representing a list of output generators that are written to in parallel. More...

#include <outputlist.h>

Inheritance diagram for OutputList:
Inheritance graph
[legend]
Collaboration diagram for OutputList:
Collaboration graph
[legend]

Public Member Functions

 OutputList (const OutputList &ol)
 
OutputListoperator= (const OutputList &ol)
 
template<class Generator >
void add ()
 
size_t size () const
 
int id () const
 Identifier for the output file.
 
void disableAllBut (OutputGenerator::OutputType o)
 
void enableAll ()
 
void disableAll ()
 
void disable (OutputGenerator::OutputType o)
 
void enable (OutputGenerator::OutputType o)
 
bool isEnabled (OutputGenerator::OutputType o)
 
void pushGeneratorState ()
 
void popGeneratorState ()
 
void generateDoc (const QCString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const QCString &docStr, bool indexWords, bool isExample, const QCString &exampleName, bool singleLine, bool linkFromIndex, bool markdownSupport)
 
void writeDoc (DocRoot *root, const Definition *ctx, const MemberDef *md, int id=0)
 
void parseText (const QCString &textStr)
 
void startIndexSection (IndexSections is)
 
void endIndexSection (IndexSections is)
 
void writePageLink (const QCString &name, bool first)
 
void startProjectNumber ()
 
void endProjectNumber ()
 
void writeStyleInfo (int part)
 
void startFile (const QCString &name, const QCString &manName, const QCString &title)
 
void writeSearchInfo ()
 
void writeFooter (const QCString &navPath)
 
void endFile ()
 
void startTitleHead (const QCString &fileName)
 
void endTitleHead (const QCString &fileName, const QCString &name)
 
void startTitle ()
 
void endTitle ()
 
void startParagraph (const QCString &classDef=QCString())
 
void endParagraph ()
 
void writeString (const QCString &text)
 
void startIndexListItem ()
 
void endIndexListItem ()
 
void startIndexList ()
 
void endIndexList ()
 
void startIndexKey ()
 
void endIndexKey ()
 
void startIndexValue (bool b)
 
void endIndexValue (const QCString &name, bool b)
 
void startItemList ()
 
void endItemList ()
 
void startIndexItem (const QCString &ref, const QCString &file)
 
void endIndexItem (const QCString &ref, const QCString &file)
 
void docify (const QCString &s)
 
void codify (const QCString &s)
 
void writeObjectLink (const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name)
 
void writeCodeLink (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip)
 
void writeTooltip (const QCString &id, const DocLinkInfo &docInfo, const QCString &decl, const QCString &desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)
 
void startTextLink (const QCString &file, const QCString &anchor)
 
void endTextLink ()
 
void startHtmlLink (const QCString &url)
 
void endHtmlLink ()
 
void writeStartAnnoItem (const QCString &type, const QCString &file, const QCString &path, const QCString &name)
 
void writeEndAnnoItem (const QCString &name)
 
void startTypewriter ()
 
void endTypewriter ()
 
void startGroupHeader (int extraLevels=0)
 
void endGroupHeader (int extraLevels=0)
 
void startItemListItem ()
 
void endItemListItem ()
 
void startMemberSections ()
 
void endMemberSections ()
 
void startHeaderSection ()
 
void endHeaderSection ()
 
void startMemberHeader (const QCString &anchor, int typ=2)
 
void endMemberHeader ()
 
void startMemberSubtitle ()
 
void endMemberSubtitle ()
 
void startMemberDocList ()
 
void endMemberDocList ()
 
void startMemberList ()
 
void endMemberList ()
 
void startInlineHeader ()
 
void endInlineHeader ()
 
void startAnonTypeScope (int i1)
 
void endAnonTypeScope (int i1)
 
void startMemberItem (const QCString &anchor, int i1, const QCString &id=QCString())
 
void endMemberItem ()
 
void startMemberTemplateParams ()
 
void endMemberTemplateParams (const QCString &anchor, const QCString &inheritId)
 
void startCompoundTemplateParams ()
 
void endCompoundTemplateParams ()
 
void startMemberGroupHeader (bool b)
 
void endMemberGroupHeader ()
 
void startMemberGroupDocs ()
 
void endMemberGroupDocs ()
 
void startMemberGroup ()
 
void endMemberGroup (bool last)
 
void insertMemberAlign (bool templ=FALSE)
 
void insertMemberAlignLeft (int typ=0, bool templ=FALSE)
 
void writeRuler ()
 
void writeAnchor (const QCString &fileName, const QCString &name)
 
void startCodeFragment (const QCString &style)
 
void endCodeFragment (const QCString &style)
 
void startCodeLine (bool hasLineNumbers)
 
void endCodeLine ()
 
void writeLineNumber (const QCString &ref, const QCString &file, const QCString &anchor, int lineNumber)
 
void startEmphasis ()
 
void endEmphasis ()
 
void writeChar (char c)
 
void startMemberDoc (const QCString &clName, const QCString &memName, const QCString &anchor, const QCString &title, int memCount, int memTotal, bool showInline)
 
void endMemberDoc (bool hasArgs)
 
void startDoxyAnchor (const QCString &fName, const QCString &manName, const QCString &anchor, const QCString &name, const QCString &args)
 
void endDoxyAnchor (const QCString &fn, const QCString &anchor)
 
void writeLatexSpacing ()
 
void startDescription ()
 
void endDescription ()
 
void startDescItem ()
 
void endDescItem ()
 
void startDescForItem ()
 
void endDescForItem ()
 
void startSubsection ()
 
void endSubsection ()
 
void startSubsubsection ()
 
void endSubsubsection ()
 
void startCenter ()
 
void endCenter ()
 
void startSmall ()
 
void endSmall ()
 
void lineBreak (const QCString &style=QCString())
 
void startBold ()
 
void endBold ()
 
void startMemberDescription (const QCString &anchor, const QCString &inheritId=QCString(), bool typ=false)
 
void endMemberDescription ()
 
void startMemberDeclaration ()
 
void endMemberDeclaration (const QCString &anchor, const QCString &inheritId)
 
void writeInheritedSectionTitle (const QCString &id, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &title, const QCString &name)
 
void startExamples ()
 
void endExamples ()
 
void startParamList (ParamListTypes t, const QCString &title)
 
void endParamList ()
 
void startIndent ()
 
void endIndent ()
 
void startSection (const QCString &lab, const QCString &title, SectionType t)
 
void endSection (const QCString &lab, SectionType t)
 
void addIndexItem (const QCString &s1, const QCString &s2)
 
void writeSynopsis ()
 
void startClassDiagram ()
 
void endClassDiagram (const ClassDiagram &d, const QCString &f, const QCString &n)
 
void startPageRef ()
 
void endPageRef (const QCString &c, const QCString &a)
 
void startQuickIndices ()
 
void endQuickIndices ()
 
void writeSplitBar (const QCString &name)
 
void writeNavigationPath (const QCString &s)
 
void writeLogo ()
 
void writeQuickLinks (bool compact, HighlightedItem hli, const QCString &file)
 
void writeSummaryLink (const QCString &file, const QCString &anchor, const QCString &title, bool first)
 
void startContents ()
 
void endContents ()
 
void startPageDoc (const QCString &pageTitle)
 
void endPageDoc ()
 
void writeNonBreakableSpace (int num)
 
void startDescTable (const QCString &title)
 
void endDescTable ()
 
void startDescTableRow ()
 
void endDescTableRow ()
 
void startDescTableTitle ()
 
void endDescTableTitle ()
 
void startDescTableData ()
 
void endDescTableData ()
 
void startDotGraph ()
 
void endDotGraph (DotClassGraph &g)
 
void startInclDepGraph ()
 
void endInclDepGraph (DotInclDepGraph &g)
 
void startCallGraph ()
 
void endCallGraph (DotCallGraph &g)
 
void startDirDepGraph ()
 
void endDirDepGraph (DotDirDeps &g)
 
void startGroupCollaboration ()
 
void endGroupCollaboration (DotGroupCollaboration &g)
 
void writeGraphicalHierarchy (DotGfxHierarchyTable &g)
 
void startTextBlock (bool dense=FALSE)
 
void endTextBlock (bool paraBreak=FALSE)
 
void lastIndexPage ()
 
void startMemberDocPrefixItem ()
 
void endMemberDocPrefixItem ()
 
void startMemberDocName (bool align)
 
void endMemberDocName ()
 
void startParameterType (bool first, const QCString &key)
 
void endParameterType ()
 
void startParameterName (bool one)
 
void endParameterName (bool last, bool one, bool bracket)
 
void startParameterList (bool openBracket)
 
void endParameterList ()
 
void exceptionEntry (const QCString &prefix, bool closeBracket)
 
void startConstraintList (const QCString &header)
 
void startConstraintParam ()
 
void endConstraintParam ()
 
void startConstraintType ()
 
void endConstraintType ()
 
void startConstraintDocs ()
 
void endConstraintDocs ()
 
void endConstraintList ()
 
void startMemberDocSimple (bool b)
 
void endMemberDocSimple (bool b)
 
void startInlineMemberType ()
 
void endInlineMemberType ()
 
void startInlineMemberName ()
 
void endInlineMemberName ()
 
void startInlineMemberDoc ()
 
void endInlineMemberDoc ()
 
void startLabels ()
 
void writeLabel (const QCString &l, bool isLast)
 
void endLabels ()
 
void cleanup ()
 
void startFontClass (const QCString &c)
 
void endFontClass ()
 
void writeCodeAnchor (const QCString &name)
 
void setCurrentDoc (const Definition *context, const QCString &anchor, bool isSourceFile)
 
void addWord (const QCString &word, bool hiPriority)
 
void startPlainFile (const QCString &name)
 
void endPlainFile ()
 
- Public Member Functions inherited from CodeOutputInterface
 CodeOutputInterface (const CodeOutputInterface &)=delete
 
CodeOutputInterfaceoperator= (const CodeOutputInterface &)=delete
 

Additional Inherited Members

- Public Types inherited from BaseOutputDocInterface
enum  ParamListTypes { Param, RetVal, Exception }
 
enum  SectionTypes { EnumValues, Examples }
 

Detailed Description

Class representing a list of output generators that are written to in parallel.

Member Function Documentation

◆ codify()

void OutputList::codify ( const QCString s)
inlinevirtual

Writes an code fragment to the output. This function should keep spaces visible, should break lines at a newline and should convert tabs to the right number of spaces.

Implements CodeOutputInterface.

◆ disable()

void OutputList::disable ( OutputGenerator::OutputType  o)
virtual

Disables a specific output format (useful for OutputList only)

Implements OutputDocInterface.

◆ disableAll()

void OutputList::disableAll ( )
virtual

Disables all output formats (useful for OutputList only)

Implements OutputDocInterface.

◆ disableAllBut()

void OutputList::disableAllBut ( OutputGenerator::OutputType  o)
virtual

Disables all output formats except format o (useful for OutputList only)

Implements OutputDocInterface.

◆ docify()

void OutputList::docify ( const QCString s)
inlinevirtual

Writes an ASCII string to the output. Converts characters that have A special meaning, like & in html.

Implements BaseOutputDocInterface.

◆ enable()

void OutputList::enable ( OutputGenerator::OutputType  o)
virtual

Enables a specific output format (useful for OutputList only)

Implements OutputDocInterface.

◆ enableAll()

void OutputList::enableAll ( )
virtual

Enables all output formats as far as they have been enabled in the config file. (useful for OutputList only)

Implements OutputDocInterface.

◆ endBold()

void OutputList::endBold ( )
inlinevirtual

End a section of text displayed in bold face.

Implements BaseOutputDocInterface.

◆ endCodeFragment()

void OutputList::endCodeFragment ( const QCString style)
inlinevirtual

Ends a block of code

Implements CodeOutputInterface.

◆ endCodeLine()

void OutputList::endCodeLine ( )
inlinevirtual

Ends a line of code started with startCodeLine()

Implements CodeOutputInterface.

◆ endDescItem()

void OutputList::endDescItem ( )
inlinevirtual

Ends an item of a description list and starts the description itself: e.g. </dt> in HTML.

Implements BaseOutputDocInterface.

◆ endDescription()

void OutputList::endDescription ( )
inlinevirtual

Ends a description list: e.g. </dl> in HTML

Implements BaseOutputDocInterface.

◆ endEmphasis()

void OutputList::endEmphasis ( )
inlinevirtual

Ends a section of text displayed in italic.

Implements BaseOutputDocInterface.

◆ endFontClass()

void OutputList::endFontClass ( )
inlinevirtual

Ends a block started with startFontClass()

Implements CodeOutputInterface.

◆ endHtmlLink()

void OutputList::endHtmlLink ( )
inlinevirtual

Ends a link started by startHtmlLink().

Implements BaseOutputDocInterface.

◆ endItemList()

void OutputList::endItemList ( )
inlinevirtual

Ends a bullet list: e.g. </ul> in html

Implements BaseOutputDocInterface.

◆ endItemListItem()

void OutputList::endItemListItem ( )
inlinevirtual

Writes a list item for a bullet or enumerated list: e.g. </li> in html

Implements BaseOutputDocInterface.

◆ endParagraph()

void OutputList::endParagraph ( )
inlinevirtual

Ends a paragraph

Implements BaseOutputDocInterface.

◆ endTypewriter()

void OutputList::endTypewriter ( )
inlinevirtual

End a section of text displayed in typewriter style.

Implements BaseOutputDocInterface.

◆ isEnabled()

bool OutputList::isEnabled ( OutputGenerator::OutputType  o)
virtual

Check whether a specific output format is currently enabled (useful for OutputList only)

Implements OutputDocInterface.

◆ popGeneratorState()

void OutputList::popGeneratorState ( )
virtual

Pops the state of the current generator (or list of generators) on a stack. Should be preceded by a call the pushGeneratorState().

Implements OutputDocInterface.

◆ pushGeneratorState()

void OutputList::pushGeneratorState ( )
virtual

Appends the output generated by generator g to this generator.

Pushes the state of the current generator (or list of generators) on a stack.

Implements OutputDocInterface.

◆ startBold()

void OutputList::startBold ( )
inlinevirtual

Changes the text font to bold face. The bold section ends with endBold()

Implements BaseOutputDocInterface.

◆ startCodeFragment()

void OutputList::startCodeFragment ( const QCString style)
inlinevirtual

Starts a source code fragment. The fragment will be fed to the code parser (see code.h) for syntax highlighting and cross-referencing. The fragment ends by a call to endCodeFragment()

Parameters
styleThe kind of code fragment.

Implements CodeOutputInterface.

◆ startDescItem()

void OutputList::startDescItem ( )
inlinevirtual

Starts an item of a description list: e.g. <dt> in HTML.

Implements BaseOutputDocInterface.

◆ startDescription()

void OutputList::startDescription ( )
inlinevirtual

Starts a description list: e.g. <dl> in HTML Items are surrounded by startDescItem() and endDescItem()

Implements BaseOutputDocInterface.

◆ startEmphasis()

void OutputList::startEmphasis ( )
inlinevirtual

Changes the text font to italic. The italic section ends with endEmphasis()

Implements BaseOutputDocInterface.

◆ startFontClass()

void OutputList::startFontClass ( const QCString clsName)
inlinevirtual

Starts a block with a certain meaning. Used for syntax highlighting, which elements of the same type are rendered using the same 'font class'.

Parameters
clsNameThe category name.

Implements CodeOutputInterface.

◆ startHtmlLink()

void OutputList::startHtmlLink ( const QCString url)
inlinevirtual

Starts a (link to an) URL found in the documentation.

Parameters
urlThe URL to link to.

Implements BaseOutputDocInterface.

◆ startItemList()

void OutputList::startItemList ( )
inlinevirtual

Start of a bullet list: e.g. <ul> in html. startItemListItem() is Used for the bullet items.

Implements BaseOutputDocInterface.

◆ startItemListItem()

void OutputList::startItemListItem ( )
inlinevirtual

Writes a list item for a bullet or enumerated list: e.g. <li> in html

Implements BaseOutputDocInterface.

◆ startParagraph()

void OutputList::startParagraph ( const QCString classDef = QCString())
inlinevirtual

Starts a new paragraph

Starts a new paragraph

Implements BaseOutputDocInterface.

◆ startTypewriter()

void OutputList::startTypewriter ( )
inlinevirtual

Changes the text font to fixed size. The section ends with endTypewriter()

Implements BaseOutputDocInterface.

◆ writeChar()

void OutputList::writeChar ( char  c)
inlinevirtual

Writes a single ASCII character to the output. Converts characters that have a special meaning.

Implements BaseOutputDocInterface.

◆ writeCodeAnchor()

void OutputList::writeCodeAnchor ( const QCString name)
inlinevirtual

Write an anchor to a source listing.

Parameters
nameThe name of the anchor.

Implements CodeOutputInterface.

◆ writeCodeLink()

void OutputList::writeCodeLink ( CodeSymbolType  type,
const QCString ref,
const QCString file,
const QCString anchor,
const QCString name,
const QCString tooltip 
)
inlinevirtual

Writes a link to an object in a code fragment.

Parameters
typeThe type of symbol, used for semantic syntax highlighting, may be Default is no info is available.
refIf this is non-zero, the object is to be found in an external documentation file.
fileThe file in which the object is located.
anchorThe anchor uniquely identifying the object within the file.
nameThe text to display as a placeholder for the link.
tooltipThe tooltip to display when the mouse is on the link.

Implements CodeOutputInterface.

◆ writeLineNumber()

void OutputList::writeLineNumber ( const QCString ref,
const QCString file,
const QCString anchor,
int  lineNumber 
)
inlinevirtual

Writes the line number of a source listing

Parameters
refExternal reference (when imported from a tag file)
fileThe file part of the URL pointing to the docs.
anchorThe anchor part of the URL pointing to the docs.
lineNumberThe line number to write

Implements CodeOutputInterface.

◆ writeObjectLink()

void OutputList::writeObjectLink ( const QCString ref,
const QCString file,
const QCString anchor,
const QCString name 
)
inlinevirtual

Writes a link to an object in the documentation.

Parameters
refIf this is non-zero, the object is to be found in an external documentation file.
fileThe file in which the object is located.
anchorThe anchor uniquely identifying the object within the file.
nameThe text to display as a placeholder for the link.

Implements BaseOutputDocInterface.

◆ writeRuler()

void OutputList::writeRuler ( )
inlinevirtual

Writes a horizontal ruler to the output

Implements BaseOutputDocInterface.

◆ writeString()

void OutputList::writeString ( const QCString text)
inlinevirtual

Writes an ASCII string to the output, without converting special characters.

Implements BaseOutputDocInterface.

◆ writeTooltip()

void OutputList::writeTooltip ( const QCString id,
const DocLinkInfo docInfo,
const QCString decl,
const QCString desc,
const SourceLinkInfo defInfo,
const SourceLinkInfo declInfo 
)
inlinevirtual

Writes a tool tip definition

Parameters
idunique identifier for the tooltip
docInfoInfo about the symbol's documentation.
declfull declaration of the symbol (for functions)
descbrief description for the symbol
defInfoInfo about the symbol's definition in the source code
declInfoInfo about the symbol's declaration in the source code

Implements CodeOutputInterface.


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