Generator for RTF output.
更多...
#include <rtfgen.h>
|
| RTFGenerator () |
|
| RTFGenerator (const RTFGenerator &) |
|
RTFGenerator & | operator= (const RTFGenerator &) |
|
virtual | ~RTFGenerator () |
|
virtual std::unique_ptr< OutputGenerator > | clone () const |
|
void | cleanup () |
|
OutputType | type () const |
|
void | setRelativePath (const QCString &path) |
|
void | setSourceFileName (const QCString &sourceFileName) |
|
void | writeDoc (DocNode *, const Definition *, const MemberDef *, int) |
|
void | startFile (const QCString &name, const QCString &manName, const QCString &title, int id) |
|
void | writeSearchInfo () |
|
void | writeFooter (const QCString &) |
|
void | endFile () |
|
void | clearBuffer () |
|
void | startIndexSection (IndexSections) |
|
void | endIndexSection (IndexSections) |
|
void | writePageLink (const QCString &, bool) |
|
void | startProjectNumber () |
|
void | endProjectNumber () |
|
void | writeStyleInfo (int part) |
|
void | startTitleHead (const QCString &) |
|
void | startTitle () |
|
void | endTitleHead (const QCString &, const QCString &name) |
|
void | endTitle () |
|
void | newParagraph () |
|
void | startParagraph (const QCString &classDef) |
|
void | endParagraph () |
|
void | writeString (const QCString &text) |
|
void | startIndexListItem () |
|
void | endIndexListItem () |
|
void | startIndexList () |
|
void | endIndexList () |
|
void | startIndexKey () |
|
void | endIndexKey () |
|
void | startIndexValue (bool) |
|
void | endIndexValue (const QCString &, bool) |
|
void | startItemList () |
|
void | endItemList () |
|
void | startIndexItem (const QCString &ref, const QCString &file) |
|
void | endIndexItem (const QCString &ref, const QCString &file) |
|
void | docify (const QCString &text) |
|
void | codify (const QCString &text) |
|
void | writeObjectLink (const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name) |
|
void | writeCodeLink (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip) |
|
void | writeTooltip (const QCString &, const DocLinkInfo &, const QCString &, const QCString &, const SourceLinkInfo &, const SourceLinkInfo &) |
|
void | startTextLink (const QCString &f, const QCString &anchor) |
|
void | endTextLink () |
|
void | startHtmlLink (const QCString &url) |
|
void | endHtmlLink () |
|
void | startTypewriter () |
|
void | endTypewriter () |
|
void | startGroupHeader (int) |
|
void | endGroupHeader (int) |
|
void | startItemListItem () |
|
void | endItemListItem () |
|
void | startMemberSections () |
|
void | endMemberSections () |
|
void | startHeaderSection () |
|
void | endHeaderSection () |
|
void | startMemberHeader (const QCString &, int) |
|
void | endMemberHeader () |
|
void | startMemberSubtitle () |
|
void | endMemberSubtitle () |
|
void | startMemberDocList () |
|
void | endMemberDocList () |
|
void | startMemberList () |
|
void | endMemberList () |
|
void | startInlineHeader () |
|
void | endInlineHeader () |
|
void | startAnonTypeScope (int) |
|
void | endAnonTypeScope (int) |
|
void | startMemberItem (const QCString &, int, const QCString &) |
|
void | endMemberItem () |
|
void | startMemberTemplateParams () |
|
void | endMemberTemplateParams (const QCString &, const QCString &) |
|
void | startCompoundTemplateParams () |
|
void | endCompoundTemplateParams () |
|
void | insertMemberAlign (bool) |
|
void | insertMemberAlignLeft (int, bool) |
|
void | writeRuler () |
|
void | writeAnchor (const QCString &fileName, const QCString &name) |
|
void | startCodeFragment (const QCString &style) |
|
void | endCodeFragment (const QCString &style) |
|
void | writeLineNumber (const QCString &, const QCString &, const QCString &, int l, bool) |
|
void | startCodeLine (bool) |
|
void | endCodeLine () |
|
void | startEmphasis () |
|
void | endEmphasis () |
|
void | startBold () |
|
void | endBold () |
|
void | startDescription () |
|
void | endDescription () |
|
void | startDescItem () |
|
void | endDescItem () |
|
void | lineBreak (const QCString &style=QCString()) |
|
void | startMemberDoc (const QCString &, const QCString &, const QCString &, const QCString &, int, int, bool) |
|
void | endMemberDoc (bool) |
|
void | startDoxyAnchor (const QCString &, const QCString &, const QCString &, const QCString &, const QCString &) |
|
void | endDoxyAnchor (const QCString &, const QCString &) |
|
void | writeChar (char c) |
|
void | writeLatexSpacing () |
|
void | writeStartAnnoItem (const QCString &type, const QCString &file, const QCString &path, const QCString &name) |
|
void | writeEndAnnoItem (const QCString &name) |
|
void | startSubsection () |
|
void | endSubsection () |
|
void | startSubsubsection () |
|
void | endSubsubsection () |
|
void | startCenter () |
|
void | endCenter () |
|
void | startSmall () |
|
void | endSmall () |
|
void | startMemberDescription (const QCString &, const QCString &, bool) |
|
void | endMemberDescription () |
|
void | startMemberDeclaration () |
|
void | endMemberDeclaration (const QCString &, const QCString &) |
|
void | writeInheritedSectionTitle (const QCString &, const QCString &, const QCString &, const QCString &, const QCString &, const QCString &) |
|
void | startDescList (SectionTypes) |
|
void | startExamples () |
|
void | endExamples () |
|
void | startParamList (ParamListTypes, const QCString &) |
|
void | endParamList () |
|
void | startDescForItem () |
|
void | endDescForItem () |
|
void | startSection (const QCString &, const QCString &, SectionType) |
|
void | endSection (const QCString &, SectionType) |
|
void | addIndexItem (const QCString &, const QCString &) |
|
void | startIndent () |
|
void | endIndent () |
|
void | writeSynopsis () |
|
void | startClassDiagram () |
|
void | endClassDiagram (const ClassDiagram &, const QCString &filename, const QCString &name) |
|
void | startPageRef () |
|
void | endPageRef (const QCString &, const QCString &) |
|
void | startQuickIndices () |
|
void | endQuickIndices () |
|
void | writeSplitBar (const QCString &) |
|
void | writeNavigationPath (const QCString &) |
|
void | writeLogo () |
|
void | writeQuickLinks (bool, HighlightedItem, const QCString &) |
|
void | writeSummaryLink (const QCString &, const QCString &, const QCString &, bool) |
|
void | startContents () |
|
void | endContents () |
|
void | writeNonBreakableSpace (int) |
|
void | startDescTable (const QCString &title) |
|
void | endDescTable () |
|
void | startDescTableRow () |
|
void | endDescTableRow () |
|
void | startDescTableTitle () |
|
void | endDescTableTitle () |
|
void | startDescTableData () |
|
void | endDescTableData () |
|
void | startDotGraph () |
|
void | endDotGraph (DotClassGraph &) |
|
void | startInclDepGraph () |
|
void | endInclDepGraph (DotInclDepGraph &) |
|
void | startGroupCollaboration () |
|
void | endGroupCollaboration (DotGroupCollaboration &g) |
|
void | startCallGraph () |
|
void | endCallGraph (DotCallGraph &) |
|
void | startDirDepGraph () |
|
void | endDirDepGraph (DotDirDeps &g) |
|
void | writeGraphicalHierarchy (DotGfxHierarchyTable &) |
|
void | startMemberGroupHeader (bool) |
|
void | endMemberGroupHeader () |
|
void | startMemberGroupDocs () |
|
void | endMemberGroupDocs () |
|
void | startMemberGroup () |
|
void | endMemberGroup (bool) |
|
void | startTextBlock (bool dense) |
|
void | endTextBlock (bool) |
|
void | lastIndexPage () |
|
void | startMemberDocPrefixItem () |
|
void | endMemberDocPrefixItem () |
|
void | startMemberDocName (bool) |
|
void | endMemberDocName () |
|
void | startParameterType (bool, const QCString &) |
|
void | endParameterType () |
|
void | startParameterName (bool) |
|
void | endParameterName (bool, bool, bool) |
|
void | startParameterList (bool) |
|
void | endParameterList () |
|
void | exceptionEntry (const QCString &, bool) |
|
void | startConstraintList (const QCString &) |
|
void | startConstraintParam () |
|
void | endConstraintParam () |
|
void | startConstraintType () |
|
void | endConstraintType () |
|
void | startConstraintDocs () |
|
void | endConstraintDocs () |
|
void | endConstraintList () |
|
void | startMemberDocSimple (bool) |
|
void | endMemberDocSimple (bool) |
|
void | startInlineMemberType () |
|
void | endInlineMemberType () |
|
void | startInlineMemberName () |
|
void | endInlineMemberName () |
|
void | startInlineMemberDoc () |
|
void | endInlineMemberDoc () |
|
void | startLabels () |
|
void | writeLabel (const QCString &l, bool isLast) |
|
void | endLabels () |
|
void | startFontClass (const QCString &) |
|
void | endFontClass () |
|
void | writeCodeAnchor (const QCString &) |
|
void | setCurrentDoc (const Definition *, const QCString &, bool) |
|
void | addWord (const QCString &, bool) |
|
| OutputGenerator (const QCString &dir) |
|
| OutputGenerator (const OutputGenerator &o) |
|
OutputGenerator & | operator= (const OutputGenerator &o) |
|
virtual | ~OutputGenerator () |
|
void | enable () |
|
void | disable () |
|
void | enableIf (OutputType o) |
|
void | disableIf (OutputType o) |
|
void | disableIfNot (OutputType o) |
|
bool | isEnabled (OutputType o) |
|
OutputGenerator * | get (OutputType o) |
|
QCString | dir () const |
|
QCString | fileName () const |
|
void | startPlainFile (const QCString &name) |
|
void | endPlainFile () |
|
bool | isEnabled () const |
|
void | pushGeneratorState () |
|
void | popGeneratorState () |
|
virtual void | startPageDoc (const QCString &) |
|
virtual void | endPageDoc () |
|
virtual | ~BaseOutputDocInterface () |
|
virtual void | parseText (const QCString &) |
|
virtual | ~CodeOutputInterface () |
|
| CodeOutputInterface () |
|
| CodeOutputInterface (const CodeOutputInterface &)=delete |
|
CodeOutputInterface & | operator= (const CodeOutputInterface &)=delete |
|
virtual int | id () const |
| Identifier for the output file 更多...
|
|
|
enum | OutputType {
Html,
Latex,
Man,
RTF,
XML,
DEF,
Perl,
Docbook
} |
|
enum | ParamListTypes { Param,
RetVal,
Exception
} |
|
enum | SectionTypes { EnumValues,
Examples
} |
|
TextStream | m_t |
|
Generator for RTF output.
在文件 rtfgen.h 第 25 行定义.
◆ RTFGenerator() [1/2]
RTFGenerator::RTFGenerator |
( |
| ) |
|
◆ RTFGenerator() [2/2]
◆ ~RTFGenerator()
RTFGenerator::~RTFGenerator |
( |
| ) |
|
|
virtual |
◆ addIndexItem()
◆ addWord()
void RTFGenerator::addWord |
( |
const QCString & |
, |
|
|
bool |
|
|
) |
| |
|
inlinevirtual |
◆ beginRTFChapter()
void RTFGenerator::beginRTFChapter |
( |
| ) |
|
|
private |
◆ beginRTFDocument()
void RTFGenerator::beginRTFDocument |
( |
| ) |
|
|
private |
在文件 rtfgen.cpp 第 225 行定义.
231 m_t <<
"\\uc1 \\deff0\\deflang1033\\deflangfe1033\n";
233 DBG_RTF(
m_t <<
"{\\comment Beginning font list}\n")
234 m_t << "{\\fonttbl
";
235 m_t << "{\\f0\\froman\\fcharset
" << theTranslator->trRTFCharSet();
236 m_t << "\\fprq2{\\*\\panose 02020603050405020304}Times New Roman;}\n
";
237 m_t << "{\\f1\\fswiss\\fcharset
" << theTranslator->trRTFCharSet();
238 m_t << "\\fprq2{\\*\\panose 020b0604020202020204}Arial;}\n
";
239 m_t << "{\\f2\\fmodern\\fcharset
" << theTranslator->trRTFCharSet();
240 m_t << "\\fprq1{\\*\\panose 02070309020205020404}Courier New;}\n
";
241 m_t << "{\\f3\\froman\\fcharset2\\fprq2{\\*\\panose 05050102010706020507}Symbol;}\n
";
244 m_t << "{\\colortbl;
";
245 m_t << "\\red0\\green0\\blue0;
";
246 m_t << "\\red0\\green0\\blue255;
";
247 m_t << "\\red0\\green255\\blue255;
";
248 m_t << "\\red0\\green255\\blue0;
";
249 m_t << "\\red255\\green0\\blue255;
";
250 m_t << "\\red255\\green0\\blue0;
";
251 m_t << "\\red255\\green255\\blue0;
";
252 m_t << "\\red255\\green255\\blue255;
";
253 m_t << "\\red0\\green0\\blue128;
";
254 m_t << "\\red0\\green128\\blue128;
";
255 m_t << "\\red0\\green128\\blue0;
";
256 m_t << "\\red128\\green0\\blue128;
";
257 m_t << "\\red128\\green0\\blue0;
";
258 m_t << "\\red128\\green128\\blue0;
";
259 m_t << "\\red128\\green128\\blue128;
";
260 m_t << "\\red192\\green192\\blue192;
";
262 // code highlighting colors. Note order is important see also RTFGenerator::startFontClass
263 m_t << "\\red0\\green128\\blue0;
"; // keyword = index 17
264 m_t << "\\red96\\green64\\blue32;
"; // keywordtype
265 m_t << "\\rede0\\green128\\blue0;
"; // keywordflow
266 m_t << "\\red128\\green0\\blue0;
"; // comment
267 m_t << "\\red128\\green96\\blue32;
"; // preprocessor
268 m_t << "\\red0\\green32\\blue128;
"; // stringliteral
269 m_t << "\\red0\\green128\\blue128;
"; // charliteral
270 m_t << "\\red255\\green0\\blue255;
"; // vhdldigit
271 m_t << "\\red0\\green0\\blue0;
"; // vhdlchar
272 m_t << "\\red112\\green0\\blue112;
"; // vhdlkeyword
273 m_t << "\\red255\\green0\\blue0;
"; // vhdllogic
277 DBG_RTF(m_t << "{\
\comment Beginning style list}\n
")
278 m_t << "{\\stylesheet\n
";
279 m_t << "{\\widctlpar\\adjustright \\fs20\\cgrid \\snext0
Normal;}\n
";
281 // set the paper dimensions according to PAPER_TYPE
282 static auto paperType = Config_getEnum(PAPER_TYPE);
286 // width & height values are inches * 1440
287 case PAPER_TYPE_t::a4: m_t << "\\paperw11900\\paperh16840
"; break;
288 case PAPER_TYPE_t::letter: m_t << "\\paperw12240\\paperh15840
"; break;
289 case PAPER_TYPE_t::legal: m_t << "\\paperw12240\\paperh20160
"; break;
290 case PAPER_TYPE_t::executive: m_t << "\\paperw10440\\paperh15120
"; break;
292 m_t << "\\margl1800\\margr1800\\margt1440\\margb1440\\gutter0\\ltrsect}\n
";
294 // sort styles ascending by \s-number via an intermediate QArray
295 unsigned maxIndex = 0;
296 for (const auto &kv : rtf_Style)
298 uint index = kv.second.index();
299 if (index > maxIndex) maxIndex = index;
301 std::vector<const StyleData*> array(maxIndex + 1, 0);
302 ASSERT(maxIndex < array.size());
304 for (const auto &kv : rtf_Style)
306 uint index = kv.second.index();
307 if (array[index] != 0)
309 msg("Style
'%s' redefines \\s%d.\n
", kv.first.c_str(), index);
311 array[index] = &kv.second;
314 // write array elements
315 size_t size = array.size();
316 for(size_t i = 0; i < size; i++)
318 const StyleData *pStyle = array[i];
321 m_t << "{
" << pStyle->reference() << pStyle->definition() << ";}\n
";
326 // this comment is needed for postprocessing!
引用了 ASSERT, Config_getEnum, DBG_RTF, StyleData::definition(), OutputGenerator::m_t, msg(), StyleData::reference(), rtf_Style, theTranslator, Translator::trRTFansicp() , 以及 Translator::trRTFCharSet().
被这些函数引用 startFile().
◆ beginRTFSection()
void RTFGenerator::beginRTFSection |
( |
| ) |
|
|
private |
◆ cleanup()
void RTFGenerator::cleanup |
( |
| ) |
|
|
virtual |
◆ clearBuffer()
void RTFGenerator::clearBuffer |
( |
| ) |
|
◆ clone()
◆ codify()
void RTFGenerator::codify |
( |
const QCString & |
s | ) |
|
|
virtual |
◆ decIndentLevel()
void RTFGenerator::decIndentLevel |
( |
| ) |
|
|
private |
◆ docify()
void RTFGenerator::docify |
( |
const QCString & |
s | ) |
|
|
virtual |
Writes an ASCII string to the output. Converts characters that have A special meaning, like &
in html.
实现了 BaseOutputDocInterface.
在文件 rtfgen.cpp 第 1614 行定义.
1618 const unsigned char *p=(
const unsigned char *)str.data();
1628 case '{':
m_t <<
"\\{";
break;
1629 case '}':
m_t <<
"\\}";
break;
1630 case '\\':
m_t <<
"\\\\";
break;
引用了 QCString::data(), FALSE, QCString::isEmpty(), m_omitParagraph , 以及 OutputGenerator::m_t.
被这些函数引用 addIndexItem(), endTitleHead(), startConstraintList(), startDescTable(), startExamples(), startParamList(), startSection(), writeChar(), writeObjectLink() , 以及 writeStartAnnoItem().
◆ endAnonTypeScope()
void RTFGenerator::endAnonTypeScope |
( |
int |
| ) |
|
|
inlinevirtual |
◆ endBold()
void RTFGenerator::endBold |
( |
| ) |
|
|
inlinevirtual |
◆ endCallGraph()
实现了 OutputGenerator.
在文件 rtfgen.cpp 第 2210 行定义.
2219 m_t <<
"\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"";
2221 m_t << fn <<
"." << imgExt;
2222 m_t <<
"\" \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par\n";
2224 DBG_RTF(
m_t <<
"{\\comment (endCallGraph)}\n")
引用了 DBG_RTF, OutputGenerator::dir(), EOF_Rtf, FALSE, OutputGenerator::fileName(), getDotImageExtension(), GOF_BITMAP, m_relPath, OutputGenerator::m_t, newParagraph(), rtf_Style_Reset , 以及 DotCallGraph::writeGraph().
◆ endCenter()
void RTFGenerator::endCenter |
( |
| ) |
|
|
inlinevirtual |
◆ endClassDiagram()
◆ endCodeFragment()
void RTFGenerator::endCodeFragment |
( |
const QCString & |
style | ) |
|
|
virtual |
◆ endCodeLine()
void RTFGenerator::endCodeLine |
( |
| ) |
|
|
virtual |
◆ endCompoundTemplateParams()
void RTFGenerator::endCompoundTemplateParams |
( |
| ) |
|
|
inlinevirtual |
◆ endConstraintDocs()
void RTFGenerator::endConstraintDocs |
( |
| ) |
|
|
virtual |
◆ endConstraintList()
void RTFGenerator::endConstraintList |
( |
| ) |
|
|
virtual |
◆ endConstraintParam()
void RTFGenerator::endConstraintParam |
( |
| ) |
|
|
virtual |
◆ endConstraintType()
void RTFGenerator::endConstraintType |
( |
| ) |
|
|
virtual |
◆ endContents()
void RTFGenerator::endContents |
( |
| ) |
|
|
inlinevirtual |
◆ endDescForItem()
void RTFGenerator::endDescForItem |
( |
| ) |
|
|
virtual |
◆ endDescItem()
void RTFGenerator::endDescItem |
( |
| ) |
|
|
virtual |
◆ endDescription()
void RTFGenerator::endDescription |
( |
| ) |
|
|
virtual |
◆ endDescTable()
void RTFGenerator::endDescTable |
( |
| ) |
|
|
virtual |
◆ endDescTableData()
void RTFGenerator::endDescTableData |
( |
| ) |
|
|
virtual |
◆ endDescTableRow()
void RTFGenerator::endDescTableRow |
( |
| ) |
|
|
virtual |
◆ endDescTableTitle()
void RTFGenerator::endDescTableTitle |
( |
| ) |
|
|
virtual |
◆ endDirDepGraph()
void RTFGenerator::endDirDepGraph |
( |
DotDirDeps & |
g | ) |
|
|
virtual |
实现了 OutputGenerator.
在文件 rtfgen.cpp 第 2232 行定义.
2241 m_t <<
"\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"";
2243 m_t << fn <<
"." << imgExt;
2244 m_t <<
"\" \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par\n";
2246 DBG_RTF(
m_t <<
"{\\comment (endDirDepGraph)}\n")
引用了 DBG_RTF, OutputGenerator::dir(), EOF_Rtf, FALSE, OutputGenerator::fileName(), getDotImageExtension(), GOF_BITMAP, m_relPath, OutputGenerator::m_t, newParagraph(), rtf_Style_Reset , 以及 DotDirDeps::writeGraph().
◆ endDotGraph()
实现了 OutputGenerator.
在文件 rtfgen.cpp 第 2156 行定义.
2166 m_t <<
"\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"";
2168 m_t << fn <<
"." << imgExt;
2169 m_t <<
"\" \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par\n";
2172 DBG_RTF(
m_t <<
"{\\comment (endDotGraph)}\n")
引用了 DBG_RTF, OutputGenerator::dir(), EOF_Rtf, FALSE, OutputGenerator::fileName(), getDotImageExtension(), GOF_BITMAP, m_relPath, OutputGenerator::m_t, newParagraph(), rtf_Style_Reset, TRUE , 以及 DotClassGraph::writeGraph().
◆ endDoxyAnchor()
void RTFGenerator::endDoxyAnchor |
( |
const QCString & |
fName, |
|
|
const QCString & |
anchor |
|
) |
| |
|
virtual |
◆ endEmphasis()
void RTFGenerator::endEmphasis |
( |
| ) |
|
|
inlinevirtual |
◆ endExamples()
void RTFGenerator::endExamples |
( |
| ) |
|
|
virtual |
◆ endFile()
void RTFGenerator::endFile |
( |
| ) |
|
|
virtual |
◆ endFontClass()
void RTFGenerator::endFontClass |
( |
| ) |
|
|
virtual |
◆ endGroupCollaboration()
◆ endGroupHeader()
void RTFGenerator::endGroupHeader |
( |
int |
| ) |
|
|
virtual |
◆ endHeaderSection()
void RTFGenerator::endHeaderSection |
( |
| ) |
|
|
inlinevirtual |
◆ endHtmlLink()
void RTFGenerator::endHtmlLink |
( |
| ) |
|
|
virtual |
◆ endInclDepGraph()
实现了 OutputGenerator.
在文件 rtfgen.cpp 第 2180 行定义.
2189 m_t <<
"\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"";
2191 m_t << fn <<
"." << imgExt;
2192 m_t <<
"\" \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par\n";
2194 DBG_RTF(
m_t <<
"{\\comment (endInclDepGraph)}\n")
引用了 DBG_RTF, OutputGenerator::dir(), EOF_Rtf, FALSE, OutputGenerator::fileName(), getDotImageExtension(), GOF_BITMAP, m_relPath, OutputGenerator::m_t, newParagraph(), rtf_Style_Reset , 以及 DotInclDepGraph::writeGraph().
◆ endIndent()
void RTFGenerator::endIndent |
( |
| ) |
|
|
virtual |
◆ endIndexItem()
◆ endIndexKey()
void RTFGenerator::endIndexKey |
( |
| ) |
|
|
virtual |
◆ endIndexList()
void RTFGenerator::endIndexList |
( |
| ) |
|
|
virtual |
◆ endIndexListItem()
void RTFGenerator::endIndexListItem |
( |
| ) |
|
|
virtual |
◆ endIndexSection()
实现了 OutputGenerator.
在文件 rtfgen.cpp 第 587 行定义.
600 m_t <<
"}" << projectName;
604 m_t <<
" doxygen" << getDoxygenVersion() <<
".}\n";
606 DBG_RTF(
m_t <<
"{\\comment end of infoblock}\n");
609 m_t <<
"\\sectd\\pgnlcrm\n";
610 m_t <<
"{\\footer "<<
rtf_Style[
"Footer"].reference() <<
"{\\chpgn}}\n";
612 DBG_RTF(
m_t <<
"{\\comment begin title page}\n")
617 m_t << "\\vertalc\\qc\\par\\par\\par\\par\\par\\par\\par\n";
621 m_t <<
"\" \\\\d \\\\*MERGEFORMAT} {\\fldrslt IMAGE }}\\par\\par\n";
632 m_t <<
"{\\field\\fldedit {\\*\\fldinst TITLE \\\\*MERGEFORMAT}{\\fldrslt " <<
rtf_title <<
"}}\\par\n";
638 m_t <<
"{\\field\\fldedit {\\*\\fldinst TITLE \\\\*MERGEFORMAT}{\\fldrslt ";
653 m_t <<
"\\par\\par\\par\\par\\par\\par\\par\\par\\par\\par\\par\\par\n";
658 m_t <<
"{\\field\\fldedit {\\*\\fldinst AUTHOR \\\\*MERGEFORMAT}{\\fldrslt "<<
rtf_author <<
" }}\\par\n";
662 m_t <<
"{\\field\\fldedit {\\*\\fldinst AUTHOR \\\\*MERGEFORMAT}{\\fldrslt AUTHOR}}\\par\n";
666 m_t <<
"{\\field\\fldedit {\\*\\fldinst CREATEDATE \\\\*MERGEFORMAT}"
668 m_t <<
"\\page\\page";
669 DBG_RTF(
m_t <<
"{\\comment End title page}\n")
673 m_t << "\\vertalt\n
";
674 m_t << rtf_Style_Reset << "\n
";
675 m_t << rtf_Style["Heading1
"].reference();
676 m_t << theTranslator->trRTFTableOfContents() << "\\par\n
";
677 m_t << rtf_Style_Reset << "\\par\n
";
678 m_t << "{\\field\\fldedit {\\*\\fldinst TOC \\\\f \\\\*MERGEFORMAT}{\\fldrslt
Table of contents}}\\par\n
";
679 m_t << rtf_Style_Reset << "\n
";
683 m_t << "\\par
" << rtf_Style_Reset << "\n
";
684 if (!mainPageHasTitle())
686 m_t << "{\\tc \\v
" << theTranslator->trMainPage() << "}\n
";
690 m_t << "{\\tc \\v
" << substitute(Doxygen::mainPage->title(),"%
","") << "}\n
";
692 m_t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \
"";
695 m_t <<
".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
705 m_t <<
"{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"modules.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
710 m_t <<
"{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"dirs.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
723 m_t <<
"{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"namespaces.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
728 m_t <<
"{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"concepts.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
733 m_t <<
"{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"hierarchy.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
749 m_t <<
"{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"annotated.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
754 m_t <<
"{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"files.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
759 m_t <<
"{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"pages.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
767 if (!gd->isReference())
775 m_t <<
"{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
776 m_t << gd->getOutputFileBase();
777 m_t <<
".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
788 if (dd->isLinkableInProject())
796 m_t <<
"{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
797 m_t << dd->getOutputFileBase();
798 m_t <<
".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
808 if (nd->isLinkableInProject() && !nd->isAlias())
816 m_t <<
"{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
817 m_t << nd->getOutputFileBase();
818 m_t <<
".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
828 if (cd->isLinkableInProject() && !cd->isAlias())
836 m_t <<
"{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
837 m_t << cd->getOutputFileBase();
838 m_t <<
".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
856 if (cd->isLinkableInProject() &&
857 cd->templateMaster()==0 &&
858 !cd->isEmbeddedInOuterScope() &&
868 m_t <<
"{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
869 m_t << cd->getOutputFileBase();
870 m_t <<
".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
882 for (
const auto &fd : *fn)
884 if (fd->isLinkableInProject())
892 m_t <<
"{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
893 m_t << fd->getOutputFileBase();
894 m_t <<
".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
896 if (fd->generateSourceFile())
904 m_t <<
"{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
905 m_t << fd->getSourceFileBase();
906 m_t <<
".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
925 m_t <<
"{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
926 m_t << pd->getOutputFileBase();
927 m_t <<
".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
962 m_t <<
"{\\field\\fldedit {\\*\\fldinst INDEX \\\\c2 \\\\*MERGEFORMAT}{\\fldrslt INDEX}}\n";
引用了 beginRTFChapter(), beginRTFSection(), Doxygen::classLinkedMap, Doxygen::conceptLinkedMap, Config_getBool, Config_getString, createDocParser(), dateToRTFDateString(), dateToString(), DBG_RTF, Doxygen::dirLinkedMap, Doxygen::exampleLinkedMap, FALSE, Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, isClassDocumentation, isClassHierarchyIndex, isCompoundIndex, isConceptDocumentation, isConceptIndex, isDirDocumentation, isDirIndex, QCString::isEmpty(), isEndIndex, isExampleDocumentation, isFileDocumentation, isFileIndex, isMainPage, isModuleDocumentation, isModuleIndex, isNamespaceDocumentation, isNamespaceIndex, isPageDocumentation, isPageDocumentation2, isPageIndex, isTitlePageAuthor, isTitlePageStart, OutputGenerator::m_t, Doxygen::mainPage, mainPageHasTitle(), Doxygen::namespaceLinkedMap, rtf_author, rtf_company, rtf_documentId, rtf_documentType, rtf_logoFilename, rtf_Style, rtf_Style_Reset, rtf_title, substitute(), theTranslator, Translator::trClassDocumentation(), Translator::trCompoundIndex(), Translator::trCompoundIndexFortran(), Translator::trConceptIndex(), Translator::trDesignUnitIndex(), Translator::trDirDocumentation(), Translator::trDirIndex(), Translator::trExampleDocumentation(), Translator::trFileDocumentation(), Translator::trFileIndex(), Translator::trHierarchicalIndex(), Translator::trMainPage(), Translator::trModuleDocumentation(), Translator::trModuleIndex(), Translator::trModulesIndex(), Translator::trNamespaceIndex(), Translator::trPageIndex(), Translator::trRTFGeneralIndex(), Translator::trRTFTableOfContents(), Translator::trTypeDocumentation(), TRUE, Translator::trVersion(), validatingParseText() , 以及 writeDoc().
◆ endIndexValue()
void RTFGenerator::endIndexValue |
( |
const QCString & |
name, |
|
|
bool |
hasBrief |
|
) |
| |
|
virtual |
◆ endInlineHeader()
void RTFGenerator::endInlineHeader |
( |
| ) |
|
|
virtual |
◆ endInlineMemberDoc()
void RTFGenerator::endInlineMemberDoc |
( |
| ) |
|
|
virtual |
◆ endInlineMemberName()
void RTFGenerator::endInlineMemberName |
( |
| ) |
|
|
virtual |
◆ endInlineMemberType()
void RTFGenerator::endInlineMemberType |
( |
| ) |
|
|
virtual |
◆ endItemList()
void RTFGenerator::endItemList |
( |
| ) |
|
|
virtual |
◆ endItemListItem()
void RTFGenerator::endItemListItem |
( |
| ) |
|
|
virtual |
◆ endLabels()
void RTFGenerator::endLabels |
( |
| ) |
|
|
virtual |
◆ endMemberDeclaration()
◆ endMemberDescription()
void RTFGenerator::endMemberDescription |
( |
| ) |
|
|
virtual |
◆ endMemberDoc()
void RTFGenerator::endMemberDoc |
( |
bool |
| ) |
|
|
virtual |
◆ endMemberDocList()
void RTFGenerator::endMemberDocList |
( |
| ) |
|
|
inlinevirtual |
◆ endMemberDocName()
void RTFGenerator::endMemberDocName |
( |
| ) |
|
|
inlinevirtual |
◆ endMemberDocPrefixItem()
void RTFGenerator::endMemberDocPrefixItem |
( |
| ) |
|
|
inlinevirtual |
◆ endMemberDocSimple()
void RTFGenerator::endMemberDocSimple |
( |
bool |
| ) |
|
|
virtual |
◆ endMemberGroup()
void RTFGenerator::endMemberGroup |
( |
bool |
hasHeader | ) |
|
|
virtual |
◆ endMemberGroupDocs()
void RTFGenerator::endMemberGroupDocs |
( |
| ) |
|
|
virtual |
◆ endMemberGroupHeader()
void RTFGenerator::endMemberGroupHeader |
( |
| ) |
|
|
virtual |
◆ endMemberHeader()
void RTFGenerator::endMemberHeader |
( |
| ) |
|
|
inlinevirtual |
◆ endMemberItem()
void RTFGenerator::endMemberItem |
( |
| ) |
|
|
virtual |
◆ endMemberList()
void RTFGenerator::endMemberList |
( |
| ) |
|
|
virtual |
◆ endMemberSections()
void RTFGenerator::endMemberSections |
( |
| ) |
|
|
inlinevirtual |
◆ endMemberSubtitle()
void RTFGenerator::endMemberSubtitle |
( |
| ) |
|
|
virtual |
◆ endMemberTemplateParams()
void RTFGenerator::endMemberTemplateParams |
( |
const QCString & |
, |
|
|
const QCString & |
|
|
) |
| |
|
inlinevirtual |
◆ endPageRef()
void RTFGenerator::endPageRef |
( |
const QCString & |
clname, |
|
|
const QCString & |
anchor |
|
) |
| |
|
virtual |
◆ endParagraph()
void RTFGenerator::endParagraph |
( |
| ) |
|
|
virtual |
◆ endParameterList()
void RTFGenerator::endParameterList |
( |
| ) |
|
|
inlinevirtual |
◆ endParameterName()
void RTFGenerator::endParameterName |
( |
bool |
, |
|
|
bool |
, |
|
|
bool |
|
|
) |
| |
|
inlinevirtual |
◆ endParameterType()
void RTFGenerator::endParameterType |
( |
| ) |
|
|
virtual |
◆ endParamList()
void RTFGenerator::endParamList |
( |
| ) |
|
|
virtual |
◆ endProjectNumber()
void RTFGenerator::endProjectNumber |
( |
| ) |
|
|
virtual |
◆ endQuickIndices()
void RTFGenerator::endQuickIndices |
( |
| ) |
|
|
inlinevirtual |
◆ endSection()
◆ endSmall()
void RTFGenerator::endSmall |
( |
| ) |
|
|
inlinevirtual |
◆ endSubsection()
void RTFGenerator::endSubsection |
( |
| ) |
|
|
virtual |
◆ endSubsubsection()
void RTFGenerator::endSubsubsection |
( |
| ) |
|
|
virtual |
◆ endTextBlock()
void RTFGenerator::endTextBlock |
( |
bool |
| ) |
|
|
virtual |
◆ endTextLink()
void RTFGenerator::endTextLink |
( |
| ) |
|
|
virtual |
◆ endTitle()
void RTFGenerator::endTitle |
( |
| ) |
|
|
inlinevirtual |
◆ endTitleHead()
void RTFGenerator::endTitleHead |
( |
const QCString & |
fileName, |
|
|
const QCString & |
name |
|
) |
| |
|
virtual |
◆ endTypewriter()
void RTFGenerator::endTypewriter |
( |
| ) |
|
|
inlinevirtual |
◆ exceptionEntry()
void RTFGenerator::exceptionEntry |
( |
const QCString & |
prefix, |
|
|
bool |
closeBracket |
|
) |
| |
|
virtual |
◆ incIndentLevel()
void RTFGenerator::incIndentLevel |
( |
| ) |
|
|
private |
在文件 rtfgen.cpp 第 1866 行定义.
1871 err(
"Maximum indent level (%d) exceeded while generating RTF output!\n",
maxIndentLevels);
引用了 err(), m_indentLevel , 以及 maxIndentLevels.
被这些函数引用 startConstraintList(), startExamples(), startIndent(), startIndexList(), startItemList(), startMemberDescription(), startMemberGroupHeader() , 以及 startParamList().
◆ indentLevel()
int RTFGenerator::indentLevel |
( |
| ) |
const |
|
private |
◆ init()
void RTFGenerator::init |
( |
| ) |
|
|
static |
在文件 rtfgen.cpp 第 170 行定义.
174 if (!d.exists() && !d.mkdir(
dir.
str()))
185 err(
"Internal: rtf_Style_Default[%s] has no definition.\n", def->
name);
196 if (!rtfStyleSheetFile.
isEmpty())
203 if (!rtfExtensionsFile.
isEmpty())
引用了 Config_getString, createSubDirs(), Rtf_Style_Default::definition, OutputGenerator::dir(), err(), Dir::exists(), QCString::isEmpty(), loadExtensions(), loadStylesheet(), Dir::mkdir(), Rtf_Style_Default::name, qPrint(), Rtf_Style_Default::reference, rtf_Style, rtf_Style_Default, QCString::str() , 以及 term().
被这些函数引用 generateOutput().
◆ insertMemberAlign()
void RTFGenerator::insertMemberAlign |
( |
bool |
| ) |
|
|
inlinevirtual |
◆ insertMemberAlignLeft()
void RTFGenerator::insertMemberAlignLeft |
( |
int |
, |
|
|
bool |
|
|
) |
| |
|
inlinevirtual |
◆ lastIndexPage()
void RTFGenerator::lastIndexPage |
( |
| ) |
|
|
virtual |
◆ lineBreak()
◆ newParagraph()
void RTFGenerator::newParagraph |
( |
| ) |
|
在文件 rtfgen.cpp 第 1948 行定义.
1952 DBG_RTF(
m_t <<
"{\\comment (newParagraph)}\n")
引用了 DBG_RTF, FALSE, m_omitParagraph , 以及 OutputGenerator::m_t.
被这些函数引用 codify(), endCallGraph(), endClassDiagram(), endConstraintDocs(), endConstraintList(), endDescItem(), endDescription(), endDirDepGraph(), endDotGraph(), endExamples(), endInclDepGraph(), endIndexValue(), endItemList(), endMemberDoc(), endMemberGroupDocs(), endMemberGroupHeader(), endMemberItem(), endMemberSubtitle(), endParamList(), endSection(), endSubsection(), endSubsubsection(), endTextBlock(), startConstraintList(), startDescItem(), startDescList(), startExamples(), startItemList(), startItemListItem(), startParagraph(), startParamList() , 以及 writeEndAnnoItem().
◆ operator=()
◆ 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
在文件 rtfgen.cpp 第 2297 行定义.
2304 err(
"Output dir %s does not exist!\n",
qPrint(path));
2313 QCString combinedName = path+
"/combined.rtf";
2316 std::ofstream f(combinedName.
str(),std::ofstream::out | std::ofstream::binary);
2319 err(
"Failed to open %s for writing!\n",combinedName.
data());
2330 if (!rtfDebug) thisDir.
remove(combinedName.
str());
2344 thisDir.
rename(mainRTFName.
str(),mainRTFName.
str() +
".org");
引用了 Dir::absPath(), Dir::currentDirPath(), QCString::data(), err(), Dir::exists(), FALSE, TextStream::flush(), Debug::isFlagSet(), Rtf_Style_Default::name, preProcessFile(), qPrint(), Dir::remove(), Dir::rename(), Debug::Rtf, Dir::setCurrent(), QCString::str(), testRTFOutput() , 以及 TRUE.
被这些函数引用 generateOutput().
◆ rtf_BList_DepthStyle()
QCString RTFGenerator::rtf_BList_DepthStyle |
( |
| ) |
|
|
private |
◆ rtf_CList_DepthStyle()
QCString RTFGenerator::rtf_CList_DepthStyle |
( |
| ) |
|
|
private |
◆ rtf_Code_DepthStyle()
QCString RTFGenerator::rtf_Code_DepthStyle |
( |
| ) |
|
|
private |
◆ rtf_DList_DepthStyle()
QCString RTFGenerator::rtf_DList_DepthStyle |
( |
| ) |
|
|
private |
◆ rtf_EList_DepthStyle()
QCString RTFGenerator::rtf_EList_DepthStyle |
( |
| ) |
|
|
private |
◆ rtf_LCList_DepthStyle()
QCString RTFGenerator::rtf_LCList_DepthStyle |
( |
| ) |
|
|
private |
◆ rtfwriteRuler_doubleline()
void RTFGenerator::rtfwriteRuler_doubleline |
( |
| ) |
|
|
private |
◆ rtfwriteRuler_emboss()
void RTFGenerator::rtfwriteRuler_emboss |
( |
| ) |
|
|
private |
◆ rtfwriteRuler_thick()
void RTFGenerator::rtfwriteRuler_thick |
( |
| ) |
|
|
private |
◆ rtfwriteRuler_thin()
void RTFGenerator::rtfwriteRuler_thin |
( |
| ) |
|
|
private |
◆ setCurrentDoc()
◆ setRelativePath()
void RTFGenerator::setRelativePath |
( |
const QCString & |
path | ) |
|
◆ setSourceFileName()
void RTFGenerator::setSourceFileName |
( |
const QCString & |
sourceFileName | ) |
|
◆ startAnonTypeScope()
void RTFGenerator::startAnonTypeScope |
( |
int |
| ) |
|
|
inlinevirtual |
◆ startBold()
void RTFGenerator::startBold |
( |
| ) |
|
|
inlinevirtual |
◆ startCallGraph()
void RTFGenerator::startCallGraph |
( |
| ) |
|
|
virtual |
◆ startCenter()
void RTFGenerator::startCenter |
( |
| ) |
|
|
inlinevirtual |
◆ startClassDiagram()
void RTFGenerator::startClassDiagram |
( |
| ) |
|
|
virtual |
◆ startCodeFragment()
void RTFGenerator::startCodeFragment |
( |
const QCString & |
style | ) |
|
|
virtual |
◆ startCodeLine()
void RTFGenerator::startCodeLine |
( |
bool |
| ) |
|
|
virtual |
◆ startCompoundTemplateParams()
void RTFGenerator::startCompoundTemplateParams |
( |
| ) |
|
|
inlinevirtual |
◆ startConstraintDocs()
void RTFGenerator::startConstraintDocs |
( |
| ) |
|
|
virtual |
◆ startConstraintList()
void RTFGenerator::startConstraintList |
( |
const QCString & |
header | ) |
|
|
virtual |
◆ startConstraintParam()
void RTFGenerator::startConstraintParam |
( |
| ) |
|
|
virtual |
◆ startConstraintType()
void RTFGenerator::startConstraintType |
( |
| ) |
|
|
virtual |
◆ startContents()
void RTFGenerator::startContents |
( |
| ) |
|
|
inlinevirtual |
◆ startDescForItem()
void RTFGenerator::startDescForItem |
( |
| ) |
|
|
virtual |
◆ startDescItem()
void RTFGenerator::startDescItem |
( |
| ) |
|
|
virtual |
◆ startDescList()
◆ startDescription()
void RTFGenerator::startDescription |
( |
| ) |
|
|
virtual |
◆ startDescTable()
void RTFGenerator::startDescTable |
( |
const QCString & |
title | ) |
|
|
virtual |
实现了 BaseOutputDocInterface.
在文件 rtfgen.cpp 第 1793 行定义.
1795 DBG_RTF(
m_t <<
"{\\comment (startDescTable) }\n")
1797 m_t << "{
" << rtf_Style["Heading5
"].reference() << "\n
";
1800 m_t << rtf_Style_Reset << rtf_DList_DepthStyle();
1801 m_t << "\\trowd \\trgaph108\\trleft426\\tblind426
"
1802 "\\trbrdrt\\brdrs\\brdrw10\\brdrcf15
"
1803 "\\trbrdrl\\brdrs\\brdrw10\\brdrcf15
"
1804 "\\trbrdrb\\brdrs\\brdrw10\\brdrcf15
"
1805 "\\trbrdrr\\brdrs\\brdrw10\\brdrcf15
"
1806 "\\trbrdrh\\brdrs\\brdrw10\\brdrcf15
"
1807 "\\trbrdrv\\brdrs\\brdrw10\\brdrcf15 \n
";
1808 int i,columnPos[2] = { 25, 100 };
1811 m_t << "\\clvertalt\\clbrdrt\\brdrs\\brdrw10\\brdrcf15
"
1812 "\\clbrdrl\\brdrs\\brdrw10\\brdrcf15
"
1813 "\\clbrdrb\\brdrs\\brdrw10\\brdrcf15
"
1814 "\\clbrdrr \\brdrs\\brdrw10\\brdrcf15
"
1816 "\\cellx
" << (rtf_pageWidth*columnPos[i]/100) << "\n
";
1818 m_t << "\\pard \\widctlpar\\intbl\\adjustright\n
";
引用了 DBG_RTF, docify(), OutputGenerator::m_t, rtf_DList_DepthStyle(), rtf_pageWidth, rtf_Style , 以及 rtf_Style_Reset.
◆ startDescTableData()
void RTFGenerator::startDescTableData |
( |
| ) |
|
|
virtual |
◆ startDescTableRow()
void RTFGenerator::startDescTableRow |
( |
| ) |
|
|
virtual |
◆ startDescTableTitle()
void RTFGenerator::startDescTableTitle |
( |
| ) |
|
|
virtual |
◆ startDirDepGraph()
void RTFGenerator::startDirDepGraph |
( |
| ) |
|
|
virtual |
◆ startDotGraph()
void RTFGenerator::startDotGraph |
( |
| ) |
|
|
virtual |
◆ startDoxyAnchor()
◆ startEmphasis()
void RTFGenerator::startEmphasis |
( |
| ) |
|
|
inlinevirtual |
◆ startExamples()
void RTFGenerator::startExamples |
( |
| ) |
|
|
virtual |
实现了 BaseOutputDocInterface.
在文件 rtfgen.cpp 第 2395 行定义.
2397 DBG_RTF(
m_t <<
"{\\comment (startExamples)}\n")
2398 m_t << "{
"; // ends at endDescList
2399 m_t << "{
"; // ends at endDescTitle
2402 docify(theTranslator->trExamples());
2407 m_t << rtf_Style_Reset << rtf_DList_DepthStyle();
引用了 DBG_RTF, docify(), endBold(), incIndentLevel(), OutputGenerator::m_t, newParagraph(), rtf_DList_DepthStyle(), rtf_Style_Reset, startBold(), theTranslator , 以及 Translator::trExamples().
◆ startFile()
◆ startFontClass()
void RTFGenerator::startFontClass |
( |
const QCString & |
clsName | ) |
|
|
virtual |
Starts a block with a certain meaning. Used for syntax highlighting, which elements of the same type are rendered using the same 'font class'.
- 参数
-
clsName | The category name. |
实现了 CodeOutputInterface.
在文件 rtfgen.cpp 第 2743 行定义.
2747 if (qname ==
"keyword") cod = 17;
2748 else if (qname ==
"keywordtype") cod = 18;
2749 else if (qname ==
"keywordflow") cod = 19;
2750 else if (qname ==
"comment") cod = 20;
2751 else if (qname ==
"preprocessor") cod = 21;
2752 else if (qname ==
"stringliteral") cod = 22;
2753 else if (qname ==
"charliteral") cod = 23;
2754 else if (qname ==
"vhdldigit") cod = 24;
2755 else if (qname ==
"vhdlchar") cod = 25;
2756 else if (qname ==
"vhdlkeyword") cod = 26;
2757 else if (qname ==
"vhdllogic") cod = 27;
2758 m_t <<
"{\\cf" << cod <<
" ";
引用了 OutputGenerator::m_t , 以及 Rtf_Style_Default::name.
◆ startGroupCollaboration()
void RTFGenerator::startGroupCollaboration |
( |
| ) |
|
|
virtual |
◆ startGroupHeader()
void RTFGenerator::startGroupHeader |
( |
int |
extraIndent | ) |
|
|
virtual |
◆ startHeaderSection()
void RTFGenerator::startHeaderSection |
( |
| ) |
|
|
inlinevirtual |
◆ startHtmlLink()
void RTFGenerator::startHtmlLink |
( |
const QCString & |
url | ) |
|
|
virtual |
◆ startInclDepGraph()
void RTFGenerator::startInclDepGraph |
( |
| ) |
|
|
virtual |
◆ startIndent()
void RTFGenerator::startIndent |
( |
| ) |
|
|
virtual |
◆ startIndexItem()
void RTFGenerator::startIndexItem |
( |
const QCString & |
ref, |
|
|
const QCString & |
file |
|
) |
| |
|
virtual |
◆ startIndexKey()
void RTFGenerator::startIndexKey |
( |
| ) |
|
|
virtual |
◆ startIndexList()
void RTFGenerator::startIndexList |
( |
| ) |
|
|
virtual |
◆ startIndexListItem()
void RTFGenerator::startIndexListItem |
( |
| ) |
|
|
virtual |
◆ startIndexSection()
实现了 OutputGenerator.
在文件 rtfgen.cpp 第 404 行定义.
417 m_t <<
"{\\title {\\comment ";
428 m_t <<
"{\\comment ";
456 DBG_RTF(
m_t <<
"{\\comment start classhierarchy}\n")
476 if (!gd->isReference())
489 if (dd->isLinkableInProject())
502 if (nd->isLinkableInProject())
515 if (cd->isLinkableInProject())
528 if (cd->isLinkableInProject() &&
529 cd->templateMaster()==0 &&
530 !cd->isEmbeddedInOuterScope() &&
546 for (
const auto &fd : *fn)
548 if (fd->isLinkableInProject() || fd->generateSourceFile())
引用了 beginRTFChapter(), Doxygen::classLinkedMap, Doxygen::conceptLinkedMap, DBG_RTF, Doxygen::dirLinkedMap, FALSE, Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, isClassDocumentation, isClassHierarchyIndex, isCompoundIndex, isConceptDocumentation, isConceptIndex, isDirDocumentation, isDirIndex, QCString::isEmpty(), isEndIndex, isExampleDocumentation, isFileDocumentation, isFileIndex, isMainPage, isModuleDocumentation, isModuleIndex, isNamespaceDocumentation, isNamespaceIndex, isPageDocumentation, isPageDocumentation2, isPageIndex, isTitlePageAuthor, isTitlePageStart, OutputGenerator::m_t, Doxygen::namespaceLinkedMap, rtf_author, rtf_comments, rtf_company, rtf_documentType, rtf_keywords, rtf_manager, rtf_subject , 以及 TRUE.
◆ startIndexValue()
void RTFGenerator::startIndexValue |
( |
bool |
hasBrief | ) |
|
|
virtual |
◆ startInlineHeader()
void RTFGenerator::startInlineHeader |
( |
| ) |
|
|
virtual |
◆ startInlineMemberDoc()
void RTFGenerator::startInlineMemberDoc |
( |
| ) |
|
|
virtual |
◆ startInlineMemberName()
void RTFGenerator::startInlineMemberName |
( |
| ) |
|
|
virtual |
◆ startInlineMemberType()
void RTFGenerator::startInlineMemberType |
( |
| ) |
|
|
virtual |
◆ startItemList()
void RTFGenerator::startItemList |
( |
| ) |
|
|
virtual |
◆ startItemListItem()
void RTFGenerator::startItemListItem |
( |
| ) |
|
|
virtual |
write bullet or enum item
实现了 BaseOutputDocInterface.
在文件 rtfgen.cpp 第 1050 行定义.
1052 DBG_RTF(
m_t <<
"{\\comment (startItemListItem)}\n")
引用了 DBG_RTF, indentLevel(), m_listItemInfo, m_omitParagraph, OutputGenerator::m_t, newParagraph(), RTFGenerator::RTFListItemInfo::number, rtf_BList_DepthStyle(), rtf_EList_DepthStyle(), rtf_Style_Reset , 以及 TRUE.
◆ startLabels()
void RTFGenerator::startLabels |
( |
| ) |
|
|
virtual |
◆ startMemberDeclaration()
void RTFGenerator::startMemberDeclaration |
( |
| ) |
|
|
inlinevirtual |
◆ startMemberDescription()
void RTFGenerator::startMemberDescription |
( |
const QCString & |
, |
|
|
const QCString & |
, |
|
|
bool |
|
|
) |
| |
|
virtual |
◆ startMemberDoc()
◆ startMemberDocList()
void RTFGenerator::startMemberDocList |
( |
| ) |
|
|
inlinevirtual |
◆ startMemberDocName()
void RTFGenerator::startMemberDocName |
( |
bool |
| ) |
|
|
inlinevirtual |
◆ startMemberDocPrefixItem()
void RTFGenerator::startMemberDocPrefixItem |
( |
| ) |
|
|
inlinevirtual |
◆ startMemberDocSimple()
void RTFGenerator::startMemberDocSimple |
( |
bool |
isEnum | ) |
|
|
virtual |
实现了 OutputGenerator.
在文件 rtfgen.cpp 第 2593 行定义.
2595 DBG_RTF(
m_t <<
"{\\comment (startMemberDocSimple)}\n")
2597 m_t << "{
" << rtf_Style["Heading5
"].reference() << "\n
";
2600 m_t << theTranslator->trEnumerationValues();
2604 m_t << theTranslator->trCompoundMembers();
2607 m_t << rtf_Style_Reset << rtf_DList_DepthStyle();
2608 m_t << "\\trowd \\trgaph108\\trleft426\\tblind426
"
2609 "\\trbrdrt\\brdrs\\brdrw10\\brdrcf15
"
2610 "\\trbrdrl\\brdrs\\brdrw10\\brdrcf15
"
2611 "\\trbrdrb\\brdrs\\brdrw10\\brdrcf15
"
2612 "\\trbrdrr\\brdrs\\brdrw10\\brdrcf15
"
2613 "\\trbrdrh\\brdrs\\brdrw10\\brdrcf15
"
2614 "\\trbrdrv\\brdrs\\brdrw10\\brdrcf15 \n
";
2615 int i,n=3,columnPos[3] = { 25, 50, 100 };
2624 m_t << "\\clvertalt\\clbrdrt\\brdrs\\brdrw10\\brdrcf15
"
2625 "\\clbrdrl\\brdrs\\brdrw10\\brdrcf15
"
2626 "\\clbrdrb\\brdrs\\brdrw10\\brdrcf15
"
2627 "\\clbrdrr \\brdrs\\brdrw10\\brdrcf15
"
2629 "\\cellx
" << (rtf_pageWidth*columnPos[i]/100) << "\n
";
2631 m_t << "\\pard \\widctlpar\\intbl\\adjustright\n
";
引用了 DBG_RTF, OutputGenerator::m_t, rtf_DList_DepthStyle(), rtf_pageWidth, rtf_Style, rtf_Style_Reset, theTranslator, Translator::trCompoundMembers() , 以及 Translator::trEnumerationValues().
◆ startMemberGroup()
void RTFGenerator::startMemberGroup |
( |
| ) |
|
|
virtual |
◆ startMemberGroupDocs()
void RTFGenerator::startMemberGroupDocs |
( |
| ) |
|
|
virtual |
◆ startMemberGroupHeader()
void RTFGenerator::startMemberGroupHeader |
( |
bool |
hasHeader | ) |
|
|
virtual |
◆ startMemberHeader()
void RTFGenerator::startMemberHeader |
( |
const QCString & |
, |
|
|
int |
|
|
) |
| |
|
inlinevirtual |
◆ startMemberItem()
void RTFGenerator::startMemberItem |
( |
const QCString & |
, |
|
|
int |
, |
|
|
const QCString & |
|
|
) |
| |
|
virtual |
◆ startMemberList()
void RTFGenerator::startMemberList |
( |
| ) |
|
|
virtual |
◆ startMemberSections()
void RTFGenerator::startMemberSections |
( |
| ) |
|
|
inlinevirtual |
◆ startMemberSubtitle()
void RTFGenerator::startMemberSubtitle |
( |
| ) |
|
|
virtual |
◆ startMemberTemplateParams()
void RTFGenerator::startMemberTemplateParams |
( |
| ) |
|
|
inlinevirtual |
◆ startPageRef()
void RTFGenerator::startPageRef |
( |
| ) |
|
|
virtual |
◆ startParagraph()
void RTFGenerator::startParagraph |
( |
const QCString & |
classDef | ) |
|
|
virtual |
◆ startParameterList()
void RTFGenerator::startParameterList |
( |
bool |
| ) |
|
|
inlinevirtual |
◆ startParameterName()
void RTFGenerator::startParameterName |
( |
bool |
| ) |
|
|
inlinevirtual |
◆ startParameterType()
void RTFGenerator::startParameterType |
( |
bool |
first, |
|
|
const QCString & |
key |
|
) |
| |
|
virtual |
◆ startParamList()
◆ startProjectNumber()
void RTFGenerator::startProjectNumber |
( |
| ) |
|
|
virtual |
◆ startQuickIndices()
void RTFGenerator::startQuickIndices |
( |
| ) |
|
|
inlinevirtual |
◆ startSection()
实现了 BaseOutputDocInterface.
在文件 rtfgen.cpp 第 1579 行定义.
1581 DBG_RTF(
m_t <<
"{\\comment (startSection)}\n")
1583 m_t << rtf_Style_Reset;
1587 case SectionType::Page: num=2; break;
1588 case SectionType::Section: num=3; break;
1589 case SectionType::Subsection: num=4; break;
1590 case SectionType::Subsubsection: num=4; break;
1591 case SectionType::Paragraph: num=4; break;
1592 default: ASSERT(0); break;
1595 heading.sprintf("Heading%d
",num);
1597 m_t << rtf_Style[heading.str()].reference();
1598 // make table of contents entry
1599 m_t << "{\\tc\\tcl
" << num << " \\v
";
引用了 ASSERT, DBG_RTF, docify(), OutputGenerator::m_t, Page, Paragraph, rtf_Style, rtf_Style_Reset, Section, QCString::sprintf(), QCString::str(), Subsection, Subsubsection , 以及 type().
◆ startSmall()
void RTFGenerator::startSmall |
( |
| ) |
|
|
inlinevirtual |
◆ startSubsection()
void RTFGenerator::startSubsection |
( |
| ) |
|
|
virtual |
◆ startSubsubsection()
void RTFGenerator::startSubsubsection |
( |
| ) |
|
|
virtual |
◆ startTextBlock()
void RTFGenerator::startTextBlock |
( |
bool |
dense | ) |
|
|
virtual |
◆ startTextLink()
void RTFGenerator::startTextLink |
( |
const QCString & |
f, |
|
|
const QCString & |
anchor |
|
) |
| |
|
virtual |
◆ startTitle()
void RTFGenerator::startTitle |
( |
| ) |
|
|
virtual |
◆ startTitleHead()
void RTFGenerator::startTitleHead |
( |
const QCString & |
| ) |
|
|
virtual |
◆ startTypewriter()
void RTFGenerator::startTypewriter |
( |
| ) |
|
|
inlinevirtual |
◆ type()
◆ writeAnchor()
void RTFGenerator::writeAnchor |
( |
const QCString & |
fileName, |
|
|
const QCString & |
name |
|
) |
| |
|
virtual |
◆ writeChar()
void RTFGenerator::writeChar |
( |
char |
c | ) |
|
|
virtual |
◆ writeCodeAnchor()
void RTFGenerator::writeCodeAnchor |
( |
const QCString & |
name | ) |
|
|
inlinevirtual |
◆ writeCodeLink()
◆ writeDoc()
◆ writeEndAnnoItem()
void RTFGenerator::writeEndAnnoItem |
( |
const QCString & |
name | ) |
|
|
virtual |
◆ writeExtensionsFile()
void RTFGenerator::writeExtensionsFile |
( |
TextStream & |
t | ) |
|
|
static |
在文件 rtfgen.cpp 第 118 行定义.
120 t <<
"# Generated by doxygen " << getDoxygenVersion() <<
"\n\n";
121 t <<
"# This file describes extensions used for generating RTF output.\n";
122 t <<
"# All text after a hash (#) is considered a comment and will be ignored.\n";
123 t <<
"# Remove a hash to activate a line.\n\n";
125 t <<
"# Overrides the project title.\n";
127 t <<
"#Title = \n\n";
129 t <<
"# Name of the company that produced this document.\n";
130 t <<
"#Company = \n\n";
132 t <<
"# Filename of a company or project logo.\n";
133 t <<
"#LogoFilename = \n\n";
135 t <<
"# Author of the document.\n";
136 t <<
"#Author = \n\n";
138 t <<
"# Type of document (e.g. Design Specification, User Manual, etc.).\n";
139 t <<
"#DocumentType = \n\n";
141 t <<
"# Document tracking number.\n";
142 t <<
"#DocumentId = \n\n";
144 t <<
"# Name of the author's manager.\n";
145 t <<
"# This field is not displayed in the document itself, but it is \n";
146 t <<
"# available in the information block of the rtf file. In Microsoft \n";
147 t <<
"# Word, it is available under File:Properties.\n";
148 t <<
"#Manager = \n\n";
150 t <<
"# Subject of the document.\n";
151 t <<
"# This field is not displayed in the document itself, but it is \n";
152 t <<
"# available in the information block of the rtf file. In Microsoft \n";
153 t <<
"# Word, it is available under File:Properties.\n";
154 t <<
"#Subject = \n\n";
156 t <<
"# Comments regarding the document.\n";
157 t <<
"# This field is not displayed in the document itself, but it is \n";
158 t <<
"# available in the information block of the rtf file. In Microsoft \n";
159 t <<
"# Word, it is available under File:Properties.\n";
160 t <<
"#Comments = \n\n";
162 t <<
"# Keywords associated with the document.\n";
163 t <<
"# This field is not displayed in the document itself, but it is \n";
164 t <<
"# available in the information block of the rtf file. In Microsoft \n";
165 t <<
"# Word, it is available under File:Properties.\n";
166 t <<
"#Keywords = \n\n";
被这些函数引用 readConfiguration().
◆ writeFooter()
void RTFGenerator::writeFooter |
( |
const QCString & |
| ) |
|
|
inlinevirtual |
◆ writeGraphicalHierarchy()
◆ writeInheritedSectionTitle()
◆ writeLabel()
void RTFGenerator::writeLabel |
( |
const QCString & |
l, |
|
|
bool |
isLast |
|
) |
| |
|
virtual |
◆ writeLatexSpacing()
void RTFGenerator::writeLatexSpacing |
( |
| ) |
|
|
inlinevirtual |
◆ writeLineNumber()
void RTFGenerator::writeLineNumber |
( |
const QCString & |
ref, |
|
|
const QCString & |
file, |
|
|
const QCString & |
anchor, |
|
|
int |
lineNumber, |
|
|
bool |
writeLineAnchor |
|
) |
| |
|
virtual |
Writes the line number of a source listing
- 参数
-
ref | External reference (when imported from a tag file) |
file | The file part of the URL pointing to the docs. |
anchor | The anchor part of the URL pointing to the docs. |
lineNumber | The line number to write |
writeLineAnchor | Indicates if an anchor for the line number needs to be written |
实现了 CodeOutputInterface.
在文件 rtfgen.cpp 第 2676 行定义.
2689 lineAnchor.
sprintf(
"_l%05d",l);
2692 bool showTarget = rtfHyperlinks && !lineAnchor.
isEmpty() && writeLineAnchor;
2695 m_t <<
"{\\bkmkstart ";
2698 m_t <<
"{\\bkmkend ";
引用了 Config_getBool, Default, OutputGenerator::fileName(), QCString::isEmpty(), m_col, m_doxyCodeLineOpen, m_sourceFileName, OutputGenerator::m_t, QCString::prepend(), rtfFormatBmkStr(), QCString::sprintf(), stripExtensionGeneral(), stripPath() , 以及 writeCodeLink().
◆ writeLogo()
void RTFGenerator::writeLogo |
( |
| ) |
|
|
inlinevirtual |
◆ writeNavigationPath()
void RTFGenerator::writeNavigationPath |
( |
const QCString & |
| ) |
|
|
inlinevirtual |
◆ writeNonBreakableSpace()
void RTFGenerator::writeNonBreakableSpace |
( |
int |
| ) |
|
|
virtual |
◆ writeObjectLink()
◆ writePageLink()
void RTFGenerator::writePageLink |
( |
const QCString & |
name, |
|
|
bool |
first |
|
) |
| |
|
virtual |
◆ writeQuickLinks()
◆ writeRTFReference()
void RTFGenerator::writeRTFReference |
( |
const QCString & |
label | ) |
|
|
private |
◆ writeRuler()
void RTFGenerator::writeRuler |
( |
| ) |
|
|
inlinevirtual |
◆ writeSearchInfo()
void RTFGenerator::writeSearchInfo |
( |
| ) |
|
|
inlinevirtual |
◆ writeSplitBar()
void RTFGenerator::writeSplitBar |
( |
const QCString & |
| ) |
|
|
inlinevirtual |
◆ writeStartAnnoItem()
◆ writeString()
void RTFGenerator::writeString |
( |
const QCString & |
text | ) |
|
|
virtual |
◆ writeStyleInfo()
void RTFGenerator::writeStyleInfo |
( |
int |
part | ) |
|
|
virtual |
◆ writeStyleSheetFile()
void RTFGenerator::writeStyleSheetFile |
( |
TextStream & |
t | ) |
|
|
static |
◆ writeSummaryLink()
◆ writeSynopsis()
void RTFGenerator::writeSynopsis |
( |
| ) |
|
|
inlinevirtual |
◆ writeTooltip()
Writes a tool tip definition
- 参数
-
id | unique identifier for the tooltip |
docInfo | Info about the symbol's documentation. |
decl | full declaration of the symbol (for functions) |
desc | brief description for the symbol |
defInfo | Info about the symbol's definition in the source code |
declInfo | Info about the symbol's declaration in the source code |
实现了 CodeOutputInterface.
在文件 rtfgen.h 第 101 行定义.
◆ m_bstartedBody
bool RTFGenerator::m_bstartedBody = false |
|
private |
◆ m_col
int RTFGenerator::m_col = 0 |
|
private |
◆ m_doxyCodeLineOpen
bool RTFGenerator::m_doxyCodeLineOpen = false |
|
private |
◆ m_indentLevel
int RTFGenerator::m_indentLevel = 0 |
|
private |
◆ m_listItemInfo
◆ m_numCols
int RTFGenerator::m_numCols = 0 |
|
private |
◆ m_omitParagraph
bool RTFGenerator::m_omitParagraph = false |
|
private |
在文件 rtfgen.h 第 307 行定义.
被这些函数引用 docify(), endCodeFragment(), endConstraintList(), endExamples(), endIndexItem(), endIndexList(), endIndexValue(), endItemList(), endMemberDescription(), endParagraph(), endParamList(), endSection(), lineBreak(), newParagraph(), startIndexItem(), startIndexList(), startItemListItem() , 以及 writeDoc().
◆ m_relPath
◆ m_sourceFileName
◆ maxIndentLevels
const int RTFGenerator::maxIndentLevels = 13 |
|
staticprivate |
该类的文档由以下文件生成:
QCString getDotImageExtension()
virtual QCString getDefFileExtension() const =0
QCString fileName() const
virtual QCString trRTFGeneralIndex()=0
static std::string currentDirPath()
RTFListItemInfo m_listItemInfo[maxIndentLevels]
QCString stripExtensionGeneral(const QCString &fName, const QCString &ext)
bool remove(const std::string &path, bool acceptsAbsPath=true) const
QCString relativePathToRoot(const QCString &name)
QCString rtf_EList_DepthStyle()
QCString rtf_CList_DepthStyle()
Class representing a directory in the file system
virtual QCString trClassDocumentation()=0
QCString rtf_BList_DepthStyle()
void rtfwriteRuler_emboss()
void writeImage(TextStream &t, const QCString &path, const QCString &relPath, const QCString &file, bool generateMap=true) const
static ConceptLinkedMap * conceptLinkedMap
static const int maxIndentLevels
bool isEmpty() const
Returns TRUE iff the string is empty
void docify(const QCString &text)
virtual QCString trTypeDocumentation()=0
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool TBRank=TRUE, bool imageMap=TRUE, int graphId=-1)
virtual QCString trConceptIndex()=0
void err(const char *fmt,...)
void startHeaderSection()
Text streaming class that buffers data.
static DirLinkedMap * dirLinkedMap
void codify(const QCString &text)
QCString writeGraph(TextStream &out, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1, bool linkRelations=TRUE)
virtual QCString trFileDocumentation()=0
DirIterator begin(DirIterator it) noexcept
static bool isFlagSet(DebugMask mask)
static bool preProcessFile(Dir &d, const QCString &infName, TextStream &t, bool bIncludeHeader=TRUE)
VERY brittle routine inline RTF's included by other RTF's.
void setSourceFileName(const QCString &sourceFileName)
static FileNameLinkedMap * inputNameLinkedMap
void testRTFOutput(const QCString &name)
Tests the integrity of the result by counting brackets.
QCString rtfFormatBmkStr(const QCString &name)
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)
QCString m_sourceFileName
QCString dateToString(bool includeTime)
@ isNamespaceDocumentation
bool rename(const std::string &orgName, const std::string &newName, bool acceptsAbsPath=true) const
virtual QCString trDirDocumentation()=0
void writeDoc(DocNode *, const Definition *, const MemberDef *, int)
#define Config_getInt(name)
virtual QCString trVersion()=0
QCString left(size_t len) const
virtual QCString trDirIndex()=0
void addIndexItem(const QCString &, const QCString &)
void loadExtensions(const QCString &name)
void loadStylesheet(const QCString &name, StyleDataMap &map)
Translator * theTranslator
static GroupLinkedMap * groupLinkedMap
QCString rtf_documentType
QCString stripPath(const QCString &s)
virtual QCString trPageIndex()=0
static bool setCurrent(const std::string &path)
static QCString dateToRTFDateString()
void rtfwriteRuler_thick()
DocText * validatingParseText(IDocParser &parserIntf, const QCString &input)
QCString rtf_logoFilename
void writeRTFReference(const QCString &label)
void clearSubDirs(const Dir &d)
const char * writeUTF8Char(TextStream &t, const char *s)
Writes the UTF8 character pointed to by s to stream t and returns a pointer to the next character.
virtual QCString trModuleDocumentation()=0
#define Config_getBool(name)
void rtfwriteRuler_thin()
virtual QCString trRTFansicp()=0
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)
void term(const char *fmt,...)
virtual QCString trModulesIndex()=0
virtual QCString trExampleDocumentation()=0
const char * qPrint(const char *s)
Rtf_Style_Default rtf_Style_Default[]
#define Config_getString(name)
static NamespaceLinkedMap * namespaceLinkedMap
const char * data() const
Returns a pointer to the contents of the string in the form of a 0-terminated C string
static QCString makeIndexName(const QCString &s, int i)
void startSubsubsection()
virtual void accept(DocVisitor *v)=0
void writeCodeLink(CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip)
OutputGenerator & operator=(const OutputGenerator &o)
Concrete visitor implementation for RTF output.
virtual QCString trDesignUnitIndex()=0
void lineBreak(const QCString &style=QCString())
void writeAnchor(const QCString &fileName, const QCString &name)
virtual QCString trCompoundIndexFortran()=0
static ClassLinkedMap * classLinkedMap
virtual QCString trNamespaceIndex()=0
void createSubDirs(const Dir &d)
virtual QCString trFileIndex()=0
virtual QCString trModuleIndex()=0
OutputGenerator(const QCString &dir)
QCString right(size_t len) const
void startPlainFile(const QCString &name)
QCString & prepend(const char *s)
virtual QCString trCompoundIndex()=0
QCString & sprintf(const char *format,...)
void setRelativePath(const QCString &path)
std::unique_ptr< IDocParser > createDocParser()
virtual QCString trHierarchicalIndex()=0
static PageLinkedMap * exampleLinkedMap
This is an alternative implementation of QCString.