The `RTFGenerator` Class Reference

Generator for RTF output. More...

Declaration

class RTFGenerator { ... }

Included Headers

Base classes

class	OutputGenerator
	Base class for shared implementation for all output generators. More...

class	OutputGenIntf
	Abstract interface for output generators. More...

Public Constructors Index

	RTFGenerator ()


	RTFGenerator (const RTFGenerator &)


	RTFGenerator (RTFGenerator &&)=delete

Public Destructor Index

	~RTFGenerator ()

Public Operators Index

RTFGenerator &	operator= (const RTFGenerator &)


RTFGenerator &	operator= (RTFGenerator &&)=delete

Public Member Functions Index

void	setRelativePath (const QCString &path)


void	setSourceFileName (const QCString &sourceFileName)


void	clearBuffer ()


OutputType	type () const override


std::unique_ptr< OutputGenIntf >	clone () override


void	addCodeGen (OutputCodeList &list) override


void	cleanup () override


void	writeDoc (const IDocNodeAST ast, const Definition , const MemberDef *, int) override


void	startFile (const QCString &name, const QCString &manName, const QCString &title, int id, int hierarchyLevel) override


void	endFile () override


void	writeSearchInfo () override


void	writeFooter (const QCString &) override


void	startPageDoc (const QCString &) override


void	endPageDoc () override


void	startIndexSection (IndexSection) override


void	endIndexSection (IndexSection) override


void	writePageLink (const QCString &, bool) override


void	startProjectNumber () override


void	endProjectNumber () override


void	writeStyleInfo (int part) override


void	startTitleHead (const QCString &) override


void	endTitleHead (const QCString &, const QCString &name) override


void	startParagraph (const QCString &classDef) override


void	endParagraph () override


void	writeString (const QCString &text) override


void	startIndexListItem () override


void	endIndexListItem () override


void	startIndexList () override


void	endIndexList () override


void	startIndexKey () override


void	endIndexKey () override


void	startIndexValue (bool) override


void	endIndexValue (const QCString &, bool) override


void	startItemList () override


void	endItemList () override


void	startIndexItem (const QCString &ref, const QCString &file) override


void	endIndexItem (const QCString &ref, const QCString &file) override


void	docify (const QCString &text) override


void	writeObjectLink (const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name) override


void	startTextLink (const QCString &f, const QCString &anchor) override


void	endTextLink () override


void	startTypewriter () override


void	endTypewriter () override


void	startGroupHeader (const QCString &, int) override


void	endGroupHeader (int) override


void	startItemListItem () override


void	endItemListItem () override


void	startMemberSections () override


void	endMemberSections () override


void	startHeaderSection () override


void	endHeaderSection () override


void	startMemberHeader (const QCString &, int) override


void	endMemberHeader () override


void	startMemberSubtitle () override


void	endMemberSubtitle () override


void	startMemberDocList () override


void	endMemberDocList () override


void	startMemberList () override


void	endMemberList () override


void	startInlineHeader () override


void	endInlineHeader () override


void	startAnonTypeScope (int) override


void	endAnonTypeScope (int) override


void	startMemberItem (const QCString &, MemberItemType, const QCString &) override


void	endMemberItem (MemberItemType) override


void	startMemberTemplateParams () override


void	endMemberTemplateParams (const QCString &, const QCString &) override


void	startCompoundTemplateParams () override


void	endCompoundTemplateParams () override


void	insertMemberAlign (bool) override


void	insertMemberAlignLeft (MemberItemType, bool) override


void	writeRuler () override


void	writeAnchor (const QCString &fileName, const QCString &name) override


void	startEmphasis () override


void	endEmphasis () override


void	startBold () override


void	endBold () override


void	lineBreak (const QCString &style=QCString()) override


void	startMemberDoc (const QCString &, const QCString &, const QCString &, const QCString &, int, int, bool) override


void	endMemberDoc (bool) override


void	startDoxyAnchor (const QCString &, const QCString &, const QCString &, const QCString &, const QCString &) override


void	endDoxyAnchor (const QCString &, const QCString &) override


void	addLabel (const QCString &, const QCString &) override


void	writeChar (char c) override


void	writeLatexSpacing () override


void	writeStartAnnoItem (const QCString &type, const QCString &file, const QCString &path, const QCString &name) override


void	startCenter () override


void	endCenter () override


void	startSmall () override


void	endSmall () override


void	startMemberDescription (const QCString &, const QCString &, bool) override


void	endMemberDescription () override


void	startMemberDeclaration () override


void	endMemberDeclaration (const QCString &, const QCString &) override


void	writeInheritedSectionTitle (const QCString &, const QCString &, const QCString &, const QCString &, const QCString &, const QCString &) override


void	startExamples () override


void	endExamples () override


void	startDescForItem () override


void	endDescForItem () override


void	startSection (const QCString &, const QCString &, SectionType) override


void	endSection (const QCString &, SectionType) override


void	addIndexItem (const QCString &, const QCString &) override


void	startIndent () override


void	endIndent () override


void	writeSynopsis () override


void	startClassDiagram () override


void	endClassDiagram (const ClassDiagram &, const QCString &filename, const QCString &name) override


void	startPageRef () override


void	endPageRef (const QCString &, const QCString &) override


void	startQuickIndices () override


void	endQuickIndices () override


void	writeSplitBar (const QCString &, const QCString &) override


void	writeNavigationPath (const QCString &) override


void	writeLogo () override


void	writeQuickLinks (HighlightedItem, const QCString &, bool) override


void	writeSummaryLink (const QCString &, const QCString &, const QCString &, bool) override


void	writePageOutline () override


void	startContents () override


void	endContents () override


void	writeNonBreakableSpace (int) override


void	startDescTable (const QCString &title, const bool hasInits) override


void	endDescTable () override


void	startDescTableRow () override


void	endDescTableRow () override


void	startDescTableTitle () override


void	endDescTableTitle () override


void	startDescTableInit () override


void	endDescTableInit () override


void	startDescTableData () override


void	endDescTableData () override


void	startDotGraph () override


void	endDotGraph (DotClassGraph &) override


void	startInclDepGraph () override


void	endInclDepGraph (DotInclDepGraph &) override


void	startGroupCollaboration () override


void	endGroupCollaboration (DotGroupCollaboration &g) override


void	startCallGraph () override


void	endCallGraph (DotCallGraph &) override


void	startDirDepGraph () override


void	endDirDepGraph (DotDirDeps &g) override


void	writeGraphicalHierarchy (DotGfxHierarchyTable &) override


void	startMemberGroupHeader (const QCString &, bool) override


void	endMemberGroupHeader () override


void	startMemberGroupDocs () override


void	endMemberGroupDocs () override


void	startMemberGroup () override


void	endMemberGroup (bool) override


void	startTextBlock (bool dense) override


void	endTextBlock (bool) override


void	lastIndexPage () override


void	startMemberDocPrefixItem () override


void	endMemberDocPrefixItem () override


void	startMemberDocName (bool) override


void	endMemberDocName () override


void	startParameterType (bool, const QCString &) override


void	endParameterType () override


void	startParameterName (bool) override


void	endParameterName () override


void	startParameterExtra () override


void	endParameterExtra (bool, bool, bool) override


void	startParameterDefVal (const char *s) override


void	endParameterDefVal () override


void	startParameterList (bool) override


void	endParameterList () override


void	exceptionEntry (const QCString &, bool) override


void	startConstraintList (const QCString &) override


void	startConstraintParam () override


void	endConstraintParam () override


void	startConstraintType () override


void	endConstraintType () override


void	startConstraintDocs () override


void	endConstraintDocs () override


void	endConstraintList () override


void	startMemberDocSimple (bool) override


void	endMemberDocSimple (bool) override


void	startInlineMemberType () override


void	endInlineMemberType () override


void	startInlineMemberName () override


void	endInlineMemberName () override


void	startInlineMemberDoc () override


void	endInlineMemberDoc () override


void	startLabels () override


void	writeLabel (const QCString &l, bool isLast) override


void	endLabels () override


void	startLocalToc (int) override


void	endLocalToc () override


void	startTocEntry (const SectionInfo *) override


void	endTocEntry (const SectionInfo *) override


void	startPlainFile (const QCString &name) override


void	endPlainFile () override

Private Member Functions Index

QCString	rtf_BList_DepthStyle ()


QCString	rtf_CList_DepthStyle ()


QCString	rtf_EList_DepthStyle ()


QCString	rtf_LCList_DepthStyle ()


QCString	rtf_DList_DepthStyle ()


void	beginRTFDocument ()


void	beginRTFChapter ()


void	beginRTFSection ()


void	rtfwriteRuler_doubleline ()


void	rtfwriteRuler_emboss ()


void	rtfwriteRuler_thick ()


void	rtfwriteRuler_thin ()


void	writeRTFReference (const QCString &label)


void	newParagraph ()


int	indentLevel () const


void	incIndentLevel ()


void	decIndentLevel ()

Private Member Attributes Index

bool	m_bstartedBody = false


bool	m_omitParagraph = false


int	m_numCols = 0


QCString	m_relPath


int	m_hierarchyLevel = 0


int	m_indentLevel = 0


std::array< RTFListItemInfo, maxIndentLevels >	m_listItemInfo


std::unique_ptr< OutputCodeList >	m_codeList


RTFCodeGenerator *	m_codeGen

Public Static Functions Index

static void	init ()


static void	writeStyleSheetFile (TextStream &t)


static void	writeExtensionsFile (TextStream &t)


static bool	preProcessFileInplace (const QCString &path, const QCString &name)
	This is an API to a VERY brittle RTF preprocessor that combines nested RTF files. More...

Private Static Attributes Index

static const int	maxIndentLevels = 13

Description

Generator for RTF output.

Definition at line 79 of file rtfgen.h.

Public Constructors

RTFGenerator()

RTFGenerator::RTFGenerator ()

Declaration at line 82 of file rtfgen.h, definition at line 336 of file rtfgen.cpp.

336RTFGenerator::RTFGenerator()

337 : OutputGenerator(Config_getString(RTF_OUTPUT))

338 , m_codeList(std::make_unique<OutputCodeList>())

339{

340 m_codeGen = m_codeList->add<RTFCodeGenerator>(&m_t);

341}

References Config_getString, m_codeGen, m_codeList, OutputGenerator::m_t and OutputGenerator::OutputGenerator.

Referenced by operator=, operator=, RTFGenerator and RTFGenerator.

RTFGenerator()

RTFGenerator::RTFGenerator (const RTFGenerator & og)

Declaration at line 83 of file rtfgen.h, definition at line 343 of file rtfgen.cpp.

343RTFGenerator::RTFGenerator(const RTFGenerator &og) : OutputGenerator(og.m_dir), OutputGenIntf()

344{

345 m_codeList = std::make_unique<OutputCodeList>(*og.m_codeList);

346 m_codeGen = m_codeList->get<RTFCodeGenerator>(OutputType::RTF);

347 m_codeGen->setTextStream(&m_t);

348 m_bstartedBody = og.m_bstartedBody;

349 m_omitParagraph = og.m_omitParagraph;

350 m_numCols = og.m_numCols;

351 m_relPath = og.m_relPath;

352 m_indentLevel = og.m_indentLevel;

353 m_listItemInfo = og.m_listItemInfo;

354}

References m_bstartedBody, m_codeGen, m_codeList, OutputGenerator::m_dir, m_indentLevel, m_listItemInfo, m_numCols, m_omitParagraph, m_relPath, OutputGenerator::m_t, OutputGenerator::OutputGenerator, RTF and RTFGenerator.

RTFGenerator()

RTFGenerator::RTFGenerator (RTFGenerator &&)

delete

Definition at line 85 of file rtfgen.h.

Reference RTFGenerator.

Public Destructor

~RTFGenerator()

RTFGenerator::~RTFGenerator ()

Definition at line 87 of file rtfgen.h.

Public Operators

operator=()

RTFGenerator & RTFGenerator::operator= (const RTFGenerator & og)

Declaration at line 84 of file rtfgen.h, definition at line 356 of file rtfgen.cpp.

356RTFGenerator &RTFGenerator::operator=(const RTFGenerator &og)

357{

358 if (this!=&og)

359 {

360 m_dir = og.m_dir;

361 m_codeList = std::make_unique<OutputCodeList>(*og.m_codeList);

362 m_codeGen = m_codeList->get<RTFCodeGenerator>(OutputType::RTF);

363 m_codeGen->setTextStream(&m_t);

364 m_bstartedBody = og.m_bstartedBody;

365 m_omitParagraph = og.m_omitParagraph;

366 m_numCols = og.m_numCols;

367 m_relPath = og.m_relPath;

368 m_indentLevel = og.m_indentLevel;

369 m_listItemInfo = og.m_listItemInfo;

370 }

371 return *this;

372}

References m_bstartedBody, m_codeGen, m_codeList, OutputGenerator::m_dir, m_indentLevel, m_listItemInfo, m_numCols, m_omitParagraph, m_relPath, OutputGenerator::m_t, RTF and RTFGenerator.

operator=()

RTFGenerator & RTFGenerator::operator= (RTFGenerator &&)

delete

Definition at line 86 of file rtfgen.h.

Reference RTFGenerator.

Public Member Functions

addCodeGen()

void RTFGenerator::addCodeGen (OutputCodeList & list)

virtual

Declaration at line 103 of file rtfgen.h, definition at line 376 of file rtfgen.cpp.

376void RTFGenerator::addCodeGen(OutputCodeList &list)

377{

378 list.add<RTFCodeGeneratorDefer>(m_codeGen);

379}

References OutputCodeList::add and m_codeGen.

addIndexItem()

void RTFGenerator::addIndexItem (const QCString & s1, const QCString & s2)

virtual

Declaration at line 209 of file rtfgen.h, definition at line 1744 of file rtfgen.cpp.

1744void RTFGenerator::addIndexItem(const QCString &s1,const QCString &s2)

1745{

1746 if (!s1.isEmpty())

1747 {

1748 m_t << "{\\xe \\v ";

1749 docify(s1);

1750 if (!s2.isEmpty())

1751 {

1752 m_t << "\\:";

1753 docify(s2);

1754 }

1755 m_t << "}\n";

1756 }

1757}

References docify, QCString::isEmpty and OutputGenerator::m_t.

Referenced by endTitleHead and startMemberDoc.

addLabel()

void RTFGenerator::addLabel (const QCString &, const QCString &)

virtual

Declaration at line 187 of file rtfgen.h, definition at line 1738 of file rtfgen.cpp.

1738void RTFGenerator::addLabel(const QCString &,const QCString &)

1739{

1740 DBG_RTF(m_t << "{\\comment addLabel}\n")

1741}

References DBG_RTF and OutputGenerator::m_t.

cleanup()

void RTFGenerator::cleanup ()

virtual

Declaration at line 104 of file rtfgen.h, definition at line 516 of file rtfgen.cpp.

516void RTFGenerator::cleanup()

517{

518 QCString dname = Config_getString(RTF_OUTPUT);

519 Dir d(dname.str());

520 clearSubDirs(d);

521}

References clearSubDirs, Config_getString and QCString::str.

clearBuffer()

void RTFGenerator::clearBuffer ()

Definition at line 97 of file rtfgen.h.

clone()

std::unique_ptr< OutputGenIntf > RTFGenerator::clone ()

inline virtual

Definition at line 102 of file rtfgen.h.

102 std::unique_ptr<OutputGenIntf> clone() override { return std::make_unique<RTFGenerator>(*this); }

docify()

void RTFGenerator::docify (const QCString & text)

virtual

Declaration at line 138 of file rtfgen.h, definition at line 1841 of file rtfgen.cpp.

1841void RTFGenerator::docify(const QCString &str)

1842{

1843 if (str.isEmpty()) return;

1844 m_t << docifyToString(str);

1845 m_omitParagraph = FALSE;

1846}

References docifyToString, FALSE, QCString::isEmpty, m_omitParagraph and OutputGenerator::m_t.

Referenced by addIndexItem, endTitleHead, startConstraintList, startDescTable, startExamples, startParameterDefVal, startSection, writeChar and writeStartAnnoItem.

endAnonTypeScope()

void RTFGenerator::endAnonTypeScope (int)

inline virtual

Definition at line 165 of file rtfgen.h.

165 void endAnonTypeScope(int) override {}

endBold()

void RTFGenerator::endBold ()

inline virtual

Definition at line 181 of file rtfgen.h.

181 void endBold() override { m_t << "}"; }

Reference OutputGenerator::m_t.

Referenced by endInlineHeader, endMemberDoc, startConstraintList and startExamples.

endCallGraph()

void RTFGenerator::endCallGraph (DotCallGraph & g)

virtual

Declaration at line 247 of file rtfgen.h, definition at line 2371 of file rtfgen.cpp.

2371void RTFGenerator::endCallGraph(DotCallGraph &g)

2372{

2373 newParagraph();

2374

2375 QCString fn = g.writeGraph(m_t,GraphOutputFormat::BITMAP,EmbeddedOutputFormat::Rtf,dir(),fileName(),m_relPath,FALSE);

2376

2377 // display the file

2378 m_t << "{\n";

2379 m_t << rtf_Style_Reset << "\n";

2380 m_t << "\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"";

2381 QCString imgExt = getDotImageExtension();

2382 m_t << fn << "." << imgExt;

2383 m_t << "\" \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par\n";

2384 m_t << "}\n";

2385 DBG_RTF(m_t << "{\\comment (endCallGraph)}\n")

2386}

References BITMAP, DBG_RTF, OutputGenerator::dir, FALSE, OutputGenerator::fileName, getDotImageExtension, m_relPath, OutputGenerator::m_t, newParagraph, Rtf, rtf_Style_Reset and DotCallGraph::writeGraph.

endCenter()

void RTFGenerator::endCenter ()

inline virtual

Definition at line 193 of file rtfgen.h.

193 void endCenter() override { m_t << "}"; }

Reference OutputGenerator::m_t.

endClassDiagram()

void RTFGenerator::endClassDiagram (const ClassDiagram & d, const QCString & filename, const QCString & name)

virtual

Declaration at line 214 of file rtfgen.h, definition at line 1861 of file rtfgen.cpp.

1861void RTFGenerator::endClassDiagram(const ClassDiagram &d,

1862 const QCString &fileName,const QCString &)

1863{

1864 newParagraph();

1865

1866 // create a png file

1867 d.writeImage(m_t,dir(),m_relPath,fileName,FALSE);

1868

1869 // display the file

1870 m_t << "{\n";

1871 m_t << rtf_Style_Reset << "\n";

1872 m_t << "\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"";

1873 m_t << fileName << ".png\"";

1874 m_t << " \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par\n";

1875 m_t << "}\n";

1876}

References OutputGenerator::dir, FALSE, OutputGenerator::fileName, m_relPath, OutputGenerator::m_t, newParagraph, rtf_Style_Reset and ClassDiagram::writeImage.

endCompoundTemplateParams()

void RTFGenerator::endCompoundTemplateParams ()

virtual

Declaration at line 171 of file rtfgen.h, definition at line 1509 of file rtfgen.cpp.

1509void RTFGenerator::endCompoundTemplateParams()

1510{

1511 newParagraph();

1512 m_t << "}\n";

1513}

References OutputGenerator::m_t and newParagraph.

endConstraintDocs()

void RTFGenerator::endConstraintDocs ()

virtual

Declaration at line 285 of file rtfgen.h, definition at line 2699 of file rtfgen.cpp.

2699void RTFGenerator::endConstraintDocs()

2700{

2701 DBG_RTF(m_t << "{\\comment (endConstraintDocs)}\n")

2702 newParagraph();

2703}

References DBG_RTF, OutputGenerator::m_t and newParagraph.

endConstraintList()

void RTFGenerator::endConstraintList ()

virtual

