BaseOutputDocInterface Class Reference

Base Interface used for generating output outside of the comment blocks. More...

#include <outputgen.h>

Inheritance diagram for BaseOutputDocInterface:

List of all members.

Public Types
enum	ParamListTypes { Param, RetVal, Exception }
enum	SectionTypes { EnumValues, Examples }
Public Member Functions
virtual	~BaseOutputDocInterface ()
virtual void	parseDoc (const char *, int, const char *, MemberDef *, const QCString &, bool)
virtual void	parseText (const QCString &)
virtual void	startItemList ()=0
virtual void	writeListItem ()=0
virtual void	endItemList ()=0
virtual void	docify (const char *s)=0
virtual void	writeChar (char c)=0
virtual void	writeString (const char *text)=0
virtual void	newParagraph ()=0
virtual void	startParagraph ()=0
virtual void	endParagraph ()=0
virtual void	writeObjectLink (const char *ref, const char *file, const char *anchor, const char *name)=0
virtual void	startHtmlLink (const char *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	startCodeFragment ()=0
virtual void	endCodeFragment ()=0
virtual void	writeRuler ()=0
virtual void	startDescription ()=0
virtual void	endDescription ()=0
virtual void	startDescItem ()=0
virtual void	endDescItem ()=0
virtual void	startCenter ()=0
virtual void	endCenter ()=0
virtual void	startSmall ()=0
virtual void	endSmall ()=0
virtual void	startSimpleSect (SectionTypes t, const char *file, const char *anchor, const char *title)=0
virtual void	endSimpleSect ()=0
virtual void	startParamList (ParamListTypes t, const char *title)=0
virtual void	endParamList ()=0
virtual void	writeDescItem ()=0
virtual void	startTitle ()=0
virtual void	endTitle ()=0
virtual void	writeAnchor (const char *fileName, const char *name)=0
virtual void	startSection (const char *, const char *, SectionInfo::SectionType)=0
virtual void	endSection (const char *, SectionInfo::SectionType)=0
virtual void	lineBreak ()=0
virtual void	addIndexItem (const char *s1, const char *s2)=0
virtual void	writeNonBreakableSpace (int)=0
virtual void	startDescTable ()=0
virtual void	endDescTable ()=0
virtual void	startDescTableTitle ()=0
virtual void	endDescTableTitle ()=0
virtual void	startDescTableData ()=0
virtual void	endDescTableData ()=0
virtual void	startTextLink (const char *file, const char *anchor)=0
virtual void	endTextLink ()=0
virtual void	startPageRef ()=0
virtual void	endPageRef (const char *, const char *)=0
virtual void	startSubsection ()=0
virtual void	endSubsection ()=0
virtual void	startSubsubsection ()=0
virtual void	endSubsubsection ()=0

---

Detailed Description

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.

Definition at line 87 of file outputgen.h.

---

Member Enumeration Documentation

enum BaseOutputDocInterface::ParamListTypes

Enumerator:

Param
RetVal
Exception

Definition at line 91 of file outputgen.h.

enum BaseOutputDocInterface::SectionTypes

Enumerator:

EnumValues
Examples

Definition at line 92 of file outputgen.h.

---

Constructor & Destructor Documentation

virtual BaseOutputDocInterface::~BaseOutputDocInterface

(

)

[inline, virtual]

Definition at line 90 of file outputgen.h.

---

Member Function Documentation

virtual void BaseOutputDocInterface::parseDoc	(	const char *	,
		int	,
		const char *	,
		MemberDef *	,
		const QCString &	,
		bool
	)			[inline, virtual]

Definition at line 100 of file outputgen.h.

virtual void BaseOutputDocInterface::parseText

(

const QCString &

)

[inline, virtual]

Reimplemented in OutputList.

Definition at line 102 of file outputgen.h.

virtual void BaseOutputDocInterface::startItemList

(

)

[pure virtual]

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

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

Referenced by OutputList::startItemList().

virtual void BaseOutputDocInterface::writeListItem

(

)

[pure virtual]

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

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

Referenced by OutputList::writeListItem().

virtual void BaseOutputDocInterface::endItemList

(

)

[pure virtual]

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

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

Referenced by OutputList::endItemList().

virtual void BaseOutputDocInterface::docify

(

const char *

s

)

[pure virtual]

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

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

Referenced by OutputList::docify(), generateFileRef(), generateLink(), generateRef(), writePageRef(), and TextGeneratorOLImpl::writeString().

virtual void BaseOutputDocInterface::writeChar

(

char

c

)

[pure virtual]

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

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

Referenced by OutputList::writeChar().

virtual void BaseOutputDocInterface::writeString

(

const char *

text

)

[pure virtual]

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

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

Referenced by OutputList::writeString().

virtual void BaseOutputDocInterface::newParagraph

(

)

[pure virtual]

Starts a new paragraph

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

Referenced by OutputList::newParagraph().

virtual void BaseOutputDocInterface::startParagraph

(

)

[pure virtual]

Starts a new paragraph

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

Referenced by OutputList::startParagraph().

virtual void BaseOutputDocInterface::endParagraph

(

)

[pure virtual]

End a paragraph

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

Referenced by OutputList::endParagraph().

virtual void BaseOutputDocInterface::writeObjectLink	(	const char *	ref,
		const char *	file,
		const char *	anchor,
		const char *	name
	)			[pure virtual]

Writes a link to an object in the documentation.

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.

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

Referenced by generateFileRef(), generateLink(), generateRef(), TextGeneratorOLImpl::writeLink(), and OutputList::writeObjectLink().

virtual void BaseOutputDocInterface::startHtmlLink

(

const char *

url

)

[pure virtual]

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

Parameters:

url

The URL to link to.

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

Referenced by OutputList::startHtmlLink().

virtual void BaseOutputDocInterface::endHtmlLink

(

)

[pure virtual]

Ends a link started by startHtmlLink().

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

Referenced by OutputList::endHtmlLink().

virtual void BaseOutputDocInterface::startBold

(

)

[pure virtual]

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

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

Referenced by OutputList::startBold().

virtual void BaseOutputDocInterface::endBold

(

)

[pure virtual]

End a section of text displayed in bold face.

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

Referenced by OutputList::endBold().

virtual void BaseOutputDocInterface::startTypewriter

(

)

[pure virtual]

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

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

Referenced by OutputList::startTypewriter().

virtual void BaseOutputDocInterface::endTypewriter

(

)

[pure virtual]

End a section of text displayed in typewriter style.

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

Referenced by OutputList::endTypewriter().

virtual void BaseOutputDocInterface::startEmphasis

(

)

[pure virtual]

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

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

Referenced by OutputList::startEmphasis().

virtual void BaseOutputDocInterface::endEmphasis

(

)

[pure virtual]

Ends a section of text displayed in italic.

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

Referenced by OutputList::endEmphasis().

virtual void BaseOutputDocInterface::startCodeFragment

(

)

[pure virtual]

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()

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

Referenced by OutputList::startCodeFragment().

virtual void BaseOutputDocInterface::endCodeFragment

(

)

[pure virtual]

Ends a source code fragment

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

Referenced by OutputList::endCodeFragment().

virtual void BaseOutputDocInterface::writeRuler

(

)

[pure virtual]

Writes a horizontal ruler to the output

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

Referenced by OutputList::writeRuler().

virtual void BaseOutputDocInterface::startDescription

(

)

[pure virtual]

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

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

Referenced by OutputList::startDescription().

virtual void BaseOutputDocInterface::endDescription

(

)

[pure virtual]

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

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

Referenced by OutputList::endDescription().

virtual void BaseOutputDocInterface::startDescItem

(

)

[pure virtual]

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

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

Referenced by OutputList::startDescItem().

virtual void BaseOutputDocInterface::endDescItem

(

)

[pure virtual]

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

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

Referenced by OutputList::endDescItem().

virtual void BaseOutputDocInterface::startCenter

(

)

[pure virtual]

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

Referenced by OutputList::startCenter().

virtual void BaseOutputDocInterface::endCenter

(

)

[pure virtual]

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

Referenced by OutputList::endCenter().

virtual void BaseOutputDocInterface::startSmall

(

)

[pure virtual]

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

Referenced by OutputList::startSmall().

virtual void BaseOutputDocInterface::endSmall

(

)

[pure virtual]

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

Referenced by OutputList::endSmall().

virtual void BaseOutputDocInterface::startSimpleSect	(	SectionTypes	t,
		const char *	file,
		const char *	anchor,
		const char *	title
	)			[pure virtual]

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

Referenced by OutputList::startSimpleSect().

virtual void BaseOutputDocInterface::endSimpleSect

(

)

[pure virtual]

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

Referenced by OutputList::endSimpleSect().

virtual void BaseOutputDocInterface::startParamList	(	ParamListTypes	t,
		const char *	title
	)			[pure virtual]

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

Referenced by OutputList::startParamList().

virtual void BaseOutputDocInterface::endParamList

(

)

[pure virtual]

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

Referenced by OutputList::endParamList().

virtual void BaseOutputDocInterface::writeDescItem

(

)

[pure virtual]

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

Referenced by OutputList::writeDescItem().

virtual void BaseOutputDocInterface::startTitle

(

)

[pure virtual]

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

Referenced by OutputList::startTitle().

virtual void BaseOutputDocInterface::endTitle

(

)

[pure virtual]

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

Referenced by OutputList::endTitle().

virtual void BaseOutputDocInterface::writeAnchor	(	const char *	fileName,
		const char *	name
	)			[pure virtual]

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

Referenced by OutputList::writeAnchor().

virtual void BaseOutputDocInterface::startSection	(	const char *	,
		const char *	,
		SectionInfo::SectionType
	)			[pure virtual]

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

Referenced by OutputList::startSection().

virtual void BaseOutputDocInterface::endSection	(	const char *	,
		SectionInfo::SectionType
	)			[pure virtual]

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

Referenced by OutputList::endSection().

virtual void BaseOutputDocInterface::lineBreak

(

)

[pure virtual]

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

Referenced by OutputList::lineBreak(), and TextGeneratorOLImpl::writeBreak().

virtual void BaseOutputDocInterface::addIndexItem	(	const char *	s1,
		const char *	s2
	)			[pure virtual]

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

Referenced by OutputList::addIndexItem().

virtual void BaseOutputDocInterface::writeNonBreakableSpace

(

int

)

[pure virtual]

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

Referenced by OutputList::writeNonBreakableSpace(), and TextGeneratorOLImpl::writeString().

virtual void BaseOutputDocInterface::startDescTable

(

)

[pure virtual]

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

Referenced by OutputList::startDescTable().

virtual void BaseOutputDocInterface::endDescTable

(

)

[pure virtual]

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

Referenced by OutputList::endDescTable().

virtual void BaseOutputDocInterface::startDescTableTitle

(

)

[pure virtual]

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

Referenced by OutputList::startDescTableTitle().

virtual void BaseOutputDocInterface::endDescTableTitle

(

)

[pure virtual]

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

Referenced by OutputList::endDescTableTitle().

virtual void BaseOutputDocInterface::startDescTableData

(

)

[pure virtual]

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

Referenced by OutputList::startDescTableData().

virtual void BaseOutputDocInterface::endDescTableData

(

)

[pure virtual]

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

Referenced by OutputList::endDescTableData().

virtual void BaseOutputDocInterface::startTextLink	(	const char *	file,
		const char *	anchor
	)			[pure virtual]

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

Referenced by OutputList::startTextLink().

virtual void BaseOutputDocInterface::endTextLink

(

)

[pure virtual]

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

Referenced by OutputList::endTextLink().

virtual void BaseOutputDocInterface::startPageRef

(

)

[pure virtual]

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

Referenced by OutputList::startPageRef(), and writePageRef().

virtual void BaseOutputDocInterface::endPageRef	(	const char *	,
		const char *
	)			[pure virtual]

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

Referenced by OutputList::endPageRef(), and writePageRef().

virtual void BaseOutputDocInterface::startSubsection

(

)

[pure virtual]

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

Referenced by OutputList::startSubsection().

virtual void BaseOutputDocInterface::endSubsection

(

)

[pure virtual]

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

Referenced by OutputList::endSubsection().

virtual void BaseOutputDocInterface::startSubsubsection

(

)

[pure virtual]

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

Referenced by OutputList::startSubsubsection().

virtual void BaseOutputDocInterface::endSubsubsection

(

)

[pure virtual]

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

Referenced by OutputList::endSubsubsection().

---

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

• outputgen.h

---

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