Helper template class which defers all methods of OutputCodeIntf to an existing object of the templated type. More...

#include <src/outputlist.h>

Inheritance diagram for OutputCodeDefer< OutputCodeGen >:

Collaboration diagram for OutputCodeDefer< OutputCodeGen >:

Public Member Functions
	OutputCodeDefer (OutputCodeGen *codeGen)

OutputType	type () const override

std::unique_ptr< OutputCodeIntf >	clone () override

void	codify (const QCString &s) override

void	stripCodeComments (bool b) override

void	startSpecialComment () override

void	endSpecialComment () override

void	setStripIndentAmount (size_t amount) override

void	writeCodeLink (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip) override

void	writeLineNumber (const QCString &ref, const QCString &file, const QCString &anchor, int lineNumber, bool writeLineAnchor) override

void	writeTooltip (const QCString &id, const DocLinkInfo &docInfo, const QCString &decl, const QCString &desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo) override

void	startCodeLine (int lineNr) override

void	endCodeLine () override

void	startFontClass (const QCString &c) override

void	endFontClass () override

void	writeCodeAnchor (const QCString &name) override

void	startCodeFragment (const QCString &style) override

void	endCodeFragment (const QCString &style) override

void	startFold (int lineNr, const QCString &startMarker, const QCString &endMarker) override

void	endFold () override

Public Member Functions inherited from OutputCodeIntf
	OutputCodeIntf ()=default

Private Attributes
OutputCodeGen *	m_codeGen

Detailed Description

template<class OutputCodeGen>
class OutputCodeDefer< OutputCodeGen >

Helper template class which defers all methods of OutputCodeIntf to an existing object of the templated type.

This allows to add the same generator to multiple lists (one that owns the element, and others that refers to it).

Definition at line 45 of file outputlist.h.

Constructor & Destructor Documentation

◆ OutputCodeDefer()

template<class OutputCodeGen>

OutputCodeDefer< OutputCodeGen >::OutputCodeDefer ( OutputCodeGen * codeGen )

inline

Definition at line 48 of file outputlist.h.

48: m_codeGen(codeGen) {}

OutputCodeDefer

Helper template class which defers all methods of OutputCodeIntf to an existing object of the templat...

Definition outputlist.h:46

OutputCodeDefer::m_codeGen

OutputCodeGen * m_codeGen

Definition outputlist.h:98

References m_codeGen.

Member Function Documentation

◆ clone()

template<class OutputCodeGen>

std::unique_ptr< OutputCodeIntf > OutputCodeDefer< OutputCodeGen >::clone ( )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 50 of file outputlist.h.

50{ return std::make_unique<OutputCodeDefer>(*this); }

◆ codify()

template<class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::codify ( const QCString & s )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 51 of file outputlist.h.

51{ m_codeGen->codify(s); }

References m_codeGen.

◆ endCodeFragment()

template<class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::endCodeFragment ( const QCString & style )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 88 of file outputlist.h.

89 { m_codeGen->endCodeFragment(style); }

References m_codeGen.

◆ endCodeLine()

template<class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::endCodeLine ( )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 73 of file outputlist.h.

74 { m_codeGen->endCodeLine(); }

References m_codeGen.

◆ endFold()

template<class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::endFold ( )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 94 of file outputlist.h.

95 { m_codeGen->endFold(); }

References m_codeGen.

◆ endFontClass()

template<class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::endFontClass ( )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 79 of file outputlist.h.

80 { m_codeGen->endFontClass(); }

References m_codeGen.

◆ endSpecialComment()

template<class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::endSpecialComment ( )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 54 of file outputlist.h.

54{ m_codeGen->endSpecialComment(); }

References m_codeGen.

◆ setStripIndentAmount()

template<class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::setStripIndentAmount ( size_t amount )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 55 of file outputlist.h.

55{ m_codeGen->setStripIndentAmount(amount); }

References m_codeGen.

◆ startCodeFragment()

template<class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::startCodeFragment ( const QCString & style )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 85 of file outputlist.h.

86 { m_codeGen->startCodeFragment(style); }

References m_codeGen.

◆ startCodeLine()