Declaration at line 286 of file rtfgen.h, definition at line 2705 of file rtfgen.cpp.

2705void RTFGenerator::endConstraintList()

2706{

2707 DBG_RTF(m_t << "{\\comment (endConstraintList)}\n")

2708 newParagraph();

2709 decIndentLevel();

2710 m_omitParagraph = TRUE;

2711 m_t << "}";

2712}

References DBG_RTF, decIndentLevel, m_omitParagraph, OutputGenerator::m_t, newParagraph and TRUE.

endConstraintParam()

void RTFGenerator::endConstraintParam ()

virtual

Declaration at line 281 of file rtfgen.h, definition at line 2674 of file rtfgen.cpp.

2674void RTFGenerator::endConstraintParam()

2675{

2676 DBG_RTF(m_t << "{\\comment (endConstraintParam)}\n")

2677 endEmphasis();

2678 m_t << " : ";

2679}

References DBG_RTF, endEmphasis and OutputGenerator::m_t.

endConstraintType()

void RTFGenerator::endConstraintType ()

virtual

Declaration at line 283 of file rtfgen.h, definition at line 2687 of file rtfgen.cpp.

2687void RTFGenerator::endConstraintType()

2688{

2689 DBG_RTF(m_t << "{\\comment (endConstraintType)}\n")

2690 endEmphasis();

2691 m_t << " ";

2692}

References DBG_RTF, endEmphasis and OutputGenerator::m_t.

endContents()

void RTFGenerator::endContents ()

inline virtual

Definition at line 226 of file rtfgen.h.

226 void endContents() override {}

endDescForItem()

void RTFGenerator::endDescForItem ()

virtual

Declaration at line 206 of file rtfgen.h, definition at line 1798 of file rtfgen.cpp.

1798void RTFGenerator::endDescForItem()

1799{

1800 DBG_RTF(m_t << "{\\comment (endDescForItem) }\n")

1801}

References DBG_RTF and OutputGenerator::m_t.

endDescTable()

void RTFGenerator::endDescTable ()

virtual

Declaration at line 230 of file rtfgen.h, definition at line 1975 of file rtfgen.cpp.

1975void RTFGenerator::endDescTable()

1976{

1977 DBG_RTF(m_t << "{\\comment (endDescTable)}\n")

1978 m_t << "}\n";

1979}

References DBG_RTF and OutputGenerator::m_t.

endDescTableData()

void RTFGenerator::endDescTableData ()

virtual

Declaration at line 238 of file rtfgen.h, definition at line 2022 of file rtfgen.cpp.

2022void RTFGenerator::endDescTableData()

2023{

2024 DBG_RTF(m_t << "{\\comment (endDescTableData) }\n")

2025 m_t << "\\cell }{\\row }\n";

2026}

References DBG_RTF and OutputGenerator::m_t.

endDescTableInit()

void RTFGenerator::endDescTableInit ()

virtual

Declaration at line 236 of file rtfgen.h, definition at line 2010 of file rtfgen.cpp.

2010void RTFGenerator::endDescTableInit()

2011{

2012 DBG_RTF(m_t << "{\\comment (endDescTableInit) }" << endl)

2013 m_t << "\\cell }";

2014}

References DBG_RTF and OutputGenerator::m_t.

endDescTableRow()

void RTFGenerator::endDescTableRow ()

virtual

Declaration at line 232 of file rtfgen.h, definition at line 1985 of file rtfgen.cpp.

1985void RTFGenerator::endDescTableRow()

1986{

1987}

endDescTableTitle()

void RTFGenerator::endDescTableTitle ()

virtual

Declaration at line 234 of file rtfgen.h, definition at line 1996 of file rtfgen.cpp.

1996void RTFGenerator::endDescTableTitle()

1997{

1998 DBG_RTF(m_t << "{\\comment (endDescTableTitle) }\n")

1999 m_t << "\\cell }";

2000}

References DBG_RTF and OutputGenerator::m_t.

endDirDepGraph()

void RTFGenerator::endDirDepGraph (DotDirDeps & g)

virtual

Declaration at line 249 of file rtfgen.h, definition at line 2393 of file rtfgen.cpp.

2393void RTFGenerator::endDirDepGraph(DotDirDeps &g)

2394{

2395 newParagraph();

2396

2397 QCString fn = g.writeGraph(m_t,GraphOutputFormat::BITMAP,EmbeddedOutputFormat::Rtf,dir(),fileName(),m_relPath,FALSE);

2398

2399 // display the file

2400 m_t << "{\n";

2401 m_t << rtf_Style_Reset << "\n";

2402 m_t << "\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"";

2403 QCString imgExt = getDotImageExtension();

2404 m_t << fn << "." << imgExt;

2405 m_t << "\" \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par\n";

2406 m_t << "}\n";

2407 DBG_RTF(m_t << "{\\comment (endDirDepGraph)}\n")

2408}

endDotGraph()

void RTFGenerator::endDotGraph (DotClassGraph & g)

virtual

Declaration at line 241 of file rtfgen.h, definition at line 2318 of file rtfgen.cpp.

2318void RTFGenerator::endDotGraph(DotClassGraph &g)

2319{

2320 newParagraph();

2321

2322 QCString fn = g.writeGraph(m_t,GraphOutputFormat::BITMAP,EmbeddedOutputFormat::Rtf,dir(),fileName(),m_relPath,TRUE,FALSE);

2323

2324 // display the file

2325 m_t << "{\n";

2326 m_t << rtf_Style_Reset << "\n";

2327 m_t << "\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"";

2328 QCString imgExt = getDotImageExtension();

2329 m_t << fn << "." << imgExt;

2330 m_t << "\" \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par\n";

2331 m_t << "}\n";

2332 newParagraph();

2333 DBG_RTF(m_t << "{\\comment (endDotGraph)}\n")

2334}

endDoxyAnchor()

void RTFGenerator::endDoxyAnchor (const QCString & fName, const QCString & anchor)

virtual

Declaration at line 186 of file rtfgen.h, definition at line 1716 of file rtfgen.cpp.

1716void RTFGenerator::endDoxyAnchor(const QCString &fName,const QCString &anchor)

1717{

1718 QCString ref;

1719 if (!fName.isEmpty())

1720 {

1721 ref+=stripPath(fName);

1722 }

1723 if (!anchor.isEmpty())

1724 {

1725 ref+='_';

1726 ref+=anchor;

1727 }

1728

1729 DBG_RTF(m_t << "{\\comment endDoxyAnchor}\n")

1730 m_t << "{\\bkmkstart ";

1731 m_t << rtfFormatBmkStr(ref);

1732 m_t << "}\n";

1733 m_t << "{\\bkmkend ";

1734 m_t << rtfFormatBmkStr(ref);

1735 m_t << "}\n";

1736}

References DBG_RTF, QCString::isEmpty, OutputGenerator::m_t, rtfFormatBmkStr and stripPath.

endEmphasis()

void RTFGenerator::endEmphasis ()

inline virtual

Definition at line 179 of file rtfgen.h.

179 void endEmphasis() override { m_t << "}"; }

Reference OutputGenerator::m_t.

Referenced by endConstraintParam, endConstraintType, endMemberDescription, endMemberGroupDocs and endPageRef.

endExamples()

void RTFGenerator::endExamples ()

virtual

Declaration at line 204 of file rtfgen.h, definition at line 2579 of file rtfgen.cpp.

2579void RTFGenerator::endExamples()

2580{

2581 DBG_RTF(m_t << "{\\comment (endExamples)}\n")

2582 m_omitParagraph = FALSE;

2583 newParagraph();

2584 decIndentLevel();

2585 m_omitParagraph = TRUE;

2586 m_t << "}";

2587}

References DBG_RTF, decIndentLevel, FALSE, m_omitParagraph, OutputGenerator::m_t, newParagraph and TRUE.

endFile()

void RTFGenerator::endFile ()

virtual

Declaration at line 107 of file rtfgen.h, definition at line 715 of file rtfgen.cpp.

715void RTFGenerator::endFile()

716{

717 DBG_RTF(m_t << "{\\comment endFile}\n")

718 m_t << "}";

719

720 endPlainFile();

721 setSourceFileName("");

722}

References DBG_RTF, endPlainFile, OutputGenerator::m_t and setSourceFileName.

endGroupCollaboration()

void RTFGenerator::endGroupCollaboration (DotGroupCollaboration & g)

virtual

Declaration at line 245 of file rtfgen.h, definition at line 2362 of file rtfgen.cpp.

2362void RTFGenerator::endGroupCollaboration(DotGroupCollaboration &)

2363{

2364}

endGroupHeader()

void RTFGenerator::endGroupHeader (int)

virtual

Declaration at line 146 of file rtfgen.h, definition at line 1660 of file rtfgen.cpp.

1660void RTFGenerator::endGroupHeader(int)

1661{

1662 DBG_RTF(m_t << "{\\comment endGroupHeader}\n")

1663 m_t << "\\par\n";

1664 m_t << rtf_Style_Reset << "\n";

1665}

References DBG_RTF, OutputGenerator::m_t and rtf_Style_Reset.

Referenced by endMemberHeader.

endHeaderSection()

void RTFGenerator::endHeaderSection ()

inline virtual

Definition at line 153 of file rtfgen.h.

153 void endHeaderSection() override {}

endInclDepGraph()

void RTFGenerator::endInclDepGraph (DotInclDepGraph & g)

virtual

Declaration at line 243 of file rtfgen.h, definition at line 2341 of file rtfgen.cpp.

2341void RTFGenerator::endInclDepGraph(DotInclDepGraph &g)

2342{

2343 newParagraph();

2344

2345 QCString fn = g.writeGraph(m_t,GraphOutputFormat::BITMAP,EmbeddedOutputFormat::Rtf,dir(),fileName(),m_relPath,FALSE);

2346

2347 // display the file

2348 m_t << "{\n";

2349 m_t << rtf_Style_Reset << "\n";

2350 m_t << "\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"";

2351 QCString imgExt = getDotImageExtension();

2352 m_t << fn << "." << imgExt;

2353 m_t << "\" \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par\n";

2354 m_t << "}\n";

2355 DBG_RTF(m_t << "{\\comment (endInclDepGraph)}\n")

2356}

endIndent()

void RTFGenerator::endIndent ()

virtual

Declaration at line 211 of file rtfgen.h, definition at line 1767 of file rtfgen.cpp.

1767void RTFGenerator::endIndent()

1768{

1769 m_t << "}\n";

1770 decIndentLevel();

1771}

References decIndentLevel and OutputGenerator::m_t.

endIndexItem()

void RTFGenerator::endIndexItem (const QCString & ref, const QCString & file)

virtual

Declaration at line 137 of file rtfgen.h, definition at line 1422 of file rtfgen.cpp.

1422void RTFGenerator::endIndexItem(const QCString &ref,const QCString &fn)

1423{

1424 DBG_RTF(m_t << "{\\comment (endIndexItem)}\n")

1425 if (ref.isEmpty() && !fn.isEmpty())

1426 {

1427 m_t << "\\tab ";

1428 writeRTFReference(fn);

1429 m_t << "\n";

1430 }

1431 else

1432 {

1433 m_t << "\n";

1434 }

1435 m_omitParagraph = TRUE;

1436}

References DBG_RTF, QCString::isEmpty, m_omitParagraph, OutputGenerator::m_t, TRUE and writeRTFReference.

endIndexKey()

void RTFGenerator::endIndexKey ()

virtual

Declaration at line 131 of file rtfgen.h, definition at line 1468 of file rtfgen.cpp.

1468void RTFGenerator::endIndexKey()

1469{

1470 DBG_RTF(m_t << "{\\comment (endIndexKey)}\n")

1471}

References DBG_RTF and OutputGenerator::m_t.

endIndexList()

void RTFGenerator::endIndexList ()

virtual

Declaration at line 129 of file rtfgen.h, definition at line 1351 of file rtfgen.cpp.

1351void RTFGenerator::endIndexList()

1352{

1353 DBG_RTF(m_t << "{\\comment (endIndexList)}\n")

1354 if (!m_omitParagraph)

1355 {

1356 m_t << "\\par";

1357 m_omitParagraph = TRUE;

1358 }

1359 m_t << "}";

1360 decIndentLevel();

1361}

References DBG_RTF, decIndentLevel, m_omitParagraph, OutputGenerator::m_t and TRUE.

endIndexListItem()

void RTFGenerator::endIndexListItem ()

virtual

Declaration at line 127 of file rtfgen.h, definition at line 2719 of file rtfgen.cpp.

2719void RTFGenerator::endIndexListItem()

2720{

2721 DBG_RTF(m_t << "{\\comment (endIndexListItem)}\n")

2722 m_t << "\\par\n";

2723}

References DBG_RTF and OutputGenerator::m_t.

endIndexSection()

void RTFGenerator::endIndexSection (IndexSection is)

virtual

Declaration at line 115 of file rtfgen.h, definition at line 924 of file rtfgen.cpp.

924void RTFGenerator::endIndexSection(IndexSection is)

925{

926 bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);

927 bool vhdlOpt = Config_getBool(OPTIMIZE_OUTPUT_VHDL);

928 QCString projectName = Config_getString(PROJECT_NAME);

929

930 switch (is)

