XMLCodeGenerator Class Reference

Inheritance diagram for XMLCodeGenerator:


Public Member Functions
	XMLCodeGenerator (QTextStream &t)
virtual	~XMLCodeGenerator ()
void	codify (const char *text)
void	writeCodeLink (const char ref, const char file, const char anchor, const char name, const char *tooltip)
void	startCodeLine ()
void	endCodeLine ()
void	startCodeAnchor (const char *id)
void	endCodeAnchor ()
void	startFontClass (const char *colorClass)
void	endFontClass ()
void	writeCodeAnchor (const char *)
void	writeLineNumber (const char extRef, const char compId, const char *anchorId, int l)
void	linkableSymbol (int, const char , Definition , Definition *)
void	finish ()

Detailed Description

Definition at line 271 of file xmlgen.cpp.

Constructor & Destructor Documentation

XMLCodeGenerator::XMLCodeGenerator ( QTextStream & t ) [inline]

Definition at line 275 of file xmlgen.cpp.

virtual XMLCodeGenerator::~XMLCodeGenerator ( ) [inline, virtual]

Definition at line 278 of file xmlgen.cpp.

Member Function Documentation

void XMLCodeGenerator::codify ( const char * text ) [inline, 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.

Implements CodeOutputInterface.

Definition at line 280 of file xmlgen.cpp.

References writeXMLCodeString(), and XML_DB.

void XMLCodeGenerator::writeCodeLink	(	const char *	ref,
		const char *	file,
		const char *	anchor,
		const char *	name,
		const char *	tooltip
	)			`[inline, 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.