CodeOutputInterface Class Reference

Output interface for code parser. More...

#include <outputgen.h>

Inheritance diagram for CodeOutputInterface:

List of all members.

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	startCodeLine ()=0
virtual void	endCodeLine ()=0
virtual void	startCodeAnchor (const char *label)=0
virtual void	endCodeAnchor ()=0
virtual void	startFontClass (const char *)=0
virtual void	endFontClass ()=0
virtual void	writeCodeAnchor (const char *name)=0
virtual void	linkableSymbol (int line, const char *symName, Definition *symDef, Definition *context)=0

---

Detailed Description

Output interface for code parser.

Definition at line 43 of file outputgen.h.

---

Constructor & Destructor Documentation

virtual CodeOutputInterface::~CodeOutputInterface

(

)

[inline, virtual]

Definition at line 46 of file outputgen.h.

---

Member Function Documentation

virtual void CodeOutputInterface::codify

(

const char *

s

)

[pure virtual]

Writes an ASCII string 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 DevNullCodeDocInterface, HtmlGenerator, LatexGenerator, ManGenerator, OutputList, RTFGenerator, and XMLCodeGenerator.

Referenced by OutputList::codify().

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 DevNullCodeDocInterface, HtmlGenerator, LatexGenerator, ManGenerator, OutputList, RTFGenerator, and XMLCodeGenerator.

Referenced by OutputList::writeCodeLink().

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

Implemented in DevNullCodeDocInterface, HtmlGenerator, LatexGenerator, ManGenerator, OutputList, RTFGenerator, and XMLCodeGenerator.

Referenced by OutputList::writeLineNumber().

virtual void CodeOutputInterface::startCodeLine

(

)

[pure virtual]

Implemented in DevNullCodeDocInterface, HtmlGenerator, LatexGenerator, ManGenerator, OutputList, RTFGenerator, and XMLCodeGenerator.

Referenced by OutputList::startCodeLine().

virtual void CodeOutputInterface::endCodeLine

(

)

[pure virtual]

Implemented in DevNullCodeDocInterface, HtmlGenerator, LatexGenerator, ManGenerator, OutputList, RTFGenerator, and XMLCodeGenerator.

Referenced by OutputList::endCodeLine(), parseFortranCode(), parsePythonCode(), and parseVhdlCode().

virtual void CodeOutputInterface::startCodeAnchor

(

const char *

label

)

[pure virtual]

Implemented in DevNullCodeDocInterface, HtmlGenerator, LatexGenerator, ManGenerator, OutputList, RTFGenerator, and XMLCodeGenerator.

Referenced by OutputList::startCodeAnchor().

virtual void CodeOutputInterface::endCodeAnchor

(

)

[pure virtual]

Implemented in DevNullCodeDocInterface, HtmlGenerator, LatexGenerator, ManGenerator, OutputList, RTFGenerator, and XMLCodeGenerator.

Referenced by OutputList::endCodeAnchor().

virtual void CodeOutputInterface::startFontClass

(

const char *

)

[pure virtual]

Implemented in DevNullCodeDocInterface, HtmlGenerator, LatexGenerator, ManGenerator, OutputList, RTFGenerator, and XMLCodeGenerator.

Referenced by OutputList::startFontClass().

virtual void CodeOutputInterface::endFontClass

(

)

[pure virtual]

Implemented in DevNullCodeDocInterface, HtmlGenerator, LatexGenerator, ManGenerator, OutputList, RTFGenerator, and XMLCodeGenerator.

Referenced by OutputList::endFontClass().

virtual void CodeOutputInterface::writeCodeAnchor

(

const char *

name

)

[pure virtual]

Implemented in DevNullCodeDocInterface, HtmlGenerator, LatexGenerator, ManGenerator, OutputList, RTFGenerator, and XMLCodeGenerator.

Referenced by OutputList::writeCodeAnchor().

virtual void CodeOutputInterface::linkableSymbol	(	int	line,
		const char *	symName,
		Definition *	symDef,
		Definition *	context
	)			[pure virtual]

Implemented in DevNullCodeDocInterface, HtmlGenerator, LatexGenerator, ManGenerator, OutputList, RTFGenerator, and XMLCodeGenerator.

---

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

• outputgen.h

---

• ソフトウェア開発
• ホームページ制作
• Tcl版
• STLport版
• Dradnats C++ Library
• 要約文庫