931 {

932 case IndexSection::isTitlePageStart:

933 if (!rtf_title.isEmpty())

934 // User has overridden document title in extensions file

935 m_t << "}" << rtf_title;

936 else

937 m_t << "}" << projectName;

938 break;

939 case IndexSection::isTitlePageAuthor:

940 {

941 m_t << " doxygen " << getDoxygenVersion() << ".}\n";

942 m_t << dateToRTFDateString();

943 DBG_RTF(m_t << "{\\comment end of infoblock}\n");

944 // setup for this section

945 m_t << "}";

946 m_t << rtf_Style_Reset <<"\n";

947 m_t << "\\sectd\\pgnlcrm\n";

948 m_t << "{\\footer "<<rtf_Style["Footer"].reference() << "{\\chpgn}}\n";

949 // the title entry

950 DBG_RTF(m_t << "{\\comment begin title page}\n")

951

952

953 m_t << rtf_Style_Reset << rtf_Style["SubTitle"].reference() << "\n"; // set to title style

954

955 m_t << "\\vertalc\\qc\\par\\par\\par\\par\\par\\par\\par\n";

956 if (!rtf_logoFilename.isEmpty())

957 {

958 m_t << "{\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"" << rtf_logoFilename;

959 m_t << "\" \\\\d \\\\*MERGEFORMAT} {\\fldrslt IMAGE }}\\par\\par\n";

960 }

961 if (!rtf_company.isEmpty())

962 {

963 m_t << rtf_company << "\\par\\par\n";

964 }

965

966 m_t << rtf_Style_Reset << rtf_Style["Title"].reference() << "\n"; // set to title style

967 if (!rtf_title.isEmpty())

968 {

969 // User has overridden document title in extensions file

970 m_t << "{\\field\\fldedit {\\*\\fldinst TITLE \\\\*MERGEFORMAT}{\\fldrslt " << rtf_title << "}}\\par\n";

971 }

972 else

973 {

974 auto parser { createDocParser() };

975 auto ast { validatingParseText(*parser.get(), projectName) };

976 if (ast)

977 {

978 m_t << "{\\field\\fldedit {\\*\\fldinst TITLE \\\\*MERGEFORMAT}{\\fldrslt ";

979 writeDoc(ast.get(),nullptr,nullptr,0);

980 m_t << "}}\\par\n";

981 }

982 }

983

984 m_t << rtf_Style_Reset << rtf_Style["SubTitle"].reference() << "\n"; // set to title style

985 m_t << "\\par\n";

986 if (!rtf_documentType.isEmpty())

987 {

988 m_t << rtf_documentType << "\\par\n";

989 }

990 if (!rtf_documentId.isEmpty())

991 {

992 m_t << rtf_documentId << "\\par\n";

993 }

994 m_t << "\\par\\par\\par\\par\\par\\par\\par\\par\\par\\par\\par\\par\n";

995

996 m_t << rtf_Style_Reset << rtf_Style["SubTitle"].reference() << "\n"; // set to subtitle style

997 if (!rtf_author.isEmpty())

998 {

999 m_t << "{\\field\\fldedit {\\*\\fldinst AUTHOR \\\\*MERGEFORMAT}{\\fldrslt "<< rtf_author << " }}\\par\n";

1000 }

1001 else

1002 {

1003 m_t << "{\\field\\fldedit {\\*\\fldinst AUTHOR \\\\*MERGEFORMAT}{\\fldrslt AUTHOR}}\\par\n";

1004 }

1005

1006 m_t << theTranslator->trVersion() << " " << Config_getString(PROJECT_NUMBER) << "\\par";

1007 switch (Config_getEnum(TIMESTAMP))

1008 {

1009 case TIMESTAMP_t::YES:

1010 case TIMESTAMP_t::DATETIME:

1011 m_t << "{\\field\\fldedit {\\*\\fldinst CREATEDATE \\\\*MERGEFORMAT}"

1012 "{\\fldrslt "<< dateToString(DateTimeType::DateTime) << " }}\\par\n";

1013 break;

1014 case TIMESTAMP_t::DATE:

1015 m_t << "{\\field\\fldedit {\\*\\fldinst CREATEDATE \\\\*MERGEFORMAT}"

1016 "{\\fldrslt "<< dateToString(DateTimeType::Date) << " }}\\par\n";

1017 break;

1018 case TIMESTAMP_t::NO:

1019 break;

1020 }

1021 m_t << "\\page\\page";

1022 DBG_RTF(m_t << "{\\comment End title page}\n")

1023

1024 // table of contents section

1025 DBG_RTF(m_t << "{\\comment Table of contents}\n")

1026 m_t << "\\vertalt\n";

1027 m_t << rtf_Style_Reset << "\n";

1028 m_t << rtf_Style["Heading1"].reference();

1029 m_t << theTranslator->trRTFTableOfContents() << "\\par\n";

1030 m_t << rtf_Style_Reset << "\\par\n";

1031 m_t << "{\\field\\fldedit {\\*\\fldinst TOC \\\\f \\\\*MERGEFORMAT}{\\fldrslt Table of contents}}\\par\n";

1032 m_t << rtf_Style_Reset << "\n";

1033 }

1034 break;

1035 case IndexSection::isMainPage:

1036 if (Doxygen::mainPage)

1037 {

1038 writePageLink(Doxygen::mainPage->getOutputFileBase(), TRUE);

1039 }

1040 break;

1041 case IndexSection::isTopicIndex:

1042 m_t << "\\par " << rtf_Style_Reset << "\n";

1043 m_t << "{\\tc \\v " << theTranslator->trTopicIndex() << "}\n";

1044 m_t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"topics.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";

1045 break;

1046 case IndexSection::isModuleIndex:

1047 m_t << "\\par " << rtf_Style_Reset << "\n";

1048 m_t << "{\\tc \\v " << theTranslator->trModuleIndex() << "}\n";

1049 m_t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"modules.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";

1050 break;

1051 case IndexSection::isDirIndex:

1052 m_t << "\\par " << rtf_Style_Reset << "\n";

1053 m_t << "{\\tc \\v " << theTranslator->trDirIndex() << "}\n";

1054 m_t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"dirs.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";

1055 break;

1056 case IndexSection::isNamespaceIndex:

1057 m_t << "\\par " << rtf_Style_Reset << "\n";

1058 if (fortranOpt)

1059 {

1060 m_t << "{\\tc \\v " << theTranslator->trModulesIndex() << "}\n";

1061 }

1062 else

1063 {

1064 m_t << "{\\tc \\v " << theTranslator->trNamespaceIndex() << "}\n";

1065 }

1066

1067 m_t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"namespaces.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";

1068 break;

1069 case IndexSection::isConceptIndex:

1070 m_t << "\\par " << rtf_Style_Reset << "\n";

1071 m_t << "{\\tc \\v " << theTranslator->trConceptIndex() << "}\n";

1072 m_t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"concepts.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";

1073 break;

1074 case IndexSection::isClassHierarchyIndex:

1075 m_t << "\\par " << rtf_Style_Reset << "\n";

1076 m_t << "{\\tc \\v " << theTranslator->trHierarchicalIndex() << "}\n";

1077 m_t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"hierarchy.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";

1078 break;

1079 case IndexSection::isCompoundIndex:

1080 m_t << "\\par " << rtf_Style_Reset << "\n";

1081 if (fortranOpt)

1082 {

1083 m_t << "{\\tc \\v " << theTranslator->trCompoundIndexFortran() << "}\n";

1084 }

1085 else if (vhdlOpt)

1086 {

1087 m_t << "{\\tc \\v " << theTranslator->trDesignUnitIndex() << "}\n";

1088 }

1089 else

1090 {

1091 m_t << "{\\tc \\v " << theTranslator->trCompoundIndex() << "}\n";

1092 }

1093 m_t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"annotated.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";

1094 break;

1095 case IndexSection::isFileIndex:

1096 m_t << "\\par " << rtf_Style_Reset << "\n";

1097 m_t << "{\\tc \\v " << theTranslator->trFileIndex() << "}\n";

1098 m_t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"files.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";

1099 break;

1100 case IndexSection::isPageIndex:

1101 m_t << "\\par " << rtf_Style_Reset << "\n";

1102 m_t << "{\\tc \\v " << theTranslator->trPageIndex() << "}\n";

1103 m_t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"pages.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";

1104 break;

1105 case IndexSection::isTopicDocumentation:

1106 {

1107 m_t << "{\\tc \\v " << theTranslator->trTopicDocumentation() << "}\n";

1108 for (const auto &gd : *Doxygen::groupLinkedMap)

1109 {

1110 if (!gd->isReference() && !gd->isASubGroup())

1111 {

1112 writePageLink(gd->getOutputFileBase(), FALSE);

1113 }

1114 }

1115 }

1116 break;

1117 case IndexSection::isModuleDocumentation:

1118 {

1119 m_t << "{\\tc \\v " << theTranslator->trModuleDocumentation() << "}\n";

1120 for (const auto &mod : ModuleManager::instance().modules())

1121 {

1122 if (!mod->isReference() && mod->isPrimaryInterface())

1123 {

1124 writePageLink(mod->getOutputFileBase(), FALSE);

1125 }

1126 }

1127 }

1128 break;

1129 case IndexSection::isDirDocumentation:

1130 {

1131 bool first=true;

1132 m_t << "{\\tc \\v " << theTranslator->trDirDocumentation() << "}\n";

1133 for (const auto &dd : *Doxygen::dirLinkedMap)

1134 {

1135 if (dd->isLinkableInProject())

1136 {

1137 m_t << "\\par " << rtf_Style_Reset << "\n";

1138 if (!first)

1139 {

1140 beginRTFSection();

1141 }

1142 first=false;

1143 m_t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";

1144 m_t << dd->getOutputFileBase();

1145 m_t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";

1146 }

1147 }

1148 }

1149 break;

1150 case IndexSection::isNamespaceDocumentation:

1151 {

1152 bool first=true;

1153 for (const auto &nd : *Doxygen::namespaceLinkedMap)

1154 {

1155 if (nd->isLinkableInProject() && !nd->isAlias())

1156 {

1157 m_t << "\\par " << rtf_Style_Reset << "\n";

1158 if (!first)

1159 {

1160 beginRTFSection();

1161 }

1162 first=false;

1163 m_t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";

1164 m_t << nd->getOutputFileBase();

1165 m_t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";

1166 }

1167 }

1168 }

1169 break;

1170 case IndexSection::isConceptDocumentation:

1171 {

1172 bool first=true;

1173 for (const auto &cd : *Doxygen::conceptLinkedMap)

1174 {

1175 if (cd->isLinkableInProject() && !cd->isAlias())

1176 {

1177 m_t << "\\par " << rtf_Style_Reset << "\n";

1178 if (!first)

1179 {

1180 beginRTFSection();

1181 }

1182 first=false;

1183 m_t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";

1184 m_t << cd->getOutputFileBase();

1185 m_t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";

1186 }

1187 }

1188 }

1189 break;

1190 case IndexSection::isClassDocumentation:

1191 {

1192 bool first=true;

1193 if (fortranOpt)

1194 {

1195 m_t << "{\\tc \\v " << theTranslator->trTypeDocumentation() << "}\n";

1196 }

1197 else

1198 {

1199 m_t << "{\\tc \\v " << theTranslator->trClassDocumentation() << "}\n";

1200 }

1201 for (const auto &cd : *Doxygen::classLinkedMap)

1202 {

1203 if (cd->isLinkableInProject() &&

1204 !cd->isImplicitTemplateInstance() &&

1205 !cd->isEmbeddedInOuterScope() &&

1206 !cd->isAlias()

1207 )

1208 {

1209 m_t << "\\par " << rtf_Style_Reset << "\n";

1210 if (!first)

1211 {

1212 beginRTFSection();

1213 }

1214 first=false;

1215 m_t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";

1216 m_t << cd->getOutputFileBase();

1217 m_t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";

1218 }

1219 }

1220 }

1221 break;

1222 case IndexSection::isFileDocumentation:

1223 {

1224 bool isFirst=TRUE;

1225

1226 m_t << "{\\tc \\v " << theTranslator->trFileDocumentation() << "}\n";

1227 for (const auto &fn : *Doxygen::inputNameLinkedMap)

1228 {

1229 for (const auto &fd : *fn)

1230 {

1231 if (fd->isLinkableInProject())

1232 {

1233 m_t << "\\par " << rtf_Style_Reset << "\n";

1234 if (!isFirst)

1235 {

1236 beginRTFSection();

1237 }

1238 isFirst=FALSE;

1239 m_t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";

1240 m_t << fd->getOutputFileBase();

1241 m_t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";

1242 }

1243 if (fd->generateSourceFile())

1244 {

1245 m_t << "\\par " << rtf_Style_Reset << "\n";

1246 if (!isFirst)

1247 {

1248 beginRTFSection();

1249 }

1250 isFirst=FALSE;

1251 m_t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";

1252 m_t << fd->getSourceFileBase();

1253 m_t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";

1254 }

1255 }

1256 }

1257 }

1258 break;

1259 case IndexSection::isExampleDocumentation:

1260 {

1261 //m_t << "}\n";

1262 bool isFirst=true;

1263 m_t << "{\\tc \\v " << theTranslator->trExamples() << "}\n";

1264 for (const auto &pd : *Doxygen::exampleLinkedMap)

1265 {

1266 m_t << "\\par " << rtf_Style_Reset << "\n";

1267 if (!isFirst)

1268 {

1269 beginRTFSection();

1270 }

1271 isFirst=false;

1272 m_t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";

1273 m_t << pd->getOutputFileBase();

1274 m_t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";

1275 }

1276 }

1277 break;

1278 case IndexSection::isPageDocumentation:

1279 {

1280 m_t << "\\par " << rtf_Style_Reset << "\n";

1281 for (const auto &pd : *Doxygen::pageLinkedMap)

1282 {

1283 if (!pd->getGroupDef() && !pd->isReference() && !pd->hasParentPage()

1284 && Doxygen::mainPage.get() != pd.get())

1285 {

1286 writePageLink(pd->getOutputFileBase(), FALSE);

1287 }

1288 }

1289 }

1290 break;

1291 case IndexSection::isPageDocumentation2:

1292 break;

1293 case IndexSection::isEndIndex:

1294 beginRTFChapter();

1295 m_t << rtf_Style["Heading1"].reference();

1296 m_t << theTranslator->trRTFGeneralIndex() << "\\par \n";

1297 m_t << rtf_Style_Reset << "\n";

1298 m_t << "{\\tc \\v " << theTranslator->trRTFGeneralIndex() << "}\n";

1299 m_t << "{\\field\\fldedit {\\*\\fldinst INDEX \\\\c2 \\\\*MERGEFORMAT}{\\fldrslt INDEX}}\n";

1300

1301 break;

1302 }

1303}

References beginRTFChapter, beginRTFSection, Doxygen::classLinkedMap, Doxygen::conceptLinkedMap, Config_getBool, Config_getEnum, Config_getString, createDocParser, Date, DateTime, dateToRTFDateString, dateToString, DBG_RTF, Doxygen::dirLinkedMap, Doxygen::exampleLinkedMap, FALSE, Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, ModuleManager::instance, isClassDocumentation, isClassHierarchyIndex, isCompoundIndex, isConceptDocumentation, isConceptIndex, isDirDocumentation, isDirIndex, isEndIndex, isExampleDocumentation, isFileDocumentation, isFileIndex, isMainPage, isModuleDocumentation, isModuleIndex, isNamespaceDocumentation, isNamespaceIndex, isPageDocumentation, isPageDocumentation2, isPageIndex, isTitlePageAuthor, isTitlePageStart, isTopicDocumentation, isTopicIndex, OutputGenerator::m_t, Doxygen::mainPage, Doxygen::namespaceLinkedMap, Doxygen::pageLinkedMap, rtf_author, rtf_company, rtf_documentId, rtf_documentType, rtf_logoFilename, rtf_Style, rtf_Style_Reset, rtf_title, theTranslator, TRUE, validatingParseText, writeDoc and writePageLink.

endIndexValue()

void RTFGenerator::endIndexValue (const QCString & name, bool hasBrief)

virtual

Declaration at line 133 of file rtfgen.h, definition at line 1480 of file rtfgen.cpp.

1480void RTFGenerator::endIndexValue(const QCString &name,bool hasBrief)

1481{

1482 DBG_RTF(m_t << "{\\comment (endIndexValue)}\n")

1483 if (hasBrief) m_t << ")";

1484 m_t << "} ";

1485 if (!name.isEmpty())

1486 {

1487 m_t << "\\tab ";

1488 writeRTFReference(name);

1489 m_t << "\n";

1490 }

1491 else

1492 {

1493 m_t << "\n";

1494 }

1495 m_omitParagraph=FALSE;

1496 newParagraph();

1497}

References DBG_RTF, FALSE, QCString::isEmpty, m_omitParagraph, OutputGenerator::m_t, newParagraph and writeRTFReference.

endInlineHeader()

void RTFGenerator::endInlineHeader ()

virtual

Declaration at line 163 of file rtfgen.h, definition at line 2733 of file rtfgen.cpp.

2733void RTFGenerator::endInlineHeader()

2734{

2735 DBG_RTF(m_t << "{\\comment (endInlineHeader)}\n")

2736 endBold();

2737 m_t << "\\par";

2738 m_t << "}\n";

2739}

References DBG_RTF, endBold and OutputGenerator::m_t.

endInlineMemberDoc()

void RTFGenerator::endInlineMemberDoc ()

virtual

Declaration at line 295 of file rtfgen.h, definition at line 2818 of file rtfgen.cpp.

2818void RTFGenerator::endInlineMemberDoc()

2819{

2820 DBG_RTF(m_t << "{\\comment (endInlineMemberDoc)}\n")

2821 m_t << "\\cell }{\\row }\n";

2822}

References DBG_RTF and OutputGenerator::m_t.

endInlineMemberName()

void RTFGenerator::endInlineMemberName ()

virtual

Declaration at line 293 of file rtfgen.h, definition at line 2806 of file rtfgen.cpp.

2806void RTFGenerator::endInlineMemberName()

2807{

2808 DBG_RTF(m_t << "{\\comment (endInlineMemberName)}\n")

2809 m_t << "\\cell }";

2810}

References DBG_RTF and OutputGenerator::m_t.

endInlineMemberType()

void RTFGenerator::endInlineMemberType ()

virtual

Declaration at line 291 of file rtfgen.h, definition at line 2794 of file rtfgen.cpp.

2794void RTFGenerator::endInlineMemberType()

2795{

2796 DBG_RTF(m_t << "{\\comment (endInlineMemberType)}\n")

2797 m_t << "\\cell }";

2798}

References DBG_RTF and OutputGenerator::m_t.

endItemList()

void RTFGenerator::endItemList ()

virtual

end bullet list

Declaration at line 135 of file rtfgen.h, definition at line 1377 of file rtfgen.cpp.

1377void RTFGenerator::endItemList()

1378{

1379 newParagraph();

1380 DBG_RTF(m_t << "{\\comment (endItemList level=" << indentLevel() << ")}\n")

1381 m_t << "}";

1382 decIndentLevel();

1383 m_omitParagraph = TRUE;

1384}

References DBG_RTF, decIndentLevel, indentLevel, m_omitParagraph, OutputGenerator::m_t, newParagraph and TRUE.

endItemListItem()

void RTFGenerator::endItemListItem ()

virtual

Declaration at line 148 of file rtfgen.h, definition at line 1406 of file rtfgen.cpp.

1406void RTFGenerator::endItemListItem()

1407{

1408 DBG_RTF(m_t << "{\\comment (endItemListItem)}\n")

1409}

References DBG_RTF and OutputGenerator::m_t.

endLabels()

void RTFGenerator::endLabels ()

virtual

Declaration at line 299 of file rtfgen.h, definition at line 2834 of file rtfgen.cpp.

2834void RTFGenerator::endLabels()

2835{

2836}

endLocalToc()

void RTFGenerator::endLocalToc ()

inline virtual

Definition at line 302 of file rtfgen.h.

302 void endLocalToc() override {}

endMemberDeclaration()

void RTFGenerator::endMemberDeclaration (const QCString &, const QCString &)

inline virtual

Definition at line 200 of file rtfgen.h.

200 void endMemberDeclaration(const QCString &,const QCString &) override {}

endMemberDescription()

void RTFGenerator::endMemberDescription ()

virtual

Declaration at line 198 of file rtfgen.h, definition at line 1783 of file rtfgen.cpp.

1783void RTFGenerator::endMemberDescription()

1784{

1785 DBG_RTF(m_t << "{\\comment (endMemberDescription)}\n")

1786 endEmphasis();

1787 decIndentLevel();

1788 m_t << "\\par";

1789 m_t << "}\n";

1790 m_omitParagraph = TRUE;

1791}

References DBG_RTF, decIndentLevel, endEmphasis, m_omitParagraph, OutputGenerator::m_t and TRUE.

endMemberDoc()

void RTFGenerator::endMemberDoc (bool)

virtual

Declaration at line 184 of file rtfgen.h, definition at line 1697 of file rtfgen.cpp.

1697void RTFGenerator::endMemberDoc(bool)

1698{

1699 DBG_RTF(m_t << "{\\comment endMemberDoc}\n")

1700 //const QCString &style = styleStack.pop();

1701 //printf("RTFGenerator::endMemberDoc() '%s'\n",style);

1702 //ASSERT(style==rtf_Style["Heading4"].reference());

1703 endBold();

1704 m_t << "}\n";

1705 newParagraph();

1706}

References DBG_RTF, endBold, OutputGenerator::m_t and newParagraph.

endMemberDocList()

void RTFGenerator::endMemberDocList ()

inline virtual

Definition at line 159 of file rtfgen.h.

159 void endMemberDocList() override {}

endMemberDocName()

void RTFGenerator::endMemberDocName ()

inline virtual

Definition at line 266 of file rtfgen.h.

266 void endMemberDocName() override {}

endMemberDocPrefixItem()

void RTFGenerator::endMemberDocPrefixItem ()

inline virtual

Definition at line 264 of file rtfgen.h.

264 void endMemberDocPrefixItem() override {}

endMemberDocSimple()

void RTFGenerator::endMemberDocSimple (bool)

virtual

Declaration at line 289 of file rtfgen.h, definition at line 2782 of file rtfgen.cpp.

2782void RTFGenerator::endMemberDocSimple(bool)

2783{

2784 DBG_RTF(m_t << "{\\comment (endMemberDocSimple)}\n")

2785 m_t << "}\n";

2786}

References DBG_RTF and OutputGenerator::m_t.

endMemberGroup()

void RTFGenerator::endMemberGroup (bool hasHeader)

virtual

Declaration at line 257 of file rtfgen.h, definition at line 2557 of file rtfgen.cpp.

2557void RTFGenerator::endMemberGroup(bool hasHeader)

2558{

2559 DBG_RTF(m_t << "{\\comment endMemberGroup}\n")

2560 if (hasHeader) decIndentLevel();

2561 m_t << "}";

2562}

References DBG_RTF, decIndentLevel and OutputGenerator::m_t.

endMemberGroupDocs()

void RTFGenerator::endMemberGroupDocs ()

virtual

Declaration at line 255 of file rtfgen.h, definition at line 2544 of file rtfgen.cpp.

2544void RTFGenerator::endMemberGroupDocs()

2545{

2546 DBG_RTF(m_t << "{\\comment endMemberGroupDocs}\n")

2547 endEmphasis();

2548 newParagraph();

2549}

References DBG_RTF, endEmphasis, OutputGenerator::m_t and newParagraph.

endMemberGroupHeader()

void RTFGenerator::endMemberGroupHeader ()

virtual

Declaration at line 253 of file rtfgen.h, definition at line 2531 of file rtfgen.cpp.

2531void RTFGenerator::endMemberGroupHeader()

2532{

2533 DBG_RTF(m_t << "{\\comment endMemberGroupHeader}\n")

2534 newParagraph();

2535 m_t << rtf_Style_Reset << rtf_CList_DepthStyle();

2536}

References DBG_RTF, OutputGenerator::m_t, newParagraph, rtf_CList_DepthStyle and rtf_Style_Reset.

endMemberHeader()

void RTFGenerator::endMemberHeader ()

inline virtual

Definition at line 155 of file rtfgen.h.

155 void endMemberHeader() override { endGroupHeader(FALSE); }

References endGroupHeader and FALSE.

endMemberItem()

void RTFGenerator::endMemberItem (MemberItemType)

virtual

Declaration at line 167 of file rtfgen.h, definition at line 1884 of file rtfgen.cpp.

1884void RTFGenerator::endMemberItem(MemberItemType)

1885{

1886 DBG_RTF(m_t << "{\\comment endMemberItem }\n")

1887 newParagraph();

1888}

References DBG_RTF, OutputGenerator::m_t and newParagraph.

endMemberList()

void RTFGenerator::endMemberList ()

virtual

Declaration at line 161 of file rtfgen.h, definition at line 1936 of file rtfgen.cpp.

1936void RTFGenerator::endMemberList()

1937{

1938 DBG_RTF(m_t << "{\\comment (endMemberList) }\n")

1939 m_t << "}\n";

1940#ifdef DELETEDCODE

1941 if (!insideTabbing)

1942 m_t << "\\end{CompactItemize}\n";

1943#endif

1944}

References DBG_RTF and OutputGenerator::m_t.

endMemberSections()

void RTFGenerator::endMemberSections ()

inline virtual

Definition at line 151 of file rtfgen.h.

151 void endMemberSections() override {}

endMemberSubtitle()

void RTFGenerator::endMemberSubtitle ()

virtual

Declaration at line 157 of file rtfgen.h, definition at line 2147 of file rtfgen.cpp.

2147void RTFGenerator::endMemberSubtitle()

2148{

2149 DBG_RTF(m_t << "{\\comment endMemberSubtitle}\n")

2150 newParagraph();

2151 m_t << "}\n";

2152}

References DBG_RTF, OutputGenerator::m_t and newParagraph.

endMemberTemplateParams()

void RTFGenerator::endMemberTemplateParams (const QCString &, const QCString &)

inline virtual

Definition at line 169 of file rtfgen.h.

169 void endMemberTemplateParams(const QCString &,const QCString &) override {}

endPageDoc()

void RTFGenerator::endPageDoc ()

inline virtual

