doxygen
|
Base Interface used for generating output outside of the comment blocks. More...
#include <outputgen.h>
Public Types | |
enum | ParamListTypes { Param, RetVal, Exception } |
enum | SectionTypes { EnumValues, Examples } |
Public Member Functions | |
virtual void | parseText (const QCString &) |
virtual void | startItemList ()=0 |
virtual void | startItemListItem ()=0 |
virtual void | endItemListItem ()=0 |
virtual void | endItemList ()=0 |
virtual void | docify (const QCString &s)=0 |
virtual void | writeChar (char c)=0 |
virtual void | writeString (const QCString &text)=0 |
virtual void | startParagraph (const QCString &classDef)=0 |
virtual void | endParagraph ()=0 |
virtual void | writeObjectLink (const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name)=0 |
virtual void | startHtmlLink (const QCString &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 | 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 | startExamples ()=0 |
virtual void | endExamples ()=0 |
virtual void | startParamList (ParamListTypes t, const QCString &title)=0 |
virtual void | endParamList ()=0 |
virtual void | startTitle ()=0 |
virtual void | endTitle ()=0 |
virtual void | writeAnchor (const QCString &fileName, const QCString &name)=0 |
virtual void | startSection (const QCString &, const QCString &, SectionType)=0 |
virtual void | endSection (const QCString &, SectionType)=0 |
virtual void | lineBreak (const QCString &style)=0 |
virtual void | addIndexItem (const QCString &s1, const QCString &s2)=0 |
virtual void | writeNonBreakableSpace (int)=0 |
virtual void | startDescTable (const QCString &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 QCString &file, const QCString &anchor)=0 |
virtual void | endTextLink ()=0 |
virtual void | startPageRef ()=0 |
virtual void | endPageRef (const QCString &, const QCString &)=0 |
virtual void | startSubsection ()=0 |
virtual void | endSubsection ()=0 |
virtual void | startSubsubsection ()=0 |
virtual void | endSubsubsection ()=0 |
![]() | |
CodeOutputInterface (const CodeOutputInterface &)=delete | |
CodeOutputInterface & | operator= (const CodeOutputInterface &)=delete |
virtual int | id () const |
Identifier for the output file. | |
virtual void | codify (const QCString &s)=0 |
virtual void | writeCodeLink (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip)=0 |
virtual void | writeLineNumber (const QCString &ref, const QCString &file, const QCString &anchor, int lineNumber, bool writeLineAnchor)=0 |
virtual void | writeTooltip (const QCString &id, const DocLinkInfo &docInfo, const QCString &decl, const QCString &desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)=0 |
virtual void | startCodeLine (bool hasLineNumbers)=0 |
virtual void | endCodeLine ()=0 |
virtual void | startFontClass (const QCString &clsName)=0 |
virtual void | endFontClass ()=0 |
virtual void | writeCodeAnchor (const QCString &name)=0 |
virtual void | setCurrentDoc (const Definition *context, const QCString &anchor, bool isSourceFile) |
virtual void | addWord (const QCString &word, bool hiPriority) |
virtual void | startCodeFragment (const QCString &style)=0 |
virtual void | endCodeFragment (const QCString &style)=0 |
Base Interface used for generating output outside of the comment blocks.
This abstract class is used by output generation functions to generate the output for a specific format, or a list of formats (see OutputList). This interface contains functions that generate fragments of the output.
|
pure virtual |
Writes an ASCII string to the output. Converts characters that have A special meaning, like &
in html.
Implemented in DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator, and ManGenerator.
|
pure virtual |
End a section of text displayed in bold face.
Implemented in OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator, and ManGenerator.
|
pure virtual |
Ends an item of a description list and starts the description itself: e.g. </dt>
in HTML.
Implemented in OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator, and ManGenerator.
|
pure virtual |
Ends a description list: e.g. </dl>
in HTML
Implemented in OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator, and ManGenerator.
|
pure virtual |
Ends a section of text displayed in italic.
Implemented in OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator, and ManGenerator.
|
pure virtual |
Ends a link started by startHtmlLink().
Implemented in DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator, and ManGenerator.
|
pure virtual |
Ends a bullet list: e.g. </ul>
in html
Implemented in DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator, and ManGenerator.
|
pure virtual |
Writes a list item for a bullet or enumerated list: e.g. </li>
in html
Implemented in OutputList, LatexGenerator, HtmlGenerator, DocbookGenerator, ManGenerator, and RTFGenerator.
|
pure virtual |
Ends a paragraph
Implemented in DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator, and ManGenerator.
|
pure virtual |
End a section of text displayed in typewriter style.
Implemented in DocbookGenerator, LatexGenerator, OutputList, HtmlGenerator, RTFGenerator, and ManGenerator.
|
pure virtual |
Changes the text font to bold face. The bold section ends with endBold()
Implemented in OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator, and ManGenerator.
|
pure virtual |
Starts an item of a description list: e.g. <dt>
in HTML.
Implemented in OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator, and ManGenerator.
|
pure virtual |
Starts a description list: e.g. <dl>
in HTML Items are surrounded by startDescItem() and endDescItem()
Implemented in OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator, and ManGenerator.
|
pure virtual |
Changes the text font to italic. The italic section ends with endEmphasis()
Implemented in OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator, and ManGenerator.
|
pure virtual |
Starts a (link to an) URL found in the documentation.
url | The URL to link to. |
Implemented in DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator, and ManGenerator.
|
pure virtual |
Start of a bullet list: e.g. <ul>
in html. startItemListItem() is Used for the bullet items.
Implemented in DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator, and ManGenerator.
|
pure virtual |
Writes a list item for a bullet or enumerated list: e.g. <li>
in html
Implemented in OutputList, LatexGenerator, HtmlGenerator, DocbookGenerator, ManGenerator, and RTFGenerator.
|
pure virtual |
Starts a new paragraph
Starts a new paragraph
Implemented in DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator, and ManGenerator.
|
pure virtual |
Changes the text font to fixed size. The section ends with endTypewriter()
Implemented in DocbookGenerator, LatexGenerator, OutputList, HtmlGenerator, RTFGenerator, and ManGenerator.
|
pure virtual |
Writes a single ASCII character to the output. Converts characters that have a special meaning.
Implemented in OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator, and ManGenerator.
|
pure virtual |
Writes a link to an object in the documentation.
ref | If this is non-zero, the object is to be found in an external documentation file. |
file | The file in which the object is located. |
anchor | The anchor uniquely identifying the object within the file. |
name | The text to display as a placeholder for the link. |
Implemented in DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator, and ManGenerator.
|
pure virtual |
Writes a horizontal ruler to the output
Implemented in OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, ManGenerator, and RTFGenerator.
|
pure virtual |
Writes an ASCII string to the output, without converting special characters.
Implemented in DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator, and ManGenerator.