CodeOutputInterface Class Reference

#include <outputgen.h>

Inheritance diagram for CodeOutputInterface:

Public Member Functions
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

Detailed Description

Output interface for code parser.

Definition at line 59 of file outputgen.h.

Constructor & Destructor Documentation

virtual CodeOutputInterface::~CodeOutputInterface ( )

inlinevirtual

Definition at line 62 of file outputgen.h.

{}

Member Function Documentation

virtual void CodeOutputInterface::addWord ( const char *  word, bool  hiPriority  )

pure virtual

Implemented in OutputList, XMLCodeGenerator, LatexGenerator, DocbookCodeGenerator, RTFGenerator, ManGenerator, HtmlGenerator, DevNullCodeDocInterface, XRefDummyCodeGenerator, HtmlCodeGenerator, and LatexCodeGenerator.

virtual void CodeOutputInterface::codify ( const char *  s )

pure virtual

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.

Implemented in XMLCodeGenerator, DocbookCodeGenerator, OutputList, HtmlGenerator, LatexGenerator, ManGenerator, RTFGenerator, DevNullCodeDocInterface, XRefDummyCodeGenerator, HtmlCodeGenerator, and LatexCodeGenerator.

virtual void CodeOutputInterface::endCodeLine ( )

pure virtual

Ends a line of code started with startCodeLine()

Implemented in XMLCodeGenerator, OutputList, DocbookCodeGenerator, ManGenerator, RTFGenerator, HtmlGenerator, LatexGenerator, DevNullCodeDocInterface, XRefDummyCodeGenerator, HtmlCodeGenerator, and LatexCodeGenerator.

virtual void CodeOutputInterface::endFontClass ( )

pure virtual

Ends a block started with startFontClass()

Implemented in OutputList, XMLCodeGenerator, RTFGenerator, DocbookCodeGenerator, ManGenerator, HtmlGenerator, LatexGenerator, DevNullCodeDocInterface, XRefDummyCodeGenerator, HtmlCodeGenerator, and LatexCodeGenerator.

virtual void CodeOutputInterface::setCurrentDoc ( Definition *  context, const char *  anchor, bool  isSourceFile  )

pure virtual

Implemented in OutputList, XMLCodeGenerator, LatexGenerator, RTFGenerator, DocbookCodeGenerator, ManGenerator, HtmlGenerator, DevNullCodeDocInterface, XRefDummyCodeGenerator, HtmlCodeGenerator, and LatexCodeGenerator.

virtual void CodeOutputInterface::startCodeLine ( bool  hasLineNumbers )

pure virtual

Implemented in XMLCodeGenerator, OutputList, DocbookCodeGenerator, ManGenerator, RTFGenerator, HtmlGenerator, LatexGenerator, DevNullCodeDocInterface, XRefDummyCodeGenerator, HtmlCodeGenerator, and LatexCodeGenerator.

virtual void CodeOutputInterface::startFontClass ( const char *  clsName )

pure virtual

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

clsName

The category name.

Implemented in OutputList, XMLCodeGenerator, RTFGenerator, ManGenerator, DocbookCodeGenerator, HtmlGenerator, LatexGenerator, DevNullCodeDocInterface, XRefDummyCodeGenerator, HtmlCodeGenerator, and LatexCodeGenerator.

virtual void CodeOutputInterface::writeCodeAnchor ( const char *  name )

pure virtual

Write an anchor to a source listing.

Parameters

name	The name of the anchor.

Implemented in OutputList, XMLCodeGenerator, RTFGenerator, ManGenerator, DocbookCodeGenerator, HtmlGenerator, LatexGenerator, DevNullCodeDocInterface, XRefDummyCodeGenerator, HtmlCodeGenerator, and LatexCodeGenerator.

virtual void CodeOutputInterface::writeCodeLink ( const char *  ref, const char *  file, const char *  anchor, const char *  name, const char *  tooltip  )

pure virtual

Writes a link to an object in a code fragment.

Parameters

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.
tooltip	The tooltip to display when the mouse is on the link.

Implemented in XMLCodeGenerator, DocbookCodeGenerator, OutputList, HtmlGenerator, LatexGenerator, ManGenerator, RTFGenerator, DevNullCodeDocInterface, XRefDummyCodeGenerator, HtmlCodeGenerator, and LatexCodeGenerator.

virtual void CodeOutputInterface::writeLineNumber ( const char *  ref, const char *  file, const char *  anchor, int  lineNumber  )

pure virtual

Writes the line number of a source listing

Parameters

ref	External reference (when imported from a tag file)
file	The file part of the URL pointing to the docs.
anchor	The anchor part of the URL pointing to the docs.
lineNumber	The line number to write

Implemented in XMLCodeGenerator, OutputList, DocbookCodeGenerator, ManGenerator, RTFGenerator, HtmlGenerator, LatexGenerator, DevNullCodeDocInterface, XRefDummyCodeGenerator, HtmlCodeGenerator, and LatexCodeGenerator.

virtual void CodeOutputInterface::writeTooltip ( const char *  id, const DocLinkInfo &  docInfo, const char *  decl, const char *  desc, const SourceLinkInfo &  defInfo, const SourceLinkInfo &  declInfo  )

pure virtual

Writes a tool tip definition

Parameters

id	unique identifier for the tooltip
docInfo	Info about the symbol's documentation.
decl	full declaration of the symbol (for functions)
desc	brief description for the symbol
defInfo	Info about the symbol's definition in the source code
declInfo	Info about the symbol's declaration in the source code

Implemented in XMLCodeGenerator, DocbookCodeGenerator, OutputList, HtmlGenerator, LatexGenerator, ManGenerator, RTFGenerator, DevNullCodeDocInterface, XRefDummyCodeGenerator, HtmlCodeGenerator, and LatexCodeGenerator.

---

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

• doxygen-1.8.11/src/outputgen.h