Definition at line 113 of file rtfgen.h.

113 void endPageDoc() override {}

endPageRef()

void RTFGenerator::endPageRef (const QCString & clname, const QCString & anchor)

virtual

Declaration at line 216 of file rtfgen.h, definition at line 1592 of file rtfgen.cpp.

1592void RTFGenerator::endPageRef(const QCString &clname, const QCString &anchor)

1593{

1594 QCString ref;

1595 if (!clname.isEmpty())

1596 {

1597 ref+=clname;

1598 }

1599 if (!anchor.isEmpty())

1600 {

1601 ref+='_';

1602 ref+=anchor;

1603 }

1604 writeRTFReference(ref);

1605 endEmphasis();

1606 m_t << ")";

1607}

References endEmphasis, QCString::isEmpty, OutputGenerator::m_t and writeRTFReference.

endParagraph()

void RTFGenerator::endParagraph ()

virtual

Declaration at line 124 of file rtfgen.h, definition at line 2133 of file rtfgen.cpp.

2133void RTFGenerator::endParagraph()

2134{

2135 DBG_RTF(m_t << "{\\comment endParagraph}\n")

2136 m_t << "}\\par\n";

2137 m_omitParagraph = TRUE;

2138}

References DBG_RTF, m_omitParagraph, OutputGenerator::m_t and TRUE.

endParameterDefVal()

void RTFGenerator::endParameterDefVal ()

inline virtual

Definition at line 274 of file rtfgen.h.

274 void endParameterDefVal() override { endTypewriter(); }

Reference endTypewriter.

endParameterExtra()

void RTFGenerator::endParameterExtra (bool last, bool, bool closeBracket)

virtual

Declaration at line 272 of file rtfgen.h, definition at line 2856 of file rtfgen.cpp.

2856void RTFGenerator::endParameterExtra(bool last,bool /* emptyList */, bool closeBracket)

2857{

2858 if (last && closeBracket)

2859 {

2860 m_t << ")";

2861 }

2862}

Reference OutputGenerator::m_t.

endParameterList()

void RTFGenerator::endParameterList ()

inline virtual

Definition at line 276 of file rtfgen.h.

276 void endParameterList() override {}

endParameterName()

void RTFGenerator::endParameterName ()

inline virtual

Definition at line 270 of file rtfgen.h.

270 void endParameterName() override {}

endParameterType()

void RTFGenerator::endParameterType ()

virtual

Declaration at line 268 of file rtfgen.h, definition at line 2598 of file rtfgen.cpp.

2598void RTFGenerator::endParameterType()

2599{

2600 DBG_RTF(m_t << "{\\comment (endParameterType)}\n")

2601 m_t << " ";

2602}

References DBG_RTF and OutputGenerator::m_t.

endPlainFile()

void RTFGenerator::endPlainFile ()

inline virtual

Definition at line 307 of file rtfgen.h.

307 void endPlainFile() override { OutputGenerator::endPlainFile(); }

Reference OutputGenerator::endPlainFile.

Referenced by endFile.

endProjectNumber()

void RTFGenerator::endProjectNumber ()

virtual

Declaration at line 118 of file rtfgen.h, definition at line 730 of file rtfgen.cpp.

730void RTFGenerator::endProjectNumber()

731{

732 DBG_RTF(m_t << "{\\comment endProjectNumber }\n")

733}

References DBG_RTF and OutputGenerator::m_t.

endQuickIndices()

void RTFGenerator::endQuickIndices ()

inline virtual

Definition at line 218 of file rtfgen.h.

218 void endQuickIndices() override {}

endSection()

void RTFGenerator::endSection (const QCString & lab, SectionType)

virtual

Declaration at line 208 of file rtfgen.h, definition at line 1831 of file rtfgen.cpp.

1831void RTFGenerator::endSection(const QCString &lab,SectionType)

1832{

1833 DBG_RTF(m_t << "{\\comment (endSection)}\n")

1834 // make bookmark

1835 m_omitParagraph=FALSE;

1836 newParagraph();

1837 writeAnchor(QCString(),lab);

1838 m_t << "}";

1839}

References DBG_RTF, FALSE, m_omitParagraph, OutputGenerator::m_t, newParagraph and writeAnchor.

endSmall()

void RTFGenerator::endSmall ()

inline virtual

Definition at line 195 of file rtfgen.h.

195 void endSmall() override { m_t << "}"; }

Reference OutputGenerator::m_t.

endTextBlock()

void RTFGenerator::endTextBlock (bool)

virtual

Declaration at line 260 of file rtfgen.h, definition at line 2107 of file rtfgen.cpp.

2107void RTFGenerator::endTextBlock(bool /*paraBreak*/)

2108{

2109 newParagraph();

2110 DBG_RTF(m_t << "{\\comment endTextBlock}\n")

2111 m_t << "}\n";

2112 //m_omitParagraph = TRUE;

2113}

References DBG_RTF, OutputGenerator::m_t and newParagraph.

endTextLink()

void RTFGenerator::endTextLink ()

virtual

Declaration at line 142 of file rtfgen.h, definition at line 1537 of file rtfgen.cpp.

1537void RTFGenerator::endTextLink()

1538{

1539 if (Config_getBool(RTF_HYPERLINKS))

1540 {

1541 m_t << "}}}\n";

1542 }

1543}

References Config_getBool and OutputGenerator::m_t.

endTitleHead()

void RTFGenerator::endTitleHead (const QCString & fileName, const QCString & name)

virtual

Declaration at line 121 of file rtfgen.h, definition at line 1619 of file rtfgen.cpp.

1619void RTFGenerator::endTitleHead(const QCString &fileName,const QCString &name)

1620{

1621 DBG_RTF(m_t << "{\\comment endTitleHead}\n")

1622 m_t << "\\par " << rtf_Style_Reset << "\n";

1623 if (!name.isEmpty())

1624 {

1625 // make table of contents entry

1626 int level = 2 + m_hierarchyLevel;

1627 m_t << "{\\tc\\tcl" << level << " \\v ";

1628 docify(name);

1629 m_t << "}\n";

1630

1631 // make an index entry

1632 addIndexItem(name,QCString());

1633 }

1634 if (!fileName.isEmpty())

1635 {

1636 writeAnchor(fileName,QCString());

1637 }

1638}

References addIndexItem, DBG_RTF, docify, OutputGenerator::fileName, QCString::isEmpty, m_hierarchyLevel, OutputGenerator::m_t, rtf_Style_Reset and writeAnchor.

endTocEntry()

void RTFGenerator::endTocEntry (const SectionInfo *)

inline virtual

Definition at line 304 of file rtfgen.h.

304 void endTocEntry(const SectionInfo *) override {}

endTypewriter()

void RTFGenerator::endTypewriter ()

inline virtual

Definition at line 144 of file rtfgen.h.

144 void endTypewriter() override { m_t << "}"; }

Reference OutputGenerator::m_t.

Referenced by endParameterDefVal.

exceptionEntry()

void RTFGenerator::exceptionEntry (const QCString & prefix, bool closeBracket)

virtual

Declaration at line 277 of file rtfgen.h, definition at line 2604 of file rtfgen.cpp.

2604void RTFGenerator::exceptionEntry(const QCString &prefix,bool closeBracket)

2605{

2606 DBG_RTF(m_t << "{\\comment (exceptionEntry)}\n")

2607 if (!prefix.isEmpty())

2608 {

2609 m_t << " " << prefix << "(";

2610 }

2611 else if (closeBracket)

2612 {

2613 m_t << ")";

2614 }

2615 m_t << " ";

2616}

References DBG_RTF, OutputGenerator::m_t and prefix.

insertMemberAlign()

void RTFGenerator::insertMemberAlign (bool)

inline virtual

Definition at line 172 of file rtfgen.h.

172 void insertMemberAlign(bool) override {}

insertMemberAlignLeft()

void RTFGenerator::insertMemberAlignLeft (MemberItemType, bool)

inline virtual

Definition at line 173 of file rtfgen.h.

173 void insertMemberAlignLeft(MemberItemType,bool) override {}

lastIndexPage()

void RTFGenerator::lastIndexPage ()

virtual

Declaration at line 261 of file rtfgen.h, definition at line 1313 of file rtfgen.cpp.

1313void RTFGenerator::lastIndexPage()

1314{

1315 DBG_RTF(m_t << "{\\comment Beginning Body of RTF Document}\n")

1316 // end page and setup for rest of document

1317 m_t << "\\sect \\sbkpage \\pgndec \\pgnrestart\n";

1318 m_t << "\\sect \\sectd \\sbknone\n";

1319

1320 // set new footer with arabic numbers

1321 m_t << "{\\footer "<< rtf_Style["Footer"].reference() << "{\\chpgn}}\n";

1322

1323}

References DBG_RTF, OutputGenerator::m_t and rtf_Style.

lineBreak()

void RTFGenerator::lineBreak (const QCString & style=QCString())

virtual

Declaration at line 182 of file rtfgen.h, definition at line 1329 of file rtfgen.cpp.

1329void RTFGenerator::lineBreak(const QCString &)

1330{

1331 DBG_RTF(m_t << "{\\comment (lineBreak)}" << "\n")

1332 m_t << "\\par\n";

1333 m_omitParagraph = TRUE;

1334}

References DBG_RTF, m_omitParagraph, OutputGenerator::m_t and TRUE.

setRelativePath()

void RTFGenerator::setRelativePath (const QCString & path)

Declaration at line 93 of file rtfgen.h, definition at line 381 of file rtfgen.cpp.

381void RTFGenerator::setRelativePath(const QCString &path)

382{

383 m_relPath = path;

384}

Reference m_relPath.

Referenced by startFile.

setSourceFileName()

void RTFGenerator::setSourceFileName (const QCString & sourceFileName)

Declaration at line 94 of file rtfgen.h, definition at line 386 of file rtfgen.cpp.

386void RTFGenerator::setSourceFileName(const QCString &name)

387{

388 m_codeGen->setSourceFileName(name);

389}

Reference m_codeGen.

Referenced by endFile and startFile.

startAnonTypeScope()

void RTFGenerator::startAnonTypeScope (int)

inline virtual

Definition at line 164 of file rtfgen.h.

164 void startAnonTypeScope(int) override {}

startBold()

void RTFGenerator::startBold ()

inline virtual

Definition at line 180 of file rtfgen.h.

180 void startBold() override { m_t << "{\\b "; }

Reference OutputGenerator::m_t.

Referenced by startConstraintList, startExamples, startInlineHeader and startMemberDoc.

startCallGraph()

void RTFGenerator::startCallGraph ()

virtual

Declaration at line 246 of file rtfgen.h, definition at line 2366 of file rtfgen.cpp.

2366void RTFGenerator::startCallGraph()

2367{

2368 DBG_RTF(m_t << "{\\comment (startCallGraph)}\n")

2369}

References DBG_RTF and OutputGenerator::m_t.

startCenter()

void RTFGenerator::startCenter ()

inline virtual

Definition at line 192 of file rtfgen.h.

192 void startCenter() override { m_t << "{\\qc\n"; }

Reference OutputGenerator::m_t.

startClassDiagram()

void RTFGenerator::startClassDiagram ()

virtual

Declaration at line 213 of file rtfgen.h, definition at line 1856 of file rtfgen.cpp.

1856void RTFGenerator::startClassDiagram()

1857{

1858 DBG_RTF(m_t << "{\\comment startClassDiagram }\n")

1859}

References DBG_RTF and OutputGenerator::m_t.

startCompoundTemplateParams()

void RTFGenerator::startCompoundTemplateParams ()

virtual

Declaration at line 170 of file rtfgen.h, definition at line 1499 of file rtfgen.cpp.

1499void RTFGenerator::startCompoundTemplateParams()

1500{

1501 //beginRTFSubSubSection();

1502 m_t << "\n";

1503 DBG_RTF(m_t << "{\\comment Begin SubSubSection}\n")

1504 m_t << "{\n";

1505 int level = 4 + m_hierarchyLevel;

1506 m_t << rtf_Style_Reset << rtf_Style[QCString().sprintf("Heading%d", level).str()].reference() << "\n";

1507}

References DBG_RTF, m_hierarchyLevel, OutputGenerator::m_t, rtf_Style, rtf_Style_Reset, QCString::sprintf and QCString::str.

startConstraintDocs()

void RTFGenerator::startConstraintDocs ()

virtual

Declaration at line 284 of file rtfgen.h, definition at line 2694 of file rtfgen.cpp.

2694void RTFGenerator::startConstraintDocs()

2695{

2696 DBG_RTF(m_t << "{\\comment (startConstraintDocs)}\n")

2697}

References DBG_RTF and OutputGenerator::m_t.

startConstraintList()

void RTFGenerator::startConstraintList (const QCString & header)

virtual

Declaration at line 279 of file rtfgen.h, definition at line 2653 of file rtfgen.cpp.

2653void RTFGenerator::startConstraintList(const QCString &header)

2654{

2655 DBG_RTF(m_t << "{\\comment (startConstraintList)}\n")

2656 m_t << "{"; // ends at endConstraintList

2657 m_t << "{";

2658 startBold();

2659 newParagraph();

2660 docify(header);

2661 endBold();

2662 m_t << "}";

2663 newParagraph();

2664 incIndentLevel();

2665 m_t << rtf_Style_Reset << rtf_DList_DepthStyle();

2666}

References DBG_RTF, docify, endBold, incIndentLevel, OutputGenerator::m_t, newParagraph, rtf_DList_DepthStyle, rtf_Style_Reset and startBold.

startConstraintParam()

void RTFGenerator::startConstraintParam ()

virtual

Declaration at line 280 of file rtfgen.h, definition at line 2668 of file rtfgen.cpp.

2668void RTFGenerator::startConstraintParam()

2669{

2670 DBG_RTF(m_t << "{\\comment (startConstraintParam)}\n")

2671 startEmphasis();

2672}

References DBG_RTF, OutputGenerator::m_t and startEmphasis.

startConstraintType()

void RTFGenerator::startConstraintType ()

virtual

Declaration at line 282 of file rtfgen.h, definition at line 2681 of file rtfgen.cpp.

2681void RTFGenerator::startConstraintType()

2682{

2683 DBG_RTF(m_t << "{\\comment (startConstraintType)}\n")

2684 startEmphasis();

2685}

References DBG_RTF, OutputGenerator::m_t and startEmphasis.

startContents()

void RTFGenerator::startContents ()

inline virtual

Definition at line 225 of file rtfgen.h.

225 void startContents() override {}

startDescForItem()

void RTFGenerator::startDescForItem ()

virtual

Declaration at line 205 of file rtfgen.h, definition at line 1793 of file rtfgen.cpp.

1793void RTFGenerator::startDescForItem()

1794{

1795 DBG_RTF(m_t << "{\\comment (startDescForItem) }\n")

1796}

References DBG_RTF and OutputGenerator::m_t.

startDescTable()

void RTFGenerator::startDescTable (const QCString & title, const bool hasInits)

virtual

Declaration at line 229 of file rtfgen.h, definition at line 1946 of file rtfgen.cpp.

1946void RTFGenerator::startDescTable(const QCString &title,const bool hasInits)

1947{

1948 DBG_RTF(m_t << "{\\comment (startDescTable) }\n")

1949 m_t << "{\\par\n";

1950 m_t << "{" << rtf_Style["Heading5"].reference() << "\n";

1951 docify(title);

1952 m_t << ":\\par}\n";

1953 m_t << rtf_Style_Reset << rtf_DList_DepthStyle();

1954 m_t << "\\trowd \\trgaph108\\trleft426\\tblind426"

1955 "\\trbrdrt\\brdrs\\brdrw10\\brdrcf15 "

1956 "\\trbrdrl\\brdrs\\brdrw10\\brdrcf15 "

1957 "\\trbrdrb\\brdrs\\brdrw10\\brdrcf15 "

1958 "\\trbrdrr\\brdrs\\brdrw10\\brdrcf15 "

1959 "\\trbrdrh\\brdrs\\brdrw10\\brdrcf15 "

1960 "\\trbrdrv\\brdrs\\brdrw10\\brdrcf15 \n";

1961 int columnPos2[2] = { 25, 100 };

1962 int columnPos3[3] = { 25, 45, 100 };

1963 for (int i=0;i<(hasInits?3:2);i++)

1964 {

1965 m_t << "\\clvertalt\\clbrdrt\\brdrs\\brdrw10\\brdrcf15 "

1966 "\\clbrdrl\\brdrs\\brdrw10\\brdrcf15 "

1967 "\\clbrdrb\\brdrs\\brdrw10\\brdrcf15 "

1968 "\\clbrdrr \\brdrs\\brdrw10\\brdrcf15 "

1969 "\\cltxlrtb "

1970 "\\cellx" << (rtf_pageWidth*(hasInits?columnPos3[i]:columnPos2[i])/100) << "\n";

1971 }

1972 m_t << "\\pard \\widctlpar\\intbl\\adjustright\n";

1973}

References DBG_RTF, docify, OutputGenerator::m_t, rtf_DList_DepthStyle, rtf_pageWidth, rtf_Style and rtf_Style_Reset.

startDescTableData()

void RTFGenerator::startDescTableData ()

virtual

Declaration at line 237 of file rtfgen.h, definition at line 2016 of file rtfgen.cpp.

2016void RTFGenerator::startDescTableData()

2017{

2018 DBG_RTF(m_t << "{\\comment (startDescTableData) }\n")

2019 m_t << "{";

2020}

References DBG_RTF and OutputGenerator::m_t.

startDescTableInit()

void RTFGenerator::startDescTableInit ()

virtual

Declaration at line 235 of file rtfgen.h, definition at line 2002 of file rtfgen.cpp.

2002void RTFGenerator::startDescTableInit()

2003{

2004 DBG_RTF(m_t << "{\\comment (startDescTableInit) }" << endl)

2005 m_t << "{";

2006 m_t << rtf_Style["BodyText"].reference();

2007 m_t << "\\qr ";

2008}

References DBG_RTF, OutputGenerator::m_t and rtf_Style.

startDescTableRow()

void RTFGenerator::startDescTableRow ()

virtual

Declaration at line 231 of file rtfgen.h, definition at line 1981 of file rtfgen.cpp.

1981void RTFGenerator::startDescTableRow()

1982{

1983}

startDescTableTitle()

void RTFGenerator::startDescTableTitle ()

virtual

Declaration at line 233 of file rtfgen.h, definition at line 1989 of file rtfgen.cpp.

1989void RTFGenerator::startDescTableTitle()

1990{

1991 DBG_RTF(m_t << "{\\comment (startDescTableTitle) }\n")

1992 m_t << "{";

1993 m_t << rtf_Style["BodyText"].reference();

1994}

References DBG_RTF, OutputGenerator::m_t and rtf_Style.

startDirDepGraph()

void RTFGenerator::startDirDepGraph ()

virtual

Declaration at line 248 of file rtfgen.h, definition at line 2388 of file rtfgen.cpp.

2388void RTFGenerator::startDirDepGraph()

2389{

2390 DBG_RTF(m_t << "{\\comment (startDirDepGraph)}\n")

2391}

References DBG_RTF and OutputGenerator::m_t.

startDotGraph()

void RTFGenerator::startDotGraph ()

virtual

Declaration at line 240 of file rtfgen.h, definition at line 2313 of file rtfgen.cpp.

2313void RTFGenerator::startDotGraph()

2314{

2315 DBG_RTF(m_t << "{\\comment (startDotGraph)}\n")

2316}

References DBG_RTF and OutputGenerator::m_t.

startDoxyAnchor()

void RTFGenerator::startDoxyAnchor (const QCString &, const QCString &, const QCString &, const QCString &, const QCString &)

virtual

Declaration at line 185 of file rtfgen.h, definition at line 1708 of file rtfgen.cpp.

