Public Member Functions | List of all members
LatexCodeGenerator Class Reference
Inheritance diagram for LatexCodeGenerator:
Inheritance graph
Collaboration diagram for LatexCodeGenerator:
Collaboration graph

Public Member Functions

 LatexCodeGenerator (TextStream &t, const QCString &relPath, const QCString &sourceFile)
 LatexCodeGenerator (TextStream &t)
void setRelativePath (const QCString &path)
void setSourceFileName (const QCString &sourceFileName)
void codify (const QCString &text) override
void writeCodeLink (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip) override
void writeTooltip (const QCString &, const DocLinkInfo &, const QCString &, const QCString &, const SourceLinkInfo &, const SourceLinkInfo &) override
void writeLineNumber (const QCString &, const QCString &, const QCString &, int, bool) override
void startCodeLine (bool) override
void endCodeLine () override
void startFontClass (const QCString &) override
void endFontClass () override
void writeCodeAnchor (const QCString &) override
void setCurrentDoc (const Definition *, const QCString &, bool) override
void addWord (const QCString &, bool) override
void startCodeFragment (const QCString &style) override
void endCodeFragment (const QCString &style) override
void incUsedTableLevel ()
void decUsedTableLevel ()
int usedTableLevel () const
- Public Member Functions inherited from CodeOutputInterface
 CodeOutputInterface (const CodeOutputInterface &)=delete
CodeOutputInterfaceoperator= (const CodeOutputInterface &)=delete
virtual int id () const
 Identifier for the output file.

Member Function Documentation

◆ codify()

void LatexCodeGenerator::codify ( const QCString s)

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.

Implements CodeOutputInterface.

◆ endCodeFragment()

void LatexCodeGenerator::endCodeFragment ( const QCString style)

Ends a block of code

Implements CodeOutputInterface.

◆ endCodeLine()

void LatexCodeGenerator::endCodeLine ( )

Ends a line of code started with startCodeLine()

Implements CodeOutputInterface.

◆ endFontClass()

void LatexCodeGenerator::endFontClass ( )

Ends a block started with startFontClass()

Implements CodeOutputInterface.

◆ startCodeFragment()

void LatexCodeGenerator::startCodeFragment ( const QCString style)

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

styleThe kind of code fragment.

Implements CodeOutputInterface.

◆ startFontClass()

void LatexCodeGenerator::startFontClass ( const QCString clsName)

Starts a block with a certain meaning. Used for syntax highlighting, which elements of the same type are rendered using the same 'font class'.

clsNameThe category name.

Implements CodeOutputInterface.

◆ writeCodeAnchor()

void LatexCodeGenerator::writeCodeAnchor ( const QCString name)

Write an anchor to a source listing.

nameThe name of the anchor.

Implements CodeOutputInterface.

◆ writeCodeLink()

void LatexCodeGenerator::writeCodeLink ( CodeSymbolType  type,
const QCString ref,
const QCString file,
const QCString anchor,
const QCString name,
const QCString tooltip 

Writes a link to an object in a code fragment.

typeThe type of symbol, used for semantic syntax highlighting, may be Default is no info is available.
refIf this is non-zero, the object is to be found in an external documentation file.
fileThe file in which the object is located.
anchorThe anchor uniquely identifying the object within the file.
nameThe text to display as a placeholder for the link.
tooltipThe tooltip to display when the mouse is on the link.

Implements CodeOutputInterface.

◆ writeLineNumber()

void LatexCodeGenerator::writeLineNumber ( const QCString ref,
const QCString file,
const QCString anchor,
int  lineNumber,
bool  writeLineAnchor 

Writes the line number of a source listing

refExternal reference (when imported from a tag file)
fileThe file part of the URL pointing to the docs.
anchorThe anchor part of the URL pointing to the docs.
lineNumberThe line number to write
writeLineAnchorIndicates if an anchor for the line number needs to be written

Implements CodeOutputInterface.

◆ writeTooltip()

void LatexCodeGenerator::writeTooltip ( const QCString id,
const DocLinkInfo docInfo,
const QCString decl,
const QCString desc,
const SourceLinkInfo defInfo,
const SourceLinkInfo declInfo 

Writes a tool tip definition

idunique identifier for the tooltip
docInfoInfo about the symbol's documentation.
declfull declaration of the symbol (for functions)
descbrief description for the symbol
defInfoInfo about the symbol's definition in the source code
declInfoInfo about the symbol's declaration in the source code

Implements CodeOutputInterface.

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