template<class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::startCodeLine ( int lineNr )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 70 of file outputlist.h.

71 { m_codeGen->startCodeLine(lineNr); }

References m_codeGen.

◆ startFold()

template<class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::startFold	(	int	lineNr,
		const QCString &	startMarker,
		const QCString &	endMarker )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 91 of file outputlist.h.

92 { m_codeGen->startFold(lineNr,startMarker,endMarker); }

References m_codeGen.

◆ startFontClass()

template<class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::startFontClass ( const QCString & c )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 76 of file outputlist.h.

77 { m_codeGen->startFontClass(c); }

References m_codeGen.

◆ startSpecialComment()

template<class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::startSpecialComment ( )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 53 of file outputlist.h.

53{ m_codeGen->startSpecialComment(); }

References m_codeGen.

◆ stripCodeComments()

template<class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::stripCodeComments ( bool b )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 52 of file outputlist.h.

52{ m_codeGen->stripCodeComments(b); }

References m_codeGen.

◆ type()

template<class OutputCodeGen>

OutputType OutputCodeDefer< OutputCodeGen >::type ( ) const

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 49 of file outputlist.h.

49{ return m_codeGen->type(); }

References m_codeGen.

Referenced by writeCodeLink().

◆ writeCodeAnchor()

template<class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::writeCodeAnchor ( const QCString & name )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 82 of file outputlist.h.

83 { m_codeGen->writeCodeAnchor(name); }

References m_codeGen.

◆ writeCodeLink()

template<class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::writeCodeLink	(	CodeSymbolType	type,
		const QCString &	ref,
		const QCString &	file,
		const QCString &	anchor,
		const QCString &	name,
		const QCString &	tooltip )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 56 of file outputlist.h.

60 { m_codeGen->writeCodeLink(type,ref,file,anchor,name,tooltip); }

OutputCodeDefer::type

OutputType type() const override

Definition outputlist.h:49

References m_codeGen, and type().

◆ writeLineNumber()

template<class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::writeLineNumber	(	const QCString &	ref,
		const QCString &	file,
		const QCString &	anchor,
		int	lineNumber,
		bool	writeLineAnchor )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 62 of file outputlist.h.

64 { m_codeGen->writeLineNumber(ref,file,anchor,lineNumber,writeLineAnchor); }

References m_codeGen.

◆ writeTooltip()

template<class OutputCodeGen>

void OutputCodeDefer< OutputCodeGen >::writeTooltip	(	const QCString &	id,
		const DocLinkInfo &	docInfo,
		const QCString &	decl,
		const QCString &	desc,
		const SourceLinkInfo &	defInfo,
		const SourceLinkInfo &	declInfo )

inlineoverridevirtual

Implements OutputCodeIntf.

Definition at line 66 of file outputlist.h.

68 { m_codeGen->writeTooltip(id,docInfo,decl,desc,defInfo,declInfo); }

References m_codeGen.

Member Data Documentation

◆ m_codeGen

template<class OutputCodeGen>

OutputCodeGen* OutputCodeDefer< OutputCodeGen >::m_codeGen

private

Definition at line 98 of file outputlist.h.

Referenced by codify(), endCodeFragment(), endCodeLine(), endFold(), endFontClass(), endSpecialComment(), OutputCodeDefer(), setStripIndentAmount(), startCodeFragment(), startCodeLine(), startFold(), startFontClass(), startSpecialComment(), stripCodeComments(), type(), writeCodeAnchor(), writeCodeLink(), writeLineNumber(), and writeTooltip().

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

src/outputlist.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OutputCodeDefer()

Member Function Documentation

◆ clone()

◆ codify()

◆ endCodeFragment()

◆ endCodeLine()

◆ endFold()

◆ endFontClass()

◆ endSpecialComment()

◆ setStripIndentAmount()

◆ startCodeFragment()

◆ startCodeLine()

◆ startFold()

◆ startFontClass()

◆ startSpecialComment()

◆ stripCodeComments()

◆ type()

◆ writeCodeAnchor()

◆ writeCodeLink()

◆ writeLineNumber()

◆ writeTooltip()

Member Data Documentation

◆ m_codeGen