1708void RTFGenerator::startDoxyAnchor(const QCString &,const QCString &,

1709 const QCString &,const QCString &,

1710 const QCString &

1711 )

1712{

1713 DBG_RTF(m_t << "{\\comment startDoxyAnchor}\n")

1714}

References DBG_RTF and OutputGenerator::m_t.

startEmphasis()

void RTFGenerator::startEmphasis ()

inline virtual

Definition at line 178 of file rtfgen.h.

178 void startEmphasis() override { m_t << "{\\i "; }

Reference OutputGenerator::m_t.

Referenced by startConstraintParam, startConstraintType, startMemberDescription, startMemberGroupDocs and startPageRef.

startExamples()

void RTFGenerator::startExamples ()

virtual

Declaration at line 203 of file rtfgen.h, definition at line 2564 of file rtfgen.cpp.

2564void RTFGenerator::startExamples()

2565{

2566 DBG_RTF(m_t << "{\\comment (startExamples)}\n")

2567 m_t << "{"; // ends at endDescList

2568 m_t << "{"; // ends at endDescTitle

2569 startBold();

2570 newParagraph();

2571 docify(theTranslator->trExamples());

2572 endBold();

2573 m_t << "}";

2574 newParagraph();

2575 incIndentLevel();

2576 m_t << rtf_Style_Reset << rtf_DList_DepthStyle();

2577}

References DBG_RTF, docify, endBold, incIndentLevel, OutputGenerator::m_t, newParagraph, rtf_DList_DepthStyle, rtf_Style_Reset, startBold and theTranslator.

startFile()

void RTFGenerator::startFile (const QCString & name, const QCString & manName, const QCString & title, int id, int hierarchyLevel)

virtual

Declaration at line 106 of file rtfgen.h, definition at line 701 of file rtfgen.cpp.

701void RTFGenerator::startFile(const QCString &name,const QCString &,const QCString &,int,int hierarchyLevel)

702{

703 //setEncoding(QCString().sprintf("CP%s",theTranslator->trRTFansicp()));

704 QCString fileName=name;

705 m_relPath = relativePathToRoot(fileName);

706 m_hierarchyLevel = hierarchyLevel;

707

708 if (!fileName.endsWith(".rtf")) fileName+=".rtf";

709 startPlainFile(fileName);

710 setRelativePath(m_relPath);

711 setSourceFileName(stripPath(fileName));

712 beginRTFDocument();

713}

References beginRTFDocument, OutputGenerator::fileName, m_hierarchyLevel, m_relPath, relativePathToRoot, setRelativePath, setSourceFileName, startPlainFile and stripPath.

startGroupCollaboration()

void RTFGenerator::startGroupCollaboration ()

virtual

Declaration at line 244 of file rtfgen.h, definition at line 2358 of file rtfgen.cpp.

2358void RTFGenerator::startGroupCollaboration()

2359{

2360}

startGroupHeader()

void RTFGenerator::startGroupHeader (const QCString &, int extraIndent)

virtual

Declaration at line 145 of file rtfgen.h, definition at line 1640 of file rtfgen.cpp.

1640void RTFGenerator::startGroupHeader(const QCString &,int extraIndent)

1641{

1642 DBG_RTF(m_t << "{\\comment startGroupHeader}\n")

1643 m_t << rtf_Style_Reset;

1644 extraIndent += m_hierarchyLevel;

1645 if (extraIndent>=2)

1646 {

1647 m_t << rtf_Style["Heading5"].reference();

1648 }

1649 else if (extraIndent==1)

1650 {

1651 m_t << rtf_Style["Heading4"].reference();

1652 }

1653 else // extraIndent==0

1654 {

1655 m_t << rtf_Style["Heading3"].reference();

1656 }

1657 m_t << "\n";

1658}

References DBG_RTF, m_hierarchyLevel, OutputGenerator::m_t, rtf_Style and rtf_Style_Reset.

Referenced by startMemberHeader.

startHeaderSection()

void RTFGenerator::startHeaderSection ()

inline virtual

Definition at line 152 of file rtfgen.h.

152 void startHeaderSection() override {}

startInclDepGraph()

void RTFGenerator::startInclDepGraph ()

virtual

Declaration at line 242 of file rtfgen.h, definition at line 2336 of file rtfgen.cpp.

2336void RTFGenerator::startInclDepGraph()

2337{

2338 DBG_RTF(m_t << "{\\comment (startInclDepGraph)}\n")

2339}

References DBG_RTF and OutputGenerator::m_t.

startIndent()

void RTFGenerator::startIndent ()

virtual

Declaration at line 210 of file rtfgen.h, definition at line 1759 of file rtfgen.cpp.

1759void RTFGenerator::startIndent()

1760{

1761 incIndentLevel();

1762 DBG_RTF(m_t << "{\\comment (startIndent) }\n")

1763 m_t << "{\n";

1764 m_t << rtf_Style_Reset << rtf_CList_DepthStyle() << "\n";

1765}

References DBG_RTF, incIndentLevel, OutputGenerator::m_t, rtf_CList_DepthStyle and rtf_Style_Reset.

startIndexItem()

void RTFGenerator::startIndexItem (const QCString & ref, const QCString & file)

virtual

Declaration at line 136 of file rtfgen.h, definition at line 1411 of file rtfgen.cpp.

1411void RTFGenerator::startIndexItem(const QCString &,const QCString &)

1412{

1413 DBG_RTF(m_t << "{\\comment (startIndexItem)}\n")

1414

1415 if (!m_omitParagraph)

1416 {

1417 m_t << "\\par\n";

1418 m_omitParagraph = TRUE;

1419 }

1420}

References DBG_RTF, m_omitParagraph, OutputGenerator::m_t and TRUE.

startIndexKey()

void RTFGenerator::startIndexKey ()

virtual

Declaration at line 130 of file rtfgen.h, definition at line 1462 of file rtfgen.cpp.

1462void RTFGenerator::startIndexKey()

1463{

1464 DBG_RTF(m_t << "{\\comment (startIndexKey)}\n")

1465 m_t << "{\\b ";

1466}

References DBG_RTF and OutputGenerator::m_t.

startIndexList()

void RTFGenerator::startIndexList ()

virtual

Declaration at line 128 of file rtfgen.h, definition at line 1341 of file rtfgen.cpp.

1341void RTFGenerator::startIndexList()

1342{

1343 DBG_RTF(m_t << "{\\comment (startIndexList)}\n")

1344 m_t << "{\n";

1345 m_t << "\\par\n";

1346 incIndentLevel();

1347 m_t << rtf_Style_Reset << rtf_LCList_DepthStyle() << "\n";

1348 m_omitParagraph = TRUE;

1349}

References DBG_RTF, incIndentLevel, m_omitParagraph, OutputGenerator::m_t, rtf_LCList_DepthStyle, rtf_Style_Reset and TRUE.

startIndexListItem()

void RTFGenerator::startIndexListItem ()

virtual

Declaration at line 126 of file rtfgen.h, definition at line 2714 of file rtfgen.cpp.

2714void RTFGenerator::startIndexListItem()

2715{

2716 DBG_RTF(m_t << "{\\comment (startIndexListItem)}\n")

2717}

References DBG_RTF and OutputGenerator::m_t.

startIndexSection()

void RTFGenerator::startIndexSection (IndexSection is)

virtual

Declaration at line 114 of file rtfgen.h, definition at line 735 of file rtfgen.cpp.

735void RTFGenerator::startIndexSection(IndexSection is)

736{

737 //QCString paperName;

738

739 //m_indentLevel = 0;

740

741 switch (is)

742 {

743 case IndexSection::isTitlePageStart:

744 // basic RTFstart

745 // get readyfor author etc

746

747 m_t << "{\\info \n";

748 m_t << "{\\title {\\comment ";

749 break;

750 case IndexSection::isTitlePageAuthor:

751 m_t << "}\n";

752 if (!rtf_subject.isEmpty()) m_t << "{\\subject " << rtf_subject << "}\n";

753 if (!rtf_comments.isEmpty()) m_t << "{\\comment " << rtf_comments << "}\n";

754 if (!rtf_company.isEmpty()) m_t << "{\\company " << rtf_company << "}\n";

755 if (!rtf_author.isEmpty()) m_t << "{\\author " << rtf_author << "}\n";

756 if (!rtf_manager.isEmpty()) m_t << "{\\manager " << rtf_manager << "}\n";

757 if (!rtf_documentType.isEmpty()) m_t << "{\\category " << rtf_documentType << "}\n";

758 if (!rtf_keywords.isEmpty()) m_t << "{\\keywords " << rtf_keywords << "}\n";

759 m_t << "{\\comment ";

760 break;

761 case IndexSection::isMainPage:

762 //Introduction

763 beginRTFChapter();

764 break;

765 case IndexSection::isTopicIndex:

766 //Topic Index

767 beginRTFChapter();

768 break;

769 case IndexSection::isModuleIndex:

770 //Module Index

771 beginRTFChapter();

772 break;

773 case IndexSection::isDirIndex:

774 //Directory Index

775 beginRTFChapter();

776 break;

777 case IndexSection::isNamespaceIndex:

778 //Namespace Index

779 beginRTFChapter();

780 break;

781 case IndexSection::isConceptIndex:

782 //Concept Index

783 beginRTFChapter();

784 break;

785 case IndexSection::isClassHierarchyIndex:

786 //Hierarchical Index

787 DBG_RTF(m_t << "{\\comment start classhierarchy}\n")

788 beginRTFChapter();

789 break;

790 case IndexSection::isCompoundIndex:

791 //Annotated Compound Index

792 beginRTFChapter();

793 break;

794 case IndexSection::isFileIndex:

795 //Annotated File Index

796 beginRTFChapter();

797 break;

798 case IndexSection::isPageIndex:

799 //Related Page Index

800 beginRTFChapter();

801 break;

802 case IndexSection::isTopicDocumentation:

803 {

804 //Topic Documentation

805 for (const auto &gd : *Doxygen::groupLinkedMap)

806 {

807 if (!gd->isReference())

808 {

809 beginRTFChapter();

810 break;

811 }

812 }

813 }

814 break;

815 case IndexSection::isModuleDocumentation:

816 {

817 //Module Documentation

818 for (const auto &mod : ModuleManager::instance().modules())

819 {

820 if (!mod->isReference() && mod->isPrimaryInterface())

821 {

822 beginRTFChapter();

823 break;

824 }

825 }

826 }

827 break;

828 case IndexSection::isDirDocumentation:

829 {

830 //Directory Documentation

831 for (const auto &dd : *Doxygen::dirLinkedMap)

832 {

833 if (dd->isLinkableInProject())

834 {

835 beginRTFChapter();

836 break;

837 }

838 }

839 }

840 break;

841 case IndexSection::isNamespaceDocumentation:

842 {

843 // Namespace Documentation

844 for (const auto &nd : *Doxygen::namespaceLinkedMap)

845 {

846 if (nd->isLinkableInProject())

847 {

848 beginRTFChapter();

849 break;

850 }

851 }

852 }

853 break;

854 case IndexSection::isConceptDocumentation:

855 {

856 // Concept Documentation

857 for (const auto &cd : *Doxygen::conceptLinkedMap)

858 {

859 if (cd->isLinkableInProject())

860 {

861 beginRTFChapter();

862 break;

863 }

864 }

865 }

866 break;

867 case IndexSection::isClassDocumentation:

868 {

869 //Compound Documentation

870 for (const auto &cd : *Doxygen::classLinkedMap)

871 {

872 if (cd->isLinkableInProject() &&

873 !cd->isImplicitTemplateInstance() &&

874 !cd->isEmbeddedInOuterScope() &&

875 !cd->isAlias()

876 )

877 {

878 beginRTFChapter();

879 break;

880 }

881 }

882 }

883 break;

884 case IndexSection::isFileDocumentation:

885 {

886 //File Documentation

887 bool isFirst=TRUE;

888 for (const auto &fn : *Doxygen::inputNameLinkedMap)

889 {

890 for (const auto &fd : *fn)

891 {

892 if (fd->isLinkableInProject() || fd->generateSourceFile())

893 {

894 if (isFirst)

895 {

896 beginRTFChapter();

897 isFirst=FALSE;

898 break;

899 }

900 }

901 }

902 if (!isFirst)

903 {

904 break;

905 }

906 }

907 }

908 break;

909 case IndexSection::isExampleDocumentation:

910 {

911 //Example Documentation

912 beginRTFChapter();

913 }

914 break;

915 case IndexSection::isPageDocumentation:

916 break;

917 case IndexSection::isPageDocumentation2:

918 break;

919 case IndexSection::isEndIndex:

920 break;

921 }

922}

References beginRTFChapter, Doxygen::classLinkedMap, Doxygen::conceptLinkedMap, DBG_RTF, Doxygen::dirLinkedMap, FALSE, Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, ModuleManager::instance, isClassDocumentation, isClassHierarchyIndex, isCompoundIndex, isConceptDocumentation, isConceptIndex, isDirDocumentation, isDirIndex, isEndIndex, isExampleDocumentation, isFileDocumentation, isFileIndex, isMainPage, isModuleDocumentation, isModuleIndex, isNamespaceDocumentation, isNamespaceIndex, isPageDocumentation, isPageDocumentation2, isPageIndex, isTitlePageAuthor, isTitlePageStart, isTopicDocumentation, isTopicIndex, OutputGenerator::m_t, Doxygen::namespaceLinkedMap, rtf_author, rtf_comments, rtf_company, rtf_documentType, rtf_keywords, rtf_manager, rtf_subject and TRUE.

startIndexValue()

void RTFGenerator::startIndexValue (bool hasBrief)

virtual

Declaration at line 132 of file rtfgen.h, definition at line 1473 of file rtfgen.cpp.

1473void RTFGenerator::startIndexValue(bool hasBrief)

1474{

1475 DBG_RTF(m_t << "{\\comment (startIndexValue)}\n")

1476 m_t << " ";

1477 if (hasBrief) m_t << "(";

1478}

References DBG_RTF and OutputGenerator::m_t.

startInlineHeader()

void RTFGenerator::startInlineHeader ()

virtual

Declaration at line 162 of file rtfgen.h, definition at line 2725 of file rtfgen.cpp.

2725void RTFGenerator::startInlineHeader()

2726{

2727 DBG_RTF(m_t << "{\\comment (startInlineHeader)}\n")

2728 m_t << "{\n";

2729 m_t << rtf_Style_Reset << rtf_Style["Heading5"].reference();

2730 startBold();

2731}

References DBG_RTF, OutputGenerator::m_t, rtf_Style, rtf_Style_Reset and startBold.

startInlineMemberDoc()

void RTFGenerator::startInlineMemberDoc ()

virtual

Declaration at line 294 of file rtfgen.h, definition at line 2812 of file rtfgen.cpp.

2812void RTFGenerator::startInlineMemberDoc()

2813{

2814 DBG_RTF(m_t << "{\\comment (startInlineMemberDoc)}\n")

2815 m_t << "{";

2816}

References DBG_RTF and OutputGenerator::m_t.

startInlineMemberName()

void RTFGenerator::startInlineMemberName ()

virtual

Declaration at line 292 of file rtfgen.h, definition at line 2800 of file rtfgen.cpp.

2800void RTFGenerator::startInlineMemberName()

2801{

2802 DBG_RTF(m_t << "{\\comment (startInlineMemberName)}\n")

2803 m_t << "{";

2804}

References DBG_RTF and OutputGenerator::m_t.

startInlineMemberType()

void RTFGenerator::startInlineMemberType ()

virtual

Declaration at line 290 of file rtfgen.h, definition at line 2788 of file rtfgen.cpp.

2788void RTFGenerator::startInlineMemberType()

2789{

2790 DBG_RTF(m_t << "{\\comment (startInlineMemberType)}\n")

2791 m_t << "{\\qr ";

2792}

References DBG_RTF and OutputGenerator::m_t.

startItemList()

void RTFGenerator::startItemList ()

virtual

start bullet list

Declaration at line 134 of file rtfgen.h, definition at line 1364 of file rtfgen.cpp.

1364void RTFGenerator::startItemList()

1365{

1366 newParagraph();

1367 incIndentLevel();

1368 int level = indentLevel();

1369 DBG_RTF(m_t << "{\\comment (startItemList level=" << level << ") }\n")

1370 m_t << "{";

1371 m_listItemInfo[level].number = 1;

1372 m_listItemInfo[level].isEnum = false;

1373 m_listItemInfo[level].type = '1';

1374}

References DBG_RTF, incIndentLevel, indentLevel, m_listItemInfo, OutputGenerator::m_t and newParagraph.

startItemListItem()

void RTFGenerator::startItemListItem ()

virtual

write bullet or enum item

Declaration at line 147 of file rtfgen.h, definition at line 1387 of file rtfgen.cpp.

1387void RTFGenerator::startItemListItem()

1388{

1389 DBG_RTF(m_t << "{\\comment (startItemListItem)}\n")

1390 newParagraph();

1391 m_t << rtf_Style_Reset;

1392 int level = indentLevel();

1393 if (m_listItemInfo[level].isEnum)

1394 {

1395 m_t << rtf_EList_DepthStyle() << "\n";

1396 m_t << m_listItemInfo[level].number << ".\\tab ";

1397 m_listItemInfo[level].number++;

1398 }

1399 else

1400 {

1401 m_t << rtf_BList_DepthStyle() << "\n";

1402 }

1403 m_omitParagraph = TRUE;

1404}

References DBG_RTF, indentLevel, m_listItemInfo, m_omitParagraph, OutputGenerator::m_t, newParagraph, rtf_BList_DepthStyle, rtf_EList_DepthStyle, rtf_Style_Reset and TRUE.

startLabels()

void RTFGenerator::startLabels ()

virtual

Declaration at line 297 of file rtfgen.h, definition at line 2824 of file rtfgen.cpp.

2824void RTFGenerator::startLabels()

2825{

2826}

startLocalToc()

void RTFGenerator::startLocalToc (int)

inline virtual

Definition at line 301 of file rtfgen.h.

301 void startLocalToc(int) override {}

startMemberDeclaration()

void RTFGenerator::startMemberDeclaration ()

inline virtual

Definition at line 199 of file rtfgen.h.

199 void startMemberDeclaration() override {}

startMemberDescription()

void RTFGenerator::startMemberDescription (const QCString &, const QCString &, bool)

virtual

Declaration at line 197 of file rtfgen.h, definition at line 1774 of file rtfgen.cpp.

1774void RTFGenerator::startMemberDescription(const QCString &,const QCString &,bool)

1775{

1776 DBG_RTF(m_t << "{\\comment (startMemberDescription)}\n")

1777 m_t << "{\n";

1778 incIndentLevel();

1779 m_t << rtf_Style_Reset << rtf_CList_DepthStyle();

1780 startEmphasis();

1781}

References DBG_RTF, incIndentLevel, OutputGenerator::m_t, rtf_CList_DepthStyle, rtf_Style_Reset and startEmphasis.

startMemberDoc()

void RTFGenerator::startMemberDoc (const QCString & clname, const QCString & memname, const QCString &, const QCString &, int, int, bool showInline)

virtual

Declaration at line 183 of file rtfgen.h, definition at line 1667 of file rtfgen.cpp.

1667void RTFGenerator::startMemberDoc(const QCString &clname,

1668 const QCString &memname,

1669 const QCString &,

1670 const QCString &,

1671 int,

1672 int,

1673 bool showInline)

