Doxygen
Loading...
Searching...
No Matches
translator.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 *
4 *
5 * Copyright (C) 1997-2015 by Dimitri van Heesch.
6 *
7 * Permission to use, copy, modify, and distribute this software and its
8 * documentation under the terms of the GNU General Public License is hereby
9 * granted. No representations are made about the suitability of this software
10 * for any purpose. It is provided "as is" without express or implied warranty.
11 * See the GNU General Public License for more details.
12 *
13 * Documents produced by Doxygen are derivative works derived from the
14 * input used in their production; they are not affected by this license.
15 *
16 */
17
18#ifndef TRANSLATOR_H
19#define TRANSLATOR_H
20
21#include "classdef.h"
22#include "config.h"
23#include "datetime.h"
24#include "index.h"
25#include "construct.h"
26
27/** Abstract base class for all translatable text fragments. */
28class Translator
29{
30 public:
31 ABSTRACT_BASE_CLASS(Translator)
32
33 /*! This method is used to provide warning message that is displayed
34 * if the user chooses a language whose translation is not up to date.
35 * It is implemented by the adapter classes.
36 */
37 virtual QCString updateNeededMessage() { return QCString(); }
38
39 // Please, have a look at comments inside the translator_en.h file
40 // to learn the meaning of the following methods. The translator_en.h
41 // file contains the TranslatorEnglish implementation, which is
42 // always up-to-date (by definition).
43
44 // --- Language control methods -------------------
45
46 virtual QCString idLanguage() = 0;
47 virtual QCString latexLanguageSupportCommand() = 0;
48 /*!
49 * Sets the LaTeX font encoding to be used. The default is set to `T1`,
50 * in case another font encoding has to be used this can be specified with
51 * this routine. In case no font encoding is required the empty string
52 * can be returned.
53 */
54 virtual QCString latexFontenc() { return QCString("T1"); }
55 virtual QCString latexFont() {
56 return QCString("\\usepackage[scaled=.90]{helvet}\n"
57 "\\usepackage{courier}\n"
58 "\\renewcommand{\\familydefault}{\\sfdefault}\n");
59 }
60 /*!
61 * Sets the commands to be inserted directly after the `\\begin{document}`
62 * in the LaTeX document.
63 */
64 virtual QCString latexDocumentPre() { return QCString(""); }
65 /*!
66 * Sets the commands to be inserted directly before the `\\end{document}`
67 * in the LaTeX document.
68 */
69 virtual QCString latexDocumentPost() { return QCString(""); }
70 /*!
71 * Set the name to be used as latex command.
72 */
73 virtual QCString latexCommandName()
74 {
75 return p_latexCommandName("pdflatex");
76 }
77 virtual QCString trISOLang() = 0;
78
79 /** language codes for Html help
80
81 <pre>
82 0x402 Bulgarian
83 0x405 Czech
84 0x406 Danish
85 0x413 Dutch
86 0xC09 English (Australia)
87 0x809 English (Britain)
88 0x1009 English (Canada)
89 0x1809 English (Ireland)
90 0x1409 English (New Zealand)
91 0x1C09 English (South Africa)
92 0x409 English (United States)
93 0x40B Finnish
94 0x40C French
95 0x407 German
96 0x408 Greece
97 0x439 Hindi
98 0x40E Hungarian
99 0x410 Italian
100 0x814 Norwegian
101 0x415 Polish
102 0x816 Portuguese(Portugal)
103 0x416 Portuguese(Brazil)
104 0x419 Russian
105 0x80A Spanish(Mexico)
106 0xC0A Spanish(Modern Sort)
107 0x40A Spanish(Traditional Sort)
108 0x41D Swedish
109 0x41F Turkey
110 0x411 Japanese
111 0x412 Korean
112 0x804 Chinese (PRC)
113 0x404 Chinese (Taiwan)
114 </pre>
115
116 New LCIDs:
117 <pre>
118 0x421 Indonesian
119 0x41A Croatian
120 0x418 Romanian
121 0x424 Slovenian
122 0x41B Slovak
123 0x422 Ukrainian
124 0x81A Serbian (Serbia, Latin)
125 0x403 Catalan
126 0x426 Latvian
127 0x427 Lithuanian
128 0x436 Afrikaans
129 0x42A Vietnamese
130 0x429 Persian (Iran)
131 0xC01 Arabic (Egypt) - I don't know which version of arabic is used inside translator_ar.h ,
132 so I have chosen Egypt at random
133 </pre>
134
135 Code for Esperanto should be as shown below but the htmlhelp compiler 1.3 does not support this
136 (and no newer version is available).
137 <pre>
138 0x48f Esperanto
139 </pre>
140 So do a fallback to the default language
141 <pre>
142 0x409 English (United States)
143 </pre>
144
145 <pre>
146 0xC1A Serbian (Serbia, Cyrillic)
147 </pre>
148 */
149 virtual QCString getLanguageString() = 0;
150
151 /**
152 * add punctuation at the end of a brief description when needed and supported by the language
153 */
154 virtual bool needsPunctuation() { return true; }
155
156 // --- Language translation methods -------------------
157
158 virtual QCString trRelatedFunctions() = 0;
159 virtual QCString trRelatedSubscript() = 0;
160 virtual QCString trDetailedDescription() = 0;
161 virtual QCString trDetails() = 0;
162 virtual QCString trMemberTypedefDocumentation() = 0;
163 virtual QCString trMemberEnumerationDocumentation() = 0;
164 virtual QCString trMemberFunctionDocumentation() = 0;
165 virtual QCString trMemberDataDocumentation() = 0;
166 virtual QCString trMore() = 0;
167 virtual QCString trListOfAllMembers() = 0;
168 virtual QCString trMemberList() = 0;
169 virtual QCString trThisIsTheListOfAllMembers() = 0;
170 virtual QCString trIncludingInheritedMembers() = 0;
171 virtual QCString trGeneratedAutomatically(const QCString &s) = 0;
172 virtual QCString trEnumName() = 0;
173 virtual QCString trEnumValue() = 0;
174 virtual QCString trDefinedIn() = 0;
175
176 // quick reference sections
177
178 virtual QCString trModules() = 0;
179 virtual QCString trClassHierarchy() = 0;
180 virtual QCString trCompoundList() = 0;
181 virtual QCString trFileList() = 0;
182 virtual QCString trCompoundMembers() = 0;
183 virtual QCString trFileMembers() = 0;
184 virtual QCString trRelatedPages() = 0;
185 virtual QCString trExamples() = 0;
186 virtual QCString trSearch() = 0;
187 virtual QCString trClassHierarchyDescription() = 0;
188 virtual QCString trFileListDescription(bool extractAll) = 0;
189 virtual QCString trCompoundListDescription() = 0;
190 virtual QCString trCompoundMembersDescription(bool extractAll) = 0;
191 virtual QCString trFileMembersDescription(bool extractAll) = 0;
192 virtual QCString trExamplesDescription() = 0;
193 virtual QCString trRelatedPagesDescription() = 0;
194 virtual QCString trModulesDescription() = 0;
195
196 // index titles (the project name is prepended for these)
197
198 virtual QCString trDocumentation(const QCString &projName) = 0;
199 virtual QCString trModuleIndex() = 0;
200 virtual QCString trHierarchicalIndex() = 0;
201 virtual QCString trCompoundIndex() = 0;
202 virtual QCString trFileIndex() = 0;
203 virtual QCString trModuleDocumentation() = 0;
204 virtual QCString trClassDocumentation() = 0;
205 virtual QCString trFileDocumentation() = 0;
206 virtual QCString trReferenceManual() = 0;
207 virtual QCString trDefines() = 0;
208 virtual QCString trTypedefs() = 0;
209 virtual QCString trEnumerations() = 0;
210 virtual QCString trFunctions() = 0;
211 virtual QCString trVariables() = 0;
212 virtual QCString trEnumerationValues() = 0;
213 virtual QCString trDefineDocumentation() = 0;
214 virtual QCString trTypedefDocumentation() = 0;
215 virtual QCString trEnumerationTypeDocumentation() = 0;
216 virtual QCString trFunctionDocumentation() = 0;
217 virtual QCString trVariableDocumentation() = 0;
218 virtual QCString trCompounds() = 0;
219 virtual QCString trGeneratedAt(const QCString &date,const QCString &projName) = 0;
220 virtual QCString trClassDiagram(const QCString &clName) = 0;
221 virtual QCString trWarning() = 0;
222 virtual QCString trVersion() = 0;
223 virtual QCString trDate() = 0;
224 virtual QCString trReturns() = 0;
225 virtual QCString trSeeAlso() = 0;
226 virtual QCString trParameters() = 0;
227 virtual QCString trExceptions() = 0;
228 virtual QCString trGeneratedBy() = 0;
229
230//////////////////////////////////////////////////////////////////////////
231// new since 0.49-990307
232//////////////////////////////////////////////////////////////////////////
233
234 virtual QCString trNamespaceList() = 0;
235 virtual QCString trNamespaceListDescription(bool extractAll) = 0;
236 virtual QCString trFriends() = 0;
237
238//////////////////////////////////////////////////////////////////////////
239// new since 0.49-990405
240//////////////////////////////////////////////////////////////////////////
241
242 virtual QCString trRelatedFunctionDocumentation() = 0;
243
244//////////////////////////////////////////////////////////////////////////
245// new since 0.49-990425
246//////////////////////////////////////////////////////////////////////////
247
248 virtual QCString trCompoundReference(const QCString &clName,
249 ClassDef::CompoundType compType,
250 bool isTemplate) = 0;
251
252 virtual QCString trFileReference(const QCString &fileName) = 0;
253 virtual QCString trNamespaceReference(const QCString &namespaceName) = 0;
254
255 virtual QCString trPublicMembers() = 0;
256 virtual QCString trPublicSlots() = 0;
257 virtual QCString trSignals() = 0;
258 virtual QCString trStaticPublicMembers() = 0;
259 virtual QCString trProtectedMembers() = 0;
260 virtual QCString trProtectedSlots() = 0;
261 virtual QCString trStaticProtectedMembers() = 0;
262 virtual QCString trPrivateMembers() = 0;
263 virtual QCString trPrivateSlots() = 0;
264 virtual QCString trStaticPrivateMembers() = 0;
265 virtual QCString trWriteList(int numEntries) = 0;
266 virtual QCString trInheritsList(int numEntries) = 0;
267 virtual QCString trInheritedByList(int numEntries) = 0;
268 virtual QCString trReimplementedFromList(int numEntries) = 0;
269 virtual QCString trReimplementedInList(int numEntries) = 0;
270 virtual QCString trNamespaceMembers() = 0;
271 virtual QCString trNamespaceMemberDescription(bool extractAll) = 0;
272 virtual QCString trNamespaceIndex() = 0;
273 virtual QCString trNamespaceDocumentation() = 0;
274
275//////////////////////////////////////////////////////////////////////////
276// new since 0.49-990522
277//////////////////////////////////////////////////////////////////////////
278
279 virtual QCString trNamespaces() = 0;
280
281//////////////////////////////////////////////////////////////////////////
282// new since 0.49-990728
283//////////////////////////////////////////////////////////////////////////
284
285 virtual QCString trGeneratedFromFiles(ClassDef::CompoundType compType,
286 bool single) = 0;
287
288//////////////////////////////////////////////////////////////////////////
289// new since 0.49-990901
290//////////////////////////////////////////////////////////////////////////
291
292 virtual QCString trReturnValues() = 0;
293 virtual QCString trMainPage() = 0;
294 virtual QCString trPageAbbreviation() = 0;
295
296//////////////////////////////////////////////////////////////////////////
297// new since 0.49-991003
298//////////////////////////////////////////////////////////////////////////
299
300 virtual QCString trDefinedAtLineInSourceFile() = 0;
301 virtual QCString trDefinedInSourceFile() = 0;
302
303//////////////////////////////////////////////////////////////////////////
304// new since 0.49-991205
305//////////////////////////////////////////////////////////////////////////
306
307 virtual QCString trDeprecated() = 0;
308
309//////////////////////////////////////////////////////////////////////////
310// new since 1.0.0
311//////////////////////////////////////////////////////////////////////////
312
313 virtual QCString trCollaborationDiagram(const QCString &clName) = 0;
314 virtual QCString trInclDepGraph(const QCString &fName) = 0;
315 virtual QCString trConstructorDocumentation() = 0;
316 virtual QCString trGotoSourceCode() = 0;
317 virtual QCString trGotoDocumentation() = 0;
318 virtual QCString trPrecondition() = 0;
319 virtual QCString trPostcondition() = 0;
320 virtual QCString trInvariant() = 0;
321 virtual QCString trInitialValue() = 0;
322 virtual QCString trCode() = 0;
323
324 virtual QCString trGraphicalHierarchy() = 0;
325 virtual QCString trGotoGraphicalHierarchy() = 0;
326 virtual QCString trGotoTextualHierarchy() = 0;
327 virtual QCString trPageIndex() = 0;
328
329//////////////////////////////////////////////////////////////////////////
330// new since 1.1.0
331//////////////////////////////////////////////////////////////////////////
332
333 virtual QCString trNote() = 0;
334 virtual QCString trPublicTypes() = 0;
335 virtual QCString trPublicAttribs() = 0;
336 virtual QCString trStaticPublicAttribs() = 0;
337 virtual QCString trProtectedTypes() = 0;
338 virtual QCString trProtectedAttribs() = 0;
339 virtual QCString trStaticProtectedAttribs() = 0;
340 virtual QCString trPrivateTypes() = 0;
341 virtual QCString trPrivateAttribs() = 0;
342 virtual QCString trStaticPrivateAttribs() = 0;
343
344//////////////////////////////////////////////////////////////////////////
345// new since 1.1.3
346//////////////////////////////////////////////////////////////////////////
347
348 virtual QCString trTodo() = 0;
349 virtual QCString trTodoList() = 0;
350
351//////////////////////////////////////////////////////////////////////////
352// new since 1.1.4
353//////////////////////////////////////////////////////////////////////////
354
355 virtual QCString trReferencedBy() = 0;
356 virtual QCString trRemarks() = 0;
357 virtual QCString trAttention() = 0;
358 virtual QCString trInclByDepGraph() = 0;
359 virtual QCString trSince() = 0;
360
361//////////////////////////////////////////////////////////////////////////
362// new since 1.1.5
363//////////////////////////////////////////////////////////////////////////
364
365 virtual QCString trLegendTitle() = 0;
366 virtual QCString trLegendDocs() = 0;
367 virtual QCString trLegend() = 0;
368
369//////////////////////////////////////////////////////////////////////////
370// new since 1.2.0
371//////////////////////////////////////////////////////////////////////////
372
373 virtual QCString trTest() = 0;
374 virtual QCString trTestList() = 0;
375
376//////////////////////////////////////////////////////////////////////////
377// new since 1.2.2
378//////////////////////////////////////////////////////////////////////////
379
380 virtual QCString trProperties() = 0;
381 virtual QCString trPropertyDocumentation() = 0;
382
383//////////////////////////////////////////////////////////////////////////
384// new since 1.2.4
385//////////////////////////////////////////////////////////////////////////
386
387 virtual QCString trClasses() = 0;
388 virtual QCString trPackage(const QCString &name) = 0;
389 virtual QCString trPackageListDescription() = 0;
390 virtual QCString trPackages() = 0;
391 virtual QCString trDefineValue() = 0;
392
393//////////////////////////////////////////////////////////////////////////
394// new since 1.2.5
395//////////////////////////////////////////////////////////////////////////
396
397 virtual QCString trBug() = 0;
398 virtual QCString trBugList() = 0;
399
400//////////////////////////////////////////////////////////////////////////
401// new since 1.2.6
402//////////////////////////////////////////////////////////////////////////
403
404
405 /*! Used as ansicpg for RTF file
406 *
407 * The following table shows the correlation of Charset name, Charset Value and
408 * <pre>
409 * Codepage number:
410 * Charset Name Charset Value(hex) Codepage number
411 * ------------------------------------------------------
412 * DEFAULT_CHARSET 1 (x01)
413 * SYMBOL_CHARSET 2 (x02)
414 * OEM_CHARSET 255 (xFF)
415 * ANSI_CHARSET 0 (x00) 1252
416 * RUSSIAN_CHARSET 204 (xCC) 1251
417 * EE_CHARSET 238 (xEE) 1250
418 * GREEK_CHARSET 161 (xA1) 1253
419 * TURKISH_CHARSET 162 (xA2) 1254
420 * BALTIC_CHARSET 186 (xBA) 1257
421 * HEBREW_CHARSET 177 (xB1) 1255
422 * ARABIC _CHARSET 178 (xB2) 1256
423 * SHIFTJIS_CHARSET 128 (x80) 932
424 * HANGEUL_CHARSET 129 (x81) 949
425 * GB2313_CHARSET 134 (x86) 936
426 * CHINESEBIG5_CHARSET 136 (x88) 950
427 * </pre>
428 *
429 */
430 virtual QCString trRTFansicp() = 0;
431
432 /*! Character sets
433 * <pre>
434 * 0 — ANSI
435 * 1 — Default
436 * 2 — Symbol
437 * 3 — Invalid
438 * 77 — Mac
439 * 128 — Shift Jis
440 * 129 — Hangul
441 * 130 — Johab
442 * 134 — GB2312
443 * 136 — Big5
444 * 161 — Greek
445 * 162 — Turkish
446 * 163 — Vietnamese
447 * 177 — Hebrew
448 * 178 — Arabic
449 * 179 — Arabic Traditional
450 * 180 — Arabic user
451 * 181 — Hebrew user
452 * 186 — Baltic
453 * 204 — Russian
454 * 222 — Thai
455 * 238 — Eastern European
456 * 254 — PC 437
457 * 255 — OEM
458 * </pre>
459 */
460 virtual QCString trRTFCharSet() = 0;
461 virtual QCString trRTFGeneralIndex() = 0;
462
463 // Translation of the word
464
465 virtual QCString trClass(bool first_capital, bool singular) = 0;
466 virtual QCString trFile(bool first_capital, bool singular) = 0;
467 virtual QCString trNamespace(bool first_capital, bool singular) = 0;
468 virtual QCString trGroup(bool first_capital, bool singular) = 0;
469 virtual QCString trPage(bool first_capital, bool singular) = 0;
470 virtual QCString trMember(bool first_capital, bool singular) = 0;
471 virtual QCString trGlobal(bool first_capital, bool singular) = 0;
472
473//////////////////////////////////////////////////////////////////////////
474// new since 1.2.7
475//////////////////////////////////////////////////////////////////////////
476
477 virtual QCString trAuthor(bool first_capital, bool singular) = 0;
478
479//////////////////////////////////////////////////////////////////////////
480// new since 1.2.11
481//////////////////////////////////////////////////////////////////////////
482
483 virtual QCString trReferences() = 0;
484
485//////////////////////////////////////////////////////////////////////////
486// new since 1.2.13
487//////////////////////////////////////////////////////////////////////////
488
489 virtual QCString trImplementedFromList(int numEntries) = 0;
490 virtual QCString trImplementedInList(int numEntries) = 0;
491
492//////////////////////////////////////////////////////////////////////////
493// new since 1.2.16
494//////////////////////////////////////////////////////////////////////////
495
496 virtual QCString trRTFTableOfContents() = 0;
497
498//////////////////////////////////////////////////////////////////////////
499// new since 1.2.17
500//////////////////////////////////////////////////////////////////////////
501
502 virtual QCString trDeprecatedList() = 0;
503
504//////////////////////////////////////////////////////////////////////////
505// new since 1.2.18
506//////////////////////////////////////////////////////////////////////////
507
508 virtual QCString trEvents() = 0;
509 virtual QCString trEventDocumentation() = 0;
510
511//////////////////////////////////////////////////////////////////////////
512// new since 1.3
513//////////////////////////////////////////////////////////////////////////
514
515 virtual QCString trPackageTypes() = 0;
516 virtual QCString trPackageFunctions() = 0;
517 virtual QCString trPackageMembers() = 0;
518 virtual QCString trStaticPackageFunctions() = 0;
519 virtual QCString trPackageAttribs() = 0;
520 virtual QCString trStaticPackageAttribs() = 0;
521
522//////////////////////////////////////////////////////////////////////////
523// new since 1.3.1
524//////////////////////////////////////////////////////////////////////////
525
526 virtual QCString trAll() = 0;
527 virtual QCString trCallGraph() = 0;
528
529//////////////////////////////////////////////////////////////////////////
530// new since 1.3.3
531//////////////////////////////////////////////////////////////////////////
532
533 virtual QCString trSearchResultsTitle() = 0;
534 virtual QCString trSearchResults(int numDocuments) = 0;
535 virtual QCString trSearchMatches() = 0;
536
537//////////////////////////////////////////////////////////////////////////
538// new since 1.3.8
539//////////////////////////////////////////////////////////////////////////
540
541 virtual QCString trSourceFile(const QCString& filename) = 0;
542
543//////////////////////////////////////////////////////////////////////////
544// new since 1.3.9
545//////////////////////////////////////////////////////////////////////////
546
547 virtual QCString trDirIndex() = 0;
548 virtual QCString trDirDocumentation() = 0;
549 virtual QCString trDirectories() = 0;
550 virtual QCString trDirReference(const QCString &dirName) = 0;
551 virtual QCString trDir(bool first_capital, bool singular) = 0;
552
553//////////////////////////////////////////////////////////////////////////
554// new since 1.4.1
555//////////////////////////////////////////////////////////////////////////
556
557 virtual QCString trOverloadText() = 0;
558
559//////////////////////////////////////////////////////////////////////////
560// new since 1.4.6
561//////////////////////////////////////////////////////////////////////////
562
563 virtual QCString trCallerGraph() = 0;
564 virtual QCString trEnumerationValueDocumentation() = 0;
565
566//////////////////////////////////////////////////////////////////////////
567// new since 1.5.4
568//////////////////////////////////////////////////////////////////////////
569
570 virtual QCString trMemberFunctionDocumentationFortran() = 0;
571 virtual QCString trCompoundListFortran() = 0;
572 virtual QCString trCompoundMembersFortran() = 0;
573 virtual QCString trCompoundListDescriptionFortran() = 0;
574 virtual QCString trCompoundMembersDescriptionFortran(bool extractAll) = 0;
575 virtual QCString trCompoundIndexFortran() = 0;
576 virtual QCString trTypeDocumentation() = 0;
577 virtual QCString trSubprograms() = 0;
578 virtual QCString trSubprogramDocumentation() = 0;
579 virtual QCString trDataTypes() = 0;
580 virtual QCString trModulesList() = 0;
581 virtual QCString trModulesListDescription(bool extractAll) = 0;
582 virtual QCString trCompoundReferenceFortran(const QCString &clName,
583 ClassDef::CompoundType compType,
584 bool isTemplate) = 0;
585 virtual QCString trModuleReference(const QCString &namespaceName) = 0;
586 virtual QCString trModulesMembers() = 0;
587 virtual QCString trModulesMemberDescription(bool extractAll) = 0;
588 virtual QCString trModulesIndex() = 0;
589 virtual QCString trModule(bool first_capital, bool singular) = 0;
590 virtual QCString trGeneratedFromFilesFortran(ClassDef::CompoundType compType,
591 bool single) = 0;
592 virtual QCString trType(bool first_capital, bool singular) = 0;
593 virtual QCString trSubprogram(bool first_capital, bool singular) = 0;
594 virtual QCString trTypeConstraints() = 0;
595
596//////////////////////////////////////////////////////////////////////////
597// new since 1.6.0
598//////////////////////////////////////////////////////////////////////////
599
600 virtual QCString trDirRelation(const QCString &name) = 0;
601 virtual QCString trLoading() = 0;
602 virtual QCString trGlobalNamespace() = 0;
603 virtual QCString trSearching() = 0;
604 virtual QCString trNoMatches() = 0;
605
606//////////////////////////////////////////////////////////////////////////
607// new since 1.6.3
608//////////////////////////////////////////////////////////////////////////
609
610 virtual QCString trFileIn(const QCString &name) = 0;
611 virtual QCString trIncludesFileIn(const QCString &name) = 0;
612 virtual QCString trDateTime(int year,int month,int day,int dayOfWeek,
613 int hour,int minutes,int seconds,
614 DateTimeType includeTime) = 0;
615 virtual QCString trDayOfWeek(int dayOfWeek, bool first_capital, bool full) = 0;
616 virtual QCString trMonth(int month, bool first_capital, bool full) = 0;
617 virtual QCString trDayPeriod(bool period) = 0;
618
619//////////////////////////////////////////////////////////////////////////
620// new since 1.7.5
621//////////////////////////////////////////////////////////////////////////
622
623 virtual QCString trCiteReferences() = 0;
624 virtual QCString trCopyright() = 0;
625 virtual QCString trDirDepGraph(const QCString &name) = 0;
626
627//////////////////////////////////////////////////////////////////////////
628// new since 1.8.0
629//////////////////////////////////////////////////////////////////////////
630
631 virtual QCString trDetailLevel() = 0;
632 virtual QCString trTemplateParameters() = 0;
633 virtual QCString trAndMore(const QCString &number) = 0;
634 virtual QCString trEnumGeneratedFromFiles(bool single) = 0;
635 virtual QCString trEnumReference(const QCString &name) = 0;
636 virtual QCString trInheritedFrom(const QCString &members,const QCString &what) = 0;
637 virtual QCString trAdditionalInheritedMembers() = 0;
638
639//////////////////////////////////////////////////////////////////////////
640// new since 1.8.2
641//////////////////////////////////////////////////////////////////////////
642
643 virtual QCString trPanelSynchronisationTooltip(bool enable) = 0;
644 virtual QCString trProvidedByCategory() = 0;
645 virtual QCString trExtendsClass() = 0;
646 virtual QCString trClassMethods() = 0;
647 virtual QCString trInstanceMethods() = 0;
648 virtual QCString trMethodDocumentation() = 0;
649
650//////////////////////////////////////////////////////////////////////////
651// new since 1.8.4
652//////////////////////////////////////////////////////////////////////////
653
654 virtual QCString trInterfaces() = 0;
655 virtual QCString trServices() = 0;
656 virtual QCString trConstantGroups() = 0;
657 virtual QCString trConstantGroupReference(const QCString &namespaceName) = 0;
658 virtual QCString trServiceReference(const QCString &sName) = 0;
659 virtual QCString trSingletonReference(const QCString &sName) = 0;
660 virtual QCString trServiceGeneratedFromFiles(bool single) = 0;
661 virtual QCString trSingletonGeneratedFromFiles(bool single) = 0;
662
663//////////////////////////////////////////////////////////////////////////
664// new since 1.8.15
665//////////////////////////////////////////////////////////////////////////
666
667 virtual QCString trDesignUnitHierarchy() = 0;
668 virtual QCString trDesignUnitList() = 0;
669 virtual QCString trDesignUnitMembers() = 0;
670 virtual QCString trDesignUnitListDescription() = 0;
671 virtual QCString trDesignUnitIndex() = 0;
672 virtual QCString trDesignUnits() = 0;
673 virtual QCString trFunctionAndProc() = 0;
674 virtual QCString trVhdlType(VhdlSpecifier type,bool single) = 0;
675 virtual QCString trCustomReference(const QCString &name) = 0;
676
677 virtual QCString trConstants() = 0;
678 virtual QCString trConstantDocumentation() = 0;
679 virtual QCString trSequences() = 0;
680 virtual QCString trSequenceDocumentation() = 0;
681 virtual QCString trDictionaries() = 0;
682 virtual QCString trDictionaryDocumentation() = 0;
683 virtual QCString trSliceInterfaces() = 0;
684 virtual QCString trInterfaceIndex() = 0;
685 virtual QCString trInterfaceList() = 0;
686 virtual QCString trInterfaceListDescription() = 0;
687 virtual QCString trInterfaceHierarchy() = 0;
688 virtual QCString trInterfaceHierarchyDescription() = 0;
689 virtual QCString trInterfaceDocumentation() = 0;
690 virtual QCString trStructs() = 0;
691 virtual QCString trStructIndex() = 0;
692 virtual QCString trStructList() = 0;
693 virtual QCString trStructListDescription() = 0;
694 virtual QCString trStructDocumentation() = 0;
695 virtual QCString trExceptionIndex() = 0;
696 virtual QCString trExceptionList() = 0;
697 virtual QCString trExceptionListDescription() = 0;
698 virtual QCString trExceptionHierarchy() = 0;
699 virtual QCString trExceptionHierarchyDescription() = 0;
700 virtual QCString trExceptionDocumentation() = 0;
701 virtual QCString trCompoundReferenceSlice(const QCString &clName, ClassDef::CompoundType compType, bool isLocal) = 0;
702 virtual QCString trOperations() = 0;
703 virtual QCString trOperationDocumentation() = 0;
704 virtual QCString trDataMembers() = 0;
705 virtual QCString trDataMemberDocumentation() = 0;
706
707//////////////////////////////////////////////////////////////////////////
708// new since 1.8.19
709//////////////////////////////////////////////////////////////////////////
710
711 virtual QCString trDesignUnitDocumentation() = 0;
712
713//////////////////////////////////////////////////////////////////////////
714// new since 1.9.2
715//////////////////////////////////////////////////////////////////////////
716
717 virtual QCString trConcept(bool first_capital, bool singular) = 0;
718 virtual QCString trConceptReference(const QCString &conceptName) = 0;
719 virtual QCString trConceptList() = 0;
720 virtual QCString trConceptIndex() = 0;
721 virtual QCString trConceptDocumentation() = 0;
722 virtual QCString trConceptListDescription(bool extractAll) = 0;
723 virtual QCString trConceptDefinition() = 0;
724
725//////////////////////////////////////////////////////////////////////////
726// new since 1.9.4
727//////////////////////////////////////////////////////////////////////////
728 virtual QCString trPackageList() = 0;
729
730//////////////////////////////////////////////////////////////////////////
731// new since 1.9.6
732//////////////////////////////////////////////////////////////////////////
733 virtual QCString trFlowchart() = 0;
734
735//////////////////////////////////////////////////////////////////////////
736// new since 1.9.7
737//////////////////////////////////////////////////////////////////////////
738 virtual QCString trRelatedSymbols() = 0;
739 virtual QCString trRelatedSymbolsSubscript() = 0;
740 virtual QCString trRelatedSymbolDocumentation() = 0;
741
742 virtual QCString trCompoundType(ClassDef::CompoundType compType, SrcLangExt lang) = 0;
743
744 virtual QCString trFileMembersDescriptionTotal(FileMemberHighlight::Enum hl) = 0;
745 virtual QCString trCompoundMembersDescriptionTotal(ClassMemberHighlight::Enum hl) = 0;
746 virtual QCString trNamespaceMembersDescriptionTotal(NamespaceMemberHighlight::Enum hl) = 0;
747 virtual QCString trDefinition() = 0;
748 virtual QCString trDeclaration() = 0;
749//////////////////////////////////////////////////////////////////////////
750// new since 1.9.8
751//////////////////////////////////////////////////////////////////////////
752 virtual QCString trTopics() = 0;
753 virtual QCString trTopicDocumentation() = 0;
754 virtual QCString trTopicList() = 0;
755 virtual QCString trTopicIndex() = 0;
756 virtual QCString trTopicListDescription() = 0;
757 virtual QCString trModuleMembersDescriptionTotal(ModuleMemberHighlight::Enum hl) = 0;
758 virtual QCString trExportedModules() = 0;
759//////////////////////////////////////////////////////////////////////////
760// new since 1.10.0
761//////////////////////////////////////////////////////////////////////////
762 virtual QCString trCopyToClipboard() = 0;
763//////////////////////////////////////////////////////////////////////////
764// new since 1.11.0
765//////////////////////////////////////////////////////////////////////////
766 virtual QCString trImportant() = 0;
767
768 protected:
769 QCString p_latexCommandName(const QCString &latexCmd)
770 {
771 QCString latex_command = Config_getString(LATEX_CMD_NAME);
772 if (latex_command.isEmpty()) latex_command = "latex";
773 if (Config_getBool(USE_PDFLATEX))
774 {
775 if (latex_command == "latex") latex_command = latexCmd;
776 }
777 return latex_command;
778 }
779 /*! For easy flexible-noun implementation.
780 * \internal
781 */
782 QCString createNoun(bool first_capital, bool singular,
783 const QCString &base,
784 const QCString &plurSuffix, const QCString &singSuffix = "" )
785 {
786 QCString result;
787 if (first_capital)
788 {
789 std::string res = getUTF8CharAt(base.str(),0);
790 res = convertUTF8ToUpper(res);
791 result = res.c_str();
792 result += base.mid(res.length());
793 }
794 else
795 {
796 result = base;
797 }
798 result += (singular ? singSuffix : plurSuffix);
799 return result;
800 }
801};
802
803#endif
ClassDef::CompoundType
CompoundType
The various compound types.
Definition classdef.h:109
QCString::mid
QCString mid(size_t index, size_t len=static_cast< size_t >(-1)) const
Definition qcstring.h:226
QCString::isEmpty
bool isEmpty() const
Returns TRUE iff the string is empty.
Definition qcstring.h:150
QCString::str
const std::string & str() const
Definition qcstring.h:526
Translator
Abstract base class for all translatable text fragments.
Definition translator.h:29
Translator::trMemberList
virtual QCString trMemberList()=0
Translator::trAll
virtual QCString trAll()=0
Translator::trStaticPrivateAttribs
virtual QCString trStaticPrivateAttribs()=0
Translator::trRTFGeneralIndex
virtual QCString trRTFGeneralIndex()=0
Translator::trCompoundListDescription
virtual QCString trCompoundListDescription()=0
Translator::trTopicIndex
virtual QCString trTopicIndex()=0
Translator::trClassHierarchyDescription
virtual QCString trClassHierarchyDescription()=0
Translator::trNamespaceDocumentation
virtual QCString trNamespaceDocumentation()=0
Translator::trTopics
virtual QCString trTopics()=0
Translator::trIncludesFileIn
virtual QCString trIncludesFileIn(const QCString &name)=0
Translator::trPrivateTypes
virtual QCString trPrivateTypes()=0
Translator::createNoun
QCString createNoun(bool first_capital, bool singular, const QCString &base, const QCString &plurSuffix, const QCString &singSuffix="")
Definition translator.h:782
Translator::trTest
virtual QCString trTest()=0
Translator::trPackage
virtual QCString trPackage(const QCString &name)=0
Translator::trBug
virtual QCString trBug()=0
Translator::trDataTypes
virtual QCString trDataTypes()=0
Translator::trMemberFunctionDocumentationFortran
virtual QCString trMemberFunctionDocumentationFortran()=0
Translator::trPackageListDescription
virtual QCString trPackageListDescription()=0
Translator::trDocumentation
virtual QCString trDocumentation(const QCString &projName)=0
Translator::trDirIndex
virtual QCString trDirIndex()=0
Translator::trExceptionHierarchy
virtual QCString trExceptionHierarchy()=0
Translator::trCollaborationDiagram
virtual QCString trCollaborationDiagram(const QCString &clName)=0
Translator::trConceptIndex
virtual QCString trConceptIndex()=0
Translator::trNamespaceReference
virtual QCString trNamespaceReference(const QCString &namespaceName)=0
Translator::trSearchMatches
virtual QCString trSearchMatches()=0
Translator::trModuleIndex
virtual QCString trModuleIndex()=0
Translator::trPrivateMembers
virtual QCString trPrivateMembers()=0
Translator::trIncludingInheritedMembers
virtual QCString trIncludingInheritedMembers()=0
Translator::trDirectories
virtual QCString trDirectories()=0
Translator::trExceptionDocumentation
virtual QCString trExceptionDocumentation()=0
Translator::trSourceFile
virtual QCString trSourceFile(const QCString &filename)=0
Translator::trClasses
virtual QCString trClasses()=0
Translator::trStaticPackageAttribs
virtual QCString trStaticPackageAttribs()=0
Translator::trPrecondition
virtual QCString trPrecondition()=0
Translator::trPrivateSlots
virtual QCString trPrivateSlots()=0
Translator::trStaticProtectedAttribs
virtual QCString trStaticProtectedAttribs()=0
Translator::trDirDepGraph
virtual QCString trDirDepGraph(const QCString &name)=0
Translator::trDeclaration
virtual QCString trDeclaration()=0
Translator::trType
virtual QCString trType(bool first_capital, bool singular)=0
Translator::trSearch
virtual QCString trSearch()=0
Translator::trFileIndex
virtual QCString trFileIndex()=0
Translator::trInclByDepGraph
virtual QCString trInclByDepGraph()=0
Translator::trPropertyDocumentation
virtual QCString trPropertyDocumentation()=0
Translator::trInheritedFrom
virtual QCString trInheritedFrom(const QCString &members, const QCString &what)=0
Translator::trCompoundReference
virtual QCString trCompoundReference(const QCString &clName, ClassDef::CompoundType compType, bool isTemplate)=0
Translator::trNamespaceIndex
virtual QCString trNamespaceIndex()=0
Translator::trGotoGraphicalHierarchy
virtual QCString trGotoGraphicalHierarchy()=0
Translator::trSequences
virtual QCString trSequences()=0
Translator::trServiceGeneratedFromFiles
virtual QCString trServiceGeneratedFromFiles(bool single)=0
Translator::trHierarchicalIndex
virtual QCString trHierarchicalIndex()=0
Translator::trExceptionListDescription
virtual QCString trExceptionListDescription()=0
Translator::trEventDocumentation
virtual QCString trEventDocumentation()=0
Translator::trInterfaceIndex
virtual QCString trInterfaceIndex()=0
Translator::trDataMemberDocumentation
virtual QCString trDataMemberDocumentation()=0
Translator::trFunctionAndProc
virtual QCString trFunctionAndProc()=0
Translator::trFileReference
virtual QCString trFileReference(const QCString &fileName)=0
Translator::trModulesList
virtual QCString trModulesList()=0
Translator::trModules
virtual QCString trModules()=0
Translator::trFileListDescription
virtual QCString trFileListDescription(bool extractAll)=0
Translator::trProvidedByCategory
virtual QCString trProvidedByCategory()=0
Translator::trWriteList
virtual QCString trWriteList(int numEntries)=0
Translator::trISOLang
virtual QCString trISOLang()=0
Translator::trGotoSourceCode
virtual QCString trGotoSourceCode()=0
Translator::trDefineValue
virtual QCString trDefineValue()=0
Translator::trConceptList
virtual QCString trConceptList()=0
Translator::trInclDepGraph
virtual QCString trInclDepGraph(const QCString &fName)=0
Translator::trGraphicalHierarchy
virtual QCString trGraphicalHierarchy()=0
Translator::trTypeConstraints
virtual QCString trTypeConstraints()=0
Translator::trModulesDescription
virtual QCString trModulesDescription()=0
Translator::trFunctionDocumentation
virtual QCString trFunctionDocumentation()=0
Translator::trMemberTypedefDocumentation
virtual QCString trMemberTypedefDocumentation()=0
Translator::trSearchResultsTitle
virtual QCString trSearchResultsTitle()=0
Translator::trCiteReferences
virtual QCString trCiteReferences()=0
Translator::trConstantGroupReference
virtual QCString trConstantGroupReference(const QCString &namespaceName)=0
Translator::trConcept
virtual QCString trConcept(bool first_capital, bool singular)=0
Translator::trMethodDocumentation
virtual QCString trMethodDocumentation()=0
Translator::trEnumReference
virtual QCString trEnumReference(const QCString &name)=0
Translator::trDeprecatedList
virtual QCString trDeprecatedList()=0
Translator::trConstantDocumentation
virtual QCString trConstantDocumentation()=0
Translator::trGroup
virtual QCString trGroup(bool first_capital, bool singular)=0
Translator::trCompoundMembersDescription
virtual QCString trCompoundMembersDescription(bool extractAll)=0
Translator::trInterfaceList
virtual QCString trInterfaceList()=0
Translator::trSince
virtual QCString trSince()=0
Translator::trVariables
virtual QCString trVariables()=0
Translator::trLoading
virtual QCString trLoading()=0
Translator::trMonth
virtual QCString trMonth(int month, bool first_capital, bool full)=0
Translator::trProtectedMembers
virtual QCString trProtectedMembers()=0
Translator::trStructs
virtual QCString trStructs()=0
Translator::trPackageFunctions
virtual QCString trPackageFunctions()=0
Translator::trFunctions
virtual QCString trFunctions()=0
Translator::trFileMembersDescriptionTotal
virtual QCString trFileMembersDescriptionTotal(FileMemberHighlight::Enum hl)=0
Translator::trExtendsClass
virtual QCString trExtendsClass()=0
Translator::trNamespace
virtual QCString trNamespace(bool first_capital, bool singular)=0
Translator::trPublicMembers
virtual QCString trPublicMembers()=0
Translator::latexDocumentPost
virtual QCString latexDocumentPost()
Definition translator.h:69
Translator::trExceptionHierarchyDescription
virtual QCString trExceptionHierarchyDescription()=0
Translator::trCallerGraph
virtual QCString trCallerGraph()=0
Translator::trReimplementedInList
virtual QCString trReimplementedInList(int numEntries)=0
Translator::trRelatedSymbolsSubscript
virtual QCString trRelatedSymbolsSubscript()=0
Translator::trInstanceMethods
virtual QCString trInstanceMethods()=0
Translator::trProtectedSlots
virtual QCString trProtectedSlots()=0
Translator::trModulesListDescription
virtual QCString trModulesListDescription(bool extractAll)=0
Translator::trPackageMembers
virtual QCString trPackageMembers()=0
Translator::trReferencedBy
virtual QCString trReferencedBy()=0
Translator::latexFontenc
virtual QCString latexFontenc()
Definition translator.h:54
Translator::trDataMembers
virtual QCString trDataMembers()=0
Translator::trGeneratedFromFilesFortran
virtual QCString trGeneratedFromFilesFortran(ClassDef::CompoundType compType, bool single)=0
Translator::trVersion
virtual QCString trVersion()=0
Translator::trGlobal
virtual QCString trGlobal(bool first_capital, bool singular)=0
Translator::trPublicTypes
virtual QCString trPublicTypes()=0
Translator::trConstantGroups
virtual QCString trConstantGroups()=0
Translator::trPackages
virtual QCString trPackages()=0
Translator::trPageIndex
virtual QCString trPageIndex()=0
Translator::trCallGraph
virtual QCString trCallGraph()=0
Translator::trFileDocumentation
virtual QCString trFileDocumentation()=0
Translator::trReturns
virtual QCString trReturns()=0
Translator::trSliceInterfaces
virtual QCString trSliceInterfaces()=0
Translator::trEnumerationValues
virtual QCString trEnumerationValues()=0
Translator::trOperationDocumentation
virtual QCString trOperationDocumentation()=0
Translator::trStaticPrivateMembers
virtual QCString trStaticPrivateMembers()=0
Translator::trPublicSlots
virtual QCString trPublicSlots()=0
Translator::trVariableDocumentation
virtual QCString trVariableDocumentation()=0
Translator::trExceptions
virtual QCString trExceptions()=0
Translator::trDir
virtual QCString trDir(bool first_capital, bool singular)=0
Translator::trOperations
virtual QCString trOperations()=0
Translator::trConstants
virtual QCString trConstants()=0
Translator::trClassMethods
virtual QCString trClassMethods()=0
Translator::trProtectedAttribs
virtual QCString trProtectedAttribs()=0
Translator::trSubprogramDocumentation
virtual QCString trSubprogramDocumentation()=0
Translator::trPrivateAttribs
virtual QCString trPrivateAttribs()=0
Translator::trSearching
virtual QCString trSearching()=0
Translator::trTodo
virtual QCString trTodo()=0
Translator::trRTFTableOfContents
virtual QCString trRTFTableOfContents()=0
Translator::trEnumerationTypeDocumentation
virtual QCString trEnumerationTypeDocumentation()=0
Translator::trRelatedPagesDescription
virtual QCString trRelatedPagesDescription()=0
Translator::trDesignUnitHierarchy
virtual QCString trDesignUnitHierarchy()=0
Translator::trDetails
virtual QCString trDetails()=0
Translator::trCompoundMembers
virtual QCString trCompoundMembers()=0
Translator::trStructDocumentation
virtual QCString trStructDocumentation()=0
Translator::trInterfaceHierarchyDescription
virtual QCString trInterfaceHierarchyDescription()=0
Translator::trPage
virtual QCString trPage(bool first_capital, bool singular)=0
Translator::trDetailedDescription
virtual QCString trDetailedDescription()=0
Translator::trExamplesDescription
virtual QCString trExamplesDescription()=0
Translator::trCompoundIndex
virtual QCString trCompoundIndex()=0
Translator::trDefinedInSourceFile
virtual QCString trDefinedInSourceFile()=0
Translator::trMore
virtual QCString trMore()=0
Translator::trModulesMembers
virtual QCString trModulesMembers()=0
Translator::trTypedefDocumentation
virtual QCString trTypedefDocumentation()=0
Translator::trRelatedSubscript
virtual QCString trRelatedSubscript()=0
Translator::trModulesMemberDescription
virtual QCString trModulesMemberDescription(bool extractAll)=0
Translator::trCompoundType
virtual QCString trCompoundType(ClassDef::CompoundType compType, SrcLangExt lang)=0
Translator::trTopicList
virtual QCString trTopicList()=0
Translator::trMemberDataDocumentation
virtual QCString trMemberDataDocumentation()=0
Translator::trInitialValue
virtual QCString trInitialValue()=0
Translator::trNoMatches
virtual QCString trNoMatches()=0
Translator::trImplementedInList
virtual QCString trImplementedInList(int numEntries)=0
Translator::trThisIsTheListOfAllMembers
virtual QCString trThisIsTheListOfAllMembers()=0
Translator::trRemarks
virtual QCString trRemarks()=0
Translator::trInterfaceHierarchy
virtual QCString trInterfaceHierarchy()=0
Translator::trClassDocumentation
virtual QCString trClassDocumentation()=0
Translator::trDirRelation
virtual QCString trDirRelation(const QCString &name)=0
Translator::trPageAbbreviation
virtual QCString trPageAbbreviation()=0
Translator::trSingletonReference
virtual QCString trSingletonReference(const QCString &sName)=0
Translator::trInheritsList
virtual QCString trInheritsList(int numEntries)=0
Translator::trModuleReference
virtual QCString trModuleReference(const QCString &namespaceName)=0
Translator::trExportedModules
virtual QCString trExportedModules()=0
Translator::updateNeededMessage
virtual QCString updateNeededMessage()
Definition translator.h:37
Translator::trClass
virtual QCString trClass(bool first_capital, bool singular)=0
Translator::trLegendDocs
virtual QCString trLegendDocs()=0
Translator::trExceptionList
virtual QCString trExceptionList()=0
Translator::trModuleDocumentation
virtual QCString trModuleDocumentation()=0
Translator::trSubprogram
virtual QCString trSubprogram(bool first_capital, bool singular)=0
Translator::trGeneratedBy
virtual QCString trGeneratedBy()=0
Translator::trSingletonGeneratedFromFiles
virtual QCString trSingletonGeneratedFromFiles(bool single)=0
Translator::trCompounds
virtual QCString trCompounds()=0
Translator::trDefinition
virtual QCString trDefinition()=0
Translator::trBugList
virtual QCString trBugList()=0
Translator::trCopyToClipboard
virtual QCString trCopyToClipboard()=0
Translator::trNote
virtual QCString trNote()=0
Translator::trRelatedPages
virtual QCString trRelatedPages()=0
Translator::trInterfaces
virtual QCString trInterfaces()=0
Translator::trDefineDocumentation
virtual QCString trDefineDocumentation()=0
Translator::trTopicDocumentation
virtual QCString trTopicDocumentation()=0
Translator::trTypeDocumentation
virtual QCString trTypeDocumentation()=0
Translator::trPostcondition
virtual QCString trPostcondition()=0
Translator::trSignals
virtual QCString trSignals()=0
Translator::trLegend
virtual QCString trLegend()=0
Translator::trAttention
virtual QCString trAttention()=0
Translator::trRTFansicp
virtual QCString trRTFansicp()=0
Translator::trStaticProtectedMembers
virtual QCString trStaticProtectedMembers()=0
Translator::trCopyright
virtual QCString trCopyright()=0
Translator::trReferences
virtual QCString trReferences()=0
Translator::trGeneratedAutomatically
virtual QCString trGeneratedAutomatically(const QCString &s)=0
Translator::latexCommandName
virtual QCString latexCommandName()
Definition translator.h:73
Translator::latexDocumentPre
virtual QCString latexDocumentPre()
Definition translator.h:64
Translator::trClassHierarchy
virtual QCString trClassHierarchy()=0
Translator::trDeprecated
virtual QCString trDeprecated()=0
Translator::trAdditionalInheritedMembers
virtual QCString trAdditionalInheritedMembers()=0
Translator::trDate
virtual QCString trDate()=0
Translator::trNamespaceList
virtual QCString trNamespaceList()=0
Translator::trSequenceDocumentation
virtual QCString trSequenceDocumentation()=0
Translator::latexLanguageSupportCommand
virtual QCString latexLanguageSupportCommand()=0
Translator::trMemberEnumerationDocumentation
virtual QCString trMemberEnumerationDocumentation()=0
Translator::trServices
virtual QCString trServices()=0
Translator::latexFont
virtual QCString latexFont()
Definition translator.h:55
Translator::trCompoundListFortran
virtual QCString trCompoundListFortran()=0
Translator::trEnumerations
virtual QCString trEnumerations()=0
Translator::trNamespaceMembersDescriptionTotal
virtual QCString trNamespaceMembersDescriptionTotal(NamespaceMemberHighlight::Enum hl)=0
Translator::trProtectedTypes
virtual QCString trProtectedTypes()=0
Translator::trMember
virtual QCString trMember(bool first_capital, bool singular)=0
Translator::trGlobalNamespace
virtual QCString trGlobalNamespace()=0
Translator::trModulesIndex
virtual QCString trModulesIndex()=0
Translator::trParameters
virtual QCString trParameters()=0
Translator::trSearchResults
virtual QCString trSearchResults(int numDocuments)=0
Translator::trModule
virtual QCString trModule(bool first_capital, bool singular)=0
Translator::trTemplateParameters
virtual QCString trTemplateParameters()=0
Translator::trMemberFunctionDocumentation
virtual QCString trMemberFunctionDocumentation()=0
Translator::needsPunctuation
virtual bool needsPunctuation()
add punctuation at the end of a brief description when needed and supported by the language
Definition translator.h:154
Translator::trFriends
virtual QCString trFriends()=0
Translator::trFileMembers
virtual QCString trFileMembers()=0
Translator::trAuthor
virtual QCString trAuthor(bool first_capital, bool singular)=0
Translator::trDesignUnitListDescription
virtual QCString trDesignUnitListDescription()=0
Translator::trDirDocumentation
virtual QCString trDirDocumentation()=0
Translator::trReimplementedFromList
virtual QCString trReimplementedFromList(int numEntries)=0
Translator::trNamespaceListDescription
virtual QCString trNamespaceListDescription(bool extractAll)=0
Translator::trGeneratedFromFiles
virtual QCString trGeneratedFromFiles(ClassDef::CompoundType compType, bool single)=0
Translator::trCompoundIndexFortran
virtual QCString trCompoundIndexFortran()=0
Translator::trStructIndex
virtual QCString trStructIndex()=0
Translator::trConceptReference
virtual QCString trConceptReference(const QCString &conceptName)=0
Translator::trGotoTextualHierarchy
virtual QCString trGotoTextualHierarchy()=0
Translator::trDictionaryDocumentation
virtual QCString trDictionaryDocumentation()=0
Translator::trEnumName
virtual QCString trEnumName()=0
Translator::trTopicListDescription
virtual QCString trTopicListDescription()=0
Translator::trAndMore
virtual QCString trAndMore(const QCString &number)=0
Translator::trDesignUnitList
virtual QCString trDesignUnitList()=0
Translator::trVhdlType
virtual QCString trVhdlType(VhdlSpecifier type, bool single)=0
Translator::trPanelSynchronisationTooltip
virtual QCString trPanelSynchronisationTooltip(bool enable)=0
Translator::trInheritedByList
virtual QCString trInheritedByList(int numEntries)=0
Translator::trFileList
virtual QCString trFileList()=0
Translator::trPackageAttribs
virtual QCString trPackageAttribs()=0
Translator::trEnumValue
virtual QCString trEnumValue()=0
Translator::trConceptDefinition
virtual QCString trConceptDefinition()=0
Translator::trEvents
virtual QCString trEvents()=0
Translator::trFlowchart
virtual QCString trFlowchart()=0
Translator::trClassDiagram
virtual QCString trClassDiagram(const QCString &clName)=0
Translator::trFileMembersDescription
virtual QCString trFileMembersDescription(bool extractAll)=0
Translator::trNamespaceMemberDescription
virtual QCString trNamespaceMemberDescription(bool extractAll)=0
Translator::trWarning
virtual QCString trWarning()=0
Translator::trExamples
virtual QCString trExamples()=0
Translator::trSeeAlso
virtual QCString trSeeAlso()=0
Translator::trDateTime
virtual QCString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, DateTimeType includeTime)=0
Translator::trTestList
virtual QCString trTestList()=0
Translator::trPackageTypes
virtual QCString trPackageTypes()=0
Translator::trNamespaceMembers
virtual QCString trNamespaceMembers()=0
Translator::trGotoDocumentation
virtual QCString trGotoDocumentation()=0
Translator::trCompoundMembersDescriptionTotal
virtual QCString trCompoundMembersDescriptionTotal(ClassMemberHighlight::Enum hl)=0
Translator::trStructList
virtual QCString trStructList()=0
Translator::trSubprograms
virtual QCString trSubprograms()=0
Translator::trStructListDescription
virtual QCString trStructListDescription()=0
Translator::trPublicAttribs
virtual QCString trPublicAttribs()=0
Translator::trModuleMembersDescriptionTotal
virtual QCString trModuleMembersDescriptionTotal(ModuleMemberHighlight::Enum hl)=0
Translator::trFile
virtual QCString trFile(bool first_capital, bool singular)=0
Translator::trDefinedIn
virtual QCString trDefinedIn()=0
Translator::trLegendTitle
virtual QCString trLegendTitle()=0
Translator::trGeneratedAt
virtual QCString trGeneratedAt(const QCString &date, const QCString &projName)=0
Translator::trDefinedAtLineInSourceFile
virtual QCString trDefinedAtLineInSourceFile()=0
Translator::trListOfAllMembers
virtual QCString trListOfAllMembers()=0
Translator::trDictionaries
virtual QCString trDictionaries()=0
Translator::trServiceReference
virtual QCString trServiceReference(const QCString &sName)=0
Translator::trDayOfWeek
virtual QCString trDayOfWeek(int dayOfWeek, bool first_capital, bool full)=0
Translator::trMainPage
virtual QCString trMainPage()=0
Translator::trDesignUnitDocumentation
virtual QCString trDesignUnitDocumentation()=0
Translator::trInterfaceListDescription
virtual QCString trInterfaceListDescription()=0
Translator::trCustomReference
virtual QCString trCustomReference(const QCString &name)=0
Translator::trStaticPublicMembers
virtual QCString trStaticPublicMembers()=0
Translator::trDetailLevel
virtual QCString trDetailLevel()=0
Translator::trEnumerationValueDocumentation
virtual QCString trEnumerationValueDocumentation()=0
Translator::trRelatedSymbols
virtual QCString trRelatedSymbols()=0
Translator::trNamespaces
virtual QCString trNamespaces()=0
Translator::p_latexCommandName
QCString p_latexCommandName(const QCString &latexCmd)
Definition translator.h:769
Translator::trRelatedFunctionDocumentation
virtual QCString trRelatedFunctionDocumentation()=0
Translator::trConceptDocumentation
virtual QCString trConceptDocumentation()=0
Translator::trImportant
virtual QCString trImportant()=0
Translator::trTodoList
virtual QCString trTodoList()=0
Translator::trCompoundListDescriptionFortran
virtual QCString trCompoundListDescriptionFortran()=0
Translator::trCompoundMembersFortran
virtual QCString trCompoundMembersFortran()=0
Translator::trStaticPackageFunctions
virtual QCString trStaticPackageFunctions()=0
Translator::trFileIn
virtual QCString trFileIn(const QCString &name)=0
Translator::trConstructorDocumentation
virtual QCString trConstructorDocumentation()=0
Translator::trDesignUnitMembers
virtual QCString trDesignUnitMembers()=0
Translator::trExceptionIndex
virtual QCString trExceptionIndex()=0
Translator::idLanguage
virtual QCString idLanguage()=0
Translator::trCompoundReferenceFortran
virtual QCString trCompoundReferenceFortran(const QCString &clName, ClassDef::CompoundType compType, bool isTemplate)=0
Translator::trStaticPublicAttribs
virtual QCString trStaticPublicAttribs()=0
Translator::trEnumGeneratedFromFiles
virtual QCString trEnumGeneratedFromFiles(bool single)=0
Translator::trReferenceManual
virtual QCString trReferenceManual()=0
Translator::trDesignUnits
virtual QCString trDesignUnits()=0
Translator::trReturnValues
virtual QCString trReturnValues()=0
Translator::getLanguageString
virtual QCString getLanguageString()=0
language codes for Html help
Translator::trCompoundReferenceSlice
virtual QCString trCompoundReferenceSlice(const QCString &clName, ClassDef::CompoundType compType, bool isLocal)=0
Translator::trInterfaceDocumentation
virtual QCString trInterfaceDocumentation()=0
Translator::trCompoundList
virtual QCString trCompoundList()=0
Translator::trRelatedSymbolDocumentation
virtual QCString trRelatedSymbolDocumentation()=0
Translator::trImplementedFromList
virtual QCString trImplementedFromList(int numEntries)=0
Translator::trDesignUnitIndex
virtual QCString trDesignUnitIndex()=0
Translator::trProperties
virtual QCString trProperties()=0
Translator::trConceptListDescription
virtual QCString trConceptListDescription(bool extractAll)=0
Translator::trCode
virtual QCString trCode()=0
Translator::trDayPeriod
virtual QCString trDayPeriod(bool period)=0
Translator::trRelatedFunctions
virtual QCString trRelatedFunctions()=0
Translator::trDirReference
virtual QCString trDirReference(const QCString &dirName)=0
Translator::trOverloadText
virtual QCString trOverloadText()=0
Translator::trInvariant
virtual QCString trInvariant()=0
Translator::trCompoundMembersDescriptionFortran
virtual QCString trCompoundMembersDescriptionFortran(bool extractAll)=0
Translator::trPackageList
virtual QCString trPackageList()=0
Translator::trRTFCharSet
virtual QCString trRTFCharSet()=0
Translator::trTypedefs
virtual QCString trTypedefs()=0
Translator::trDefines
virtual QCString trDefines()=0
Config_getBool
#define Config_getBool(name)
Definition config.h:33
Config_getString
#define Config_getString(name)
Definition config.h:32
ABSTRACT_BASE_CLASS
#define ABSTRACT_BASE_CLASS(cls)
Macro to implement rule of 5 for an abstract base class.
Definition construct.h:20
DateTimeType
DateTimeType
Definition datetime.h:38
SrcLangExt
SrcLangExt
Language as given by extension.
Definition types.h:42
VhdlSpecifier
VhdlSpecifier
Definition types.h:548
convertUTF8ToUpper
std::string convertUTF8ToUpper(const std::string &input)
Converts the input string into a upper case version, also taking into account non-ASCII characters th...
Definition utf8.cpp:192
getUTF8CharAt
std::string getUTF8CharAt(const std::string &input, size_t pos)
Returns the UTF8 character found at byte position pos in the input string.
Definition utf8.cpp:127