22 #include "outputgen.h" 33 OutputType type()
const {
return OutputType::RTF; }
35 void writeCodeLink(CodeSymbolType type,
47 void startCodeLine(
int);
49 void startFontClass(
const QCString &);
51 void writeCodeAnchor(
const QCString &) {}
52 void startCodeFragment(
const QCString &style);
53 void endCodeFragment(
const QCString &);
59 void setSourceFileName(
const QCString &name);
60 void setIndentLevel(
int level) { m_indentLevel=level; }
64 bool m_doxyCodeLineOpen =
false;
66 int m_indentLevel = 0;
83 static void writeStyleSheetFile(
TextStream &t);
84 static void writeExtensionsFile(
TextStream &t);
85 OutputType type()
const {
return OutputType::RTF; }
87 void setRelativePath(
const QCString &path);
88 void setSourceFileName(
const QCString &sourceFileName);
93 void writeSearchInfo() {}
94 void writeFooter(
const QCString &) {}
98 void startPageDoc(
const QCString &) {}
100 void startIndexSection(IndexSection);
101 void endIndexSection(IndexSection);
102 void writePageLink(
const QCString &,
bool);
103 void startProjectNumber();
104 void endProjectNumber();
105 void writeStyleInfo(
int part);
106 void startTitleHead(
const QCString &);
109 void startParagraph(
const QCString &classDef);
111 void writeString(
const QCString &text);
112 void startIndexListItem();
113 void endIndexListItem();
114 void startIndexList();
116 void startIndexKey();
118 void startIndexValue(
bool);
119 void endIndexValue(
const QCString &,
bool);
120 void startItemList();
129 void startTypewriter() { m_t <<
"{\\f2 "; }
130 void endTypewriter() { m_t <<
"}"; }
131 void startGroupHeader(
int);
132 void endGroupHeader(
int);
133 void startItemListItem();
134 void endItemListItem();
136 void startMemberSections() {}
137 void endMemberSections() {}
138 void startHeaderSection() {}
139 void endHeaderSection() {}
140 void startMemberHeader(
const QCString &,
int) { startGroupHeader(0); }
141 void endMemberHeader() { endGroupHeader(FALSE); }
142 void startMemberSubtitle();
143 void endMemberSubtitle();
144 void startMemberDocList() {}
145 void endMemberDocList() {}
146 void startMemberList();
147 void endMemberList();
148 void startInlineHeader();
149 void endInlineHeader();
150 void startAnonTypeScope(
int) {}
151 void endAnonTypeScope(
int) {}
153 void endMemberItem(MemberItemType);
154 void startMemberTemplateParams() {}
156 void startCompoundTemplateParams();
157 void endCompoundTemplateParams();
158 void insertMemberAlign(
bool) {}
159 void insertMemberAlignLeft(MemberItemType,
bool){}
161 void writeRuler() { rtfwriteRuler_thin(); }
164 void startEmphasis() { m_t <<
"{\\i "; }
165 void endEmphasis() { m_t <<
"}"; }
166 void startBold() { m_t <<
"{\\b "; }
167 void endBold() { m_t <<
"}"; }
170 void endMemberDoc(
bool);
174 void writeChar(
char c);
175 void writeLatexSpacing() {};
178 void startCenter() { m_t <<
"{\\qc\n"; }
179 void endCenter() { m_t <<
"}"; }
180 void startSmall() { m_t <<
"{\\sub "; }
181 void endSmall() { m_t <<
"}"; }
184 void endMemberDescription();
185 void startMemberDeclaration() {}
189 void startExamples();
191 void startDescForItem();
192 void endDescForItem();
198 void writeSynopsis() {}
199 void startClassDiagram();
203 void startQuickIndices() {}
204 void endQuickIndices() {}
205 void writeSplitBar(
const QCString &) {}
206 void writeNavigationPath(
const QCString &) {}
208 void writeQuickLinks(HighlightedItem,
const QCString &) {}
210 void startContents() {}
211 void endContents() {}
212 void writeNonBreakableSpace(
int);
214 void startDescTable(
const QCString &title);
216 void startDescTableRow();
217 void endDescTableRow();
218 void startDescTableTitle();
219 void endDescTableTitle();
220 void startDescTableData();
221 void endDescTableData();
223 void startDotGraph();
225 void startInclDepGraph();
227 void startGroupCollaboration();
229 void startCallGraph();
231 void startDirDepGraph();
235 void startMemberGroupHeader(
bool);
236 void endMemberGroupHeader();
237 void startMemberGroupDocs();
238 void endMemberGroupDocs();
239 void startMemberGroup();
240 void endMemberGroup(
bool);
242 void startTextBlock(
bool dense);
243 void endTextBlock(
bool);
244 void lastIndexPage();
246 void startMemberDocPrefixItem() {}
247 void endMemberDocPrefixItem() {}
248 void startMemberDocName(
bool) {}
249 void endMemberDocName() {}
250 void startParameterType(
bool,
const QCString &);
251 void endParameterType();
252 void startParameterName(
bool) {}
253 void endParameterName() {}
254 void startParameterExtra() {}
255 void endParameterExtra(
bool,
bool,
bool);
256 void startParameterDefVal(
const char *s) { docify(s); startTypewriter(); }
257 void endParameterDefVal() { endTypewriter(); }
258 void startParameterList(
bool);
259 void endParameterList() {}
260 void exceptionEntry(
const QCString &,
bool);
262 void startConstraintList(
const QCString &);
263 void startConstraintParam();
264 void endConstraintParam();
265 void startConstraintType();
266 void endConstraintType();
267 void startConstraintDocs();
268 void endConstraintDocs();
269 void endConstraintList();
271 void startMemberDocSimple(
bool);
272 void endMemberDocSimple(
bool);
273 void startInlineMemberType();
274 void endInlineMemberType();
275 void startInlineMemberName();
276 void endInlineMemberName();
277 void startInlineMemberDoc();
278 void endInlineMemberDoc();
281 void writeLabel(
const QCString &l,
bool isLast);
286 static bool preProcessFileInplace(
const QCString &path,
const QCString &name);
296 void beginRTFDocument();
297 void beginRTFChapter();
298 void beginRTFSection();
299 void rtfwriteRuler_doubleline();
300 void rtfwriteRuler_emboss();
301 void rtfwriteRuler_thick();
302 void rtfwriteRuler_thin();
303 void writeRTFReference(
const QCString &label);
306 int indentLevel()
const;
307 void incIndentLevel();
308 void decIndentLevel();
310 bool m_bstartedBody =
false;
311 bool m_omitParagraph =
false;
314 int m_hierarchyLevel = 0;
317 static const int maxIndentLevels = 13;
318 int m_indentLevel = 0;
319 struct RTFListItemInfo
325 std::array<RTFListItemInfo,maxIndentLevels> m_listItemInfo;
326 std::unique_ptr<OutputCodeList> m_codeList;
The common base class of all entity definitions found in the sources.
Definition: definition.h:74
A model of a class/file/namespace member symbol.
Definition: memberdef.h:47
Text streaming class that buffers data.
Definition: textstream.h:34
Generator for RTF code fragments.
Definition: rtfgen.h:27
class that represents a list of constant references to sections.
Definition: section.h:104
Generator for RTF output.
Definition: rtfgen.h:71
Represents a graphical class hierarchy.
Definition: dotgfxhierarchytable.h:31
Representation of a group collaboration graph.
Definition: dotgroupcollaboration.h:28
opaque representation of the abstract syntax tree (AST)
Definition: docparser.h:46
Class representing a list of different code generators.
Definition: outputlist.h:199
Class representing a built-in class diagram.
Definition: diagram.h:29
Representation of an call graph.
Definition: dotcallgraph.h:26
Representation of a class inheritance or dependency graph.
Definition: dotclassgraph.h:28
Base class for specific output generators.
Definition: outputgen.h:64
Representation of an include dependency graph.
Definition: dotincldepgraph.h:30
Representation of an directory dependency graph.
Definition: dotdirdeps.h:25
This is an alternative implementation of QCString.
Definition: qcstring.h:93
Definition: outputgen.h:49
Definition: outputgen.h:41