1674{

1675 DBG_RTF(m_t << "{\\comment startMemberDoc}\n")

1676 if (!memname.isEmpty() && memname[0]!='@')

1677 {

1678 addIndexItem(memname,clname);

1679 addIndexItem(clname,memname);

1680 }

1681

1682 int level = 4 + m_hierarchyLevel;

1683 if (showInline)

1684 ++level;

1685 if (level > 5)

1686 level = 5;

1687 if (level < 1)

1688 level = 1;

1689 m_t << rtf_Style_Reset << rtf_Style[QCString().sprintf("Heading%d", level).str()].reference();

1690 //styleStack.push(rtf_Style_Heading4);

1691 m_t << "{\n";

1692 //printf("RTFGenerator::startMemberDoc() '%s'\n",rtf_Style["Heading4"].reference());

1693 startBold();

1694 m_t << "\n";

1695}

References addIndexItem, DBG_RTF, QCString::isEmpty, m_hierarchyLevel, OutputGenerator::m_t, rtf_Style, rtf_Style_Reset, QCString::sprintf, startBold and QCString::str.

startMemberDocList()

void RTFGenerator::startMemberDocList ()

inline virtual

Definition at line 158 of file rtfgen.h.

158 void startMemberDocList() override {}

startMemberDocName()

void RTFGenerator::startMemberDocName (bool)

inline virtual

Definition at line 265 of file rtfgen.h.

265 void startMemberDocName(bool) override {}

startMemberDocPrefixItem()

void RTFGenerator::startMemberDocPrefixItem ()

inline virtual

Definition at line 263 of file rtfgen.h.

263 void startMemberDocPrefixItem() override {}

startMemberDocSimple()

void RTFGenerator::startMemberDocSimple (bool isEnum)

virtual

Declaration at line 288 of file rtfgen.h, definition at line 2741 of file rtfgen.cpp.

2741void RTFGenerator::startMemberDocSimple(bool isEnum)

2742{

2743 DBG_RTF(m_t << "{\\comment (startMemberDocSimple)}\n")

2744 m_t << "{\\par\n";

2745 m_t << "{" << rtf_Style["Heading5"].reference() << "\n";

2746 if (isEnum)

2747 {

2748 m_t << theTranslator->trEnumerationValues();

2749 }

2750 else

2751 {

2752 m_t << theTranslator->trCompoundMembers();

2753 }

2754 m_t << ":\\par}\n";

2755 m_t << rtf_Style_Reset << rtf_DList_DepthStyle();

2756 m_t << "\\trowd \\trgaph108\\trleft426\\tblind426"

2757 "\\trbrdrt\\brdrs\\brdrw10\\brdrcf15 "

2758 "\\trbrdrl\\brdrs\\brdrw10\\brdrcf15 "

2759 "\\trbrdrb\\brdrs\\brdrw10\\brdrcf15 "

2760 "\\trbrdrr\\brdrs\\brdrw10\\brdrcf15 "

2761 "\\trbrdrh\\brdrs\\brdrw10\\brdrcf15 "

2762 "\\trbrdrv\\brdrs\\brdrw10\\brdrcf15 \n";

2763 int n=3,columnPos[3] = { 25, 50, 100 };

2764 if (isEnum)

2765 {

2766 columnPos[0]=30;

2767 columnPos[1]=100;

2768 n=2;

2769 }

2770 for (int i=0;i<n;i++)

2771 {

2772 m_t << "\\clvertalt\\clbrdrt\\brdrs\\brdrw10\\brdrcf15 "

2773 "\\clbrdrl\\brdrs\\brdrw10\\brdrcf15 "

2774 "\\clbrdrb\\brdrs\\brdrw10\\brdrcf15 "

2775 "\\clbrdrr \\brdrs\\brdrw10\\brdrcf15 "

2776 "\\cltxlrtb "

2777 "\\cellx" << (rtf_pageWidth*columnPos[i]/100) << "\n";

2778 }

2779 m_t << "\\pard \\widctlpar\\intbl\\adjustright\n";

2780}

References DBG_RTF, OutputGenerator::m_t, rtf_DList_DepthStyle, rtf_pageWidth, rtf_Style, rtf_Style_Reset and theTranslator.

startMemberGroup()

void RTFGenerator::startMemberGroup ()

virtual

Declaration at line 256 of file rtfgen.h, definition at line 2551 of file rtfgen.cpp.

2551void RTFGenerator::startMemberGroup()

2552{

2553 DBG_RTF(m_t << "{\\comment startMemberGroup}\n")

2554 m_t << rtf_Style_Reset << rtf_BList_DepthStyle() << "\n";

2555}

References DBG_RTF, OutputGenerator::m_t, rtf_BList_DepthStyle and rtf_Style_Reset.

startMemberGroupDocs()

void RTFGenerator::startMemberGroupDocs ()

virtual

Declaration at line 254 of file rtfgen.h, definition at line 2538 of file rtfgen.cpp.

2538void RTFGenerator::startMemberGroupDocs()

2539{

2540 DBG_RTF(m_t << "{\\comment startMemberGroupDocs}\n")

2541 startEmphasis();

2542}

References DBG_RTF, OutputGenerator::m_t and startEmphasis.

startMemberGroupHeader()

void RTFGenerator::startMemberGroupHeader (const QCString &, bool hasHeader)

virtual

Declaration at line 252 of file rtfgen.h, definition at line 2523 of file rtfgen.cpp.

2523void RTFGenerator::startMemberGroupHeader(const QCString &,bool hasHeader)

2524{

2525 DBG_RTF(m_t << "{\\comment startMemberGroupHeader}\n")

2526 m_t << "{\n";

2527 if (hasHeader) incIndentLevel();

2528 m_t << rtf_Style_Reset << rtf_Style["GroupHeader"].reference();

2529}

References DBG_RTF, incIndentLevel, OutputGenerator::m_t, rtf_Style and rtf_Style_Reset.

startMemberHeader()

void RTFGenerator::startMemberHeader (const QCString &, int)

inline virtual

Definition at line 154 of file rtfgen.h.

154 void startMemberHeader(const QCString &,int) override { startGroupHeader("",0); }

Reference startGroupHeader.

startMemberItem()

void RTFGenerator::startMemberItem (const QCString &, MemberItemType, const QCString &)

virtual

Declaration at line 166 of file rtfgen.h, definition at line 1878 of file rtfgen.cpp.

1878void RTFGenerator::startMemberItem(const QCString &,MemberItemType,const QCString &)

1879{

1880 DBG_RTF(m_t << "{\\comment startMemberItem }\n")

1881 m_t << rtf_Style_Reset << rtf_BList_DepthStyle() << "\n"; // set style to appropriate depth

1882}

References DBG_RTF, OutputGenerator::m_t, rtf_BList_DepthStyle and rtf_Style_Reset.

startMemberList()

void RTFGenerator::startMemberList ()

virtual

Declaration at line 160 of file rtfgen.h, definition at line 1925 of file rtfgen.cpp.

1925void RTFGenerator::startMemberList()

1926{

1927 m_t << "\n";

1928 DBG_RTF(m_t << "{\\comment (startMemberList) }\n")

1929 m_t << "{\n";

1930#ifdef DELETEDCODE

1931 if (!insideTabbing)

1932 m_t << "\\begin{CompactItemize}\n";

1933#endif

1934}

References DBG_RTF and OutputGenerator::m_t.

startMemberSections()

void RTFGenerator::startMemberSections ()

inline virtual

Definition at line 150 of file rtfgen.h.

150 void startMemberSections() override {}

startMemberSubtitle()

void RTFGenerator::startMemberSubtitle ()

virtual

Declaration at line 156 of file rtfgen.h, definition at line 2140 of file rtfgen.cpp.

2140void RTFGenerator::startMemberSubtitle()

2141{

2142 DBG_RTF(m_t << "{\\comment startMemberSubtitle}\n")

2143 m_t << "{\n";

2144 m_t << rtf_Style_Reset << rtf_CList_DepthStyle() << "\n";

2145}

References DBG_RTF, OutputGenerator::m_t, rtf_CList_DepthStyle and rtf_Style_Reset.

startMemberTemplateParams()

void RTFGenerator::startMemberTemplateParams ()

inline virtual

Definition at line 168 of file rtfgen.h.

168 void startMemberTemplateParams() override {}

startPageDoc()

void RTFGenerator::startPageDoc (const QCString &)

inline virtual

Definition at line 112 of file rtfgen.h.

112 void startPageDoc(const QCString &) override {}

startPageRef()

void RTFGenerator::startPageRef ()

virtual

Declaration at line 215 of file rtfgen.h, definition at line 1586 of file rtfgen.cpp.

1586void RTFGenerator::startPageRef()

1587{

1588 m_t << " (";

1589 startEmphasis();

1590}

References OutputGenerator::m_t and startEmphasis.

startParagraph()

void RTFGenerator::startParagraph (const QCString & classDef)

virtual

Declaration at line 123 of file rtfgen.h, definition at line 2125 of file rtfgen.cpp.

2125void RTFGenerator::startParagraph(const QCString &txt)

2126{

2127 DBG_RTF(m_t << "{\\comment startParagraph}\n")

2128 newParagraph();

2129 m_t << "{\n";

2130 if (QCString(txt) == "reference") m_t << "\\ql\n";

2131}

References DBG_RTF, OutputGenerator::m_t and newParagraph.

startParameterDefVal()

void RTFGenerator::startParameterDefVal (const char * s)

inline virtual

Definition at line 273 of file rtfgen.h.

273 void startParameterDefVal(const char *s) override { docify(s); startTypewriter(); }

References docify and startTypewriter.

startParameterExtra()

void RTFGenerator::startParameterExtra ()

inline virtual

Definition at line 271 of file rtfgen.h.

271 void startParameterExtra() override {}

startParameterList()

void RTFGenerator::startParameterList (bool openBracket)

virtual

Declaration at line 275 of file rtfgen.h, definition at line 2851 of file rtfgen.cpp.

2851void RTFGenerator::startParameterList(bool openBracket)

2852{

2853 if (openBracket) m_t << "(";

2854}

Reference OutputGenerator::m_t.

startParameterName()

void RTFGenerator::startParameterName (bool)

inline virtual

Definition at line 269 of file rtfgen.h.

269 void startParameterName(bool) override {}

startParameterType()

void RTFGenerator::startParameterType (bool first, const QCString & key)

virtual

Declaration at line 267 of file rtfgen.h, definition at line 2589 of file rtfgen.cpp.

2589void RTFGenerator::startParameterType(bool first,const QCString &key)

2590{

2591 DBG_RTF(m_t << "{\\comment (startParameterType)}\n")

2592 if (!first && !key.isEmpty())

2593 {

2594 m_t << " " << key << " ";

2595 }

2596}

References DBG_RTF, QCString::isEmpty and OutputGenerator::m_t.

startPlainFile()

void RTFGenerator::startPlainFile (const QCString & name)

inline virtual

Definition at line 306 of file rtfgen.h.

306 void startPlainFile(const QCString &name) override { OutputGenerator::startPlainFile(name); }

Reference OutputGenerator::startPlainFile.

Referenced by startFile.

startProjectNumber()

void RTFGenerator::startProjectNumber ()

virtual

Declaration at line 117 of file rtfgen.h, definition at line 724 of file rtfgen.cpp.

724void RTFGenerator::startProjectNumber()

725{

726 DBG_RTF(m_t << "{\\comment startProjectNumber }\n")

727 m_t << " ";

728}

References DBG_RTF and OutputGenerator::m_t.

startQuickIndices()

void RTFGenerator::startQuickIndices ()

inline virtual

Definition at line 217 of file rtfgen.h.

217 void startQuickIndices() override {}

startSection()

void RTFGenerator::startSection (const QCString &, const QCString & title, SectionType type)

virtual

Declaration at line 207 of file rtfgen.h, definition at line 1803 of file rtfgen.cpp.

1803void RTFGenerator::startSection(const QCString &,const QCString &title,SectionType type)

1804{

1805 DBG_RTF(m_t << "{\\comment (startSection)}\n")

1806 m_t << "{";

1807 m_t << rtf_Style_Reset;

1808 int num=SectionType::MaxLevel;

1809 switch(type.level())

1810 {

1811 case SectionType::Page: num=2+m_hierarchyLevel; break;

1812 case SectionType::Section: num=3+m_hierarchyLevel; break;

1813 case SectionType::Subsection: // fall through

1814 case SectionType::Subsubsection: // fall through

1815 case SectionType::Paragraph: // fall through

1816 case SectionType::Subparagraph: // fall through

1817 case SectionType::Subsubparagraph: num=4+m_hierarchyLevel; break;

1818 default: ASSERT(0); break;

1819 }

1820 num = std::clamp(num, SectionType::MinLevel, SectionType::MaxLevel);

1821 QCString heading;

1822 heading.sprintf("Heading%d",num);

1823 // set style

1824 m_t << rtf_Style[heading.str()].reference();

1825 // make table of contents entry

1826 m_t << "{\\tc\\tcl" << num << " \\v ";

1827 docify(title);

1828 m_t << "}\n";

1829}

References ASSERT, DBG_RTF, docify, m_hierarchyLevel, OutputGenerator::m_t, SectionType::MaxLevel, SectionType::MinLevel, SectionType::Page, SectionType::Paragraph, rtf_Style, rtf_Style_Reset, SectionType::Section, QCString::sprintf, QCString::str, SectionType::Subparagraph, SectionType::Subsection, SectionType::Subsubparagraph, SectionType::Subsubsection and type.

startSmall()

void RTFGenerator::startSmall ()

inline virtual

Definition at line 194 of file rtfgen.h.

194 void startSmall() override { m_t << "{\\sub "; }

Reference OutputGenerator::m_t.

startTextBlock()

void RTFGenerator::startTextBlock (bool dense)

virtual

Declaration at line 259 of file rtfgen.h, definition at line 2092 of file rtfgen.cpp.

2092void RTFGenerator::startTextBlock(bool dense)

2093{

2094 DBG_RTF(m_t << "{\\comment startTextBlock}\n")

2095 m_t << "{\n";

2096 m_t << rtf_Style_Reset;

2097 if (dense) // no spacing between "paragraphs"

2098 {

2099 m_t << rtf_Style["DenseText"].reference();

2100 }

2101 else // some spacing

2102 {

2103 m_t << rtf_Style["BodyText"].reference();

2104 }

2105}

References DBG_RTF, OutputGenerator::m_t, rtf_Style and rtf_Style_Reset.

startTextLink()

void RTFGenerator::startTextLink (const QCString & f, const QCString & anchor)

virtual

Declaration at line 141 of file rtfgen.h, definition at line 1515 of file rtfgen.cpp.

1515void RTFGenerator::startTextLink(const QCString &f,const QCString &anchor)

1516{

1517 if (Config_getBool(RTF_HYPERLINKS))

1518 {

1519 QCString ref;

1520 if (!f.isEmpty())

1521 {

1522 ref+=stripPath(f);

1523 }

1524 if (!anchor.isEmpty())

1525 {

1526 ref+='_';

1527 ref+=anchor;

1528 }

1529

1530 m_t << "{\\field {\\*\\fldinst { HYPERLINK \\\\l \"";

1531 m_t << rtfFormatBmkStr(ref);

1532 m_t << "\" }{}";

1533 m_t << "}{\\fldrslt {\\cs37\\ul\\cf2 ";

1534 }

1535}

References Config_getBool, QCString::isEmpty, OutputGenerator::m_t, rtfFormatBmkStr and stripPath.

startTitleHead()

void RTFGenerator::startTitleHead (const QCString &)

virtual

Declaration at line 120 of file rtfgen.h, definition at line 1609 of file rtfgen.cpp.

1609void RTFGenerator::startTitleHead(const QCString &)

1610{

1611 DBG_RTF(m_t << "{\\comment startTitleHead}\n")

1612 int level = 2 + m_hierarchyLevel;

1613 QCString heading;

1614 heading.sprintf("Heading%d", level);

1615 // beginRTFSection();

1616 m_t << rtf_Style_Reset << rtf_Style[heading.str()].reference() << "\n";

1617}

References DBG_RTF, m_hierarchyLevel, OutputGenerator::m_t, rtf_Style, rtf_Style_Reset, QCString::sprintf and QCString::str.

startTocEntry()

void RTFGenerator::startTocEntry (const SectionInfo *)

inline virtual

Definition at line 303 of file rtfgen.h.

303 void startTocEntry(const SectionInfo *) override {}

startTypewriter()

void RTFGenerator::startTypewriter ()

inline virtual

Definition at line 143 of file rtfgen.h.

143 void startTypewriter() override { m_t << "{\\f2 "; }

Reference OutputGenerator::m_t.

Referenced by startParameterDefVal.

type()

OutputType RTFGenerator::type ()

inline virtual

Definition at line 101 of file rtfgen.h.

101 OutputType type() const override { return OutputType::RTF; }

Reference RTF.

Referenced by startSection.

writeAnchor()

void RTFGenerator::writeAnchor (const QCString & fileName, const QCString & name)

virtual

Declaration at line 177 of file rtfgen.h, definition at line 1890 of file rtfgen.cpp.

1890void RTFGenerator::writeAnchor(const QCString &fileName,const QCString &name)

1891{

1892 QCString anchor;

1893 if (!fileName.isEmpty())

1894 {

1895 anchor+=stripPath(fileName);

1896 }

1897 if (!fileName.isEmpty() && !name.isEmpty())

1898 {

1899 anchor+='_';

1900 }

1901 if (!name.isEmpty())

1902 {

1903 anchor+=name;

1904 }

1905 //printf("writeAnchor(%s->%s)\n",qPrint(anchor),qPrint(rtfFormatBmkStr(anchor)));

1906

1907 DBG_RTF(m_t << "{\\comment writeAnchor (" << anchor << ")}\n")

1908 m_t << "{\\bkmkstart " << rtfFormatBmkStr(anchor) << "}\n";

1909 m_t << "{\\bkmkend " << rtfFormatBmkStr(anchor) << "}\n";

1910}

References DBG_RTF, OutputGenerator::fileName, QCString::isEmpty, OutputGenerator::m_t, rtfFormatBmkStr and stripPath.

Referenced by endSection and endTitleHead.

writeChar()

void RTFGenerator::writeChar (char c)

virtual

Declaration at line 188 of file rtfgen.h, definition at line 1848 of file rtfgen.cpp.

1848void RTFGenerator::writeChar(char c)

1849{

1850 char cs[2];

1851 cs[0]=c;

1852 cs[1]=0;

1853 docify(cs);

1854}

Reference docify.

writeDoc()

void RTFGenerator::writeDoc (const IDocNodeAST * ast, const Definition * ctx, const MemberDef *, int)

virtual

Declaration at line 105 of file rtfgen.h, definition at line 2618 of file rtfgen.cpp.

2618void RTFGenerator::writeDoc(const IDocNodeAST *ast,const Definition *ctx,const MemberDef *,int)

2619{

2620 auto astImpl = dynamic_cast<const DocNodeAST*>(ast);

2621 if (astImpl)

2622 {

2623 RTFDocVisitor visitor(m_t,*m_codeList,ctx?ctx->getDefFileExtension():QCString(""),m_hierarchyLevel);

2624 std::visit(visitor,astImpl->root);

2625 }

2626 m_omitParagraph = TRUE;

2627}

References Definition::getDefFileExtension, m_codeList, m_hierarchyLevel, m_omitParagraph, OutputGenerator::m_t and TRUE.

Referenced by endIndexSection.

writeFooter()

void RTFGenerator::writeFooter (const QCString &)

inline virtual

Definition at line 110 of file rtfgen.h.

110 void writeFooter(const QCString &) override {}

writeGraphicalHierarchy()

void RTFGenerator::writeGraphicalHierarchy (DotGfxHierarchyTable &)

inline virtual

Definition at line 250 of file rtfgen.h.

250 void writeGraphicalHierarchy(DotGfxHierarchyTable &) override {}

writeInheritedSectionTitle()

void RTFGenerator::writeInheritedSectionTitle (const QCString &, const QCString & ref, const QCString & file, const QCString & anchor, const QCString & title, const QCString & name)

