BaseOutputDocInterface Class Reference

#include <outputgen.h>

Inheritance diagram for BaseOutputDocInterface:

Public Types
enum	ParamListTypes { Param, RetVal, Exception }
enum	SectionTypes { EnumValues, Examples }

Public Member Functions
virtual	~BaseOutputDocInterface ()
virtual bool	parseText (const QCString &s)
virtual void	startItemList ()=0
virtual void	startItemListItem ()=0
virtual void	endItemListItem ()=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	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	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	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	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 (const char *style)=0
virtual void	addIndexItem (const char *s1, const char *s2)=0
virtual void	writeNonBreakableSpace (int)=0
virtual void	startDescTable (const char *title)=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
Public Member Functions inherited from CodeOutputInterface
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

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 139 of file outputgen.h.

Member Enumeration Documentation

enum BaseOutputDocInterface::ParamListTypes

Enumerator
Param
RetVal
Exception

Definition at line 143 of file outputgen.h.

{ Param, RetVal, Exception };

enum BaseOutputDocInterface::SectionTypes

Enumerator
EnumValues
Examples

Definition at line 144 of file outputgen.h.

                      { /*See, Return, Author, Version, 
                        Since, Date, Bug, Note,
                        Warning, Par, Deprecated, Pre, 
                        Post, Invar, Remark, Attention, 
                        Todo, Test, RCS, */ EnumValues, 
                        Examples 
                      };

Constructor & Destructor Documentation

virtual BaseOutputDocInterface::~BaseOutputDocInterface ( )

inlinevirtual

Definition at line 142 of file outputgen.h.

{}

Member Function Documentation

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

pure virtual

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

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, OutputList, ManGenerator, and RTFGenerator.

virtual void BaseOutputDocInterface::endBold ( )

pure virtual

End a section of text displayed in bold face.

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

virtual void BaseOutputDocInterface::endCenter ( )

pure virtual

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

virtual void BaseOutputDocInterface::endCodeFragment ( )

pure virtual

Ends a source code fragment

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

virtual void BaseOutputDocInterface::endDescForItem ( )

pure virtual

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

virtual void BaseOutputDocInterface::endDescItem ( )

pure virtual

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

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

virtual void BaseOutputDocInterface::endDescription ( )

pure virtual

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

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

virtual void BaseOutputDocInterface::endDescTable ( )

pure virtual

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

virtual void BaseOutputDocInterface::endDescTableData ( )

pure virtual

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

virtual void BaseOutputDocInterface::endDescTableTitle ( )

pure virtual

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

virtual void BaseOutputDocInterface::endEmphasis ( )

pure virtual

Ends a section of text displayed in italic.

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

virtual void BaseOutputDocInterface::endHtmlLink ( )

pure virtual

Ends a link started by startHtmlLink().

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

virtual void BaseOutputDocInterface::endItemList ( )

pure virtual

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

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

virtual void BaseOutputDocInterface::endItemListItem ( )

pure virtual

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

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

virtual void BaseOutputDocInterface::endPageRef ( const char *  , const char *    )

pure virtual

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

virtual void BaseOutputDocInterface::endParagraph ( )

pure virtual

Ends a paragraph

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

virtual void BaseOutputDocInterface::endParamList ( )

pure virtual

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

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

pure virtual

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

virtual void BaseOutputDocInterface::endSimpleSect ( )

pure virtual

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

virtual void BaseOutputDocInterface::endSmall ( )

pure virtual

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

virtual void BaseOutputDocInterface::endSubsection ( )

pure virtual

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

virtual void BaseOutputDocInterface::endSubsubsection ( )

pure virtual

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

virtual void BaseOutputDocInterface::endTextLink ( )

pure virtual

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

virtual void BaseOutputDocInterface::endTitle ( )

pure virtual

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

virtual void BaseOutputDocInterface::endTypewriter ( )

pure virtual

End a section of text displayed in typewriter style.

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

virtual void BaseOutputDocInterface::lineBreak ( const char *  style )

pure virtual

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

virtual bool BaseOutputDocInterface::parseText ( const QCString &  s )

inlinevirtual

Reimplemented in OutputList.

Definition at line 152 of file outputgen.h.

{ return s.isEmpty(); }

virtual void BaseOutputDocInterface::startBold ( )

pure virtual

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

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

virtual void BaseOutputDocInterface::startCenter ( )

pure virtual

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

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

virtual void BaseOutputDocInterface::startDescForItem ( )

pure virtual

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

virtual void BaseOutputDocInterface::startDescItem ( )

pure virtual

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

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

virtual void BaseOutputDocInterface::startDescription ( )

pure virtual

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

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

virtual void BaseOutputDocInterface::startDescTable ( const char *  title )

pure virtual

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

virtual void BaseOutputDocInterface::startDescTableData ( )

pure virtual

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

virtual void BaseOutputDocInterface::startDescTableTitle ( )

pure virtual

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

virtual void BaseOutputDocInterface::startEmphasis ( )

pure virtual

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

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

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

virtual void BaseOutputDocInterface::startItemList ( )

pure virtual

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

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

virtual void BaseOutputDocInterface::startItemListItem ( )

pure virtual

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

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

virtual void BaseOutputDocInterface::startPageRef ( )

pure virtual

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

virtual void BaseOutputDocInterface::startParagraph ( )

pure virtual

Starts a new paragraph

Starts a new paragraph

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

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

pure virtual

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

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

pure virtual

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

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

pure virtual

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

virtual void BaseOutputDocInterface::startSmall ( )

pure virtual

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

virtual void BaseOutputDocInterface::startSubsection ( )

pure virtual

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

virtual void BaseOutputDocInterface::startSubsubsection ( )

pure virtual

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

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

pure virtual

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

virtual void BaseOutputDocInterface::startTitle ( )

pure virtual

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

virtual void BaseOutputDocInterface::startTypewriter ( )

pure virtual

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

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

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

pure virtual

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

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

virtual void BaseOutputDocInterface::writeNonBreakableSpace ( int  )

pure virtual

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

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, OutputList, ManGenerator, and RTFGenerator.

virtual void BaseOutputDocInterface::writeRuler ( )

pure virtual

Writes a horizontal ruler to the output

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

virtual void BaseOutputDocInterface::writeString ( const char *  text )

pure virtual

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

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

---

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

• doxygen-1.8.11/src/outputgen.h