virtual

Declaration at line 201 of file rtfgen.h, definition at line 2838 of file rtfgen.cpp.

2838void RTFGenerator::writeInheritedSectionTitle(

2839 const QCString &/*id*/,const QCString &ref,

2840 const QCString &file, const QCString &anchor,

2841 const QCString &title, const QCString &name)

2842{

2843 m_t << rtf_Style_Reset;

2844 m_t << rtf_Style["Heading4"].reference();

2845 m_t << "\n";

2846 m_t << theTranslator->trInheritedFrom(docifyToString(title), objectLinkToString(ref, file, anchor, name));

2847 m_t << "\\par\n";

2848 m_t << rtf_Style_Reset << "\n";

2849}

References docifyToString, OutputGenerator::m_t, objectLinkToString, rtf_Style, rtf_Style_Reset and theTranslator.

writeLabel()

void RTFGenerator::writeLabel (const QCString & l, bool isLast)

virtual

Declaration at line 298 of file rtfgen.h, definition at line 2828 of file rtfgen.cpp.

2828void RTFGenerator::writeLabel(const QCString &l,bool isLast)

2829{

2830 m_t << "{\\f2 [" << l << "]}";

2831 if (!isLast) m_t << ", ";

2832}

Reference OutputGenerator::m_t.

writeLatexSpacing()

void RTFGenerator::writeLatexSpacing ()

inline virtual

Definition at line 189 of file rtfgen.h.

189 void writeLatexSpacing() override {};//{ m_t << "\\hspace{0.3cm}"; }

writeLogo()

void RTFGenerator::writeLogo ()

inline virtual

Definition at line 221 of file rtfgen.h.

221 void writeLogo() override {}

writeNavigationPath()

void RTFGenerator::writeNavigationPath (const QCString &)

inline virtual

Definition at line 220 of file rtfgen.h.

220 void writeNavigationPath(const QCString &) override {}

writeNonBreakableSpace()

void RTFGenerator::writeNonBreakableSpace (int)

virtual

Declaration at line 227 of file rtfgen.h, definition at line 1919 of file rtfgen.cpp.

1919void RTFGenerator::writeNonBreakableSpace(int)

1920{

1921 m_t << "\\~ ";

1922}

Reference OutputGenerator::m_t.

writeObjectLink()

void RTFGenerator::writeObjectLink (const QCString & ref, const QCString & file, const QCString & anchor, const QCString & name)

virtual

Declaration at line 139 of file rtfgen.h, definition at line 1580 of file rtfgen.cpp.

1580void RTFGenerator::writeObjectLink(const QCString &ref, const QCString &f,

1581 const QCString &anchor, const QCString &text)

1582{

1583 m_t << objectLinkToString(ref,f,anchor,text);

1584}

References OutputGenerator::m_t and objectLinkToString.

writePageLink()

void RTFGenerator::writePageLink (const QCString & name, bool)

virtual

Declaration at line 116 of file rtfgen.h, definition at line 1305 of file rtfgen.cpp.

1305void RTFGenerator::writePageLink(const QCString &name,bool)

1306{

1307 m_t << "\\par " << rtf_Style_Reset << "\n";

1308 m_t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";

1309 m_t << name;

1310 m_t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";

1311}

References OutputGenerator::m_t and rtf_Style_Reset.

Referenced by endIndexSection.

writePageOutline()

void RTFGenerator::writePageOutline ()

inline virtual

Definition at line 224 of file rtfgen.h.

224 void writePageOutline() override {}

writeQuickLinks()

void RTFGenerator::writeQuickLinks (HighlightedItem, const QCString &, bool)

inline virtual

Definition at line 222 of file rtfgen.h.

222 void writeQuickLinks(HighlightedItem,const QCString &,bool) override {}

writeRuler()

void RTFGenerator::writeRuler ()

inline virtual

Definition at line 175 of file rtfgen.h.

175 void writeRuler() override { rtfwriteRuler_thin(); }

Reference rtfwriteRuler_thin.

writeSearchInfo()

void RTFGenerator::writeSearchInfo ()

inline virtual

Definition at line 109 of file rtfgen.h.

109 void writeSearchInfo() override {}

writeSplitBar()

void RTFGenerator::writeSplitBar (const QCString &, const QCString &)

inline virtual

Definition at line 219 of file rtfgen.h.

219 void writeSplitBar(const QCString &,const QCString &) override {}

writeStartAnnoItem()

void RTFGenerator::writeStartAnnoItem (const QCString & type, const QCString & file, const QCString & path, const QCString & name)

virtual

Declaration at line 190 of file rtfgen.h, definition at line 1438 of file rtfgen.cpp.

1438void RTFGenerator::writeStartAnnoItem(const QCString &,const QCString &f,

1439 const QCString &path,const QCString &name)

1440{

1441 DBG_RTF(m_t << "{\\comment (writeStartAnnoItem)}\n")

1442 m_t << "{\\b ";

1443 if (!path.isEmpty()) docify(path);

1444 if (!f.isEmpty() && Config_getBool(RTF_HYPERLINKS))

1445 {

1446 m_t << "{\\field {\\*\\fldinst { HYPERLINK \\\\l \"";

1447 m_t << rtfFormatBmkStr(stripPath(f));

1448 m_t << "\" }{}";

1449 m_t << "}{\\fldrslt {\\cs37\\ul\\cf2 ";

1450

1451 docify(name);

1452

1453 m_t << "}}}\n";

1454 }

1455 else

1456 {

1457 docify(name);

1458 }

1459 m_t << "} ";

1460}

References Config_getBool, DBG_RTF, docify, QCString::isEmpty, OutputGenerator::m_t, rtfFormatBmkStr and stripPath.

writeString()

void RTFGenerator::writeString (const QCString & text)

virtual

Declaration at line 125 of file rtfgen.h, definition at line 1336 of file rtfgen.cpp.

1336void RTFGenerator::writeString(const QCString &text)

1337{

1338 m_t << text;

1339}

Reference OutputGenerator::m_t.

writeStyleInfo()

void RTFGenerator::writeStyleInfo (int part)

virtual

Declaration at line 119 of file rtfgen.h, definition at line 1325 of file rtfgen.cpp.

1325void RTFGenerator::writeStyleInfo(int)

1326{

1327}

writeSummaryLink()

void RTFGenerator::writeSummaryLink (const QCString &, const QCString &, const QCString &, bool)

inline virtual

Definition at line 223 of file rtfgen.h.

223 void writeSummaryLink(const QCString &,const QCString &,const QCString &,bool) override {}

writeSynopsis()

void RTFGenerator::writeSynopsis ()

inline virtual

Definition at line 212 of file rtfgen.h.

212 void writeSynopsis() override {}

Private Member Functions

beginRTFChapter()

void RTFGenerator::beginRTFChapter ()

Declaration at line 316 of file rtfgen.h, definition at line 660 of file rtfgen.cpp.

660void RTFGenerator::beginRTFChapter()

661{

662 m_t << "\n";

663 DBG_RTF(m_t << "{\\comment BeginRTFChapter}\n")

664 m_t << rtf_Style_Reset;

665

666 // if we are compact, no extra page breaks...

667 if (Config_getBool(COMPACT_RTF))

668 {

669 // m_t << "\\sect\\sectd\\sbknone\n";

670 m_t << "\\sect\\sbknone\n";

671 rtfwriteRuler_thick();

672 }

673 else

674 m_t << "\\sect\\sbkpage\n";

675 //m_t << "\\sect\\sectd\\sbkpage\n";

676

677 m_t << rtf_Style["Heading1"].reference() << "\n";

678}

References Config_getBool, DBG_RTF, OutputGenerator::m_t, rtf_Style, rtf_Style_Reset and rtfwriteRuler_thick.

Referenced by endIndexSection and startIndexSection.

beginRTFDocument()

void RTFGenerator::beginRTFDocument ()

Declaration at line 315 of file rtfgen.h, definition at line 523 of file rtfgen.cpp.

523void RTFGenerator::beginRTFDocument()

524{

525 /* all the included RTF files should begin with the

526 * same header

527 */

528 m_t << "{\\rtf1\\ansi\\ansicpg" << theTranslator->trRTFansicp();

529 m_t << "\\uc1 \\deff0\\deflang1033\\deflangfe1033\n";

530

531 DBG_RTF(m_t << "{\\comment Beginning font list}\n")

532 m_t << "{\\fonttbl ";

533 m_t << "{\\f0\\froman\\fcharset" << theTranslator->trRTFCharSet();

534 m_t << "\\fprq2{\\*\\panose 02020603050405020304}Times New Roman;}\n";

535 m_t << "{\\f1\\fswiss\\fcharset" << theTranslator->trRTFCharSet();

536 m_t << "\\fprq2{\\*\\panose 020b0604020202020204}Arial;}\n";

537 m_t << "{\\f2\\fmodern\\fcharset" << theTranslator->trRTFCharSet();

538 m_t << "\\fprq1{\\*\\panose 02070309020205020404}Courier New;}\n";

539 m_t << "{\\f3\\froman\\fcharset2\\fprq2{\\*\\panose 05050102010706020507}Symbol;}\n";

540 m_t << "}\n";

541 DBG_RTF(m_t << "{\\comment begin colors}\n")

542 m_t << "{\\colortbl;";

543 m_t << "\\red0\\green0\\blue0;";

544 m_t << "\\red0\\green0\\blue255;";

545 m_t << "\\red0\\green255\\blue255;";

546 m_t << "\\red0\\green255\\blue0;";

547 m_t << "\\red255\\green0\\blue255;";

548 m_t << "\\red255\\green0\\blue0;";

549 m_t << "\\red255\\green255\\blue0;";

550 m_t << "\\red255\\green255\\blue255;";

551 m_t << "\\red0\\green0\\blue128;";

552 m_t << "\\red0\\green128\\blue128;";

553 m_t << "\\red0\\green128\\blue0;";

554 m_t << "\\red128\\green0\\blue128;";

555 m_t << "\\red128\\green0\\blue0;";

556 m_t << "\\red128\\green128\\blue0;";

557 m_t << "\\red128\\green128\\blue128;";

558 m_t << "\\red192\\green192\\blue192;";

559

560 // code highlighting colors. Note order is important see also RTFGenerator::startFontClass

561 m_t << "\\red0\\green128\\blue0;"; // keyword = index 17

562 m_t << "\\red96\\green64\\blue32;"; // keywordtype

563 m_t << "\\rede0\\green128\\blue0;"; // keywordflow

564 m_t << "\\red128\\green0\\blue0;"; // comment

565 m_t << "\\red128\\green96\\blue32;"; // preprocessor

566 m_t << "\\red0\\green32\\blue128;"; // stringliteral

567 m_t << "\\red0\\green128\\blue128;"; // charliteral

568 m_t << "\\red255\\green0\\blue255;"; // vhdldigit

569 m_t << "\\red0\\green0\\blue0;"; // vhdlchar

570 m_t << "\\red112\\green0\\blue112;"; // vhdlkeyword

571 m_t << "\\red255\\green0\\blue0;"; // vhdllogic

572

573 m_t << "}\n";

574

575 DBG_RTF(m_t << "{\\comment Beginning style list}\n")

576 m_t << "{\\stylesheet\n";

577 m_t << "{\\widctlpar\\adjustright \\fs20\\cgrid \\snext0 Normal;}\n";

578

579 // set the paper dimensions according to PAPER_TYPE

580 auto paperType = Config_getEnum(PAPER_TYPE);

581 m_t << "{";

582 switch (paperType)

583 {

584 // width & height values are inches * 1440

585 case PAPER_TYPE_t::a4: m_t << "\\paperw11900\\paperh16840"; break;

586 case PAPER_TYPE_t::letter: m_t << "\\paperw12240\\paperh15840"; break;

587 case PAPER_TYPE_t::legal: m_t << "\\paperw12240\\paperh20160"; break;

588 case PAPER_TYPE_t::executive: m_t << "\\paperw10440\\paperh15120"; break;

589 }

590 m_t << "\\margl1800\\margr1800\\margt1440\\margb1440\\gutter0\\ltrsect}\n";

591

592 // sort styles ascending by \s-number via an intermediate QArray

593 unsigned maxIndex = 0;

594 for (const auto &[name,data] : rtf_Style)

595 {

596 uint32_t index = data.index();

597 if (index > maxIndex) maxIndex = index;

598 }

599 std::vector<const StyleData*> array(maxIndex + 1, nullptr);

600 ASSERT(maxIndex < array.size());

601

602 for (const auto &[name,data] : rtf_Style)

603 {

604 uint32_t index = data.index();

605 if (array[index] != nullptr)

606 {

607 err("Style '{}' redefines \\s{}.\n", name, index);

608 }

609 array[index] = &data;

610 }

611

612 // write array elements

613 size_t size = array.size();

614 for(size_t i = 0; i < size; i++)

615 {

616 const StyleData *pStyle = array[i];

617 if (pStyle)

618 {

619 m_t << "{" << pStyle->reference() << pStyle->definition() << ";}\n";

620 }

621 }

622

623 m_t << "}\n";

624

625 // place to write rtf_Table_Default

626 int id = -1;

627 m_t << "{\\*\\listtable" << "\n";

628 for (int i=0 ; rtf_Table_Default[i].definition ; i++ )

629 {

630 if (id != rtf_Table_Default[i].id)

631 {

632 if (id != -1)

633 {

634 m_t << "\\listid" << id << "}" << "\n";

635 }

636 id = rtf_Table_Default[i].id;

637 m_t << "{\\list\\listtemplateid" << rtf_Table_Default[i].id << "\n";

638 }

639 m_t << "{ " << rtf_Table_Default[i].definition << " }" << "\n";

640 }

641 m_t << "\\listid" << id << "}" << "\n";

642 m_t << "}" <<"\n";

643 m_t << "{\\listoverridetable" <<"\n";

644 id = -1;

645 for (int i=0 ; rtf_Table_Default[i].definition ; i++ )

646 {

647 if (id != rtf_Table_Default[i].id)

648 {

649 id = rtf_Table_Default[i].id;

650 m_t << "{\\listoverride\\listid" << id << "\\listoverridecount0\\ls" << id << "}" << "\n";

651 }

652 }

653 m_t << "}" << "\n";

654

655 // this comment is needed for postprocessing!

656 m_t << "{\\comment begin body}\n";

657

658}

References ASSERT, Config_getEnum, DBG_RTF, StyleData::definition, err, OutputGenerator::m_t, StyleData::reference, rtf_Style, rtf_Table_Default and theTranslator.

Referenced by startFile.

beginRTFSection()

void RTFGenerator::beginRTFSection ()

Declaration at line 317 of file rtfgen.h, definition at line 680 of file rtfgen.cpp.

680void RTFGenerator::beginRTFSection()

681{

682 m_t << "\n";

683 DBG_RTF(m_t << "{\\comment BeginRTFSection}\n")

684 m_t << rtf_Style_Reset;

685

686 // if we are compact, no extra page breaks...

687 if (Config_getBool(COMPACT_RTF))

688 {

689 m_t << "\\sect\\sbknone\n";

690 rtfwriteRuler_emboss();

691 }

692 else

693 {

694 m_t << "\\sect\\sbkpage\n";

695 }

696 int level = 2 + m_hierarchyLevel;

697

698 m_t << rtf_Style[QCString().sprintf("Heading%d", level).str()].reference() << "\n";

699}

References Config_getBool, DBG_RTF, m_hierarchyLevel, OutputGenerator::m_t, rtf_Style, rtf_Style_Reset, rtfwriteRuler_emboss, QCString::sprintf and QCString::str.

Referenced by endIndexSection.

decIndentLevel()

void RTFGenerator::decIndentLevel ()

Declaration at line 327 of file rtfgen.h, definition at line 2047 of file rtfgen.cpp.

2047void RTFGenerator::decIndentLevel()

2048{

2049 m_indentLevel--;

2050 if (m_indentLevel<0)

2051 {

2052 err("Negative indent level while generating RTF output!\n");

2053 m_indentLevel=0;

2054 }

2055 m_codeGen->setIndentLevel(m_indentLevel);

2056}

References err, m_codeGen and m_indentLevel.

Referenced by endConstraintList, endExamples, endIndent, endIndexList, endItemList, endMemberDescription and endMemberGroup.

incIndentLevel()

void RTFGenerator::incIndentLevel ()

Declaration at line 326 of file rtfgen.h, definition at line 2035 of file rtfgen.cpp.

2035void RTFGenerator::incIndentLevel()

2036{

2037 m_indentLevel++;

2038 if (m_indentLevel>=maxIndentLevels)

2039 {

2040 m_indentLevel = maxIndentLevels-1;

2041 int m = maxIndentLevels;

2042 err("Maximum indent level ({}) exceeded while generating RTF output!\n",m);

2043 }

2044 m_codeGen->setIndentLevel(m_indentLevel);

2045}

References err, m_codeGen, m_indentLevel and maxIndentLevels.

Referenced by startConstraintList, startExamples, startIndent, startIndexList, startItemList, startMemberDescription and startMemberGroupHeader.

indentLevel()

int RTFGenerator::indentLevel ()

Declaration at line 325 of file rtfgen.h, definition at line 2030 of file rtfgen.cpp.

2030int RTFGenerator::indentLevel() const

2031{

2032 return std::min(m_indentLevel,maxIndentLevels-1);

2033}

References m_indentLevel and maxIndentLevels.

Referenced by endItemList, rtf_BList_DepthStyle, rtf_CList_DepthStyle, rtf_DList_DepthStyle, rtf_EList_DepthStyle, rtf_LCList_DepthStyle, startItemList and startItemListItem.

newParagraph()

void RTFGenerator::newParagraph ()

Declaration at line 323 of file rtfgen.h, definition at line 2115 of file rtfgen.cpp.

2115void RTFGenerator::newParagraph()

2116{

2117 if (!m_omitParagraph)

2118 {

2119 DBG_RTF(m_t << "{\\comment (newParagraph)}\n")

2120 m_t << "\\par\n";

2121 }

2122 m_omitParagraph = FALSE;

2123}

References DBG_RTF, FALSE, m_omitParagraph and OutputGenerator::m_t.

Referenced by endCallGraph, endClassDiagram, endCompoundTemplateParams, endConstraintDocs, endConstraintList, endDirDepGraph, endDotGraph, endExamples, endInclDepGraph, endIndexValue, endItemList, endMemberDoc, endMemberGroupDocs, endMemberGroupHeader, endMemberItem, endMemberSubtitle, endSection, endTextBlock, startConstraintList, startExamples, startItemList, startItemListItem and startParagraph.

rtf_BList_DepthStyle()

QCString RTFGenerator::rtf_BList_DepthStyle ()

Declaration at line 310 of file rtfgen.h, definition at line 2073 of file rtfgen.cpp.

2073QCString RTFGenerator::rtf_BList_DepthStyle()

2074{

2075 QCString n=makeIndexName("ListBullet",indentLevel());

2076 return rtf_Style[n.str()].reference();

2077}

References indentLevel, makeIndexName, rtf_Style and QCString::str.

Referenced by startItemListItem, startMemberGroup and startMemberItem.

rtf_CList_DepthStyle()

QCString RTFGenerator::rtf_CList_DepthStyle ()

Declaration at line 311 of file rtfgen.h, definition at line 2059 of file rtfgen.cpp.

2059QCString RTFGenerator::rtf_CList_DepthStyle()

2060{

2061 QCString n=makeIndexName("ListContinue",indentLevel());

2062 return rtf_Style[n.str()].reference();

2063}

References indentLevel, makeIndexName, rtf_Style and QCString::str.

Referenced by endMemberGroupHeader, startIndent, startMemberDescription and startMemberSubtitle.

rtf_DList_DepthStyle()

QCString RTFGenerator::rtf_DList_DepthStyle ()

Declaration at line 314 of file rtfgen.h, definition at line 2086 of file rtfgen.cpp.

2086QCString RTFGenerator::rtf_DList_DepthStyle()

2087{

2088 QCString n=makeIndexName("DescContinue",indentLevel());

2089 return rtf_Style[n.str()].reference();

2090}

References indentLevel, makeIndexName, rtf_Style and QCString::str.

Referenced by startConstraintList, startDescTable, startExamples and startMemberDocSimple.

rtf_EList_DepthStyle()

QCString RTFGenerator::rtf_EList_DepthStyle ()

Declaration at line 312 of file rtfgen.h, definition at line 2080 of file rtfgen.cpp.

2080QCString RTFGenerator::rtf_EList_DepthStyle()

2081{

2082 QCString n=makeIndexName("ListEnum",indentLevel());

2083 return rtf_Style[n.str()].reference();

2084}

References indentLevel, makeIndexName, rtf_Style and QCString::str.

Referenced by startItemListItem.

rtf_LCList_DepthStyle()

QCString RTFGenerator::rtf_LCList_DepthStyle ()

Declaration at line 313 of file rtfgen.h, definition at line 2066 of file rtfgen.cpp.

2066QCString RTFGenerator::rtf_LCList_DepthStyle()

2067{

2068 QCString n=makeIndexName("LatexTOC",indentLevel());

2069 return rtf_Style[n.str()].reference();

2070}

References indentLevel, makeIndexName, rtf_Style and QCString::str.

Referenced by startIndexList.

rtfwriteRuler_doubleline()

void RTFGenerator::rtfwriteRuler_doubleline ()

Declaration at line 318 of file rtfgen.h, definition at line 2629 of file rtfgen.cpp.

2629void RTFGenerator::rtfwriteRuler_doubleline()

2630{

2631 DBG_RTF(m_t << "{\\comment (rtfwriteRuler_doubleline)}\n")

2632 m_t << "{\\pard\\widctlpar\\brdrb\\brdrdb\\brdrw15\\brsp20 \\adjustright \\par}\n";

2633}

References DBG_RTF and OutputGenerator::m_t.

rtfwriteRuler_emboss()

void RTFGenerator::rtfwriteRuler_emboss ()

Declaration at line 319 of file rtfgen.h, definition at line 2635 of file rtfgen.cpp.

2635void RTFGenerator::rtfwriteRuler_emboss()

2636{

2637 DBG_RTF(m_t << "{\\comment (rtfwriteRuler_emboss)}\n")

2638 m_t << "{\\pard\\widctlpar\\brdrb\\brdremboss\\brdrw15\\brsp20 \\adjustright \\par}\n";

2639}

References DBG_RTF and OutputGenerator::m_t.

Referenced by beginRTFSection.

rtfwriteRuler_thick()

void RTFGenerator::rtfwriteRuler_thick ()

Declaration at line 320 of file rtfgen.h, definition at line 2641 of file rtfgen.cpp.

2641void RTFGenerator::rtfwriteRuler_thick()

2642{

2643 DBG_RTF(m_t << "{\\comment (rtfwriteRuler_thick)}\n")

2644 m_t << "{\\pard\\widctlpar\\brdrb\\brdrs\\brdrw75\\brsp20 \\adjustright \\par}\n";

2645}

References DBG_RTF and OutputGenerator::m_t.

Referenced by beginRTFChapter.

rtfwriteRuler_thin()

void RTFGenerator::rtfwriteRuler_thin ()

Declaration at line 321 of file rtfgen.h, definition at line 2647 of file rtfgen.cpp.

2647void RTFGenerator::rtfwriteRuler_thin()

2648{

2649 DBG_RTF(m_t << "{\\comment (rtfwriteRuler_thin)}\n")

2650 m_t << "{\\pard\\widctlpar\\brdrb\\brdrs\\brdrw5\\brsp20 \\adjustright \\par}\n";

2651}

References DBG_RTF and OutputGenerator::m_t.

Referenced by writeRuler.

writeRTFReference()

void RTFGenerator::writeRTFReference (const QCString & label)

Declaration at line 322 of file rtfgen.h, definition at line 1912 of file rtfgen.cpp.

1912void RTFGenerator::writeRTFReference(const QCString &label)

1913{

1914 m_t << "{\\field\\fldedit {\\*\\fldinst PAGEREF ";

1915 m_t << rtfFormatBmkStr(stripPath(label));

1916 m_t << " \\\\*MERGEFORMAT}{\\fldrslt pagenum}}";

1917}

References OutputGenerator::m_t, rtfFormatBmkStr and stripPath.

Referenced by endIndexItem, endIndexValue and endPageRef.

Private Member Attributes

m_bstartedBody

bool RTFGenerator::m_bstartedBody = false

Definition at line 329 of file rtfgen.h.

329 bool m_bstartedBody = false; // has startbody been called yet?

Referenced by operator= and RTFGenerator.

m_codeGen

RTFCodeGenerator* RTFGenerator::m_codeGen

Definition at line 346 of file rtfgen.h.

346 RTFCodeGenerator *m_codeGen;

Referenced by addCodeGen, decIndentLevel, incIndentLevel, operator=, RTFGenerator, RTFGenerator and setSourceFileName.

m_codeList

std::unique_ptr<OutputCodeList> RTFGenerator::m_codeList

Definition at line 345 of file rtfgen.h.

345 std::unique_ptr<OutputCodeList> m_codeList;

Referenced by operator=, RTFGenerator, RTFGenerator and writeDoc.

m_hierarchyLevel

int RTFGenerator::m_hierarchyLevel = 0

Definition at line 333 of file rtfgen.h.

333 int m_hierarchyLevel = 0;

Referenced by beginRTFSection, endTitleHead, startCompoundTemplateParams, startFile, startGroupHeader, startMemberDoc, startSection, startTitleHead and writeDoc.

m_indentLevel

int RTFGenerator::m_indentLevel = 0

Definition at line 337 of file rtfgen.h.

337 int m_indentLevel = 0;

Referenced by decIndentLevel, incIndentLevel, indentLevel, operator= and RTFGenerator.

m_listItemInfo

std::array<RTFListItemInfo,maxIndentLevels> RTFGenerator::m_listItemInfo

Definition at line 344 of file rtfgen.h.

344 std::array<RTFListItemInfo,maxIndentLevels> m_listItemInfo;

Referenced by operator=, RTFGenerator, startItemList and startItemListItem.

m_numCols

int RTFGenerator::m_numCols = 0

Definition at line 331 of file rtfgen.h.

331 int m_numCols = 0; // number of columns in a table

Referenced by operator= and RTFGenerator.

m_omitParagraph

bool RTFGenerator::m_omitParagraph = false

Definition at line 330 of file rtfgen.h.

330 bool m_omitParagraph = false; // should a the next paragraph command be ignored?

Referenced by docify, endConstraintList, endExamples, endIndexItem, endIndexList, endIndexValue, endItemList, endMemberDescription, endParagraph, endSection, lineBreak, newParagraph, operator=, RTFGenerator, startIndexItem, startIndexList, startItemListItem and writeDoc.

m_relPath

QCString RTFGenerator::m_relPath

Definition at line 332 of file rtfgen.h.

332 QCString m_relPath;

Referenced by endCallGraph, endClassDiagram, endDirDepGraph, endDotGraph, endInclDepGraph, operator=, RTFGenerator, setRelativePath and startFile.

Public Static Functions

init()

void RTFGenerator::init ()

static

Declaration at line 89 of file rtfgen.h, definition at line 458 of file rtfgen.cpp.

458void RTFGenerator::init()

459{

460 QCString dir=Config_getString(RTF_OUTPUT);

461 Dir d(dir.str());

462 if (!d.exists() && !d.mkdir(dir.str()))

463 {

464 term("Could not create output directory {}\n",dir);

465 }

466

467 // first duplicate strings of rtf_Style_Default

468 const struct Rtf_Style_Default* def = rtf_Style_Default;

469 while (def->reference)

470 {

471 if (def->definition == nullptr)

472 {

473 err("Internal: rtf_Style_Default[{}] has no definition.\n", def->name);

474 }

475 else

476 {

477 rtf_Style.emplace(def->name, StyleData(def->reference, def->definition));

478 }

479 def++;

480 }

481

482 // overwrite some (or all) definitions from file

483 QCString rtfStyleSheetFile = Config_getString(RTF_STYLESHEET_FILE);

484 if (!rtfStyleSheetFile.isEmpty())

485 {

486 loadStylesheet(rtfStyleSheetFile, rtf_Style);

487 }

488

489 // If user has defined an extension file, load its contents.

490 QCString rtfExtensionsFile = Config_getString(RTF_EXTENSIONS_FILE);

491 if (!rtfExtensionsFile.isEmpty())

492 {

493 loadExtensions(rtfExtensionsFile);

494

495 if (!rtf_logoFilename.isEmpty())

496 {

497 FileInfo fi(rtf_logoFilename.str());

498 if (!fi.exists())

499 {

500 err("Logo '{}' specified by 'LogoFilename' in the rtf extension file '{}' does not exist!\n",

501 rtf_logoFilename, rtfExtensionsFile);

502 rtf_logoFilename = "";

503 }

504 else

505 {

506 QCString destFileName = Config_getString(RTF_OUTPUT)+"/"+fi.fileName();

507 copyFile(rtf_logoFilename,destFileName);

508 rtf_logoFilename = fi.fileName();

509 }

510 }

511 }

512

513 createSubDirs(d);

514}

References Config_getString, copyFile, createSubDirs, Rtf_Style_Default::definition, OutputGenerator::dir, err, Dir::exists, FileInfo::exists, FileInfo::fileName, QCString::isEmpty, loadExtensions, loadStylesheet, Dir::mkdir, Rtf_Style_Default::name, Rtf_Style_Default::reference, rtf_logoFilename, rtf_Style, rtf_Style_Default and term.

Referenced by generateOutput.

preProcessFileInplace()

bool RTFGenerator::preProcessFileInplace (const QCString & path, const QCString & name)

static

This is an API to a VERY brittle RTF preprocessor that combines nested RTF files.

This version replaces the infile with the new file

Declaration at line 95 of file rtfgen.h, definition at line 2458 of file rtfgen.cpp.

2458bool RTFGenerator::preProcessFileInplace(const QCString &path,const QCString &name)

2459{

2460 static bool rtfDebug = Debug::isFlagSet(Debug::Rtf);

2461

2462 Dir d(path.str());

2463 // store the original directory

2464 if (!d.exists())

2465 {

2466 err("Output dir {} does not exist!\n",path);

2467 return FALSE;

2468 }

2469 std::string oldDir = Dir::currentDirPath();

2470

2471 // go to the html output directory (i.e. path)

2472 Dir::setCurrent(d.absPath());

2473 Dir thisDir;

2474

2475 QCString combinedName = path+"/combined.rtf";

2476 QCString mainRTFName = path+"/"+name;

2477

2478 std::ofstream f = Portable::openOutputStream(combinedName);

2479 if (!f.is_open())

2480 {

2481 err("Failed to open {} for writing!\n",combinedName);

2482 Dir::setCurrent(oldDir);

2483 return FALSE;

2484 }

2485 TextStream outt(&f);

2486

2487 if (!preProcessFile(thisDir,mainRTFName,outt,true,false))

2488 {

2489 // it failed, remove the temp file

2490 outt.flush();

2491 f.close();

2492 if (!rtfDebug) removeSet.insert(FileInfo(thisDir.filePath(combinedName.str())).absFilePath());

2493 Dir::setCurrent(oldDir);

2494 return FALSE;

2495 }

2496

2497 // everything worked, move the files

2498 outt.flush();

2499 f.close();

2500 if (!rtfDebug)

2501 {

2502 thisDir.remove(mainRTFName.str());

2503 }

2504 else

2505 {

2506 thisDir.rename(mainRTFName.str(),mainRTFName.str() + ".org");

2507 }

2508 thisDir.rename(combinedName.str(),mainRTFName.str());

2509

2510 testRTFOutput(mainRTFName);

2511

2512 QCString rtfOutputDir = Dir::currentDirPath();

2513 for (auto &s : removeSet)

2514 {

2515 QCString s1(s.c_str());

2516 if (s1.startsWith(rtfOutputDir)) Portable::unlink(s1);

2517 }

2518

2519 Dir::setCurrent(oldDir);

2520 return TRUE;

2521}

References FileInfo::absFilePath, Dir::absPath, Dir::currentDirPath, err, Dir::exists, FALSE, Dir::filePath, TextStream::flush, Debug::isFlagSet, Portable::openOutputStream, preProcessFile, Dir::remove, removeSet, Dir::rename, Debug::Rtf, Dir::setCurrent, QCString::startsWith, QCString::str, testRTFOutput, TRUE and Portable::unlink.

Referenced by generateOutput.

writeExtensionsFile()

void RTFGenerator::writeExtensionsFile (TextStream & t)

static

Declaration at line 91 of file rtfgen.h, definition at line 406 of file rtfgen.cpp.

406void RTFGenerator::writeExtensionsFile(TextStream &t)

407{

408 t << "# Generated by doxygen " << getDoxygenVersion() << "\n\n";

409 t << "# This file describes extensions used for generating RTF output.\n";

410 t << "# All text after a hash (#) is considered a comment and will be ignored.\n";

411 t << "# Remove a hash to activate a line.\n\n";

412

413 t << "# Overrides the project title.\n";

414

415 t << "#Title = \n\n";

416

417 t << "# Name of the company that produced this document.\n";

418 t << "#Company = \n\n";

419

420 t << "# Filename of a company or project logo.\n";

421 t << "#LogoFilename = \n\n";

422

423 t << "# Author of the document.\n";

424 t << "#Author = \n\n";

425

426 t << "# Type of document (e.g. Design Specification, User Manual, etc.).\n";

427 t << "#DocumentType = \n\n";

428

429 t << "# Document tracking number.\n";

430 t << "#DocumentId = \n\n";

431

432 t << "# Name of the author's manager.\n";

433 t << "# This field is not displayed in the document itself, but it is \n";

434 t << "# available in the information block of the rtf file. In Microsoft \n";

435 t << "# Word, it is available under File:Properties.\n";

436 t << "#Manager = \n\n";

437

438 t << "# Subject of the document.\n";

439 t << "# This field is not displayed in the document itself, but it is \n";

440 t << "# available in the information block of the rtf file. In Microsoft \n";

441 t << "# Word, it is available under File:Properties.\n";

442 t << "#Subject = \n\n";

443

444 t << "# Comments regarding the document.\n";

445 t << "# This field is not displayed in the document itself, but it is \n";

446 t << "# available in the information block of the rtf file. In Microsoft \n";

447 t << "# Word, it is available under File:Properties.\n";

448 t << "#Comments = \n\n";

449

450 t << "# Keywords associated with the document.\n";

451 t << "# This field is not displayed in the document itself, but it is \n";

452 t << "# available in the information block of the rtf file. In Microsoft \n";

453 t << "# Word, it is available under File:Properties.\n";

454 t << "#Keywords = \n\n";

455}

Referenced by readConfiguration.

writeStyleSheetFile()

void RTFGenerator::writeStyleSheetFile (TextStream & t)

static

Declaration at line 90 of file rtfgen.h, definition at line 391 of file rtfgen.cpp.

391void RTFGenerator::writeStyleSheetFile(TextStream &t)

392{

393 t << "# Generated by doxygen " << getDoxygenVersion() << "\n\n";

394 t << "# This file describes styles used for generating RTF output.\n";

395 t << "# All text after a hash (#) is considered a comment and will be ignored.\n";

396 t << "# Remove a hash to activate a line.\n\n";

397

398 for (int i=0 ; rtf_Style_Default[i].reference!=nullptr ; i++ )

399 {

400 t << "# " << rtf_Style_Default[i].name << " = "

401 << rtf_Style_Default[i].reference

402 << rtf_Style_Default[i].definition << "\n";

403 }

404}

Reference rtf_Style_Default.

Referenced by readConfiguration.

Private Static Attributes

maxIndentLevels

const int RTFGenerator::maxIndentLevels = 13

static

Definition at line 336 of file rtfgen.h.

336 static const int maxIndentLevels = 13;

Referenced by incIndentLevel and indentLevel.

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

Generated via doxygen2docusaurus by Doxygen 1.14.0.

Declaration​

Included Headers​

Base classes​

Public Constructors Index​

Public Destructor Index​

Public Operators Index​

Public Member Functions Index​

Private Member Functions Index​

Private Member Attributes Index​

Public Static Functions Index​

Private Static Attributes Index​

Description​

Public Constructors​

RTFGenerator()​

RTFGenerator()​

RTFGenerator()​

Public Destructor​

~RTFGenerator()​

Public Operators​

operator=()​

operator=()​

Public Member Functions​

addCodeGen()​

addIndexItem()​

addLabel()​

cleanup()​

clearBuffer()​

clone()​

docify()​

endAnonTypeScope()​

endBold()​

endCallGraph()​

endCenter()​

endClassDiagram()​

endCompoundTemplateParams()​

endConstraintDocs()​

endConstraintList()​

endConstraintParam()​

endConstraintType()​

endContents()​

endDescForItem()​

endDescTable()​

endDescTableData()​

endDescTableInit()​

endDescTableRow()​

endDescTableTitle()​

endDirDepGraph()​

endDotGraph()​

endDoxyAnchor()​

endEmphasis()​

endExamples()​

endFile()​

endGroupCollaboration()​

endGroupHeader()​

endHeaderSection()​

endInclDepGraph()​

endIndent()​

endIndexItem()​

endIndexKey()​

endIndexList()​

endIndexListItem()​

endIndexSection()​

endIndexValue()​

endInlineHeader()​

endInlineMemberDoc()​

endInlineMemberName()​

endInlineMemberType()​

endItemList()​

endItemListItem()​

endLabels()​

endLocalToc()​

endMemberDeclaration()​

endMemberDescription()​

endMemberDoc()​

endMemberDocList()​

endMemberDocName()​

endMemberDocPrefixItem()​

endMemberDocSimple()​

endMemberGroup()​

endMemberGroupDocs()​

Declaration

Included Headers

Base classes

Public Constructors Index

Public Destructor Index

Public Operators Index

Public Member Functions Index

Private Member Functions Index

Private Member Attributes Index

Public Static Functions Index

Private Static Attributes Index

Description

Public Constructors

RTFGenerator()

RTFGenerator()

RTFGenerator()

Public Destructor

~RTFGenerator()

Public Operators

operator=()

operator=()

Public Member Functions

addCodeGen()

addIndexItem()

addLabel()

cleanup()

clearBuffer()

clone()

docify()

endAnonTypeScope()

endBold()

endCallGraph()

endCenter()

endClassDiagram()

endCompoundTemplateParams()

endConstraintDocs()

endConstraintList()

endConstraintParam()

endConstraintType()

endContents()

endDescForItem()

endDescTable()

endDescTableData()

endDescTableInit()

endDescTableRow()

endDescTableTitle()

endDirDepGraph()

endDotGraph()

endDoxyAnchor()

endEmphasis()

endExamples()

endFile()

endGroupCollaboration()

endGroupHeader()

endHeaderSection()

endInclDepGraph()

endIndent()

endIndexItem()

endIndexKey()

endIndexList()

endIndexListItem()

endIndexSection()

endIndexValue()

endInlineHeader()

endInlineMemberDoc()

endInlineMemberName()

endInlineMemberType()

endItemList()

endItemListItem()

endLabels()

endLocalToc()

endMemberDeclaration()

endMemberDescription()

endMemberDoc()

endMemberDocList()

endMemberDocName()

endMemberDocPrefixItem()

endMemberDocSimple()

endMemberGroup()

endMemberGroupDocs()